Skip to content

Commit 24dfee3

Browse files
committed
doc: Add more content for networking documentation
Jira: ZEP-687 Change-Id: Ic02f828dcc2a3994d537829832387c56f4c74ed2 Signed-off-by: Jukka Rissanen <[email protected]>
1 parent 0a2d795 commit 24dfee3

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

doc/subsystems/networking/networking.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,59 @@ The networking section contains information regarding the network stack
77
of the Zephyr kernel. Use the information to understand the
88
principles behind the operation of the stacks and how they were implemented.
99

10+
The networking stack supports the following features:
11+
12+
* IPv6
13+
14+
* IPv6 header compresson, which is part of the 6LoWPAN support
15+
16+
* UDP
17+
* IPv4
18+
19+
* In this version of the IP stack, IPv6 and IPv4 cannot be utilized at the
20+
same time.
21+
* DHCP client support for IPv4
22+
23+
* TCP
24+
25+
* Both client and server roles are supported
26+
27+
* RPL (Ripple) IPv6 mesh routing
28+
* CoAP
29+
* MQTT
30+
* Highly configurable
31+
32+
* Features, buffer sizes/counts, stack sizes, etc.
33+
34+
Additionally these network technologies are supported:
35+
36+
* IEEE 802.15.4
37+
* Bluetooth
38+
* Ethernet
39+
* SLIP (for testing with Qemu)
40+
41+
Source tree layout
42+
==================
43+
44+
The IP stack source code tree is organized as follows:
45+
46+
``net/ip/``
47+
The core stack itself. This is where the Contiki uIP stack code
48+
is located.
49+
50+
``include/net/``
51+
Public API header files. These are the header files applications need
52+
to include to use IP networking functionality.
53+
54+
``samples/net/``
55+
Sample networking code. This is a good reference to get started with
56+
network application development.
57+
58+
``tests/net/``
59+
Test applications. These applications are used to verify the
60+
functionality of the IP stack, but are not the best
61+
source for sample code (see ``samples/net`` instead).
62+
1063
.. toctree::
1164
:maxdepth: 1
1265

0 commit comments

Comments
 (0)