Commit 107db7ec authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Marcel Holtmann

docs: networking: convert 6lowpan.txt to ReST

- add SPDX header;
- use document title markup;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: default avatarStefan Schmidt <stefan@datenfreihafen.org>
Signed-off-by: default avatarMarcel Holtmann <marcel@holtmann.org>
parent 8788a1ee
.. SPDX-License-Identifier: GPL-2.0
Netdev private dataroom for 6lowpan interfaces: ==============================================
Netdev private dataroom for 6lowpan interfaces
==============================================
All 6lowpan able net devices, means all interfaces with ARPHRD_6LOWPAN, All 6lowpan able net devices, means all interfaces with ARPHRD_6LOWPAN,
must have "struct lowpan_priv" placed at beginning of netdev_priv. must have "struct lowpan_priv" placed at beginning of netdev_priv.
The priv_size of each interface should be calculate by: The priv_size of each interface should be calculate by::
dev->priv_size = LOWPAN_PRIV_SIZE(LL_6LOWPAN_PRIV_DATA); dev->priv_size = LOWPAN_PRIV_SIZE(LL_6LOWPAN_PRIV_DATA);
Where LL_PRIV_6LOWPAN_DATA is sizeof linklayer 6lowpan private data struct. Where LL_PRIV_6LOWPAN_DATA is sizeof linklayer 6lowpan private data struct.
To access the LL_PRIV_6LOWPAN_DATA structure you can cast: To access the LL_PRIV_6LOWPAN_DATA structure you can cast::
lowpan_priv(dev)-priv; lowpan_priv(dev)-priv;
to your LL_6LOWPAN_PRIV_DATA structure. to your LL_6LOWPAN_PRIV_DATA structure.
Before registering the lowpan netdev interface you must run: Before registering the lowpan netdev interface you must run::
lowpan_netdev_setup(dev, LOWPAN_LLTYPE_FOOBAR); lowpan_netdev_setup(dev, LOWPAN_LLTYPE_FOOBAR);
wheres LOWPAN_LLTYPE_FOOBAR is a define for your 6LoWPAN linklayer type of wheres LOWPAN_LLTYPE_FOOBAR is a define for your 6LoWPAN linklayer type of
enum lowpan_lltypes. enum lowpan_lltypes.
Example to evaluate the private usually you can do: Example to evaluate the private usually you can do::
static inline struct lowpan_priv_foobar * static inline struct lowpan_priv_foobar *
lowpan_foobar_priv(struct net_device *dev) lowpan_foobar_priv(struct net_device *dev)
{ {
return (struct lowpan_priv_foobar *)lowpan_priv(dev)->priv; return (struct lowpan_priv_foobar *)lowpan_priv(dev)->priv;
} }
switch (dev->type) { switch (dev->type) {
case ARPHRD_6LOWPAN: case ARPHRD_6LOWPAN:
lowpan_priv = lowpan_priv(dev); lowpan_priv = lowpan_priv(dev);
/* do great stuff which is ARPHRD_6LOWPAN related */ /* do great stuff which is ARPHRD_6LOWPAN related */
switch (lowpan_priv->lltype) { switch (lowpan_priv->lltype) {
...@@ -42,8 +45,8 @@ case ARPHRD_6LOWPAN: ...@@ -42,8 +45,8 @@ case ARPHRD_6LOWPAN:
... ...
} }
break; break;
... ...
} }
In case of generic 6lowpan branch ("net/6lowpan") you can remove the check In case of generic 6lowpan branch ("net/6lowpan") you can remove the check
on ARPHRD_6LOWPAN, because you can be sure that these function are called on ARPHRD_6LOWPAN, because you can be sure that these function are called
......
...@@ -33,6 +33,7 @@ Contents: ...@@ -33,6 +33,7 @@ Contents:
tls tls
tls-offload tls-offload
nfc nfc
6lowpan
.. only:: subproject and html .. only:: subproject and html
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment