ieee802154: add support for channel pages from IEEE 802.15.4-2006
[linux-2.6.git] / include / net / ieee802154_netdev.h
1 /*
2  * An interface between IEEE802.15.4 device and rest of the kernel.
3  *
4  * Copyright (C) 2007, 2008, 2009 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  */
25
26 #ifndef IEEE802154_NETDEVICE_H
27 #define IEEE802154_NETDEVICE_H
28
29 /*
30  * A control block of skb passed between the ARPHRD_IEEE802154 device
31  * and other stack parts.
32  */
33 struct ieee802154_mac_cb {
34         u8 lqi;
35         struct ieee802154_addr sa;
36         struct ieee802154_addr da;
37         u8 flags;
38         u8 seq;
39 };
40
41 static inline struct ieee802154_mac_cb *mac_cb(struct sk_buff *skb)
42 {
43         return (struct ieee802154_mac_cb *)skb->cb;
44 }
45
46 #define MAC_CB_FLAG_TYPEMASK            ((1 << 3) - 1)
47
48 #define MAC_CB_FLAG_ACKREQ              (1 << 3)
49 #define MAC_CB_FLAG_SECEN               (1 << 4)
50 #define MAC_CB_FLAG_INTRAPAN            (1 << 5)
51
52 static inline int mac_cb_is_ackreq(struct sk_buff *skb)
53 {
54         return mac_cb(skb)->flags & MAC_CB_FLAG_ACKREQ;
55 }
56
57 static inline int mac_cb_is_secen(struct sk_buff *skb)
58 {
59         return mac_cb(skb)->flags & MAC_CB_FLAG_SECEN;
60 }
61
62 static inline int mac_cb_is_intrapan(struct sk_buff *skb)
63 {
64         return mac_cb(skb)->flags & MAC_CB_FLAG_INTRAPAN;
65 }
66
67 static inline int mac_cb_type(struct sk_buff *skb)
68 {
69         return mac_cb(skb)->flags & MAC_CB_FLAG_TYPEMASK;
70 }
71
72 #define IEEE802154_MAC_SCAN_ED          0
73 #define IEEE802154_MAC_SCAN_ACTIVE      1
74 #define IEEE802154_MAC_SCAN_PASSIVE     2
75 #define IEEE802154_MAC_SCAN_ORPHAN      3
76
77 /*
78  * This should be located at net_device->ml_priv
79  */
80 struct ieee802154_mlme_ops {
81         int (*assoc_req)(struct net_device *dev,
82                         struct ieee802154_addr *addr,
83                         u8 channel, u8 page, u8 cap);
84         int (*assoc_resp)(struct net_device *dev,
85                         struct ieee802154_addr *addr,
86                         u16 short_addr, u8 status);
87         int (*disassoc_req)(struct net_device *dev,
88                         struct ieee802154_addr *addr,
89                         u8 reason);
90         int (*start_req)(struct net_device *dev,
91                         struct ieee802154_addr *addr,
92                         u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
93                         u8 pan_coord, u8 blx, u8 coord_realign);
94         int (*scan_req)(struct net_device *dev,
95                         u8 type, u32 channels, u8 page, u8 duration);
96
97         /*
98          * FIXME: these should become the part of PIB/MIB interface.
99          * However we still don't have IB interface of any kind
100          */
101         u16 (*get_pan_id)(struct net_device *dev);
102         u16 (*get_short_addr)(struct net_device *dev);
103         u8 (*get_dsn)(struct net_device *dev);
104         u8 (*get_bsn)(struct net_device *dev);
105 };
106
107 static inline struct ieee802154_mlme_ops *ieee802154_mlme_ops(
108                 struct net_device *dev)
109 {
110         return dev->ml_priv;
111 }
112
113 #endif
114
115