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/skbuff.h>
  21
  22 /* General MAC frame format:
  23  *  2 bytes: Frame Control
  24  *  1 byte:  Sequence Number
  25  * 20 bytes: Addressing fields
  26  * 14 bytes: Auxiliary Security Header
  27  */
  28 #define MAC802154_FRAME_HARD_HEADER_LEN         (2 + 1 + 20 + 14)
  29
  30 /* The following flags are used to indicate changed address settings from
  31  * the stack to the hardware.
  32  */
  33
  34 /* indicates that the Short Address changed */
  35 #define IEEE802154_AFILT_SADDR_CHANGED          0x00000001
  36 /* indicates that the IEEE Address changed */
  37 #define IEEE802154_AFILT_IEEEADDR_CHANGED       0x00000002
  38 /* indicates that the PAN ID changed */
  39 #define IEEE802154_AFILT_PANID_CHANGED          0x00000004
  40 /* indicates that PAN Coordinator status changed */
  41 #define IEEE802154_AFILT_PANC_CHANGED           0x00000008
  42
  43 struct ieee802154_hw_addr_filt {
  44         __le16  pan_id;         /* Each independent PAN selects a unique
  45                                  * identifier. This PAN id allows communication
  46                                  * between devices within a network using short
  47                                  * addresses and enables transmissions between
  48                                  * devices across independent networks.
  49                                  */
  50         __le16  short_addr;
  51         __le64  ieee_addr;
  52         u8      pan_coord;
  53 };
  54
  55 struct ieee802154_hw {
  56         /* filled by the driver */
  57         int     extra_tx_headroom;
  58         u32     flags;
  59         struct  device *parent;
  60
  61         /* filled by mac802154 core */
  62         struct  ieee802154_hw_addr_filt hw_filt;
  63         void    *priv;
  64         struct  wpan_phy *phy;
  65 };
  66
  67 /* Checksum is in hardware and is omitted from a packet
  68  *
  69  * These following flags are used to indicate hardware capabilities to
  70  * the stack. Generally, flags here should have their meaning
  71  * done in a way that the simplest hardware doesn't need setting
  72  * any particular flags. There are some exceptions to this rule,
  73  * however, so you are advised to review these flags carefully.
  74  */
  75
  76 /* Indicates that xmitter will add FCS on it's own. */
  77 #define IEEE802154_HW_TX_OMIT_CKSUM     0x00000001
  78 /* Indicates that receiver will autorespond with ACK frames. */
  79 #define IEEE802154_HW_AACK              0x00000002
  80 /* Indicates that transceiver will support transmit power setting. */
  81 #define IEEE802154_HW_TXPOWER           0x00000004
  82 /* Indicates that transceiver will support listen before transmit. */
  83 #define IEEE802154_HW_LBT               0x00000008
  84 /* Indicates that transceiver will support cca mode setting. */
  85 #define IEEE802154_HW_CCA_MODE          0x00000010
  86 /* Indicates that transceiver will support cca ed level setting. */
  87 #define IEEE802154_HW_CCA_ED_LEVEL      0x00000020
  88 /* Indicates that transceiver will support csma (max_be, min_be, csma retries)
  89  * settings. */
  90 #define IEEE802154_HW_CSMA_PARAMS       0x00000040
  91 /* Indicates that transceiver will support ARET frame retries setting. */
  92 #define IEEE802154_HW_FRAME_RETRIES     0x00000080
  93 /* Indicates that transceiver will support hardware address filter setting. */
  94 #define IEEE802154_HW_AFILT             0x00000100
  95 /* Indicates that transceiver will support promiscuous mode setting. */
  96 #define IEEE802154_HW_PROMISCUOUS       0x00000200
  97 /* Indicates that receiver omits FCS. */
  98 #define IEEE802154_HW_RX_OMIT_CKSUM     0x00000400
  99 /* Indicates that receiver will not filter frames with bad checksum. */
 100 #define IEEE802154_HW_RX_DROP_BAD_CKSUM 0x00000800
 101
 102 /* Indicates that receiver omits FCS and xmitter will add FCS on it's own. */
 103 #define IEEE802154_HW_OMIT_CKSUM        (IEEE802154_HW_TX_OMIT_CKSUM | \
 104                                          IEEE802154_HW_RX_OMIT_CKSUM)
 105
 106 /* This groups the most common CSMA support fields into one. */
 107 #define IEEE802154_HW_CSMA              (IEEE802154_HW_CCA_MODE | \
 108                                          IEEE802154_HW_CCA_ED_LEVEL | \
 109                                          IEEE802154_HW_CSMA_PARAMS)
 110
 111 /* This groups the most common ARET support fields into one. */
 112 #define IEEE802154_HW_ARET              (IEEE802154_HW_CSMA | \
 113                                          IEEE802154_HW_FRAME_RETRIES)
 114
 115 /* struct ieee802154_ops - callbacks from mac802154 to the driver
 116  *
 117  * This structure contains various callbacks that the driver may
 118  * handle or, in some cases, must handle, for example to transmit
 119  * a frame.
 120  *
 121  * start: Handler that 802.15.4 module calls for device initialization.
 122  *        This function is called before the first interface is attached.
 123  *
 124  * stop:  Handler that 802.15.4 module calls for device cleanup.
 125  *        This function is called after the last interface is removed.
 126  *
 127  * xmit_sync:
 128  *        Handler that 802.15.4 module calls for each transmitted frame.
 129  *        skb cntains the buffer starting from the IEEE 802.15.4 header.
 130  *        The low-level driver should send the frame based on available
 131  *        configuration. This is called by a workqueue and useful for
 132  *        synchronous 802.15.4 drivers.
 133  *        This function should return zero or negative errno.
 134  *
 135  *        WARNING:
 136  *        This will be deprecated soon. We don't accept synced xmit callbacks
 137  *        drivers anymore.
 138  *
 139  * xmit_async:
 140  *        Handler that 802.15.4 module calls for each transmitted frame.
 141  *        skb cntains the buffer starting from the IEEE 802.15.4 header.
 142  *        The low-level driver should send the frame based on available
 143  *        configuration.
 144  *        This function should return zero or negative errno.
 145  *
 146  * ed:    Handler that 802.15.4 module calls for Energy Detection.
 147  *        This function should place the value for detected energy
 148  *        (usually device-dependant) in the level pointer and return
 149  *        either zero or negative errno. Called with pib_lock held.
 150  *
 151  * set_channel:
 152  *        Set radio for listening on specific channel.
 153  *        Set the device for listening on specified channel.
 154  *        Returns either zero, or negative errno. Called with pib_lock held.
 155  *
 156  * set_hw_addr_filt:
 157  *        Set radio for listening on specific address.
 158  *        Set the device for listening on specified address.
 159  *        Returns either zero, or negative errno.
 160  *
 161  * set_txpower:
 162  *        Set radio transmit power in dB. Called with pib_lock held.
 163  *        Returns either zero, or negative errno.
 164  *
 165  * set_lbt
 166  *        Enables or disables listen before talk on the device. Called with
 167  *        pib_lock held.
 168  *        Returns either zero, or negative errno.
 169  *
 170  * set_cca_mode
 171  *        Sets the CCA mode used by the device. Called with pib_lock held.
 172  *        Returns either zero, or negative errno.
 173  *
 174  * set_cca_ed_level
 175  *        Sets the CCA energy detection threshold in dBm. Called with pib_lock
 176  *        held.
 177  *        Returns either zero, or negative errno.
 178  *
 179  * set_csma_params
 180  *        Sets the CSMA parameter set for the PHY. Called with pib_lock held.
 181  *        Returns either zero, or negative errno.
 182  *
 183  * set_frame_retries
 184  *        Sets the retransmission attempt limit. Called with pib_lock held.
 185  *        Returns either zero, or negative errno.
 186  *
 187  * set_promiscuous_mode
 188  *        Enables or disable promiscuous mode.
 189  */
 190 struct ieee802154_ops {
 191         struct module   *owner;
 192         int             (*start)(struct ieee802154_hw *hw);
 193         void            (*stop)(struct ieee802154_hw *hw);
 194         int             (*xmit_sync)(struct ieee802154_hw *hw,
 195                                      struct sk_buff *skb);
 196         int             (*xmit_async)(struct ieee802154_hw *hw,
 197                                       struct sk_buff *skb);
 198         int             (*ed)(struct ieee802154_hw *hw, u8 *level);
 199         int             (*set_channel)(struct ieee802154_hw *hw, u8 page,
 200                                        u8 channel);
 201         int             (*set_hw_addr_filt)(struct ieee802154_hw *hw,
 202                                             struct ieee802154_hw_addr_filt *filt,
 203                                             unsigned long changed);
 204         int             (*set_txpower)(struct ieee802154_hw *hw, int db);
 205         int             (*set_lbt)(struct ieee802154_hw *hw, bool on);
 206         int             (*set_cca_mode)(struct ieee802154_hw *hw, u8 mode);
 207         int             (*set_cca_ed_level)(struct ieee802154_hw *hw,
 208                                             s32 level);
 209         int             (*set_csma_params)(struct ieee802154_hw *hw,
 210                                            u8 min_be, u8 max_be, u8 retries);
 211         int             (*set_frame_retries)(struct ieee802154_hw *hw,
 212                                              s8 retries);
 213         int             (*set_promiscuous_mode)(struct ieee802154_hw *hw,
 214                                                 const bool on);
 215 };
 216
 217 /**
 218  * ieee802154_netdev_to_extended_addr - convert big endian 64 byte void pointer to __le64
 219  * @dev_addr: big endian address pointer like netdevice dev_addr attribute
 220  */
 221 static inline __le64 ieee802154_netdev_to_extended_addr(const void *dev_addr)
 222 {
 223         return (__force __le64)swab64p(dev_addr);
 224 }
 225
 226 /* Basic interface to register ieee802154 hwice */
 227 struct ieee802154_hw *
 228 ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);
 229 void ieee802154_free_hw(struct ieee802154_hw *hw);
 230 int ieee802154_register_hw(struct ieee802154_hw *hw);
 231 void ieee802154_unregister_hw(struct ieee802154_hw *hw);
 232
 233 void ieee802154_rx(struct ieee802154_hw *hw, struct sk_buff *skb);
 234 void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
 235                            u8 lqi);
 236
 237 void ieee802154_wake_queue(struct ieee802154_hw *hw);
 238 void ieee802154_stop_queue(struct ieee802154_hw *hw);
 239 void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb);
 240
 241 #endif /* NET_MAC802154_H */