Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
R
RIOT
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
cm-projects
RIOT
Commits
b2d724cc
Commit
b2d724cc
authored
6 years ago
by
Martine Lenders
Browse files
Options
Downloads
Patches
Plain Diff
gnrc_sixlowpan: document submodules according to #8511
parent
af627606
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
sys/include/net/gnrc/sixlowpan.h
+35
-2
35 additions, 2 deletions
sys/include/net/gnrc/sixlowpan.h
with
35 additions
and
2 deletions
sys/include/net/gnrc/sixlowpan.h
+
35
−
2
View file @
b2d724cc
...
...
@@ -11,11 +11,44 @@
* @ingroup net_gnrc
* @brief GNRC's 6LoWPAN implementation
*
* This module is for usage with the @ref net_gnrc_netapi.
* # Internal API and sub-modules
*
* Internally, @ref net_gnrc_sixlowpan is sub-divided into several sub-modules.
* They implement certain features of the 6LoWPAN standard. Currently
* implemented are
*
* - [Fragmentation](https://tools.ietf.org/html/rfc4944#section-5.3)
* ([gnrc_sixlowpan_frag](@ref net_gnrc_sixlowpan_frag))
* - [Uncompressed IPv6](https://tools.ietf.org/html/rfc4944#section-5.1)
* (as part of the main @ref net_gnrc_sixlowpan module)
* - IPv6 datagram compression according to [RFC 6282](https://tools.ietf.org/html/rfc6282)
* aka IPHC ([gnrc_sixlowpan_iphc](@ref net_gnrc_sixlowpan_iphc), IPv6
* extension header NHC currently missing)
*
* Each sub-module has a `send` and `recv` function prefixed by their
* respective sub-module name with the following signatures
*
* ~~~~~~~~~~~~~~~~~~~~~ {.c}
* void send(gnrc_pktsnip_t *pkt, void *ctx, uint8_t page);
* void recv(gnrc_pktsnip_t *pkt, void *ctx, uint8_t page);
* ~~~~~~~~~~~~~~~~~~~~~
*
* A 6LoWPAN frame `pkt` must pass the sub-modules sequentially in the order of
* its dispatches on receive or the step that makes most sense next on send.
* After it was passed into another sub-module using the respective
* `send`/`recv` function a sub-module must not operate on the `pkt` anymore.
*
* The `ctx` parameter can be used to provide data structures of a sub-module to
* the next sub-module if that needs to modify or read them (e.g. reassembly
* buffer state for IPHC) otherwise, leave it `NULL`.
*
* Finally, the `page` parameter is to provide a sub-module the current parsing
* page context according to [RFC 8025](https://tools.ietf.org/html/rfc8025).
*
* # Supported NETAPI commands
*
* This module handles the following @ref net_gnrc_netapi message types:
* To interact with other modules this module handles the following
* @ref net_gnrc_netapi message types:
*
* ## `GNRC_NETAPI_MSG_TYPE_RCV`
*
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment