ieee 802.15.4 documentation updates
Subsystems (4)
Please pull 3 small updates for IEEE 802.15.4 code (documentation and headers move).
The following changes since commit 72dccb01e8632aa5ffe58070003d0fa19d007116:
Eric Dumazet (1):
bnx2: Update vlan_features
are available in the git repository at:
git://git.kernel.org/pub/scm/linux/kernel/git/lowpan/lowpan.git for-linus
Daniel Silverstone (1):
IEEE80154: Add documentation to the IEEE80154 netlink and fakehard driver
Dmitry Eremin-Solenikov (1):
ieee802154: move headers out of extra directory
Thadeu Lima de Souza Cascardo (1):
trivial: fix typo in ieee802154 documentation and add it to index
Documentation/networking/00-INDEX | 2 +
Documentation/networking/ieee802154.txt | 2 +-
drivers/ieee802154/fakehard.c | 128 +++++++++++++++++++-
include/net/{ieee802154 => }/af_ieee802154.h | 0
include/net/{ieee802154/mac_def.h => ieee802154.h} | 4 +-
include/net/ieee802154/nl802154.h | 41 ------
.../netdevice.h => ieee802154_netdev.h} | 0
include/net/nl802154.h | 117 ++++++++++++++++++
net/ieee802154/af_ieee802154.c | 4 +-
net/ieee802154/dgram.c | 6 +-
net/ieee802154/netlink.c | 6 +-
net/ieee802154/raw.c | 2 +-
12 files changed, 255 insertions(+), 57 deletions(-)
rename include/net/{ieee802154 => }/af_ieee802154.h (100%)
rename include/net/{ieee802154/mac_def.h => ieee802154.h} (98%)
delete mode 100644 include/net/ieee802154/nl802154.h
rename include/net/{ieee802154/netdevice.h => ieee802154_netdev.h} (100%)
create mode 100644 include/net/nl802154.hA message that is not in the archive (sent off-list or not yet received): 1248703695-7043-1-git-send-email-dbaryshkov-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
PATCH 1/3 IEEE80154: Add documentation to the IEEE80154 netlink and fakehard driver
From: Daniel Silverstone <dsilvers-gyMb1R/nBgPUHbNLRunGg9i2O/[email protected]>
This adds some perfunctory documentation comments to the IEEE 802.15.4 fakehard.c driver (Fake hard MAC) and the nl802154.h (outgoing netlink messages) header.
These comments are not necessarily complete, but they do reference the IEEE 802.15.4-2006 document where possible.
--- drivers/ieee802154/fakehard.c | 120 +++++++++++++++++++++++++++++++++++++ include/net/ieee802154/nl802154.h | 76 +++++++++++++++++++++++ 2 files changed, 196 insertions(+), 0 deletions(-)
drivers/ieee802154/fakehard.c +120 -0
@@ -31,6 +31,12 @@#include <net/ieee802154/mac_def.h> #include <net/ieee802154/nl802154.h> +/** +* fake_get_pan_id - Retrieve the PAN ID of the device. +* @dev: The network device to retrieve the PAN of. +* +* Return the ID of the PAN from the PIB. +*/ static u16 fake_get_pan_id (struct net_device *dev) {BUG_ON (dev->type !=ARPHRD_IEEE802154 );
@@ -38,6 +44,14 @@ static u16 fake_get_pan_id(struct net_device *dev)return 0xeba1 ; } +/** +* fake_get_short_addr - Retrieve the short address of the device. +* @dev: The network device to retrieve the short address of. +* +* Returns the IEEE 802.15.4 short-form address cached for this +* device. If the device has not yet had a short address assigned +* then this should return 0xFFFF to indicate a lack of association. +*/ static u16 fake_get_short_addr (struct net_device *dev) {BUG_ON (dev->type !=ARPHRD_IEEE802154 );
@@ -45,6 +59,19 @@ static u16 fake_get_short_addr(struct net_device *dev)return 0x1 ; } +/** +* fake_get_dsn - Retrieve the DSN of the device. +* @dev: The network device to retrieve the DSN for. +* +* Returns the IEEE 802.15.4 DSN for the network device. +* The DSN is the sequence number which will be added to each +* packet or MAC command frame by the MAC during transmission. +* +* DSN means 'Data Sequence Number'. +* +* Note: This is in section 7.2.1.2 of the IEEE 802.15.4-2006 +* document. +*/ static u8 fake_get_dsn (struct net_device *dev) {BUG_ON (dev->type !=ARPHRD_IEEE802154 );
@@ -52,6 +79,19 @@ static u8 fake_get_dsn(struct net_device *dev)return 0x00 ;/* DSN are implemented in HW, so return just 0 */ } +/** +* fake_get_bsn - Retrieve the BSN of the device. +* @dev: The network device to retrieve the BSN for. +* +* Returns the IEEE 802.15.4 BSN for the network device. +* The BSN is the sequence number which will be added to each +* beacon frame sent by the MAC. +* +* BSN means 'Beacon Sequence Number'. +* +* Note: This is in section 7.2.1.2 of the IEEE 802.15.4-2006 +* document. +*/ static u8 fake_get_bsn (struct net_device *dev) {BUG_ON (dev->type !=ARPHRD_IEEE802154 );
@@ -59,6 +99,19 @@ static u8 fake_get_bsn(struct net_device *dev)return 0x00 ;/* BSN are implemented in HW, so return just 0 */ } +/** +* fake_assoc_req - Make an association request to the HW. +* @dev: The network device which we are associating to a network. +* @addr: The coordinator with which we wish to associate. +* @channel: The channel on which to associate. +* @cap: The capability information field to use in the association. +* +* Start an association with a coordinator. The coordinator's address +* and PAN ID can be found in @addr. +* +* Note: This is in section 7.3.1 and 7.5.3.1 of the IEEE +* 802.15.4-2006 document. +*/ static int fake_assoc_req (struct net_device *dev,struct ieee802154_addr *addr,u8 channel,u8 cap) {
@@ -67,18 +120,70 @@ static int fake_assoc_req(struct net_device *dev, IEEE802154_SUCCESS); } +/** +* fake_assoc_resp - Send an association response to a device. +* @dev: The network device on which to send the response. +* @addr: The address of the device to respond to. +* @short_addr: The assigned short address for the device (if any). +* @status: The result of the association request. +* +* Queue the association response of the coordinator to another +* device's attempt to associate with the network which we +* coordinate. This is then added to the indirect-send queue to be +* transmitted to the end device when it polls for data. +* +* Note: This is in section 7.3.2 and 7.5.3.1 of the IEEE +* 802.15.4-2006 document. +*/ static int fake_assoc_resp (struct net_device *dev,struct ieee802154_addr *addr,u16 short_addr,u8 status) {return 0 ; } +/** +* fake_disassoc_req - Disassociate a device from a network. +* @dev: The network device on which we're disassociating a device. +* @addr: The device to disassociate from the network. +* @reason: The reason to give to the device for being disassociated. +* +* This sends a disassociation notification to the device being +* disassociated from the network. +* +* Note: This is in section 7.5.3.2 of the IEEE 802.15.4-2006 +* document, with the reason described in 7.3.3.2. +*/ static int fake_disassoc_req (struct net_device *dev,struct ieee802154_addr *addr,u8 reason) {return ieee802154_nl_disassoc_confirm (dev,IEEE802154_SUCCESS ); } +/** +* fake_start_req - Start an IEEE 802.15.4 PAN. +* @dev: The network device on which to start the PAN. +* @addr: The coordinator address to use when starting the PAN. +* @channel: The channel on which to start the PAN. +* @bcn_ord: Beacon order. +* @sf_ord: Superframe order. +* @pan_coord: Whether or not we are the PAN coordinator or just +* requesting a realignment perhaps? +* @blx: Battery Life Extension feature bitfield. +* @coord_realign: Something to realign something else. +* +* If pan_coord is non-zero then this starts a network with the +* provided parameters, otherwise it attempts a coordinator +* realignment of the stated network instead. +* +* Note: This is in section 7.5.2.3 of the IEEE 802.15.4-2006 +* document, with 7.3.8 describing coordinator realignment. +* +* Note: There is currently no way to notify the coordinator userland +* program of whether or not the PAN has started successfully. As +* such, the coordinator program cannot know when the MAC has +* completed starting the network and will simply have to assume +* completeness based on some form of time delay. +*/ static int fake_start_req(struct net_device *dev, struct ieee802154_addr *addr, u8 channel, u8 bcn_ord, u8 sf_ord, u8 pan_coord, u8 blx,
@@ -87,6 +192,21 @@ static int fake_start_req(struct net_device *dev, struct ieee802154_addr *addr,return 0 ; } +/** +* fake_scan_req - Start a channel scan. +* @dev: The network device on which to perform a channel scan. +* @type: The type of scan to perform. +* @channels: The channel bitmask to scan. +* @duration: How long to spend on each channel. +* +* This starts either a passive (energy) scan or an active (PAN) scan +* on the channels indicated in the @channels bitmask. The duration of +* the scan is measured in terms of superframe duration. Specifically, +* the scan will spend aBaseSuperFrameDuration * ((2^n) + 1) on each +* channel. +* +* Note: This is in section 7.5.2.1 of the IEEE 802.15.4-2006 document. +*/ static int fake_scan_req (struct net_device *dev,u8 type,u32 channels,u8 duration) {
include/net/ieee802154/nl802154.h +76 -0
93 lines not on this page · raw message
Signature · 4 lines
1.6.3.3 ------------------------------------------------------------------------------
A message that is not in the archive (sent off-list or not yet received): 1248703695-7043-2-git-send-email-dbaryshkov-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
PATCH 2/3 ieee802154: move headers out of extra directory
include/net/ieee802154/af_ieee802154.h (and others) naming seems to be too long and redundant. Drop one level of subdirectories.
---
drivers/ieee802154/fakehard.c | 8 ++++----
include/net/{ieee802154 => }/af_ieee802154.h | 0
include/net/{ieee802154/mac_def.h => ieee802154.h} | 4 ++--
.../netdevice.h => ieee802154_netdev.h} | 0
include/net/{ieee802154 => }/nl802154.h | 0
net/ieee802154/af_ieee802154.c | 4 ++--
net/ieee802154/dgram.c | 6 +++---
net/ieee802154/netlink.c | 6 +++---
net/ieee802154/raw.c | 2 +-
9 files changed, 15 insertions(+), 15 deletions(-)
rename include/net/{ieee802154 => }/af_ieee802154.h (100%)
rename include/net/{ieee802154/mac_def.h => ieee802154.h} (98%)
rename include/net/{ieee802154/netdevice.h => ieee802154_netdev.h} (100%)
rename include/net/{ieee802154 => }/nl802154.h (100%)drivers/ieee802154/fakehard.c +4 -4
@@ -26,10 +26,10 @@#include <linux/skbuff.h> #include <linux/if_arp.h> -#include <net/ieee802154/af_ieee802154.h> -#include <net/ieee802154/netdevice.h> -#include <net/ieee802154/mac_def.h> -#include <net/ieee802154/nl802154.h> +#include <net/af_ieee802154.h> +#include <net/ieee802154_netdev.h> +#include <net/ieee802154.h> +#include <net/nl802154.h> /** * fake_get_pan_id - Retrieve the PAN ID of the device.
include/net/af_ieee802154.h renamed from include/net/ieee802154/af_ieee802154.h +0 -0
include/net/ieee802154.h renamed from include/net/ieee802154/mac_def.h +2 -2
@@ -23,8 +23,8 @@* Dmitry Eremin-Solenikov <[email protected]> */ -#ifndef IEEE802154_MAC_DEF_H -#define IEEE802154_MAC_DEF_H +#ifndef NET_IEEE802154_H +#define NET_IEEE802154_H #define IEEE802154_FC_TYPE_BEACON 0x0/* Frame is beacon */ #define IEEE802154_FC_TYPE_DATA 0x1/* Frame is data */
include/net/ieee802154_netdev.h renamed from include/net/ieee802154/netdevice.h +0 -0
include/net/nl802154.h renamed from include/net/ieee802154/nl802154.h +0 -0
net/ieee802154/af_ieee802154.c +2 -2
@@ -34,8 +34,8 @@#include <net/tcp_states.h> #include <net/route.h> -#include <net/ieee802154/af_ieee802154.h> -#include <net/ieee802154/netdevice.h> +#include <net/af_ieee802154.h> +#include <net/ieee802154_netdev.h> #include "af802154.h"
net/ieee802154/dgram.c +3 -3
@@ -26,9 +26,9 @@#include <linux/if_arp.h> #include <linux/list.h> #include <net/sock.h> -#include <net/ieee802154/af_ieee802154.h> -#include <net/ieee802154/mac_def.h> -#include <net/ieee802154/netdevice.h> +#include <net/af_ieee802154.h> +#include <net/ieee802154.h> +#include <net/ieee802154_netdev.h> #include <asm/ioctls.h>
net/ieee802154/netlink.c +3 -3
@@ -27,9 +27,9 @@#include <net/netlink.h> #include <net/genetlink.h> #include <linux/nl802154.h> -#include <net/ieee802154/af_ieee802154.h> -#include <net/ieee802154/nl802154.h> -#include <net/ieee802154/netdevice.h> +#include <net/af_ieee802154.h> +#include <net/nl802154.h> +#include <net/ieee802154_netdev.h> static unsigned int ieee802154_seq_num;
net/ieee802154/raw.c +1 -1
@@ -26,7 +26,7 @@#include <linux/if_arp.h> #include <linux/list.h> #include <net/sock.h> -#include <net/ieee802154/af_ieee802154.h> +#include <net/af_ieee802154.h> #include "af802154.h"
Signature · 4 lines
1.6.3.3 ------------------------------------------------------------------------------
A message that is not in the archive (sent off-list or not yet received): 1248703695-7043-3-git-send-email-dbaryshkov-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
PATCH 3/3 trivial: fix typo in ieee802154 documentation and add it to index
From: Thadeu Lima de Souza Cascardo <[email protected]>
--- Documentation/networking/00-INDEX | 2 ++ Documentation/networking/ieee802154.txt | 2 +- 2 files changed, 3 insertions(+), 1 deletions(-)
Documentation/networking/00-INDEX +2 -0
@@ -60,6 +60,8 @@ framerelay.txt - info on using Frame Relay/Data Link Connection Identifier (DLCI). generic_netlink.txt - info on Generic Netlink +ieee802154.txt + - Linux IEEE 802.15.4 implementation, API and drivers ip-sysctl.txt - /proc/sys/net/ipv4/* variables ip_dynaddr.txt
Documentation/networking/ieee802154.txt +1 -1
@@ -69,7 +69,7 @@ We provide an example of simple HardMAC driver at drivers/ieee802154/fakehard.c SoftMAC ======= -We are going to provide intermediate layer impelementing IEEE 802.15.4 MAC +We are going to provide intermediate layer implementing IEEE 802.15.4 MAC in software. This is currently WIP. See header include/net/ieee802154/mac802154.h and several drivers in
Signature · 4 lines
1.6.3.3 ------------------------------------------------------------------------------
David Miller
maintainerFrom: Dmitry Eremin-Solenikov <[email protected]>
Date: Mon, 27 Jul 2009 18:08:12 +0400
Quoted 10 lines
Please pull 3 small updates for IEEE 802.15.4 code (documentation and headers move).
The following changes since commit
72dccb01e8632aa5ffe58070003d0fa19d007116:
Eric Dumazet (1):
bnx2: Updatevlan_featuresare available in the git repository at:
git://git.kernel.org/pub/scm/linux/kernel/git/lowpan/lowpan.gitfor-linus
Pulled into net-next-2.6, thanks.