F030C8T6_Kbus_MIX.git

QuakeGod

2024-11-25 9aed5d7e7b3c7bf09da712e9c272ece401a7acc9

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