include/net/ieee802154_netdev.h

   1 /*
   2  * An interface between IEEE802.15.4 device and rest of the kernel.
   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  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Written by:
  20  * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
  21  * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
  22  * Maxim Osipov <maxim.osipov@siemens.com>
  23  * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
  24  * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
  25  */
  26
  27 #ifndef IEEE802154_NETDEVICE_H
  28 #define IEEE802154_NETDEVICE_H
  29
  30 #include <net/ieee802154.h>
  31 #include <net/af_ieee802154.h>
  32 #include <linux/netdevice.h>
  33 #include <linux/skbuff.h>
  34
  35 struct ieee802154_sechdr {
  36 #if defined(__LITTLE_ENDIAN_BITFIELD)
  37         u8 level:3,
  38            key_id_mode:2,
  39            reserved:3;
  40 #elif defined(__BIG_ENDIAN_BITFIELD)
  41         u8 reserved:3,
  42            key_id_mode:2,
  43            level:3;
  44 #else
  45 #error  "Please fix <asm/byteorder.h>"
  46 #endif
  47         u8 key_id;
  48         __le32 frame_counter;
  49         union {
  50                 __le32 short_src;
  51                 __le64 extended_src;
  52         };
  53 };
  54
  55 struct ieee802154_addr {
  56         u8 mode;
  57         __le16 pan_id;
  58         union {
  59                 __le16 short_addr;
  60                 __le64 extended_addr;
  61         };
  62 };
  63
  64 struct ieee802154_hdr_fc {
  65 #if defined(__LITTLE_ENDIAN_BITFIELD)
  66         u16 type:3,
  67             security_enabled:1,
  68             frame_pending:1,
  69             ack_request:1,
  70             intra_pan:1,
  71             reserved:3,
  72             dest_addr_mode:2,
  73             version:2,
  74             source_addr_mode:2;
  75 #elif defined(__BIG_ENDIAN_BITFIELD)
  76         u16 reserved:1,
  77             intra_pan:1,
  78             ack_request:1,
  79             frame_pending:1,
  80             security_enabled:1,
  81             type:3,
  82             source_addr_mode:2,
  83             version:2,
  84             dest_addr_mode:2,
  85             reserved2:2;
  86 #else
  87 #error  "Please fix <asm/byteorder.h>"
  88 #endif
  89 };
  90
  91 struct ieee802154_hdr {
  92         struct ieee802154_hdr_fc fc;
  93         u8 seq;
  94         struct ieee802154_addr source;
  95         struct ieee802154_addr dest;
  96         struct ieee802154_sechdr sec;
  97 };
  98
  99 /* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
 100  * the contents of hdr will be, and the actual value of those bits in
 101  * hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
 102  * version, if SECEN is set.
 103  */
 104 int ieee802154_hdr_push(struct sk_buff *skb, const struct ieee802154_hdr *hdr);
 105
 106 /* pulls the entire 802.15.4 header off of the skb, including the security
 107  * header, and performs pan id decompression
 108  */
 109 int ieee802154_hdr_pull(struct sk_buff *skb, struct ieee802154_hdr *hdr);
 110
 111 /* parses the frame control, sequence number of address fields in a given skb
 112  * and stores them into hdr, performing pan id decompression and length checks
 113  * to be suitable for use in header_ops.parse
 114  */
 115 int ieee802154_hdr_peek_addrs(const struct sk_buff *skb,
 116                               struct ieee802154_hdr *hdr);
 117
 118 /* parses the full 802.15.4 header a given skb and stores them into hdr,
 119  * performing pan id decompression and length checks to be suitable for use in
 120  * header_ops.parse
 121  */
 122 int ieee802154_hdr_peek(const struct sk_buff *skb, struct ieee802154_hdr *hdr);
 123
 124 int ieee802154_max_payload(const struct ieee802154_hdr *hdr);
 125
 126 static inline int
 127 ieee802154_sechdr_authtag_len(const struct ieee802154_sechdr *sec)
 128 {
 129         switch (sec->level) {
 130         case IEEE802154_SCF_SECLEVEL_MIC32:
 131         case IEEE802154_SCF_SECLEVEL_ENC_MIC32:
 132                 return 4;
 133         case IEEE802154_SCF_SECLEVEL_MIC64:
 134         case IEEE802154_SCF_SECLEVEL_ENC_MIC64:
 135                 return 8;
 136         case IEEE802154_SCF_SECLEVEL_MIC128:
 137         case IEEE802154_SCF_SECLEVEL_ENC_MIC128:
 138                 return 16;
 139         case IEEE802154_SCF_SECLEVEL_NONE:
 140         case IEEE802154_SCF_SECLEVEL_ENC:
 141         default:
 142                 return 0;
 143         }
 144 }
 145
 146 static inline int ieee802154_hdr_length(struct sk_buff *skb)
 147 {
 148         struct ieee802154_hdr hdr;
 149         int len = ieee802154_hdr_pull(skb, &hdr);
 150
 151         if (len > 0)
 152                 skb_push(skb, len);
 153
 154         return len;
 155 }
 156
 157 static inline bool ieee802154_addr_equal(const struct ieee802154_addr *a1,
 158                                          const struct ieee802154_addr *a2)
 159 {
 160         if (a1->pan_id != a2->pan_id || a1->mode != a2->mode)
 161                 return false;
 162
 163         if ((a1->mode == IEEE802154_ADDR_LONG &&
 164              a1->extended_addr != a2->extended_addr) ||
 165             (a1->mode == IEEE802154_ADDR_SHORT &&
 166              a1->short_addr != a2->short_addr))
 167                 return false;
 168
 169         return true;
 170 }
 171
 172 static inline __le64 ieee802154_devaddr_from_raw(const void *raw)
 173 {
 174         u64 temp;
 175
 176         memcpy(&temp, raw, IEEE802154_ADDR_LEN);
 177         return (__force __le64)swab64(temp);
 178 }
 179
 180 static inline void ieee802154_devaddr_to_raw(void *raw, __le64 addr)
 181 {
 182         u64 temp = swab64((__force u64)addr);
 183
 184         memcpy(raw, &temp, IEEE802154_ADDR_LEN);
 185 }
 186
 187 static inline void ieee802154_addr_from_sa(struct ieee802154_addr *a,
 188                                            const struct ieee802154_addr_sa *sa)
 189 {
 190         a->mode = sa->addr_type;
 191         a->pan_id = cpu_to_le16(sa->pan_id);
 192
 193         switch (a->mode) {
 194         case IEEE802154_ADDR_SHORT:
 195                 a->short_addr = cpu_to_le16(sa->short_addr);
 196                 break;
 197         case IEEE802154_ADDR_LONG:
 198                 a->extended_addr = ieee802154_devaddr_from_raw(sa->hwaddr);
 199                 break;
 200         }
 201 }
 202
 203 static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa *sa,
 204                                          const struct ieee802154_addr *a)
 205 {
 206         sa->addr_type = a->mode;
 207         sa->pan_id = le16_to_cpu(a->pan_id);
 208
 209         switch (a->mode) {
 210         case IEEE802154_ADDR_SHORT:
 211                 sa->short_addr = le16_to_cpu(a->short_addr);
 212                 break;
 213         case IEEE802154_ADDR_LONG:
 214                 ieee802154_devaddr_to_raw(sa->hwaddr, a->extended_addr);
 215                 break;
 216         }
 217 }
 218
 219 /*
 220  * A control block of skb passed between the ARPHRD_IEEE802154 device
 221  * and other stack parts.
 222  */
 223 struct ieee802154_mac_cb {
 224         u8 lqi;
 225         u8 type;
 226         bool ackreq;
 227         bool secen;
 228         struct ieee802154_addr source;
 229         struct ieee802154_addr dest;
 230 };
 231
 232 static inline struct ieee802154_mac_cb *mac_cb(struct sk_buff *skb)
 233 {
 234         return (struct ieee802154_mac_cb *)skb->cb;
 235 }
 236
 237 static inline struct ieee802154_mac_cb *mac_cb_init(struct sk_buff *skb)
 238 {
 239         BUILD_BUG_ON(sizeof(struct ieee802154_mac_cb) > sizeof(skb->cb));
 240
 241         memset(skb->cb, 0, sizeof(struct ieee802154_mac_cb));
 242         return mac_cb(skb);
 243 }
 244
 245 #define IEEE802154_LLSEC_KEY_SIZE 16
 246
 247 struct ieee802154_llsec_key_id {
 248         u8 mode;
 249         u8 id;
 250         union {
 251                 struct ieee802154_addr device_addr;
 252                 __le32 short_source;
 253                 __le64 extended_source;
 254         };
 255 };
 256
 257 struct ieee802154_llsec_key {
 258         u8 frame_types;
 259         u32 cmd_frame_ids;
 260         u8 key[IEEE802154_LLSEC_KEY_SIZE];
 261 };
 262
 263 struct ieee802154_llsec_key_entry {
 264         struct list_head list;
 265
 266         struct ieee802154_llsec_key_id id;
 267         struct ieee802154_llsec_key *key;
 268 };
 269
 270 struct ieee802154_llsec_device_key {
 271         struct list_head list;
 272
 273         struct ieee802154_llsec_key_id key_id;
 274         u32 frame_counter;
 275 };
 276
 277 enum {
 278         IEEE802154_LLSEC_DEVKEY_IGNORE,
 279         IEEE802154_LLSEC_DEVKEY_RESTRICT,
 280
 281         __IEEE802154_LLSEC_DEVKEY_MAX,
 282 };
 283
 284 struct ieee802154_llsec_device {
 285         struct list_head list;
 286
 287         __le16 pan_id;
 288         __le16 short_addr;
 289         __le64 hwaddr;
 290         u32 frame_counter;
 291         bool seclevel_exempt;
 292
 293         u8 key_mode;
 294         struct list_head keys;
 295 };
 296
 297 struct ieee802154_llsec_seclevel {
 298         struct list_head list;
 299
 300         u8 frame_type;
 301         u8 cmd_frame_id;
 302         bool device_override;
 303         u32 sec_levels;
 304 };
 305
 306 struct ieee802154_llsec_params {
 307         bool enabled;
 308
 309         __be32 frame_counter;
 310         u8 out_level;
 311         struct ieee802154_llsec_key_id out_key;
 312
 313         __le64 default_key_source;
 314
 315         __le16 pan_id;
 316         __le64 hwaddr;
 317         __le64 coord_hwaddr;
 318         __le16 coord_shortaddr;
 319 };
 320
 321 struct ieee802154_llsec_table {
 322         struct list_head keys;
 323         struct list_head devices;
 324         struct list_head security_levels;
 325 };
 326
 327 #define IEEE802154_MAC_SCAN_ED          0
 328 #define IEEE802154_MAC_SCAN_ACTIVE      1
 329 #define IEEE802154_MAC_SCAN_PASSIVE     2
 330 #define IEEE802154_MAC_SCAN_ORPHAN      3
 331
 332 struct ieee802154_mac_params {
 333         s8 transmit_power;
 334         u8 min_be;
 335         u8 max_be;
 336         u8 csma_retries;
 337         s8 frame_retries;
 338
 339         bool lbt;
 340         u8 cca_mode;
 341         s32 cca_ed_level;
 342 };
 343
 344 struct wpan_phy;
 345
 346 enum {
 347         IEEE802154_LLSEC_PARAM_ENABLED = 1 << 0,
 348         IEEE802154_LLSEC_PARAM_FRAME_COUNTER = 1 << 1,
 349         IEEE802154_LLSEC_PARAM_OUT_LEVEL = 1 << 2,
 350         IEEE802154_LLSEC_PARAM_OUT_KEY = 1 << 3,
 351         IEEE802154_LLSEC_PARAM_KEY_SOURCE = 1 << 4,
 352         IEEE802154_LLSEC_PARAM_PAN_ID = 1 << 5,
 353         IEEE802154_LLSEC_PARAM_HWADDR = 1 << 6,
 354         IEEE802154_LLSEC_PARAM_COORD_HWADDR = 1 << 7,
 355         IEEE802154_LLSEC_PARAM_COORD_SHORTADDR = 1 << 8,
 356 };
 357
 358 /*
 359  * This should be located at net_device->ml_priv
 360  *
 361  * get_phy should increment the reference counting on returned phy.
 362  * Use wpan_wpy_put to put that reference.
 363  */
 364 struct ieee802154_mlme_ops {
 365         /* The following fields are optional (can be NULL). */
 366
 367         int (*assoc_req)(struct net_device *dev,
 368                         struct ieee802154_addr *addr,
 369                         u8 channel, u8 page, u8 cap);
 370         int (*assoc_resp)(struct net_device *dev,
 371                         struct ieee802154_addr *addr,
 372                         __le16 short_addr, u8 status);
 373         int (*disassoc_req)(struct net_device *dev,
 374                         struct ieee802154_addr *addr,
 375                         u8 reason);
 376         int (*start_req)(struct net_device *dev,
 377                         struct ieee802154_addr *addr,
 378                         u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
 379                         u8 pan_coord, u8 blx, u8 coord_realign);
 380         int (*scan_req)(struct net_device *dev,
 381                         u8 type, u32 channels, u8 page, u8 duration);
 382
 383         int (*set_mac_params)(struct net_device *dev,
 384                               const struct ieee802154_mac_params *params);
 385         void (*get_mac_params)(struct net_device *dev,
 386                                struct ieee802154_mac_params *params);
 387
 388         /* The fields below are required. */
 389
 390         struct wpan_phy *(*get_phy)(const struct net_device *dev);
 391
 392         /*
 393          * FIXME: these should become the part of PIB/MIB interface.
 394          * However we still don't have IB interface of any kind
 395          */
 396         __le16 (*get_pan_id)(const struct net_device *dev);
 397         __le16 (*get_short_addr)(const struct net_device *dev);
 398         u8 (*get_dsn)(const struct net_device *dev);
 399 };
 400
 401 /* The IEEE 802.15.4 standard defines 2 type of the devices:
 402  * - FFD - full functionality device
 403  * - RFD - reduce functionality device
 404  *
 405  * So 2 sets of mlme operations are needed
 406  */
 407 struct ieee802154_reduced_mlme_ops {
 408         struct wpan_phy *(*get_phy)(const struct net_device *dev);
 409 };
 410
 411 static inline struct ieee802154_mlme_ops *
 412 ieee802154_mlme_ops(const struct net_device *dev)
 413 {
 414         return dev->ml_priv;
 415 }
 416
 417 static inline struct ieee802154_reduced_mlme_ops *
 418 ieee802154_reduced_mlme_ops(const struct net_device *dev)
 419 {
 420         return dev->ml_priv;
 421 }
 422
 423 #endif