/libs/network/wiznet/Ethernet/socket.h
C++ Header | 461 lines | 91 code | 29 blank | 341 comment | 2 complexity | a3bbc38874c7fa814e95789f0ebce383 MD5 | raw file
1//***************************************************************************** 2// 3//! \file socket.h 4//! \brief SOCKET APIs Header file. 5//! \details SOCKET APIs like as berkeley socket api. 6//! \version 1.0.0 7//! \date 2013/10/21 8//! \par Revision history 9//! <2013/10/21> 1st Release 10//! \author MidnightCow 11//! \copyright 12//! 13//! Copyright (c) 2013, WIZnet Co., LTD. 14//! All rights reserved. 15//! 16//! Redistribution and use in source and binary forms, with or without 17//! modification, are permitted provided that the following conditions 18//! are met: 19//! 20//! * Redistributions of source code must retain the above copyright 21//! notice, this list of conditions and the following disclaimer. 22//! * Redistributions in binary form must reproduce the above copyright 23//! notice, this list of conditions and the following disclaimer in the 24//! documentation and/or other materials provided with the distribution. 25//! * Neither the name of the <ORGANIZATION> nor the names of its 26//! contributors may be used to endorse or promote products derived 27//! from this software without specific prior written permission. 28//! 29//! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 30//! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 31//! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 32//! ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 33//! LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 34//! CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 35//! SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 36//! INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 37//! CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38//! ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 39//! THE POSSIBILITY OF SUCH DAMAGE. 40// 41//***************************************************************************** 42/** 43 * @defgroup WIZnet_socket_APIs 1. WIZnet socket APIs 44 * @brief WIZnet socket APIs are based on Berkeley socket APIs, thus it has much similar name and interface. 45 * But there is a little bit of difference. 46 * @details 47 * <b> Comparison between WIZnet and Berkeley SOCKET APIs </b> 48 * <table> 49 * <tr> <td><b>API</b></td> <td><b>WIZnet</b></td> <td><b>Berkeley</b></td> </tr> 50 * <tr> <td>socket()</td> <td>O</td> <td>O</td> </tr> 51 * <tr> <td><b>bind()</b></td> <td>X</td> <td>O</td> </tr> 52 * <tr> <td><b>listen()</b></td> <td>O</td> <td>O</td> </tr> 53 * <tr> <td><b>connect()</b></td> <td>O</td> <td>O</td> </tr> 54 * <tr> <td><b>accept()</b></td> <td>X</td> <td>O</td> </tr> 55 * <tr> <td><b>recv()</b></td> <td>O</td> <td>O</td> </tr> 56 * <tr> <td><b>send()</b></td> <td>O</td> <td>O</td> </tr> 57 * <tr> <td><b>recvfrom()</b></td> <td>O</td> <td>O</td> </tr> 58 * <tr> <td><b>sendto()</b></td> <td>O</td> <td>O</td> </tr> 59 * <tr> <td><b>closesocket()</b></td> <td>O<br>close() & disconnect()</td> <td>O</td> </tr> 60 * </table> 61 * There are @b bind() and @b accept() functions in @b Berkeley SOCKET API but, 62 * not in @b WIZnet SOCKET API. Because socket() of WIZnet is not only creating a SOCKET but also binding a local port number, 63 * and listen() of WIZnet is not only listening to connection request from client but also accepting the connection request. \n 64 * When you program "TCP SERVER" with Berkeley SOCKET API, you can use only one listen port. 65 * When the listen SOCKET accepts a connection request from a client, it keeps listening. 66 * After accepting the connection request, a new SOCKET is created and the new SOCKET is used in communication with the client. \n 67 * Following figure shows network flow diagram by Berkeley SOCKET API. 68 * @image html Berkeley_SOCKET.jpg "<Berkeley SOCKET API>" 69 * But, When you program "TCP SERVER" with WIZnet SOCKET API, you can use as many as 8 listen SOCKET with same port number. \n 70 * Because there's no accept() in WIZnet SOCKET APIs, when the listen SOCKET accepts a connection request from a client, 71 * it is changed in order to communicate with the client. 72 * And the changed SOCKET is not listening any more and is dedicated for communicating with the client. \n 73 * If there're many listen SOCKET with same listen port number and a client requests a connection, 74 * the SOCKET which has the smallest SOCKET number accepts the request and is changed as communication SOCKET. \n 75 * Following figure shows network flow diagram by WIZnet SOCKET API. 76 * @image html WIZnet_SOCKET.jpg "<WIZnet SOCKET API>" 77 */ 78#ifndef _SOCKET_H_ 79#define _SOCKET_H_ 80 81#include "Ethernet/wizchip_conf.h" 82 83#define SOCKET uint8_t ///< SOCKET type define for legacy driver 84 85#define SOCK_OK 1 ///< Result is OK about socket process. 86#define SOCK_BUSY 0 ///< Socket is busy on processing the operation. Valid only Non-block IO Mode. 87#define SOCK_FATAL -1000 ///< Result is fatal error about socket process. 88 89#define SOCK_ERROR 0 90#define SOCKERR_SOCKNUM (SOCK_ERROR - 1) ///< Invalid socket number 91#define SOCKERR_SOCKOPT (SOCK_ERROR - 2) ///< Invalid socket option 92#define SOCKERR_SOCKINIT (SOCK_ERROR - 3) ///< Socket is not initialized 93#define SOCKERR_SOCKCLOSED (SOCK_ERROR - 4) ///< Socket unexpectedly closed. 94#define SOCKERR_SOCKMODE (SOCK_ERROR - 5) ///< Invalid socket mode for socket operation. 95#define SOCKERR_SOCKFLAG (SOCK_ERROR - 6) ///< Invalid socket flag 96#define SOCKERR_SOCKSTATUS (SOCK_ERROR - 7) ///< Invalid socket status for socket operation. 97#define SOCKERR_ARG (SOCK_ERROR - 10) ///< Invalid argrument. 98#define SOCKERR_PORTZERO (SOCK_ERROR - 11) ///< Port number is zero 99#define SOCKERR_IPINVALID (SOCK_ERROR - 12) ///< Invalid IP address 100#define SOCKERR_TIMEOUT (SOCK_ERROR - 13) ///< Timeout occurred 101#define SOCKERR_DATALEN (SOCK_ERROR - 14) ///< Data length is zero or greater than buffer max size. 102#define SOCKERR_BUFFER (SOCK_ERROR - 15) ///< Socket buffer is not enough for data communication. 103 104#define SOCKFATAL_PACKLEN (SOCK_FATAL - 1) ///< Invalid packet length. Fatal Error. 105 106/* 107 * SOCKET FLAG 108 */ 109#define SF_ETHER_OWN (Sn_MR_MFEN) ///< In \ref Sn_MR_MACRAW, Receive only the packet as broadcast, multicast and own packet 110#define SF_IGMP_VER2 (Sn_MR_MC) ///< In \ref Sn_MR_UDP with \ref SF_MULTI_ENABLE, Select IGMP version 2. 111#define SF_TCP_NODELAY (Sn_MR_ND) ///< In \ref Sn_MR_TCP, Use to nodelayed ack. 112#define SF_MULTI_ENABLE (Sn_MR_MULTI) ///< In \ref Sn_MR_UDP, Enable multicast mode. 113 114#if _WIZCHIP_ == 5500 115 #define SF_BROAD_BLOCK (Sn_MR_BCASTB) ///< In \ref Sn_MR_UDP or \ref Sn_MR_MACRAW, Block broadcast packet. Valid only in W5500 116 #define SF_MULTI_BLOCK (Sn_MR_MMB) ///< In \ref Sn_MR_MACRAW, Block multicast packet. Valid only in W5500 117 #define SF_IPv6_BLOCK (Sn_MR_MIP6B) ///< In \ref Sn_MR_MACRAW, Block IPv6 packet. Valid only in W5500 118 #define SF_UNI_BLOCK (Sn_MR_UCASTB) ///< In \ref Sn_MR_UDP with \ref SF_MULTI_ENABLE. Valid only in W5500 119#endif 120 121#define SF_IO_NONBLOCK 0x01 ///< Socket nonblock io mode. It used parameter in \ref socket(). 122 123/* 124 * UDP & MACRAW Packet Infomation 125 */ 126#define PACK_FIRST 0x80 ///< In Non-TCP packet, It indicates to start receiving a packet. 127#define PACK_REMAINED 0x01 ///< In Non-TCP packet, It indicates to remain a packet to be received. 128#define PACK_COMPLETED 0x00 ///< In Non-TCP packet, It indicates to complete to receive a packet. 129 130/** 131 * @ingroup WIZnet_socket_APIs 132 * @brief Open a socket. 133 * @details Initializes the socket with 'sn' passed as parameter and open. 134 * 135 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 136 * @param protocol Protocol type to operate such as TCP, UDP and MACRAW. 137 * @param port Port number to be bined. 138 * @param flag Socket flags as \ref SF_ETHER_OWN, \ref SF_IGMP_VER2, \ref SF_TCP_NODELAY, \ref SF_MULTI_ENABLE, \ref SF_IO_NONBLOCK and so on.\n 139 * Valid flags only in W5500 : @ref SF_BROAD_BLOCK, @ref SF_MULTI_BLOCK, @ref SF_IPv6_BLOCK, and @ref SF_UNI_BLOCK. 140 * @sa Sn_MR 141 * 142 * @return @b Success : The socket number @b 'sn' passed as parameter\n 143 * @b Fail :\n @ref SOCKERR_SOCKNUM - Invalid socket number\n 144 * @ref SOCKERR_SOCKMODE - Not support socket mode as TCP, UDP, and so on. \n 145 * @ref SOCKERR_SOCKFLAG - Invaild socket flag. 146 */ 147int8_t socket(uint8_t sn, uint8_t protocol, uint16_t port, uint8_t flag); 148 149/** 150 * @ingroup WIZnet_socket_APIs 151 * @brief Close a socket. 152 * @details It closes the socket with @b'sn' passed as parameter. 153 * 154 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 155 * 156 * @return @b Success : @ref SOCK_OK \n 157 * @b Fail : @ref SOCKERR_SOCKNUM - Invalid socket number 158 */ 159int8_t close(uint8_t sn); 160 161/** 162 * @ingroup WIZnet_socket_APIs 163 * @brief Listen to a connection request from a client. 164 * @details It is listening to a connection request from a client. 165 * If connection request is accepted successfully, the connection is established. Socket sn is used in passive(server) mode. 166 * 167 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 168 * @return @b Success : @ref SOCK_OK \n 169 * @b Fail :\n @ref SOCKERR_SOCKINIT - Socket is not initialized \n 170 * @ref SOCKERR_SOCKCLOSED - Socket closed unexpectedly. 171 */ 172int8_t listen(uint8_t sn); 173 174/** 175 * @ingroup WIZnet_socket_APIs 176 * @brief Try to connect a server. 177 * @details It requests connection to the server with destination IP address and port number passed as parameter.\n 178 * @note It is valid only in TCP client mode. 179 * In block io mode, it does not return until connection is completed. 180 * In Non-block io mode, it return @ref SOCK_BUSY immediatly. 181 * 182 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 183 * @param addr Pointer variable of destination IP address. It should be allocated 4 bytes. 184 * @param port Destination port number. 185 * 186 * @return @b Success : @ref SOCK_OK \n 187 * @b Fail :\n @ref SOCKERR_SOCKNUM - Invalid socket number\n 188 * @ref SOCKERR_SOCKMODE - Invalid socket mode\n 189 * @ref SOCKERR_SOCKINIT - Socket is not initialized\n 190 * @ref SOCKERR_IPINVALID - Wrong server IP address\n 191 * @ref SOCKERR_PORTZERO - Server port zero\n 192 * @ref SOCKERR_TIMEOUT - Timeout occurred during request connection\n 193 * @ref SOCK_BUSY - In non-block io mode, it returned immediatly\n 194 */ 195int8_t connect(uint8_t sn, uint8_t * addr, uint16_t port); 196 197/** 198 * @ingroup WIZnet_socket_APIs 199 * @brief Try to disconnect a connection socket. 200 * @details It sends request message to disconnect the TCP socket 'sn' passed as parameter to the server or client. 201 * @note It is valid only in TCP server or client mode. \n 202 * In block io mode, it does not return until disconnection is completed. \n 203 * In Non-block io mode, it return @ref SOCK_BUSY immediatly. \n 204 205 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 206 * @return @b Success : @ref SOCK_OK \n 207 * @b Fail :\n @ref SOCKERR_SOCKNUM - Invalid socket number \n 208 * @ref SOCKERR_SOCKMODE - Invalid operation in the socket \n 209 * @ref SOCKERR_TIMEOUT - Timeout occurred \n 210 * @ref SOCK_BUSY - Socket is busy. 211 */ 212int8_t disconnect(uint8_t sn); 213 214/** 215 * @ingroup WIZnet_socket_APIs 216 * @brief Send data to the connected peer in TCP socket. 217 * @details It is used to send outgoing data to the connected socket. 218 * @note It is valid only in TCP server or client mode. It can't send data greater than socket buffer size. \n 219 * In block io mode, It doesn't return until data send is completed - socket buffer size is greater than data. \n 220 * In non-block io mode, It return @ref SOCK_BUSY immediatly when socket buffer is not enough. \n 221 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 222 * @param buf Pointer buffer containing data to be sent. 223 * @param len The byte length of data in buf. 224 * @return @b Success : The sent data size \n 225 * @b Fail : \n @ref SOCKERR_SOCKSTATUS - Invalid socket status for socket operation \n 226 * @ref SOCKERR_TIMEOUT - Timeout occurred \n 227 * @ref SOCKERR_SOCKMODE - Invalid operation in the socket \n 228 * @ref SOCKERR_SOCKNUM - Invalid socket number \n 229 * @ref SOCKERR_DATALEN - zero data length \n 230 * @ref SOCK_BUSY - Socket is busy. 231 */ 232int32_t send(uint8_t sn, uint8_t * buf, uint16_t len); 233 234/** 235 * @ingroup WIZnet_socket_APIs 236 * @brief Receive data from the connected peer. 237 * @details It is used to read incoming data from the connected socket.\n 238 * It waits for data as much as the application wants to receive. 239 * @note It is valid only in TCP server or client mode. It can't receive data greater than socket buffer size. \n 240 * In block io mode, it doesn't return until data reception is completed - data is filled as <I>len</I> in socket buffer. \n 241 * In non-block io mode, it return @ref SOCK_BUSY immediatly when <I>len</I> is greater than data size in socket buffer. \n 242 * 243 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 244 * @param buf Pointer buffer to read incoming data. 245 * @param len The max data length of data in buf. 246 * @return @b Success : The real received data size \n 247 * @b Fail :\n 248 * @ref SOCKERR_SOCKSTATUS - Invalid socket status for socket operation \n 249 * @ref SOCKERR_SOCKMODE - Invalid operation in the socket \n 250 * @ref SOCKERR_SOCKNUM - Invalid socket number \n 251 * @ref SOCKERR_DATALEN - zero data length \n 252 * @ref SOCK_BUSY - Socket is busy. 253 */ 254int32_t recv(uint8_t sn, uint8_t * buf, uint16_t len); 255 256/** 257 * @ingroup WIZnet_socket_APIs 258 * @brief Sends datagram to the peer with destination IP address and port number passed as parameter. 259 * @details It sends datagram of UDP or MACRAW to the peer with destination IP address and port number passed as parameter.\n 260 * Even if the connectionless socket has been previously connected to a specific address, 261 * the address and port number parameters override the destination address for that particular datagram only. 262 * @note In block io mode, It doesn't return until data send is completed - socket buffer size is greater than <I>len</I>. 263 * In non-block io mode, It return @ref SOCK_BUSY immediatly when socket buffer is not enough. 264 * 265 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 266 * @param buf Pointer buffer to send outgoing data. 267 * @param len The byte length of data in buf. 268 * @param addr Pointer variable of destination IP address. It should be allocated 4 bytes. 269 * @param port Destination port number. 270 * 271 * @return @b Success : The sent data size \n 272 * @b Fail :\n @ref SOCKERR_SOCKNUM - Invalid socket number \n 273 * @ref SOCKERR_SOCKMODE - Invalid operation in the socket \n 274 * @ref SOCKERR_SOCKSTATUS - Invalid socket status for socket operation \n 275 * @ref SOCKERR_DATALEN - zero data length \n 276 * @ref SOCKERR_IPINVALID - Wrong server IP address\n 277 * @ref SOCKERR_PORTZERO - Server port zero\n 278 * @ref SOCKERR_SOCKCLOSED - Socket unexpectedly closed \n 279 * @ref SOCKERR_TIMEOUT - Timeout occurred \n 280 * @ref SOCK_BUSY - Socket is busy. 281 */ 282int32_t sendto(uint8_t sn, uint8_t * buf, uint16_t len, uint8_t * addr, uint16_t port); 283 284/** 285 * @ingroup WIZnet_socket_APIs 286 * @brief Receive datagram of UDP or MACRAW 287 * @details This function is an application I/F function which is used to receive the data in other then TCP mode. \n 288 * This function is used to receive UDP and MAC_RAW mode, and handle the header as well. 289 * This function can divide to received the packet data. 290 * On the MACRAW SOCKET, the addr and port parameters are ignored. 291 * @note In block io mode, it doesn't return until data reception is completed - data is filled as <I>len</I> in socket buffer 292 * In non-block io mode, it return @ref SOCK_BUSY immediatly when <I>len</I> is greater than data size in socket buffer. 293 * 294 * @param sn Socket number. It should be <b>0 ~ @ref \_WIZCHIP_SOCK_NUM_</b>. 295 * @param buf Pointer buffer to read incoming data. 296 * @param len The max data length of data in buf. 297 * When the received packet size <= len, receives data as packet sized. 298 * When others, receives data as len. 299 * @param addr Pointer variable of destination IP address. It should be allocated 4 bytes. 300 * It is valid only when the first call recvfrom for receiving the packet. 301 * When it is valid, @ref packinfo[7] should be set as '1' after call @ref getsockopt(sn, SO_PACKINFO, &packinfo). 302 * @param port Pointer variable of destination port number. 303 * It is valid only when the first call recvform for receiving the packet. 304* When it is valid, @ref packinfo[7] should be set as '1' after call @ref getsockopt(sn, SO_PACKINFO, &packinfo). 305 * 306 * @return @b Success : This function return real received data size for success.\n 307 * @b Fail : @ref SOCKERR_DATALEN - zero data length \n 308 * @ref SOCKERR_SOCKMODE - Invalid operation in the socket \n 309 * @ref SOCKERR_SOCKNUM - Invalid socket number \n 310 * @ref SOCKBUSY - Socket is busy. 311 */ 312int32_t recvfrom(uint8_t sn, uint8_t * buf, uint16_t len, uint8_t * addr, uint16_t *port); 313 314 315///////////////////////////// 316// SOCKET CONTROL & OPTION // 317///////////////////////////// 318#define SOCK_IO_BLOCK 0 ///< Socket Block IO Mode in @ref setsockopt(). 319#define SOCK_IO_NONBLOCK 1 ///< Socket Non-block IO Mode in @ref setsockopt(). 320 321/** 322 * @defgroup DATA_TYPE DATA TYPE 323 */ 324 325/** 326 * @ingroup DATA_TYPE 327 * @brief The kind of Socket Interrupt. 328 * @sa Sn_IR, Sn_IMR, setSn_IR(), getSn_IR(), setSn_IMR(), getSn_IMR() 329 */ 330typedef enum 331{ 332 SIK_CONNECTED = (1 << 0), ///< conntected 333 SIK_DISCONNECTED = (1 << 1), ///< disconnected 334 SIK_RECEIVED = (1 << 2), ///< data received 335 SIK_TIMEOUT = (1 << 3), ///< timeout occured 336 SIK_SENT = (1 << 4), ///< send ok 337 SIK_ALL = 0x1F, ///< all interrupt 338}sockint_kind; 339 340/** 341 * @ingroup DATA_TYPE 342 * @brief The type of @ref ctlsocket(). 343 */ 344typedef enum 345{ 346 CS_SET_IOMODE, ///< set socket IO mode with @ref SOCK_IO_BLOCK or @ref SOCK_IO_NONBLOCK 347 CS_GET_IOMODE, ///< get socket IO mode 348 CS_GET_MAXTXBUF, ///< get the size of socket buffer allocated in TX memory 349 CS_GET_MAXRXBUF, ///< get the size of socket buffer allocated in RX memory 350 CS_CLR_INTERRUPT, ///< clear the interrupt of socket with @ref sockint_kind 351 CS_GET_INTERRUPT, ///< get the socket interrupt. refer to @ref sockint_kind 352 CS_SET_INTMASK, ///< set the interrupt mask of socket with @ref sockint_kind 353 CS_GET_INTMASK ///< get the masked interrupt of socket. refer to @ref sockint_kind 354}ctlsock_type; 355 356 357/** 358 * @ingroup DATA_TYPE 359 * @brief The type of socket option in @ref setsockopt() or @ref getsockopt() 360 */ 361typedef enum 362{ 363 SO_FLAG, ///< Valid only in getsockopt(), For set flag of socket refer to <I>flag</I> in @ref socket(). 364 SO_TTL, ///< Set/Get TTL. @ref Sn_TTL ( @ref setSn_TTL(), @ref getSn_TTL() ) 365 SO_TOS, ///< Set/Get TOS. @ref Sn_TOS ( @ref setSn_TOS(), @ref getSn_TOS() ) 366 SO_MSS, ///< Set/Get MSS. @ref Sn_MSSR ( @ref setSn_MSSR(), @ref getSn_MSSR() ) 367 SO_DESTIP, ///< Set/Get the destination IP address. @ref Sn_DIPR ( @ref setSn_DIPR(), @ref getSn_DIPR() ) 368 SO_DESTPORT, ///< Set/Get the destionation Port number. @ref Sn_DPORT ( @ref setSn_DPORT(), @ref getSn_DPORT() ) 369#if _WIZCHIP_ != 5100 370 SO_KEEPALIVESEND, ///< Valid only in setsockopt. Manually send keep-alive packet in TCP mode 371 #if _WIZCHIP_ > 5200 372 SO_KEEPALIVEAUTO, ///< Set/Get keep-alive auto transmittion timer in TCP mode 373 #endif 374#endif 375 SO_SENDBUF, ///< Valid only in getsockopt. Get the free data size of Socekt TX buffer. @ref Sn_TX_FSR, @ref getSn_TX_FSR() 376 SO_RECVBUF, ///< Valid only in getsockopt. Get the received data size in socket RX buffer. @ref Sn_RX_RSR, @ref getSn_RX_RSR() 377 SO_STATUS, ///< Valid only in getsockopt. Get the socket status. @ref Sn_SR, @ref getSn_SR() 378 SO_REMAINSIZE, ///< Valid only in getsockopt. Get the remained packet size in other then TCP mode. 379 SO_PACKINFO ///< Valid only in getsockopt. Get the packet information as @ref PACK_FIRST, @ref PACK_REMAINED, and @ref PACK_COMPLETED in other then TCP mode. 380}sockopt_type; 381 382/** 383 * @ingroup WIZnet_socket_APIs 384 * @brief Control socket. 385 * @details Control IO mode, Interrupt & Mask of socket and get the socket buffer information. 386 * Refer to @ref ctlsock_type. 387 * @param sn socket number 388 * @param cstype type of control socket. refer to @ref ctlsock_type. 389 * @param arg Data type and value is determined according to @ref ctlsock_type. \n 390 * <table> 391 * <tr> <td> @b cstype </td> <td> @b data type</td><td>@b value</td></tr> 392 * <tr> <td> @ref CS_SET_IOMODE \n @ref CS_GET_IOMODE </td> <td> uint8_t </td><td>@ref SOCK_IO_BLOCK @ref SOCK_IO_NONBLOCK</td></tr> 393 * <tr> <td> @ref CS_GET_MAXTXBUF \n @ref CS_GET_MAXRXBUF </td> <td> uint16_t </td><td> 0 ~ 16K </td></tr> 394 * <tr> <td> @ref CS_CLR_INTERRUPT \n @ref CS_GET_INTERRUPT \n @ref CS_SET_INTMASK \n @ref CS_GET_INTMASK </td> <td> @ref sockint_kind </td><td> @ref SIK_CONNECTED, etc. </td></tr> 395 * </table> 396 * @return @b Success @ref SOCK_OK \n 397 * @b fail @ref SOCKERR_ARG - Invalid argument\n 398 */ 399int8_t ctlsocket(uint8_t sn, ctlsock_type cstype, void* arg); 400 401/** 402 * @ingroup WIZnet_socket_APIs 403 * @brief set socket options 404 * @details Set socket option like as TTL, MSS, TOS, and so on. Refer to @ref sockopt_type. 405 * 406 * @param sn socket number 407 * @param sotype socket option type. refer to @ref sockopt_type 408 * @param arg Data type and value is determined according to <I>sotype</I>. \n 409 * <table> 410 * <tr> <td> @b sotype </td> <td> @b data type</td><td>@b value</td></tr> 411 * <tr> <td> @ref SO_TTL </td> <td> uint8_t </td><td> 0 ~ 255 </td> </tr> 412 * <tr> <td> @ref SO_TOS </td> <td> uint8_t </td><td> 0 ~ 255 </td> </tr> 413 * <tr> <td> @ref SO_MSS </td> <td> uint16_t </td><td> 0 ~ 65535 </td> </tr> 414 * <tr> <td> @ref SO_DESTIP </td> <td> uint8_t[4] </td><td> </td></tr> 415 * <tr> <td> @ref SO_DESTPORT </td> <td> uint16_t </td><td> 0 ~ 65535 </td></tr> 416 * <tr> <td> @ref SO_KEEPALIVESEND </td> <td> null </td><td> null </td></tr> 417 * <tr> <td> @ref SO_KEEPALIVEAUTO </td> <td> uint8_t </td><td> 0 ~ 255 </td></tr> 418 * </table> 419 * @return 420 * - @b Success : @ref SOCK_OK \n 421 * - @b Fail 422 * - @ref SOCKERR_SOCKNUM - Invalid Socket number \n 423 * - @ref SOCKERR_SOCKMODE - Invalid socket mode \n 424 * - @ref SOCKERR_SOCKOPT - Invalid socket option or its value \n 425 * - @ref SOCKERR_TIMEOUT - Timeout occurred when sending keep-alive packet \n 426 */ 427int8_t setsockopt(uint8_t sn, sockopt_type sotype, void* arg); 428 429/** 430 * @ingroup WIZnet_socket_APIs 431 * @brief get socket options 432 * @details Get socket option like as FLAG, TTL, MSS, and so on. Refer to @ref sockopt_type 433 * @param sn socket number 434 * @param sotype socket option type. refer to @ref sockopt_type 435 * @param arg Data type and value is determined according to <I>sotype</I>. \n 436 * <table> 437 * <tr> <td> @b sotype </td> <td>@b data type</td><td>@b value</td></tr> 438 * <tr> <td> @ref SO_FLAG </td> <td> uint8_t </td><td> @ref SF_ETHER_OWN, etc... </td> </tr> 439 * <tr> <td> @ref SO_TOS </td> <td> uint8_t </td><td> 0 ~ 255 </td> </tr> 440 * <tr> <td> @ref SO_MSS </td> <td> uint16_t </td><td> 0 ~ 65535 </td> </tr> 441 * <tr> <td> @ref SO_DESTIP </td> <td> uint8_t[4] </td><td> </td></tr> 442 * <tr> <td> @ref SO_DESTPORT </td> <td> uint16_t </td><td> </td></tr> 443 * <tr> <td> @ref SO_KEEPALIVEAUTO </td> <td> uint8_t </td><td> 0 ~ 255 </td></tr> 444 * <tr> <td> @ref SO_SENDBUF </td> <td> uint16_t </td><td> 0 ~ 65535 </td></tr> 445 * <tr> <td> @ref SO_RECVBUF </td> <td> uint16_t </td><td> 0 ~ 65535 </td></tr> 446 * <tr> <td> @ref SO_STATUS </td> <td> uint8_t </td><td> @ref SOCK_ESTABLISHED, etc.. </td></tr> 447 * <tr> <td> @ref SO_REMAINSIZE </td> <td> uint16_t </td><td> 0~ 65535 </td></tr> 448 * <tr> <td> @ref SO_PACKINFO </td> <td> uint8_t </td><td> @ref PACK_FIRST, etc... </td></tr> 449 * </table> 450 * @return 451 * - @b Success : @ref SOCK_OK \n 452 * - @b Fail 453 * - @ref SOCKERR_SOCKNUM - Invalid Socket number \n 454 * - @ref SOCKERR_SOCKOPT - Invalid socket option or its value \n 455 * - @ref SOCKERR_SOCKMODE - Invalid socket mode \n 456 * @note 457 * The option as SO_REMAINED and SO_PACKINFO is valid only in NON-TCP mode and after call @ref recvfrom(). 458 */ 459int8_t getsockopt(uint8_t sn, sockopt_type sotype, void* arg); 460 461#endif // _SOCKET_H_