include/net/mac802154.h

   1 /*
   2  * IEEE802.15.4-2003 specification
   3  *
   4  * Copyright (C) 2007-2012 Siemens AG
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  */
  16 #ifndef NET_MAC802154_H
  17 #define NET_MAC802154_H
  18
  19 #include <net/af_ieee802154.h>
  20 #include <linux/ieee802154.h>
  21 #include <linux/skbuff.h>
  22 #include <linux/unaligned/memmove.h>
  23
  24 #include <net/cfg802154.h>
  25
  26 /* General MAC frame format:
  27  *  2 bytes: Frame Control
  28  *  1 byte:  Sequence Number
  29  * 20 bytes: Addressing fields
  30  * 14 bytes: Auxiliary Security Header
  31  */
  32 #define MAC802154_FRAME_HARD_HEADER_LEN         (2 + 1 + 20 + 14)
  33
  34 /**
  35  * enum ieee802154_hw_addr_filt_flags - hardware address filtering flags
  36  *
  37  * The following flags are used to indicate changed address settings from
  38  * the stack to the hardware.
  39  *
  40  * @IEEE802154_AFILT_SADDR_CHANGED: Indicates that the short address will be
  41  *      change.
  42  *
  43  * @IEEE802154_AFILT_IEEEADDR_CHANGED: Indicates that the extended address
  44  *      will be change.
  45  *
  46  * @IEEE802154_AFILT_PANID_CHANGED: Indicates that the pan id will be change.
  47  *
  48  * @IEEE802154_AFILT_PANC_CHANGED: Indicates that the address filter will
  49  *      do frame address filtering as a pan coordinator.
  50  */
  51 enum ieee802154_hw_addr_filt_flags {
  52         IEEE802154_AFILT_SADDR_CHANGED          = BIT(1),
  53         IEEE802154_AFILT_IEEEADDR_CHANGED       = BIT(2),
  54         IEEE802154_AFILT_PANID_CHANGED          = BIT(3),
  55         IEEE802154_AFILT_PANC_CHANGED           = BIT(4),
  56 };
  57
  58 struct ieee802154_hw_addr_filt {
  59         __le16  pan_id;         /* Each independent PAN selects a unique
  60                                  * identifier. This PAN id allows communication
  61                                  * between devices within a network using short
  62                                  * addresses and enables transmissions between
  63                                  * devices across independent networks.
  64                                  */
  65         __le16  short_addr;
  66         __le64  ieee_addr;
  67         u8      pan_coord;
  68 };
  69
  70 struct ieee802154_hw {
  71         /* filled by the driver */
  72         int     extra_tx_headroom;
  73         u32     flags;
  74         struct  device *parent;
  75
  76         /* filled by mac802154 core */
  77         struct  ieee802154_hw_addr_filt hw_filt;
  78         void    *priv;
  79         struct  wpan_phy *phy;
  80 };
  81
  82 /**
  83  * enum ieee802154_hw_flags - hardware flags
  84  *
  85  * These flags are used to indicate hardware capabilities to
  86  * the stack. Generally, flags here should have their meaning
  87  * done in a way that the simplest hardware doesn't need setting
  88  * any particular flags. There are some exceptions to this rule,
  89  * however, so you are advised to review these flags carefully.
  90  *
  91  * @IEEE802154_HW_TX_OMIT_CKSUM: Indicates that xmitter will add FCS on it's
  92  *      own.
  93  *
  94  * @IEEE802154_HW_LBT: Indicates that transceiver will support listen before
  95  *      transmit.
  96  *
  97  * @IEEE802154_HW_CSMA_PARAMS: Indicates that transceiver will support csma
  98  *      parameters (max_be, min_be, backoff exponents).
  99  *
 100  * @IEEE802154_HW_FRAME_RETRIES: Indicates that transceiver will support ARET
 101  *      frame retries setting.
 102  *
 103  * @IEEE802154_HW_AFILT: Indicates that transceiver will support hardware
 104  *      address filter setting.
 105  *
 106  * @IEEE802154_HW_PROMISCUOUS: Indicates that transceiver will support
 107  *      promiscuous mode setting.
 108  *
 109  * @IEEE802154_HW_RX_OMIT_CKSUM: Indicates that receiver omits FCS.
 110  *
 111  * @IEEE802154_HW_RX_DROP_BAD_CKSUM: Indicates that receiver will not filter
 112  *      frames with bad checksum.
 113  */
 114 enum ieee802154_hw_flags {
 115         IEEE802154_HW_TX_OMIT_CKSUM     = BIT(1),
 116         IEEE802154_HW_LBT               = BIT(2),
 117         IEEE802154_HW_CSMA_PARAMS       = BIT(3),
 118         IEEE802154_HW_FRAME_RETRIES     = BIT(4),
 119         IEEE802154_HW_AFILT             = BIT(5),
 120         IEEE802154_HW_PROMISCUOUS       = BIT(6),
 121         IEEE802154_HW_RX_OMIT_CKSUM     = BIT(7),
 122         IEEE802154_HW_RX_DROP_BAD_CKSUM = BIT(8),
 123 };
 124
 125 /* Indicates that receiver omits FCS and xmitter will add FCS on it's own. */
 126 #define IEEE802154_HW_OMIT_CKSUM        (IEEE802154_HW_TX_OMIT_CKSUM | \
 127                                          IEEE802154_HW_RX_OMIT_CKSUM)
 128
 129 /* struct ieee802154_ops - callbacks from mac802154 to the driver
 130  *
 131  * This structure contains various callbacks that the driver may
 132  * handle or, in some cases, must handle, for example to transmit
 133  * a frame.
 134  *
 135  * start: Handler that 802.15.4 module calls for device initialization.
 136  *        This function is called before the first interface is attached.
 137  *
 138  * stop:  Handler that 802.15.4 module calls for device cleanup.
 139  *        This function is called after the last interface is removed.
 140  *
 141  * xmit_sync:
 142  *        Handler that 802.15.4 module calls for each transmitted frame.
 143  *        skb cntains the buffer starting from the IEEE 802.15.4 header.
 144  *        The low-level driver should send the frame based on available
 145  *        configuration. This is called by a workqueue and useful for
 146  *        synchronous 802.15.4 drivers.
 147  *        This function should return zero or negative errno.
 148  *
 149  *        WARNING:
 150  *        This will be deprecated soon. We don't accept synced xmit callbacks
 151  *        drivers anymore.
 152  *
 153  * xmit_async:
 154  *        Handler that 802.15.4 module calls for each transmitted frame.
 155  *        skb cntains the buffer starting from the IEEE 802.15.4 header.
 156  *        The low-level driver should send the frame based on available
 157  *        configuration.
 158  *        This function should return zero or negative errno.
 159  *
 160  * ed:    Handler that 802.15.4 module calls for Energy Detection.
 161  *        This function should place the value for detected energy
 162  *        (usually device-dependant) in the level pointer and return
 163  *        either zero or negative errno. Called with pib_lock held.
 164  *
 165  * set_channel:
 166  *        Set radio for listening on specific channel.
 167  *        Set the device for listening on specified channel.
 168  *        Returns either zero, or negative errno. Called with pib_lock held.
 169  *
 170  * set_hw_addr_filt:
 171  *        Set radio for listening on specific address.
 172  *        Set the device for listening on specified address.
 173  *        Returns either zero, or negative errno.
 174  *
 175  * set_txpower:
 176  *        Set radio transmit power in mBm. Called with pib_lock held.
 177  *        Returns either zero, or negative errno.
 178  *
 179  * set_lbt
 180  *        Enables or disables listen before talk on the device. Called with
 181  *        pib_lock held.
 182  *        Returns either zero, or negative errno.
 183  *
 184  * set_cca_mode
 185  *        Sets the CCA mode used by the device. Called with pib_lock held.
 186  *        Returns either zero, or negative errno.
 187  *
 188  * set_cca_ed_level
 189  *        Sets the CCA energy detection threshold in mBm. Called with pib_lock
 190  *        held.
 191  *        Returns either zero, or negative errno.
 192  *
 193  * set_csma_params
 194  *        Sets the CSMA parameter set for the PHY. Called with pib_lock held.
 195  *        Returns either zero, or negative errno.
 196  *
 197  * set_frame_retries
 198  *        Sets the retransmission attempt limit. Called with pib_lock held.
 199  *        Returns either zero, or negative errno.
 200  *
 201  * set_promiscuous_mode
 202  *        Enables or disable promiscuous mode.
 203  */
 204 struct ieee802154_ops {
 205         struct module   *owner;
 206         int             (*start)(struct ieee802154_hw *hw);
 207         void            (*stop)(struct ieee802154_hw *hw);
 208         int             (*xmit_sync)(struct ieee802154_hw *hw,
 209                                      struct sk_buff *skb);
 210         int             (*xmit_async)(struct ieee802154_hw *hw,
 211                                       struct sk_buff *skb);
 212         int             (*ed)(struct ieee802154_hw *hw, u8 *level);
 213         int             (*set_channel)(struct ieee802154_hw *hw, u8 page,
 214                                        u8 channel);
 215         int             (*set_hw_addr_filt)(struct ieee802154_hw *hw,
 216                                             struct ieee802154_hw_addr_filt *filt,
 217                                             unsigned long changed);
 218         int             (*set_txpower)(struct ieee802154_hw *hw, s32 mbm);
 219         int             (*set_lbt)(struct ieee802154_hw *hw, bool on);
 220         int             (*set_cca_mode)(struct ieee802154_hw *hw,
 221                                         const struct wpan_phy_cca *cca);
 222         int             (*set_cca_ed_level)(struct ieee802154_hw *hw, s32 mbm);
 223         int             (*set_csma_params)(struct ieee802154_hw *hw,
 224                                            u8 min_be, u8 max_be, u8 retries);
 225         int             (*set_frame_retries)(struct ieee802154_hw *hw,
 226                                              s8 retries);
 227         int             (*set_promiscuous_mode)(struct ieee802154_hw *hw,
 228                                                 const bool on);
 229 };
 230
 231 /**
 232  * ieee802154_be64_to_le64 - copies and convert be64 to le64
 233  * @le64_dst: le64 destination pointer
 234  * @be64_src: be64 source pointer
 235  */
 236 static inline void ieee802154_be64_to_le64(void *le64_dst, const void *be64_src)
 237 {
 238         __put_unaligned_memmove64(swab64p(be64_src), le64_dst);
 239 }
 240
 241 /**
 242  * ieee802154_le64_to_be64 - copies and convert le64 to be64
 243  * @be64_dst: be64 destination pointer
 244  * @le64_src: le64 source pointer
 245  */
 246 static inline void ieee802154_le64_to_be64(void *be64_dst, const void *le64_src)
 247 {
 248         __put_unaligned_memmove64(swab64p(le64_src), be64_dst);
 249 }
 250
 251 /**
 252  * ieee802154_alloc_hw - Allocate a new hardware device
 253  *
 254  * This must be called once for each hardware device. The returned pointer
 255  * must be used to refer to this device when calling other functions.
 256  * mac802154 allocates a private data area for the driver pointed to by
 257  * @priv in &struct ieee802154_hw, the size of this area is given as
 258  * @priv_data_len.
 259  *
 260  * @priv_data_len: length of private data
 261  * @ops: callbacks for this device
 262  *
 263  * Return: A pointer to the new hardware device, or %NULL on error.
 264  */
 265 struct ieee802154_hw *
 266 ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);
 267
 268 /**
 269  * ieee802154_free_hw - free hardware descriptor
 270  *
 271  * This function frees everything that was allocated, including the
 272  * private data for the driver. You must call ieee802154_unregister_hw()
 273  * before calling this function.
 274  *
 275  * @hw: the hardware to free
 276  */
 277 void ieee802154_free_hw(struct ieee802154_hw *hw);
 278
 279 /**
 280  * ieee802154_register_hw - Register hardware device
 281  *
 282  * You must call this function before any other functions in
 283  * mac802154. Note that before a hardware can be registered, you
 284  * need to fill the contained wpan_phy's information.
 285  *
 286  * @hw: the device to register as returned by ieee802154_alloc_hw()
 287  *
 288  * Return: 0 on success. An error code otherwise.
 289  */
 290 int ieee802154_register_hw(struct ieee802154_hw *hw);
 291
 292 /**
 293  * ieee802154_unregister_hw - Unregister a hardware device
 294  *
 295  * This function instructs mac802154 to free allocated resources
 296  * and unregister netdevices from the networking subsystem.
 297  *
 298  * @hw: the hardware to unregister
 299  */
 300 void ieee802154_unregister_hw(struct ieee802154_hw *hw);
 301
 302 /**
 303  * ieee802154_rx - receive frame
 304  *
 305  * Use this function to hand received frames to mac802154. The receive
 306  * buffer in @skb must start with an IEEE 802.15.4 header. In case of a
 307  * paged @skb is used, the driver is recommended to put the ieee802154
 308  * header of the frame on the linear part of the @skb to avoid memory
 309  * allocation and/or memcpy by the stack.
 310  *
 311  * This function may not be called in IRQ context. Calls to this function
 312  * for a single hardware must be synchronized against each other.
 313  *
 314  * @hw: the hardware this frame came in on
 315  * @skb: the buffer to receive, owned by mac802154 after this call
 316  */
 317 void ieee802154_rx(struct ieee802154_hw *hw, struct sk_buff *skb);
 318
 319 /**
 320  * ieee802154_rx_irqsafe - receive frame
 321  *
 322  * Like ieee802154_rx() but can be called in IRQ context
 323  * (internally defers to a tasklet.)
 324  *
 325  * @hw: the hardware this frame came in on
 326  * @skb: the buffer to receive, owned by mac802154 after this call
 327  * @lqi: link quality indicator
 328  */
 329 void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
 330                            u8 lqi);
 331 /**
 332  * ieee802154_wake_queue - wake ieee802154 queue
 333  * @hw: pointer as obtained from ieee802154_alloc_hw().
 334  *
 335  * Drivers should use this function instead of netif_wake_queue.
 336  */
 337 void ieee802154_wake_queue(struct ieee802154_hw *hw);
 338
 339 /**
 340  * ieee802154_stop_queue - stop ieee802154 queue
 341  * @hw: pointer as obtained from ieee802154_alloc_hw().
 342  *
 343  * Drivers should use this function instead of netif_stop_queue.
 344  */
 345 void ieee802154_stop_queue(struct ieee802154_hw *hw);
 346
 347 /**
 348  * ieee802154_xmit_complete - frame transmission complete
 349  *
 350  * @hw: pointer as obtained from ieee802154_alloc_hw().
 351  * @skb: buffer for transmission
 352  * @ifs_handling: indicate interframe space handling
 353  */
 354 void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb,
 355                               bool ifs_handling);
 356
 357 #endif /* NET_MAC802154_H */