Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/lowpan...

diff --combined drivers/ieee802154/fakehard.c
index 14045a7,8a52e6e..c94d2c2
--- 1/drivers/ieee802154/fakehard.c
--- 2/drivers/ieee802154/fakehard.c
+++ b/drivers/ieee802154/fakehard.c
@@@ -26,11 -26,17 +26,17 @@@
  #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.
+  * @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 +44,14 @@@
        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 +59,19 @@@
        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 +79,19 @@@
        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 +99,19 @@@
        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 +120,70 @@@
                        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 +192,21 @@@
        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)
  {
@@@ -132,7 -252,7 +252,7 @@@ static int ieee802154_fake_xmit(struct 
  
        /* FIXME: do hardware work here ... */
  
 -      return 0;
 +      return NETDEV_TX_OK;
  }