Replace confusing references to uIP with just 'the network'

This commit is contained in:
Gregory Nutt 2016-05-30 09:51:15 -06:00
parent 44353f320c
commit 9b4cec9228
11 changed files with 48 additions and 46 deletions

View File

@ -102,9 +102,9 @@ extern "C"
****************************************************************************/
/* If CONFIG_NET_ARPIOCTLS is defined then the semi-standard ioctl commands
* described above are supported. If not, you can call the uIP ARP interfaces
* directly in a very non-standard way. See include/nuttx/net/arp.h for
* prototypes.
* described above are supported. If not, you can call the network ARP
* interfaces directly in a very non-standard way. See
* include/nuttx/net/arp.h for prototypes.
*/
#undef EXTERN

View File

@ -86,9 +86,9 @@ struct cs89x0_driver_s
uint32_t cs_txunderrun; /* Count of Tx underrun errors */
#endif
/* This holds the information visible to uIP/NuttX */
/* This holds the information visible to the NuttX network */
struct net_driver_s cs_dev; /* Interface understood by uIP */
struct net_driver_s cs_dev; /* Interface understood by the network */
};
/****************************************************************************

View File

@ -1,6 +1,6 @@
/****************************************************************************
* include/nuttx/net/icmp.h
* Header file for the uIP ICMP stack.
* Header file for the NuttX ICMP stack.
*
* Copyright (C) 2007-2009, 2012, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>

View File

@ -1,6 +1,6 @@
/****************************************************************************
* include/nuttx/net/icmpv6.h
* Header file for the uIP ICMPv6 stack.
* Header file for the NuttX ICMPv6 stack.
*
* Copyright (C) 2007-2009, 2012, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>

View File

@ -1,7 +1,7 @@
/****************************************************************************
* include/nuttx/net/igmp.h
* The definitions in this header file are intended only for internal use
* by the NuttX port of the uIP stack.
* by the NuttX network stack.
*
* Copyright (C) 2010, 2012, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>

View File

@ -1,7 +1,7 @@
/****************************************************************************
* include/nuttx/net/ip.h
*
* The uIP header file contains IP-related definitions for a number of C
* This header file contains IP-related definitions for a number of C
* macros that are used by applications as well as internally by the
* OS networking logic.
*

View File

@ -222,10 +222,11 @@ void net_initialize(void);
/****************************************************************************
* Critical section management. The NuttX configuration setting
* CONFIG_NET_NOINTS indicates that uIP not called from the interrupt level.
* If CONFIG_NET_NOINTS is defined, then these will map to semaphore
* controls. Otherwise, it assumed that uIP will be called from interrupt
* level handling and these will map to interrupt enable/disable controls.
* CONFIG_NET_NOINTS indicates that the network stack not called from the
* interrupt level. If CONFIG_NET_NOINTS is defined, then these will map
* to semaphore controls. Otherwise, it assumed that the stack will be
* called from interrupt level handling and these will map to interrupt
* enable/disable controls.
*
*
* If CONFIG_NET_NOINTS is defined, then semaphore based locking is used:

View File

@ -1,10 +1,10 @@
/****************************************************************************
* include/nuttx/net/netconfig.h
* Configuration options for NuttX uIP-based networking.
* Configuration options for NuttX networking.
*
* This file is used for tweaking various configuration options for
* uIP. This is most assuring the correct default values are provided and
* that configured options are valid.
* This file is used for tweaking various configuration options for the
* network. This is most assuring the correct default values are provided
* and that configured options are valid.
*
* Note: Network configuration options the netconfig.h should not be changed,
* but rather the per-project defconfig file.
@ -72,8 +72,8 @@
/* Layer 2 Configuration Options ********************************************/
/* The default data link layer for uIP is Ethernet. If CONFIG_NET_SLIP is
* defined in the NuttX header file, then SLIP will be supported. The basic
/* The default data link laye is Ethernet. If CONFIG_NET_SLIP is defined in
* the NuttX header file, then SLIP will be supported. The basic
* differences between the SLIP and Ethernet configurations is that when SLIP
* is selected:
*
@ -204,7 +204,7 @@
/* IP configuration options */
/* The IP TTL (time to live) of IP packets sent by uIP.
/* The IP TTL (time to live) of IP packets sent by the network stack.
*
* This should normally not be changed.
*/
@ -494,7 +494,7 @@
#ifndef CONFIG_NET_ARPTAB_SIZE
/* The size of the ARP table.
*
* This option should be set to a larger value if this uIP node will
* This option should be set to a larger value if this network node will
* have many connections from the local network.
*/
@ -532,7 +532,7 @@
/* Statistics datatype
*
* This typedef defines the dataype used for keeping statistics in
* uIP.
* the network.
*/
typedef uint16_t net_stats_t;

View File

@ -1,6 +1,7 @@
/****************************************************************************
* include/nuttx/net/netdev.h
* Defines architecture-specific device driver interfaces to the uIP network.
* Defines architecture-specific device driver interfaces to the NuttX
* network.
*
* Copyright (C) 2007, 2009, 2011-2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
@ -232,9 +233,9 @@ struct net_driver_s
* headers from this buffer. The size of the link level headers is
* configured by the NET_LL_HDRLEN(dev) define.
*
* uIP will handle only a single buffer for both incoming and outgoing
* packets. However, the drive design may be concurrently send and
* filling separate, break-off buffers if CONFIG_NET_MULTIBUFFER is
* The network will handle only a single buffer for both incoming and
* outgoing packets. However, the driver design may be concurrently send
* and filling separate, break-off buffers if CONFIG_NET_MULTIBUFFER is
* defined. That buffer management must be controlled by the driver.
*/
@ -266,7 +267,7 @@ struct net_driver_s
*
* Holds the length of the packet in the d_buf buffer.
*
* When the network device driver calls the uIP input function,
* When the network device driver calls the network input function,
* d_len should be set to the length of the packet in the d_buf
* buffer.
*
@ -353,10 +354,10 @@ typedef int (*devif_poll_callback_t)(FAR struct net_driver_s *dev);
****************************************************************************/
/****************************************************************************
* uIP device driver functions
* Network device driver functions
*
* These functions are used by a network device driver for interacting
* with uIP.
* with the NuttX network.
*
* Process an incoming IP packet.
*
@ -383,9 +384,9 @@ typedef int (*devif_poll_callback_t)(FAR struct net_driver_s *dev);
* }
* }
*
* Note: If you are writing a uIP device driver that needs ARP
* (Address Resolution Protocol), e.g., when running uIP over
* Ethernet, you will need to call the uIP ARP code before calling
* Note: If you are writing a network device driver that needs ARP
* (Address Resolution Protocol), e.g., when running the network over
* Ethernet, you will need to call the network ARP code before calling
* this function:
*
* #define BUF ((struct eth_hdr_s *)&dev->d_buf[0])
@ -424,8 +425,8 @@ int ipv6_input(FAR struct net_driver_s *dev);
/****************************************************************************
* Polling of connections
*
* These functions will traverse each active uIP connection structure and
* perform appropriate operations: devif_timer() will perform TCP timer
* These functions will traverse each active network connection structure
* and perform appropriate operations: devif_timer() will perform TCP timer
* operations (and UDP polling operations); devif_poll() will perform TCP
* and UDP polling operations. The CAN driver MUST implement logic to
* periodically call devif_timer(); devif_poll() may be called asynchronously
@ -437,7 +438,7 @@ int ipv6_input(FAR struct net_driver_s *dev);
* value (which it should do only if it cannot accept further write data).
*
* When the callback function is called, there may be an outbound packet
* waiting for service in the uIP packet buffer, and if so the d_len field
* waiting for service in the device packet buffer, and if so the d_len field
* is set to a value larger than zero. The device driver should then send
* out the packet.
*
@ -455,9 +456,9 @@ int ipv6_input(FAR struct net_driver_s *dev);
* ...
* devif_poll(dev, driver_callback);
*
* Note: If you are writing a uIP device driver that needs ARP (Address
* Resolution Protocol), e.g., when running uIP over Ethernet, you will
* need to call the arp_out() function in the callback function
* Note: If you are writing a network device driver that needs ARP (Address
* Resolution Protocol), e.g., when running the networ over Ethernet, you
* will need to call the arp_out() function in the callback function
* before sending the packet:
*
* int driver_callback(FAR struct net_driver_s *dev)

View File

@ -1,10 +1,10 @@
/****************************************************************************
* include/nuttx/net/tcp.h
* Header file for the uIP TCP/IP stack.
* Header file for the NuttX TCP/IP stack.
*
* The uIP TCP/IP stack header file contains definitions for a number
* of C macros that are used by uIP programs as well as internal uIP
* structures, TCP/IP header structures and function declarations.
* This TCP/IP stack header file contains definitions for a number of C
* macros that are used by internal network structures, TCP/IP header
* structures and function declarations.
*
* Copyright (C) 2007, 2009-2010, 2012-2014 Gregory Nutt. All rights
* reserved.

View File

@ -1,10 +1,10 @@
/****************************************************************************
* include/nuttx/net/udp.h
* Header file for the uIP UDP stack.
* Header file for the NuttX UDP stack.
*
* The uIP UDP stack header file contains definitions for a number
* of C macros that are used by uIP programs as well as internal uIP
* structures, UDP header structures and function declarations.
* The UDP stack header file contains definitions for a number of C macros
* that are used by the internal network structures, UDP header structures
* and function declarations.
*
* Copyright (C) 2007, 2009, 2012, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>