nuttx/net/README.txt

README
======

Directory Structure
===================

  nuttx/
   |
   `- net/
       |
       +- arp      - Address resolution protocol (IPv4)
       +- devif    - Stack/device interface layer
       +- icmp     - Internet Control Message Protocol (IPv4)
       +- icmpv6   - Internet Control Message Protocol (IPv6)
       +- local    - Unix domain (local) sockets
       +- loopback - Local loopback
       +- neighbor - Neighbor Discovery Protocol (IPv6)
       +- netdev   - Socket network device interface
       +- pkt      - "Raw" packet socket support
       +- socket   - BSD socket interface
       +- route    - Routing table support
       +- tcp      - Transmission Control Protocol
       +- udp      - User Datagram Protocol
       +- usrsock  - User socket API for user-space networking stack
       `- utils    - Miscellaneous utility functions


    +-------------------------------------------------------------------++------------------------+
    |                     Application layer                             || usrsock daemon         |
    +-------------------------------------------------------------------++------------------------+
    +-------------------------------------------------------------------++----------------+ +-----+
    |                   Socket layer (socket/)                          || /dev/usrsock   | |     |
    +-------------------------------------------------------------------++----------------+ |     |
    +------------++--------------------------------------------------++-------------------+ |     |
    |  Network   || Protocol stacks (arp, ipv6, icmp, pkt, tcp, udp) || usrsock/          | |     |
    |   Device   |+--------------------------------------------------++-------------------+ |     |
    | Interface  |+------------------------------------++---------------------------------+ |     |
    | (netdev/)  ||  Network Device Interface (devif/) || Utilities                       | |     |
    +------------++------------------------------------++---------------------------------+ |     |
    +----------------------------------------------------------------+                      |     |
    |                    Network Device Drivers                      |                      | HAL |
    +----------------------------------------------------------------+                      +-----+
    +----------------------------------------------------------------+ +--------------------------+
    |                    Networking Hardware                         | |  Hardware TCP/IP Stack   |
    +----------------------------------------------------------------+ +--------------------------+
Rename uip_driver_s net_driver_s 2014-06-28 00:48:12 +02:00			`README`
			`======`

			`Directory Structure`
			`===================`

			`nuttx/`
			`\|`
			`- net/
			`\|`
Networking: Move net/ipv6 to net/neighbor 2015-01-16 23:49:48 +01:00			`+- arp - Address resolution protocol (IPv4)`
Rename uip_driver_s net_driver_s 2014-06-28 00:48:12 +02:00			`+- devif - Stack/device interface layer`
Networking: Make a home for ICMPv6 2015-01-14 21:26:50 +01:00			`+- icmp - Internet Control Message Protocol (IPv4)`
			`+- icmpv6 - Internet Control Message Protocol (IPv6)`
Add basic build structure for Unix domain sockets 2015-01-24 21:03:32 +01:00			`+- local - Unix domain (local) sockets`
Networking: Add NetDB support for the local loopback device 2015-08-24 18:08:26 +02:00			`+- loopback - Local loopback`
Networking: Move net/ipv6 to net/neighbor 2015-01-16 23:49:48 +01:00			`+- neighbor - Neighbor Discovery Protocol (IPv6)`
Rename uip_driver_s net_driver_s 2014-06-28 00:48:12 +02:00			`+- netdev - Socket network device interface`
			`+- pkt - "Raw" packet socket support`
			`+- socket - BSD socket interface`
			`+- route - Routing table support`
			`+- tcp - Transmission Control Protocol`
			`+- udp - User Datagram Protocol`
Add user-space networking stack API (usrsock) User-space networking stack API allows user-space daemon to provide TCP/IP stack implementation for NuttX network. Main use for this is to allow use and seamless integration of HW-provided TCP/IP stacks to NuttX. For example, user-space daemon can translate /dev/usrsock API requests to HW TCP/IP API requests while rest of the user-space can access standard socket API, with socket descriptors that can be used with NuttX system calls. 2017-03-31 16:58:14 +02:00			`+- usrsock - User socket API for user-space networking stack`
Rename uip_driver_s net_driver_s 2014-06-28 00:48:12 +02:00			`- utils - Miscellaneous utility functions


Add user-space networking stack API (usrsock) User-space networking stack API allows user-space daemon to provide TCP/IP stack implementation for NuttX network. Main use for this is to allow use and seamless integration of HW-provided TCP/IP stacks to NuttX. For example, user-space daemon can translate /dev/usrsock API requests to HW TCP/IP API requests while rest of the user-space can access standard socket API, with socket descriptors that can be used with NuttX system calls. 2017-03-31 16:58:14 +02:00			`+-------------------------------------------------------------------++------------------------+`
			`\| Application layer \|\| usrsock daemon \|`
			`+-------------------------------------------------------------------++------------------------+`
			`+-------------------------------------------------------------------++----------------+ +-----+`
			`\| Socket layer (socket/) \|\| /dev/usrsock \| \| \|`
			`+-------------------------------------------------------------------++----------------+ \| \|`
			`+------------++--------------------------------------------------++-------------------+ \| \|`
			`\| Network \|\| Protocol stacks (arp, ipv6, icmp, pkt, tcp, udp) \|\| usrsock/ \| \| \|`
			`\| Device \|+--------------------------------------------------++-------------------+ \| \|`
			`\| Interface \|+------------------------------------++---------------------------------+ \| \|`
			`\| (netdev/) \|\| Network Device Interface (devif/) \|\| Utilities \| \| \|`
			`+------------++------------------------------------++---------------------------------+ \| \|`
			`+----------------------------------------------------------------+ \| \|`
			`\| Network Device Drivers \| \| HAL \|`
			`+----------------------------------------------------------------+ +-----+`
			`+----------------------------------------------------------------+ +--------------------------+`
			`\| Networking Hardware \| \| Hardware TCP/IP Stack \|`
Move net/iob to drivers/iob so that the I/O buffering feature can be available to other drivers when networking is disabled. 2017-04-21 00:08:49 +02:00			`+----------------------------------------------------------------+ +--------------------------+`