From 081ff02ec9336330a2923fcfdd9ebfb277a9f97d Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Fri, 27 Jun 2014 15:18:18 -0600 Subject: [PATCH] Add net/README.txt --- ChangeLog | 2 +- Documentation/README.html | 4 +++- Documentation/acronyms.txt | 43 ++++++++++++++++++++++++++++++++++++++ README.txt | 2 ++ net/README.txt | 38 +++++++++++++++++++++++++++++++++ 5 files changed, 87 insertions(+), 2 deletions(-) create mode 100755 Documentation/acronyms.txt create mode 100644 net/README.txt diff --git a/ChangeLog b/ChangeLog index 741adb425a..aaa9240d0e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -7549,6 +7549,6 @@ file. From Max Neklyudov (2104-6-27). * arch/arm/src/sam34: Various fixes PMC and clock configuration for the SAM4CM port from Max Neklyudov (2104-6-27). - * configs/sama5d4-ek/src/dram_main.c: SAMA5D4: Bootloader needs to flushi + * configs/sama5d4-ek/src/dram_main.c: SAMA5D4: Bootloader needs to flush D-Cache to memory before disabling the caches (2014-6-27). diff --git a/Documentation/README.html b/Documentation/README.html index 87a27f4a68..b2a8775d08 100644 --- a/Documentation/README.html +++ b/Documentation/README.html @@ -8,7 +8,7 @@

NuttX README Files

-

Last Updated: June 6, 2014

+

Last Updated: June 27, 2014

@@ -284,6 +284,8 @@ | | `- README.txt | |- mm/ | | `- README.txt + | |- net/ + | | `- README.txt | |- syscall/ | | `- README.txt | `- tools/ diff --git a/Documentation/acronyms.txt b/Documentation/acronyms.txt new file mode 100755 index 0000000000..eb78239cea --- /dev/null +++ b/Documentation/acronyms.txt @@ -0,0 +1,43 @@ +AIC Advanced Interrupt Controller (Atmel SAM) +ADC Analog to Digital Conversion +ARP Address Resolution Protocol (networking) +BCH Block to Character +CAN Controller Area Network +DEVIF Device Interface (networking) +DAC Digital to Analog Conversion +DEV Device +DRAM Dynamic RAM +FAT File Allocation Table +FTL FLASH Translation Layer +I2C Inter-Integrated Circuit +I2S Inter IC Sound +ICMP Internet Control Message Protocol (networking) +IOB I/O Buffer (networking) +LIBC The "C" Library +MM Memory Management/Manager +MMC Multi-Media Card +MMCSD See MMC and SD +MTD Memory Technology Device +NFS Network File System +NETDEV Network Device (networking) +NSH NuttShell +NX NuttX, the NuttX Graphics server (graphics) +NXFFS NuttX Flash File System +NXWM The NuttX Window Manager (graphics) +PID Peripheral ID (Atmel SAM) +PWM Pulse Width Modulation +PKT "Raw" Packet socket (networking) +RAM Random Access Memory +SAIC Secure Advanced Interrupt Controller (Atmel SAM) +SD Secure Digital +SPI Serial Periperhal Interface +TCP Transmission Control Protocol (networking) +TSC Touchscreen Controller +TWI Two-Wire Interface +UDP User Datagram Protocol (networking) +UART Universal Asynchronous Receiver/Transmitter +USB Universal Serial Bus +USART Universal Synchronous/Asynchronous Receiver/Transmitter +WDT Watchdog Timer + + diff --git a/README.txt b/README.txt index b9de2f8a2d..b868b81bb5 100644 --- a/README.txt +++ b/README.txt @@ -1152,6 +1152,8 @@ nuttx | `- README.txt |- mm/ | `- README.txt + |- net/ + | `- README.txt |- syscall/ | `- README.txt `- tools/ diff --git a/net/README.txt b/net/README.txt new file mode 100644 index 0000000000..7370944c12 --- /dev/null +++ b/net/README.txt @@ -0,0 +1,38 @@ +README +====== + +Directory Structure +=================== + + nuttx/ + | + `- net/ + | + +- arp - Address resolution protocol + +- devif - Stack/device interface layer + +- icmp - Internet Control Message Protocol + +- iob - I/O buffering logic + +- 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 + `- utils - Miscellaneous utility functions + + + +-------------------------------------------------------------+ + | Application layer | + +-------------------------------------------------------------+ + +-------------------------------------------------------------+ + | Socket layer (socket/) | + +-------------------------------------------------------------+ + +------------++-----------------------------------------------+ + | Network || Protocol stacks (arp, icmp, pkt, tcp, udp) | + | Device |+-----------------------------------------------+ + | Interface |+---------------------------------++------------+ + | (netdev/) ||Network Device Interface (devif/)|| Utilities | + +------------++---------------------------------++------------+ + +-------------------------------------------------------------+ + | Network Device Drivers | + +-------------------------------------------------------------+