Networking: A little more wording changes related to interrupts vs. events

This commit is contained in:
Gregory Nutt 2017-08-29 15:08:38 -06:00
parent 04ad162540
commit 0b2a4eb4bd
30 changed files with 48 additions and 48 deletions

View File

@ -378,8 +378,8 @@ void arp_notify(in_addr_t ipaddr);
* ipaddr - Refers to an IP address in network order
*
* Assumptions
* Interrupts are disabled; Returned value will become unstable when
* interrupts are re-enabled or if any other network APIs are called.
* The network is locked; Returned value will become unstable when the
* network is unlocked or if any other network APIs are called.
*
****************************************************************************/

View File

@ -86,7 +86,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -111,7 +111,7 @@ struct icmp_ping_s
* TRUE:timeout FALSE:no timeout
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -66,7 +66,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -77,7 +77,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -133,7 +133,7 @@ struct net_driver_s; /* Forward reference */
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/
@ -189,7 +189,7 @@ int icmpv6_neighbor(const net_ipv6addr_t ipaddr);
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -92,7 +92,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -123,7 +123,7 @@ struct icmpv6_ping_s
* TRUE:timeout FALSE:no timeout
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -246,7 +246,7 @@ static void icmpv6_echo_request(FAR struct net_driver_s *dev,
* Modified value of the input flags
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -83,7 +83,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -68,7 +68,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -295,7 +295,7 @@ void igmp_poll(FAR struct net_driver_s *dev);
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -110,7 +110,7 @@ static uint16_t igmp_chksum(FAR uint8_t *buffer, int buflen)
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -104,7 +104,7 @@ struct tcp_close_s
* TRUE:timeout FALSE:no timeout
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -551,7 +551,7 @@ static int inet_recvfrom_timeout(struct inet_recvfrom_s *pstate)
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -206,7 +206,7 @@ void pkt_free(FAR struct pkt_conn_s *conn)
* connection to be used with the provided Ethernet header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -246,7 +246,7 @@ FAR struct pkt_conn_s *pkt_active(struct eth_hdr_s *buf)
* Traverse the list of allocated packet connections
*
* Assumptions:
* This function is called from UIP logic at interrupt level (or with
* This function is called from network logic at interrupt level (or with
* interrupts disabled).
*
****************************************************************************/

View File

@ -80,7 +80,7 @@
* place.
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -72,7 +72,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -88,7 +88,7 @@ struct accept_s
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -158,7 +158,7 @@ static inline void accept_tcpsender(FAR struct socket *psock,
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -76,7 +76,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/
@ -201,7 +201,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -312,7 +312,7 @@ static int tcp_selectport(uint8_t domain, FAR const union ip_addr_u *ipaddr,
* connection to be used with the provided TCP/IP header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -379,7 +379,7 @@ static inline FAR struct tcp_conn_s *
* connection to be used with the provided TCP/IP header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -819,7 +819,7 @@ void tcp_free(FAR struct tcp_conn_s *conn)
* connection to be used with the provided TCP/IP header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -852,7 +852,7 @@ FAR struct tcp_conn_s *tcp_active(FAR struct net_driver_s *dev,
* Traverse the list of active TCP connections
*
* Assumptions:
* This function is called from UIP logic at interrupt level (or with
* This function is called from network logic at interrupt level (or with
* interrupts disabled).
*
****************************************************************************/
@ -878,7 +878,7 @@ FAR struct tcp_conn_s *tcp_nextconn(FAR struct tcp_conn_s *conn)
* a new connection and initialize it to send a SYNACK in return.
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/

View File

@ -80,7 +80,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -85,7 +85,7 @@ struct tcp_poll_s
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -121,7 +121,7 @@
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -223,7 +223,7 @@ static inline void psock_lost_connection(FAR struct socket *psock,
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -275,7 +275,7 @@ static inline void send_ipselect(FAR struct net_driver_s *dev,
* the network device is not Ethernet).
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -336,7 +336,7 @@ static inline bool psock_send_addrchck(FAR struct tcp_conn_s *conn)
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -127,7 +127,7 @@ struct sendfile_s
* TRUE:timeout FALSE:no timeout
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -269,7 +269,7 @@ static uint16_t ack_eventhandler(FAR struct net_driver_s *dev,
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/
@ -323,7 +323,7 @@ static inline bool sendfile_addrcheck(FAR struct tcp_conn_s *conn)
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -76,7 +76,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -245,7 +245,7 @@ static uint16_t udp_select_port(uint8_t domain, FAR union ip_binding_u *u)
* used within the provided UDP header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -337,7 +337,7 @@ static inline FAR struct udp_conn_s *
* used within the provided UDP header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -534,7 +534,7 @@ void udp_free(FAR struct udp_conn_s *conn)
* connection to be used within the provided UDP header
*
* Assumptions:
* This function is called from UIP logic at interrupt level
* This function is called from network logic at interrupt level
*
****************************************************************************/
@ -567,7 +567,7 @@ FAR struct udp_conn_s *udp_active(FAR struct net_driver_s *dev,
* Traverse the list of allocated UDP connections
*
* Assumptions:
* This function is called from UIP logic at interrupt level (or with
* This function is called from network logic at interrupt level (or with
* interrupts disabled).
*
****************************************************************************/

View File

@ -72,7 +72,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -79,7 +79,7 @@
* no outgoing data.
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/

View File

@ -84,7 +84,7 @@ struct udp_poll_s
* None
*
* Assumptions:
* Running at the interrupt level
* The network is locked
*
****************************************************************************/

View File

@ -93,7 +93,7 @@
* None
*
* Assumptions:
* Called from the interrupt level or with interrupts disabled.
* The network is locked.
*
****************************************************************************/