Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Commit

Permalink
update some FILES list files
Browse files Browse the repository at this point in the history
  • Loading branch information
goldsimon committed Aug 3, 2016
1 parent 4c06a73 commit dd11030
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 16 deletions.
1 change: 1 addition & 0 deletions FILES
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
src/ - The source code for the lwIP TCP/IP stack.
doc/ - The documentation for lwIP.
test/ - Some code to test whether the sources do what they should.

See also the FILES file in each subdirectory.
5 changes: 4 additions & 1 deletion doc/FILES
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
doxygen/ - Configuration files and scripts to create the lwIP doxygen source
documentation (found at http://www.nongnu.org/lwip/)

savannah.txt - How to obtain the current development source code.
contrib.txt - How to contribute to lwIP as a developer.
rawapi.txt - The documentation for the core API of lwIP.
Also provides an overview about the other APIs and multithreading.
snmp_agent.txt - The documentation for the lwIP SNMP agent.
sys_arch.txt - The documentation for a system abstraction layer of lwIP.
ppp.txt - Documentation of the PPP interface for lwIP.
6 changes: 4 additions & 2 deletions src/FILES
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
api/ - The code for the high-level wrapper API. Not needed if
you use the lowel-level call-back/raw API.

apps/ - Higher layer applications that are specifically programmed
with the lwIP low-level raw API.

core/ - The core of the TPC/IP stack; protocol implementations,
memory and buffer management, and the low-level raw API.

include/ - lwIP include files.

netif/ - Generic network interface device drivers are kept here,
as well as the ARP module.
netif/ - Generic network interface device drivers are kept here.

For more information on the various subdirectories, check the FILES
file in each directory.
19 changes: 6 additions & 13 deletions src/netif/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,23 @@ This directory contains generic network interface device drivers that
do not contain any hardware or architecture specific code. The files
are:

etharp.c
Implements the ARP (Address Resolution Protocol) over
Ethernet. The code in this file should be used together with
Ethernet device drivers. Note that this module has been
largely made Ethernet independent so you should be able to
adapt this for other link layers (such as Firewire).
ethernet.c
Shared code for Ethernet based interfaces.

ethernetif.c
An example of how an Ethernet device driver could look. This
file can be used as a "skeleton" for developing new Ethernet
network device drivers. It uses the etharp.c ARP code.

loopif.c
A "loopback" network interface driver. It requires configuration
through the define LWIP_LOOPIF_MULTITHREADING (see opt.h).
lowpan6.c
A 6LoWPAN implementation as a netif.

slipif.c
A generic implementation of the SLIP (Serial Line IP)
protocol. It requires a sio (serial I/O) module to work.

lowpan6.c
6LoWPAN implementation

ppp/ Point-to-Point Protocol stack
The lwIP PPP support is based from pppd (http://ppp.samba.org) with
huge changes to match code size and memory requirements for embedded
devices. Please read ppp/PPPD_FOLLOWUP for a detailed explanation.
devices. Please read /doc/ppp.txt and ppp/PPPD_FOLLOWUP for a detailed
explanation.

0 comments on commit dd11030

Please sign in to comment.