diff options
author | Jukka Rissanen <jukka.rissanen@linux.intel.com> | 2016-08-22 11:03:51 +0300 |
---|---|---|
committer | Jukka Rissanen <jukka.rissanen@linux.intel.com> | 2016-08-24 16:00:36 +0300 |
commit | 24dfee30c3bd5f3fa71267450e668b2e6eb5cb50 (patch) | |
tree | 33631e3fbfea84adabb93ce36c6fd2cf4c9a67f0 /doc | |
parent | 0a2d7953e27eb0cfb8e6a67d039da4a1b25104a5 (diff) |
doc: Add more content for networking documentation
Jira: ZEP-687
Change-Id: Ic02f828dcc2a3994d537829832387c56f4c74ed2
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/subsystems/networking/networking.rst | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/subsystems/networking/networking.rst b/doc/subsystems/networking/networking.rst index 5f8fd8fcc..2c1f87f69 100644 --- a/doc/subsystems/networking/networking.rst +++ b/doc/subsystems/networking/networking.rst @@ -7,6 +7,59 @@ The networking section contains information regarding the network stack of the Zephyr kernel. Use the information to understand the principles behind the operation of the stacks and how they were implemented. +The networking stack supports the following features: + +* IPv6 + + * IPv6 header compresson, which is part of the 6LoWPAN support + +* UDP +* IPv4 + + * In this version of the IP stack, IPv6 and IPv4 cannot be utilized at the + same time. + * DHCP client support for IPv4 + +* TCP + + * Both client and server roles are supported + +* RPL (Ripple) IPv6 mesh routing +* CoAP +* MQTT +* Highly configurable + + * Features, buffer sizes/counts, stack sizes, etc. + +Additionally these network technologies are supported: + +* IEEE 802.15.4 +* Bluetooth +* Ethernet +* SLIP (for testing with Qemu) + +Source tree layout +================== + +The IP stack source code tree is organized as follows: + +``net/ip/`` + The core stack itself. This is where the Contiki uIP stack code + is located. + +``include/net/`` + Public API header files. These are the header files applications need + to include to use IP networking functionality. + +``samples/net/`` + Sample networking code. This is a good reference to get started with + network application development. + +``tests/net/`` + Test applications. These applications are used to verify the + functionality of the IP stack, but are not the best + source for sample code (see ``samples/net`` instead). + .. toctree:: :maxdepth: 1 |