blob: d07b0726b28540c7d80fe73d0630b3a03f19f817 [file] [log] [blame]
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +04001/*
2 * Copyright (C) 2007, 2008, 2009 Siemens AG
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2
6 * as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040013 * Written by:
14 * Dmitry Eremin-Solenikov <[email protected]>
15 */
16
Alexander Aring5ad60d32014-10-25 09:41:02 +020017#ifndef __NET_CFG802154_H
18#define __NET_CFG802154_H
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040019
20#include <linux/netdevice.h>
21#include <linux/mutex.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050022#include <linux/bug.h>
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040023
[email protected]06060692012-05-15 20:50:29 +000024/* According to the IEEE 802.15.4 stadard the upper most significant bits of
25 * the 32-bit channel bitmaps shall be used as an integer value to specify 32
26 * possible channel pages. The lower 27 bits of the channel bit map shall be
27 * used as a bit mask to specify channel numbers within a channel page.
28 */
29#define WPAN_NUM_CHANNELS 27
30#define WPAN_NUM_PAGES 32
31
Alexander Aringa5dd1d72014-11-02 04:18:35 +010032struct wpan_phy;
33
34struct cfg802154_ops {
Alexander Aring4a9a8162014-11-02 04:18:38 +010035 struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
36 const char *name,
37 int type);
Alexander Aring9d30a8cf2014-11-12 03:36:54 +010038 void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
39 struct net_device *dev);
Alexander Aringab0bd562014-11-12 03:36:55 +010040 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
Alexander Aring702bf372014-11-12 03:36:57 +010041 int (*set_pan_id)(struct wpan_phy *wpan_phy,
42 struct wpan_dev *wpan_dev, u16 pan_id);
Alexander Aringa5dd1d72014-11-02 04:18:35 +010043};
44
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040045struct wpan_phy {
46 struct mutex pib_lock;
47
Alexander Aring6322d502014-11-12 03:36:51 +010048 /* If multiple wpan_phys are registered and you're handed e.g.
49 * a regular netdev with assigned ieee802154_ptr, you won't
50 * know whether it points to a wpan_phy your driver has registered
51 * or not. Assign this to something global to your driver to
52 * help determine whether you own this wpan_phy or not.
53 */
54 const void *privid;
55
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040056 /*
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010057 * This is a PIB according to 802.15.4-2011.
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040058 * We do not provide timing-related variables, as they
59 * aren't used outside of driver
60 */
61 u8 current_channel;
62 u8 current_page;
Dmitry Eremin-Solenikova0b4a732009-09-22 15:26:48 +040063 u32 channels_supported[32];
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010064 s8 transmit_power;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040065 u8 cca_mode;
66
Alexander Aringdee56d142014-11-05 20:51:25 +010067 __le64 perm_extended_addr;
68
Phoebe Buckheister6ca00192014-02-17 11:34:12 +010069 s32 cca_ed_level;
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +010070
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040071 struct device dev;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040072
Alexander Aring48961672014-10-25 05:25:10 +020073 char priv[0] __aligned(NETDEV_ALIGN);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040074};
75
Alexander Aringd5ae67b2014-11-05 20:51:17 +010076struct wpan_dev {
77 struct wpan_phy *wpan_phy;
Alexander Aring190ac1c2014-11-09 08:36:49 +010078 int iftype;
Alexander Aring863e88f2014-11-09 08:36:45 +010079
Alexander Aringfcf39e62014-11-09 08:36:50 +010080 /* the remainder of this struct should be private to cfg802154 */
81 struct list_head list;
82 struct net_device *netdev;
83
84 u32 identifier;
85
Alexander Aring863e88f2014-11-09 08:36:45 +010086 /* MAC PIB */
87 __le16 pan_id;
88 __le16 short_addr;
89 __le64 extended_addr;
90
91 /* MAC BSN field */
92 u8 bsn;
93 /* MAC DSN field */
94 u8 dsn;
95
96 u8 min_be;
97 u8 max_be;
98 u8 csma_retries;
99 s8 frame_retries;
100
101 bool lbt;
102
103 bool promiscuous_mode;
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100104};
105
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +0300106#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
107
Alexander Aringa5dd1d72014-11-02 04:18:35 +0100108struct wpan_phy *
Alexander Aringf6013792014-11-09 08:36:47 +0100109wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400110static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
111{
112 phy->dev.parent = dev;
113}
Alexander Aringe72740d2014-10-25 05:25:11 +0200114
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400115int wpan_phy_register(struct wpan_phy *phy);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400116void wpan_phy_unregister(struct wpan_phy *phy);
117void wpan_phy_free(struct wpan_phy *phy);
Dmitry Eremin-Solenikov1c889f42009-09-15 16:57:04 +0400118/* Same semantics as for class_for_each_device */
119int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400120
121static inline void *wpan_phy_priv(struct wpan_phy *phy)
122{
123 BUG_ON(!phy);
124 return &phy->priv;
125}
126
127struct wpan_phy *wpan_phy_find(const char *str);
Dmitry Eremin-Solenikov69d9ab92009-09-14 18:11:03 +0400128
129static inline void wpan_phy_put(struct wpan_phy *phy)
130{
131 put_device(&phy->dev);
132}
133
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400134static inline const char *wpan_phy_name(struct wpan_phy *phy)
135{
136 return dev_name(&phy->dev);
137}
Alexander Aring5ad60d32014-10-25 09:41:02 +0200138
139#endif /* __NET_CFG802154_H */