334 lines
12 KiB
C
334 lines
12 KiB
C
/****************************************************************************
|
|
* net/inet/inet.h
|
|
*
|
|
* Copyright (C) 2007-2009, 2011-2014 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __NET_INET_INET_H
|
|
#define __NET_INET_INET_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <nuttx/net/net.h>
|
|
#include <nuttx/net/ip.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Configuration */
|
|
|
|
#undef HAVE_INET_SOCKETS
|
|
#undef HAVE_PFINET_SOCKETS
|
|
#undef HAVE_PFINET6_SOCKETS
|
|
|
|
#if defined(CONFIG_NET_IPv4) || defined(CONFIG_NET_IPv6)
|
|
# define HAVE_INET_SOCKETS
|
|
|
|
# if defined(CONFIG_NET_IPv4)
|
|
# define HAVE_PFINET_SOCKETS
|
|
# endif
|
|
|
|
# if defined(CONFIG_NET_IPv6)
|
|
# define HAVE_PFINET6_SOCKETS
|
|
# endif
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
/* Increasing number used for the IP ID field. */
|
|
|
|
EXTERN uint16_t g_ipid;
|
|
#endif /* CONFIG_NET_IPv4 */
|
|
|
|
/* Well-known IPv6 addresses */
|
|
|
|
#ifdef CONFIG_NET_IPv6
|
|
EXTERN const net_ipv6addr_t g_ipv6_unspecaddr; /* An address of all zeroes */
|
|
EXTERN const net_ipv6addr_t g_ipv6_allnodes; /* All link local nodes */
|
|
|
|
#if defined(CONFIG_NET_ICMPv6_AUTOCONF) || defined(CONFIG_NET_ICMPv6_ROUTER) || \
|
|
defined(CONFIG_NET_MLD)
|
|
/* IPv6 Multi-cast IP addresses. See RFC 2375 */
|
|
|
|
EXTERN const net_ipv6addr_t g_ipv6_allrouters; /* All link local routers */
|
|
#ifdef CONFIG_NET_ICMPv6_AUTOCONF
|
|
EXTERN const net_ipv6addr_t g_ipv6_llnetmask; /* Netmask for local link address */
|
|
#endif
|
|
#ifdef CONFIG_NET_MLD
|
|
EXTERN const net_ipv6addr_t g_ipv6_allmldv2routers; /* All MLDv2 link local routers */
|
|
#endif
|
|
#ifdef CONFIG_NET_ETHERNET
|
|
/* IPv6 Multi-cast Ethernet addresses. Formed from the 16-bit prefix:
|
|
*
|
|
* 0x33:0x33:xx:xx:xx:xx:
|
|
*
|
|
* and the last 32-bits of the IPv6 IP address
|
|
*/
|
|
|
|
EXTERN const struct ether_addr g_ipv6_ethallnodes; /* All link local nodes */
|
|
EXTERN const struct ether_addr g_ipv6_ethallrouters; /* All link local routers */
|
|
|
|
#endif /* CONFIG_NET_ETHERNET */
|
|
#endif /* CONFIG_NET_ICMPv6_AUTOCONF || CONFIG_NET_ICMPv6_ROUTER || CONFIG_NET_MLD */
|
|
#endif /* CONFIG_NET_IPv6 */
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#if defined(CONFIG_NET_TCP) && !defined(CONFIG_NET_TCP_NO_STACK)
|
|
struct tcp_conn_s; /* Forward reference */
|
|
#endif
|
|
struct socket; /* Forward reference */
|
|
|
|
/****************************************************************************
|
|
* Name: inet_setipid
|
|
*
|
|
* Description:
|
|
* This function may be used at boot time to set the initial ip_id.
|
|
*
|
|
* Assumptions:
|
|
*
|
|
****************************************************************************/
|
|
|
|
void inet_setipid(uint16_t id);
|
|
|
|
/****************************************************************************
|
|
* Name: inet_sockif
|
|
*
|
|
* Description:
|
|
* Return the socket interface associated with the inet address family.
|
|
*
|
|
* Input Parameters:
|
|
* family - Socket address family
|
|
* type - Socket type
|
|
* protocol - Socket protocol
|
|
*
|
|
* Returned Value:
|
|
* On success, a non-NULL instance of struct sock_intf_s is returned. NULL
|
|
* is returned only if the address family is not supported.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR const struct sock_intf_s *
|
|
inet_sockif(sa_family_t family, int type, int protocol);
|
|
|
|
/****************************************************************************
|
|
* Name: ipv4_setsockopt and ipv6_setsockopt
|
|
*
|
|
* Description:
|
|
* ipv4/6_setsockopt() sets the IPv4- or IPv6-protocol socket option
|
|
* specified by the 'option' argument to the value pointed to by the
|
|
* 'value' argument for the socket specified by the 'psock' argument.
|
|
*
|
|
* See <netinet/in.h> for the a complete list of values of IPv4 and IPv6
|
|
* protocol socket options.
|
|
*
|
|
* Input Parameters:
|
|
* psock Socket structure of socket to operate on
|
|
* option identifies the option to set
|
|
* value Points to the argument value
|
|
* value_len The length of the argument value
|
|
*
|
|
* Returned Value:
|
|
* Returns zero (OK) on success. On failure, it returns a negated errno
|
|
* value to indicate the nature of the error. See psock_setcockopt() for
|
|
* the list of possible error values.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
int ipv4_setsockopt(FAR struct socket *psock, int option,
|
|
FAR const void *value, socklen_t value_len);
|
|
#endif
|
|
#ifdef CONFIG_NET_IPv6
|
|
int ipv6_setsockopt(FAR struct socket *psock, int option,
|
|
FAR const void *value, socklen_t value_len);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: ipv4_getsockname and ipv6_sockname
|
|
*
|
|
* Description:
|
|
* The ipv4_getsockname() and ipv6_getsockname() function retrieve the
|
|
* locally-bound name of the specified INET socket.
|
|
*
|
|
* Input Parameters:
|
|
* psock Point to the socket structure instance [in]
|
|
* addr sockaddr structure to receive data [out]
|
|
* addrlen Length of sockaddr structure [in/out]
|
|
*
|
|
* Returned Value:
|
|
* On success, 0 is returned, the 'addr' argument points to the address
|
|
* of the socket, and the 'addrlen' argument points to the length of the
|
|
* address. Otherwise, a negated errno value is returned. See
|
|
* getsockname() for the list of returned error values.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
int ipv4_getsockname(FAR struct socket *psock, FAR struct sockaddr *addr,
|
|
FAR socklen_t *addrlen);
|
|
#endif
|
|
#ifdef CONFIG_NET_IPv6
|
|
int ipv6_getsockname(FAR struct socket *psock, FAR struct sockaddr *addr,
|
|
FAR socklen_t *addrlen);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: ipv4_getpeername and ipv6_peername
|
|
*
|
|
* Description:
|
|
* The ipv4_getpeername() and ipv6_peername() function retrieve the
|
|
* remote-connected name of the specified INET socket.
|
|
*
|
|
* Parameters:
|
|
* psock Point to the socket structure instance [in]
|
|
* addr sockaddr structure to receive data [out]
|
|
* addrlen Length of sockaddr structure [in/out]
|
|
*
|
|
* Returned Value:
|
|
* On success, 0 is returned, the 'addr' argument points to the address
|
|
* of the socket, and the 'addrlen' argument points to the length of the
|
|
* address. Otherwise, a negated errno value is returned. See
|
|
* getpeername() for the list of returned error values.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
int ipv4_getpeername(FAR struct socket *psock, FAR struct sockaddr *addr,
|
|
FAR socklen_t *addrlen);
|
|
#endif
|
|
#ifdef CONFIG_NET_IPv6
|
|
int ipv6_getpeername(FAR struct socket *psock, FAR struct sockaddr *addr,
|
|
FAR socklen_t *addrlen);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: inet_recvfrom
|
|
*
|
|
* Description:
|
|
* Implements the socket recvfrom interface for the case of the AF_INET
|
|
* and AF_INET6 address families. inet_recvfrom() receives messages from
|
|
* a socket, and may be used to receive data on a socket whether or not it
|
|
* is connection-oriented.
|
|
*
|
|
* If 'from' is not NULL, and the underlying protocol provides the source
|
|
* address, this source address is filled in. The argument 'fromlen' is
|
|
* initialized to the size of the buffer associated with from, and
|
|
* modified on return to indicate the actual size of the address stored
|
|
* there.
|
|
*
|
|
* Input Parameters:
|
|
* psock A pointer to a NuttX-specific, internal socket structure
|
|
* buf Buffer to receive data
|
|
* len Length of buffer
|
|
* flags Receive flags
|
|
* from Address of source (may be NULL)
|
|
* fromlen The length of the address structure
|
|
*
|
|
* Returned Value:
|
|
* On success, returns the number of characters received. If no data is
|
|
* available to be received and the peer has performed an orderly shutdown,
|
|
* recv() will return 0. Otherwise, on errors, a negated errno value is
|
|
* returned (see recvfrom() for the list of appropriate error values).
|
|
*
|
|
****************************************************************************/
|
|
|
|
ssize_t inet_recvfrom(FAR struct socket *psock, FAR void *buf, size_t len,
|
|
int flags, FAR struct sockaddr *from,
|
|
FAR socklen_t *fromlen);
|
|
|
|
/****************************************************************************
|
|
* Name: inet_close
|
|
*
|
|
* Description:
|
|
* Performs the close operation on an AF_INET or AF_INET6 socket instance
|
|
*
|
|
* Input Parameters:
|
|
* psock Socket instance
|
|
*
|
|
* Returned Value:
|
|
* 0 on success; -1 on error with errno set appropriately.
|
|
*
|
|
* Assumptions:
|
|
*
|
|
****************************************************************************/
|
|
|
|
int inet_close(FAR struct socket *psock);
|
|
|
|
/****************************************************************************
|
|
* Name: inet_txdrain
|
|
*
|
|
* Description:
|
|
* Wait for any buffered Tx data to be sent from the socket.
|
|
*
|
|
* Parameters:
|
|
* psock - Pointer to the socket structure instance
|
|
* abstime - The absolute time when the timeout will occur
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success; a negated error value is returned on
|
|
* any failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
struct timespec;
|
|
int inet_txdrain(FAR struct socket *psock,
|
|
FAR const struct timespec *abstime);
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* __NET_INET_INET_H */
|