mirror of
https://github.com/apache/nuttx.git
synced 2026-05-29 20:56:47 +08:00
Standardization of some function headers.
This commit is contained in:
+2
-2
@@ -125,7 +125,7 @@ struct pollfd; /* Forward reference */
|
||||
* Description:
|
||||
* Handle incoming ICMP input
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - The device driver structure containing the received ICMP
|
||||
* packet
|
||||
*
|
||||
@@ -232,7 +232,7 @@ FAR struct icmp_conn_s *icmp_findconn(FAR struct net_driver_s *dev, uint8_t id);
|
||||
* Description:
|
||||
* Poll a device "connection" structure for availability of ICMP TX data
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - The device driver structure to use in the send operation
|
||||
*
|
||||
* Returned Value:
|
||||
|
||||
@@ -210,7 +210,7 @@ drop:
|
||||
* Description:
|
||||
* Handle incoming ICMP input
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - The device driver structure containing the received ICMP
|
||||
* packet
|
||||
*
|
||||
|
||||
@@ -75,7 +75,7 @@ struct icmp_poll_s
|
||||
* This function is called to perform the actual UDP receive operation
|
||||
* via the device interface layer.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev The structure of the network driver that caused the event
|
||||
* conn The connection structure associated with the socket
|
||||
* flags Set of events describing why the callback was invoked
|
||||
|
||||
@@ -59,7 +59,7 @@
|
||||
* Description:
|
||||
* Poll a device "connection" structure for availability of ICMP TX data
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - The device driver structure to use in the send operation
|
||||
*
|
||||
* Returned Value:
|
||||
|
||||
@@ -89,7 +89,7 @@ struct icmp_recvfrom_s
|
||||
* Description:
|
||||
* Check for send timeout.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* pstate - Reference to instance ot recvfrom state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -131,7 +131,7 @@ static inline int recvfrom_timeout(FAR struct icmp_recvfrom_s *pstate)
|
||||
* ECHO request and/or ECHO reply actions when polled by the lower, device
|
||||
* interfacing layer.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev The structure of the network driver that caused the interrupt
|
||||
* conn The received packet, cast to void *
|
||||
* pvpriv An instance of struct icmp_recvfrom_s cast to void*
|
||||
|
||||
@@ -106,7 +106,7 @@ struct icmp_sendto_s
|
||||
* Description:
|
||||
* Check for send timeout.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* pstate - Reference to instance ot sendto state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -146,7 +146,7 @@ static inline int sendto_timeout(FAR struct icmp_sendto_s *pstate)
|
||||
* Description:
|
||||
* Setup to send an ICMP request packet
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - The device driver structure to use in the send operation
|
||||
* pstate - Reference to an instance of the ICMP sendto state structure
|
||||
*
|
||||
@@ -230,7 +230,7 @@ static void sendto_request(FAR struct net_driver_s *dev,
|
||||
* ECHO request and/or ECHO reply actions when polled by the lower, device
|
||||
* interfacing layer.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev The structure of the network driver that caused the interrupt
|
||||
* conn The received packet, cast to void *
|
||||
* pvpriv An instance of struct icmp_sendto_s cast to void*
|
||||
|
||||
+10
-10
@@ -118,7 +118,7 @@ const struct sock_intf_s g_icmp_sockif =
|
||||
* protocol are usable by this address family. Perform any family-
|
||||
* specific socket fields.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock A pointer to a user allocated socket structure to be
|
||||
* initialized.
|
||||
* protocol (see sys/socket.h)
|
||||
@@ -172,7 +172,7 @@ static int icmp_setup(FAR struct socket *psock, int protocol)
|
||||
* Description:
|
||||
* Return the bit encoded capabilities of this socket.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock - Socket structure of the socket whose capabilities are being
|
||||
* queried.
|
||||
*
|
||||
@@ -192,7 +192,7 @@ static sockcaps_t icmp_sockcaps(FAR struct socket *psock)
|
||||
* Description:
|
||||
* Increment the refernce count on the underlying connection structure.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock - Socket structure of the socket whose reference count will be
|
||||
* incremented.
|
||||
*
|
||||
@@ -233,7 +233,7 @@ static void icmp_addref(FAR struct socket *psock)
|
||||
* Connectionless sockets may dissolve the association by connecting to
|
||||
* an address with the sa_family member of sockaddr set to AF_UNSPEC.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock Pointer to a socket structure initialized by psock_socket()
|
||||
* addr Server address (form depends on type of socket)
|
||||
* addrlen Length of actual 'addr'
|
||||
@@ -278,7 +278,7 @@ static int icmp_connect(FAR struct socket *psock,
|
||||
* pending connections are present on the queue, icmp_accept returns
|
||||
* EAGAIN.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock Reference to the listening socket structure
|
||||
* addr Receives the address of the connecting client
|
||||
* addrlen Input: allocated size of 'addr', Return: returned size of 'addr'
|
||||
@@ -308,7 +308,7 @@ static int icmp_accept(FAR struct socket *psock, FAR struct sockaddr *addr,
|
||||
* name to a socket." When a socket is created with socket(), it exists
|
||||
* in a name space (address family) but has no name assigned.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock Socket structure of the socket to bind
|
||||
* addr Socket local address
|
||||
* addrlen Length of 'addr'
|
||||
@@ -342,7 +342,7 @@ static int icmp_bind(FAR struct socket *psock, FAR const struct sockaddr *addr,
|
||||
* If the socket has not been bound to a local name, the value stored in
|
||||
* the object pointed to by address is unspecified.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock Socket structure of the socket to be queried
|
||||
* addr sockaddr structure to receive data [out]
|
||||
* addrlen Length of sockaddr structure [in/out]
|
||||
@@ -372,7 +372,7 @@ static int icmp_getsockname(FAR struct socket *psock,
|
||||
* packet sockets, psock_listen() calls this function. The psock_listen()
|
||||
* call applies only to sockets of type SOCK_STREAM or SOCK_SEQPACKET.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock Reference to an internal, boound socket structure.
|
||||
* backlog The maximum length the queue of pending connections may grow.
|
||||
* If a connection request arrives with the queue full, the client
|
||||
@@ -440,7 +440,7 @@ static int icmp_netpoll(FAR struct socket *psock, FAR struct pollfd *fds,
|
||||
* Description:
|
||||
* Socket send() method for the raw packet socket.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock An instance of the internal socket structure.
|
||||
* buf Data to send
|
||||
* len Length of data to send
|
||||
@@ -469,7 +469,7 @@ static ssize_t icmp_send(FAR struct socket *psock, FAR const void *buf,
|
||||
* Description:
|
||||
* Performs the close operation on a raw packet socket instance
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* psock Socket instance
|
||||
*
|
||||
* Returned Value:
|
||||
|
||||
Reference in New Issue
Block a user