blob: d104c882fc296ceac67f9acd03e47abb09a347b3 [file] [log] [blame]
Sergey Lapin9ec76712009-06-08 12:18:48 +00001/*
2 * An interface between IEEE802.15.4 device and rest of the kernel.
3 *
alex.bluesman.smirnov@gmail.com74a02fc2012-05-15 20:50:23 +00004 * Copyright (C) 2007-2012 Siemens AG
Sergey Lapin9ec76712009-06-08 12:18:48 +00005 *
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>
alex.bluesman.smirnov@gmail.com74a02fc2012-05-15 20:50:23 +000024 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
Sergey Lapin9ec76712009-06-08 12:18:48 +000025 */
26
27#ifndef IEEE802154_NETDEVICE_H
28#define IEEE802154_NETDEVICE_H
29
alex.bluesman.smirnov@gmail.com1cd829c2012-05-15 20:50:21 +000030#include <net/af_ieee802154.h>
31
Sergey Lapin9ec76712009-06-08 12:18:48 +000032/*
33 * A control block of skb passed between the ARPHRD_IEEE802154 device
34 * and other stack parts.
35 */
36struct ieee802154_mac_cb {
37 u8 lqi;
38 struct ieee802154_addr sa;
39 struct ieee802154_addr da;
40 u8 flags;
41 u8 seq;
42};
43
44static inline struct ieee802154_mac_cb *mac_cb(struct sk_buff *skb)
45{
46 return (struct ieee802154_mac_cb *)skb->cb;
47}
48
49#define MAC_CB_FLAG_TYPEMASK ((1 << 3) - 1)
50
51#define MAC_CB_FLAG_ACKREQ (1 << 3)
52#define MAC_CB_FLAG_SECEN (1 << 4)
53#define MAC_CB_FLAG_INTRAPAN (1 << 5)
54
55static inline int mac_cb_is_ackreq(struct sk_buff *skb)
56{
57 return mac_cb(skb)->flags & MAC_CB_FLAG_ACKREQ;
58}
59
60static inline int mac_cb_is_secen(struct sk_buff *skb)
61{
62 return mac_cb(skb)->flags & MAC_CB_FLAG_SECEN;
63}
64
65static inline int mac_cb_is_intrapan(struct sk_buff *skb)
66{
67 return mac_cb(skb)->flags & MAC_CB_FLAG_INTRAPAN;
68}
69
70static inline int mac_cb_type(struct sk_buff *skb)
71{
72 return mac_cb(skb)->flags & MAC_CB_FLAG_TYPEMASK;
73}
74
75#define IEEE802154_MAC_SCAN_ED 0
76#define IEEE802154_MAC_SCAN_ACTIVE 1
77#define IEEE802154_MAC_SCAN_PASSIVE 2
78#define IEEE802154_MAC_SCAN_ORPHAN 3
79
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +030080struct wpan_phy;
Sergey Lapin9ec76712009-06-08 12:18:48 +000081/*
82 * This should be located at net_device->ml_priv
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +030083 *
84 * get_phy should increment the reference counting on returned phy.
85 * Use wpan_wpy_put to put that reference.
Sergey Lapin9ec76712009-06-08 12:18:48 +000086 */
87struct ieee802154_mlme_ops {
88 int (*assoc_req)(struct net_device *dev,
89 struct ieee802154_addr *addr,
Dmitry Eremin-Solenikov16eea492009-08-19 19:32:24 +040090 u8 channel, u8 page, u8 cap);
Sergey Lapin9ec76712009-06-08 12:18:48 +000091 int (*assoc_resp)(struct net_device *dev,
92 struct ieee802154_addr *addr,
93 u16 short_addr, u8 status);
94 int (*disassoc_req)(struct net_device *dev,
95 struct ieee802154_addr *addr,
96 u8 reason);
97 int (*start_req)(struct net_device *dev,
98 struct ieee802154_addr *addr,
Dmitry Eremin-Solenikov16eea492009-08-19 19:32:24 +040099 u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
Sergey Lapin9ec76712009-06-08 12:18:48 +0000100 u8 pan_coord, u8 blx, u8 coord_realign);
101 int (*scan_req)(struct net_device *dev,
Dmitry Eremin-Solenikov16eea492009-08-19 19:32:24 +0400102 u8 type, u32 channels, u8 page, u8 duration);
Sergey Lapin9ec76712009-06-08 12:18:48 +0000103
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +0300104 struct wpan_phy *(*get_phy)(const struct net_device *dev);
105
Sergey Lapin9ec76712009-06-08 12:18:48 +0000106 /*
107 * FIXME: these should become the part of PIB/MIB interface.
108 * However we still don't have IB interface of any kind
109 */
Dmitry Eremin-Solenikova9966b52009-10-02 19:05:00 +0400110 u16 (*get_pan_id)(const struct net_device *dev);
111 u16 (*get_short_addr)(const struct net_device *dev);
112 u8 (*get_dsn)(const struct net_device *dev);
113 u8 (*get_bsn)(const struct net_device *dev);
Sergey Lapin9ec76712009-06-08 12:18:48 +0000114};
115
alex.bluesman.smirnov@gmail.com74a02fc2012-05-15 20:50:23 +0000116/* The IEEE 802.15.4 standard defines 2 type of the devices:
117 * - FFD - full functionality device
118 * - RFD - reduce functionality device
119 *
120 * So 2 sets of mlme operations are needed
121 */
122struct ieee802154_reduced_mlme_ops {
123 struct wpan_phy *(*get_phy)(const struct net_device *dev);
124};
125
126static inline struct ieee802154_mlme_ops *
127ieee802154_mlme_ops(const struct net_device *dev)
128{
129 return dev->ml_priv;
130}
131
132static inline struct ieee802154_reduced_mlme_ops *
133ieee802154_reduced_mlme_ops(const struct net_device *dev)
Sergey Lapin9ec76712009-06-08 12:18:48 +0000134{
135 return dev->ml_priv;
136}
137
138#endif