NET: Misc naming clean-up

This commit is contained in:
Gregory Nutt 2014-07-02 17:23:25 -06:00
parent c22420c3fb
commit 8e9df8ade0
4 changed files with 86 additions and 15 deletions

View File

@ -184,9 +184,11 @@
. .
|- nuttx |- nuttx
| |-- <a href="#topmakefile">Makefile</a> | |-- <a href="#topmakefile">Makefile</a>
| |-- Kconfig
| |-- <a href="#DirStructDocumentation">Documentation</a> | |-- <a href="#DirStructDocumentation">Documentation</a>
| | `-- <i>(documentation files)</i>/ | | `-- <i>(documentation files)</i>/
| |-- <a href="#DirStructArch">arch</a>/ | |-- <a href="#DirStructArch">arch</a>/
| | |-- Kconfig
| | |-- <i>&lt;arch-name&gt;</i>/ | | |-- <i>&lt;arch-name&gt;</i>/
| | | |-- include/ | | | |-- include/
| | | | |--<i>&lt;chip-name&gt;</i>/ | | | | |--<i>&lt;chip-name&gt;</i>/
@ -201,6 +203,7 @@
| | `-- <i>&lt;other-architecture directories&gt;</i>/ | | `-- <i>&lt;other-architecture directories&gt;</i>/
| |-- <a href="#DirStructBinFmt">binfmt</a>/ | |-- <a href="#DirStructBinFmt">binfmt</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | |-- <i>(binfmt-specific sub-directories)</i>/ | | |-- <i>(binfmt-specific sub-directories)</i>/
| | | `-- <i>(binfmt-specific source files)</i> | | | `-- <i>(binfmt-specific source files)</i>
| | `-- <i>(common binfmt source files)</i> | | `-- <i>(common binfmt source files)</i>
@ -216,16 +219,19 @@
| | `-- <i>&lt;(other board directories)&gt;</i>/ | | `-- <i>&lt;(other board directories)&gt;</i>/
| |-- <a href="#DirStructDrivers">drivers</a>/ | |-- <a href="#DirStructDrivers">drivers</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | |-- <i>(driver-specific sub-directories)/</i> | | |-- <i>(driver-specific sub-directories)/</i>
| | | `-- <i>(driver-specific source files)</i> | | | `-- <i>(driver-specific source files)</i>
| | `-- <i>(common driver source files)</i> | | `-- <i>(common driver source files)</i>
| |-- <a href="#DirStructFs">fs</a>/ | |-- <a href="#DirStructFs">fs</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | |-- <i>(file system-specific sub-directories)</i>/ | | |-- <i>(file system-specific sub-directories)</i>/
| | | `-- <i>(file system-specific source files)</i> | | | `-- <i>(file system-specific source files)</i>
| | `-- <i>(common file system source files)</i> | | `-- <i>(common file system source files)</i>
| |-- <a href="#DirStructGraphics">graphics</a>/ | |-- <a href="#DirStructGraphics">graphics</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | |-- <i>(feature-specific sub-directories)</i>/ | | |-- <i>(feature-specific sub-directories)</i>/
| | | `-- <i>(feature-specific source files library source files)</i> | | | `-- <i>(feature-specific source files library source files)</i>
| | `-- <i>(common graphics-related source files)</i> | | `-- <i>(common graphics-related source files)</i>
@ -237,43 +243,76 @@
| | `-- <i>(non-standard header files)</i> | | `-- <i>(non-standard header files)</i>
| |-- <a href="#DirStructLib">libc</a>/ | |-- <a href="#DirStructLib">libc</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | `-- <i>(libc source files)</i> | | `-- <i>(libc source files)</i>
| |-- <a href="#DirStructLibXX">libxx</a>/ | |-- <a href="#DirStructLibXX">libxx</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | `-- <i>(libxx management source files)</i> | | `-- <i>(libxx management source files)</i>
| |-- <a href="#DirStructMm">mm</a>/ | |-- <a href="#DirStructMm">mm</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | `-- <i>(memory management source files)</i> | | `-- <i>(memory management source files)</i>
| |-- <a href="#DirStructNet">net</a>/ | |-- <a href="#DirStructNet">net</a>/
| | |-- Makefile | | |-- Makefile
| | |-- uip/ | | |-- Kconfig
| | | `-- <i>(uip source files)</i> | | |-- arp/
| | `-- <i>(BSD socket source files)</i> | | | `-- <i>(ARP source files)</i>
| | |-- devif/
| | | `-- <i>(Ethernet device interface source files)</i>
| | |-- icmp/
| | | `-- <i>(ICMP source files)</i>
| | |-- igmp/
| | | `-- <i>(IGMP source files)</i>
| | |-- iob/
| | | `-- <i>(I/O buffering source files)</i>
| | |-- ipv6/
| | | `-- <i>(IPv6 source files)</i>
| | |-- netdev/
| | | `-- <i>(Socket device interface source files)</i>
| | |-- pkt/
| | | `-- <i>(Packet socket source files)</i>
| | |-- route/
| | | `-- <i>(Routing table source files)</i>
| | |-- socket/
| | | `-- <i>(BSD socket source files)</i>
| | |-- tcp/
| | | `-- <i>(TCP source files)</i>
| | |-- udp/
| | | `-- <i>(UDP source files)</i>
| | `-- utils/
| | `-- <i>(Miscellaneous, utility source files)</i>
| |-- <a href="#DirStructSched">sched</a>/ | |-- <a href="#DirStructSched">sched</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | `-- <i>(sched source files)</i> | | `-- <i>(sched source files)</i>
| |-- <a href="#DirStructSysCall">syscall</a>/ | |-- <a href="#DirStructSysCall">syscall</a>/
| | |-- Makefile | | |-- Makefile
| | |-- Kconfig
| | `-- <i>(syscall source files)</i> | | `-- <i>(syscall source files)</i>
| `-- <a href="#DirStructTools">tools</a>/ | `-- <a href="#DirStructTools">tools</a>/
| `-- <i>(miscellaneous scripts and programs)</i> | `-- <i>(miscellaneous scripts and programs)</i>
`- apps `- apps
|-- <a href="#DirStructNetUtils">netutils</a>/ |-- <a href="#DirStructNetUtils">netutils</a>/
| |-- Makefile | |-- Makefile
| |-- Kconfig
| |-- <i>(network feature sub-directories)</i>/ | |-- <i>(network feature sub-directories)</i>/
| | `-- <i>(network feature source files)</i> | | `-- <i>(network feature source files)</i>
| `-- <i>(netutils common files)</i> | `-- <i>(netutils common files)</i>
|-- <a href="#DirStructNshLib">nshlib</a>/ |-- <a href="#DirStructNshLib">nshlib</a>/
| |-- Makefile | |-- Makefile
| |-- Kconfig
| `-- <i>NuttShell (NSH) files</i> | `-- <i>NuttShell (NSH) files</i>
|-- <i>(Board-specific applications)</i>/ |-- <i>(Board-specific applications)</i>/
| |-- Makefile | |-- Makefile
| |-- Kconfig
| |-- <i>(Board-specific application sub-directories)</i>/ | |-- <i>(Board-specific application sub-directories)</i>/
| | `-- <i>(Board-specific application source files)</i> | | `-- <i>(Board-specific application source files)</i>
| `-- <i>(Board-specific common files)</i> | `-- <i>(Board-specific common files)</i>
`-- <a href="#DirStructExamples">examples</a>/ `-- <a href="#DirStructExamples">examples</a>/
`-- <i>(example)</i>/ `-- <i>(example)</i>/
|-- Makefile |-- Makefile
|-- Kconfig
`-- <i>(example source files)</i> `-- <i>(example source files)</i>
</pre></ul> </pre></ul>
@ -1223,10 +1262,42 @@ include/
|-- netinet/ |-- netinet/
| `-- <i>(Standard header files)</i> | `-- <i>(Standard header files)</i>
|-- nuttx/ |-- nuttx/
| |-analog/
| | `-- <i>(Analog driver header files)</i>
| |-audio/
| | `-- <i>(Audio driver header files)</i>
| |-binfmt/
| | `-- <i>(Binary format header files)</i>
| |-fs/
| | `-- <i>(File System header files)</i>
| |-input/
| | `-- <i>(Input device driver header files)</i>
| |-lcd/
| | `-- <i>(LCD driver header files)</i>
| |-mtd/
| | `-- <i>(Memory technology device header files)</i>
| |-serial/
| | `-- <i>(Serial driver header files)</i>
| |-net/ | |-net/
| | `-- uip/ | | `-- <i>(Networking header files)</i>
| | `-- <i>(uIP specific header files)</i> | |-nx/
| `-- <i>(NuttX specific header files)</i> | | `-- <i>(NX graphics header files)</i>
| |-power/
| | `-- <i>(Power management header files)</i>
| |-sensors/
| | `-- <i>(Sensor device driver header files)</i>
| |-sercomm/
| | `-- <i>(SERCOMM driver header files)</i>
| |-serial/
| | `-- <i>(Serial driver header files)</i>
| |-spi/
| | `-- <i>(SPI driver header files)</i>
| |-syslog/
| | `-- <i>(SYSLOG header files)</i>
| |-usb/
| | `-- <i>(USB driver header files)</i>
| `-wireless/
| `-- <i>(Wireless device driver header files)</i>
`- sys/ `- sys/
`-- <i>(More standard header files)</i> `-- <i>(More standard header files)</i>
</per></ul> </per></ul>
@ -1292,8 +1363,7 @@ libc/
<h2>2.12 <a name="DirStructNet">nuttx/net</a></h2> <h2>2.12 <a name="DirStructNet">nuttx/net</a></h2>
<p> <p>
This directory contains the implementation of the NuttX internal socket APIs. This directory contains the implementation of the NuttX networking layer including internal socket APIs.
The subdirectory, <code>uip</code> contains the uIP port.
</P> </P>
<h2>2.13 <a name="DirStructSched">nuttx/sched</a></h2> <h2>2.13 <a name="DirStructSched">nuttx/sched</a></h2>

View File

@ -1303,7 +1303,7 @@ static void enc_txif(FAR struct enc_driver_s *priv)
wd_cancel(priv->txtimeout); wd_cancel(priv->txtimeout);
/* Poll for uip packets */ /* Poll for TX packets from the networking layer */
devif_poll(&priv->dev, enc_txpoll); devif_poll(&priv->dev, enc_txpoll);
} }
@ -1319,7 +1319,7 @@ static void enc_txif(FAR struct enc_driver_s *priv)
* Function: enc_rxldpkt * Function: enc_rxldpkt
* *
* Description: * Description:
* Load packet from the enc's RX buffer to the uip d_buf. * Load packet from the enc's RX buffer to the driver d_buf.
* *
* Parameters: * Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure

View File

@ -290,7 +290,7 @@ int devif_input(struct net_driver_s *dev);
* out the packet. * out the packet.
* *
* Example: * Example:
* int driver_callback(struct uip_driver_dev *dev) * int driver_callback(struct net_driver_s *dev)
* { * {
* if (dev->d_len > 0) * if (dev->d_len > 0)
* { * {
@ -308,7 +308,7 @@ int devif_input(struct net_driver_s *dev);
* need to call the arp_out() function in the callback function * need to call the arp_out() function in the callback function
* before sending the packet: * before sending the packet:
* *
* int driver_callback(struct uip_driver_dev *dev) * int driver_callback(struct net_driver_s *dev)
* { * {
* if (dev->d_len > 0) * if (dev->d_len > 0)
* { * {
@ -316,6 +316,7 @@ int devif_input(struct net_driver_s *dev);
* devicedriver_send(); * devicedriver_send();
* return 1; <-- Terminates polling if necessary * return 1; <-- Terminates polling if necessary
* } * }
*
* return 0; * return 0;
* } * }
* *

View File

@ -498,9 +498,9 @@ FAR struct tcp_conn_s *tcp_listener(uint16_t portno)
* Name: tcp_alloc_accept() * Name: tcp_alloc_accept()
* *
* Description: * Description:
* Called when uip_interrupt matches the incoming packet with a connection * Called when driver interrupt processing matches the incoming packet
* in LISTEN. In that case, this function will create a new connection and * with a connection in LISTEN. In that case, this function will create
* initialize it to send a SYNACK in return. * a new connection and initialize it to send a SYNACK in return.
* *
* Assumptions: * Assumptions:
* This function is called from UIP logic at interrupt level * This function is called from UIP logic at interrupt level