blob: 24c7321f364736f941dc1ffac5f9e4725b327563 [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
Alexander Aringf3ea5e42014-11-17 08:20:51 +010024#include <net/nl802154.h>
25
[email protected]06060692012-05-15 20:50:29 +000026/* According to the IEEE 802.15.4 stadard the upper most significant bits of
27 * the 32-bit channel bitmaps shall be used as an integer value to specify 32
28 * possible channel pages. The lower 27 bits of the channel bit map shall be
29 * used as a bit mask to specify channel numbers within a channel page.
30 */
31#define WPAN_NUM_CHANNELS 27
32#define WPAN_NUM_PAGES 32
33
Alexander Aringa5dd1d72014-11-02 04:18:35 +010034struct wpan_phy;
35
36struct cfg802154_ops {
Alexander Aring4a9a8162014-11-02 04:18:38 +010037 struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
38 const char *name,
39 int type);
Alexander Aring9d30a8cf2014-11-12 03:36:54 +010040 void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
41 struct net_device *dev);
Alexander Aringf3ea5e42014-11-17 08:20:51 +010042 int (*add_virtual_intf)(struct wpan_phy *wpan_phy,
43 const char *name,
44 enum nl802154_iftype type);
Alexander Aringab0bd562014-11-12 03:36:55 +010045 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
Alexander Aring702bf372014-11-12 03:36:57 +010046 int (*set_pan_id)(struct wpan_phy *wpan_phy,
47 struct wpan_dev *wpan_dev, u16 pan_id);
Alexander Aring9830c622014-11-12 03:36:58 +010048 int (*set_short_addr)(struct wpan_phy *wpan_phy,
49 struct wpan_dev *wpan_dev, u16 short_addr);
Alexander Aring656a9992014-11-12 03:36:59 +010050 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy,
51 struct wpan_dev *wpan_dev, u8 min_be,
52 u8 max_be);
Alexander Aringa01ba762014-11-12 03:37:01 +010053 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
54 struct wpan_dev *wpan_dev,
55 u8 max_csma_backoffs);
Alexander Aring17a3a462014-11-12 03:37:03 +010056 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy,
57 struct wpan_dev *wpan_dev,
58 s8 max_frame_retries);
Alexander Aringc8937a1d2014-11-12 03:37:05 +010059 int (*set_lbt_mode)(struct wpan_phy *wpan_phy,
60 struct wpan_dev *wpan_dev, bool mode);
Alexander Aringa5dd1d72014-11-02 04:18:35 +010061};
62
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040063struct wpan_phy {
64 struct mutex pib_lock;
65
Alexander Aring6322d502014-11-12 03:36:51 +010066 /* If multiple wpan_phys are registered and you're handed e.g.
67 * a regular netdev with assigned ieee802154_ptr, you won't
68 * know whether it points to a wpan_phy your driver has registered
69 * or not. Assign this to something global to your driver to
70 * help determine whether you own this wpan_phy or not.
71 */
72 const void *privid;
73
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040074 /*
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010075 * This is a PIB according to 802.15.4-2011.
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040076 * We do not provide timing-related variables, as they
77 * aren't used outside of driver
78 */
79 u8 current_channel;
80 u8 current_page;
Dmitry Eremin-Solenikova0b4a732009-09-22 15:26:48 +040081 u32 channels_supported[32];
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010082 s8 transmit_power;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040083 u8 cca_mode;
84
Alexander Aringdee56d142014-11-05 20:51:25 +010085 __le64 perm_extended_addr;
86
Phoebe Buckheister6ca00192014-02-17 11:34:12 +010087 s32 cca_ed_level;
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +010088
Alexander Aring61f2dcb2014-11-12 19:51:56 +010089 /* PHY depended MAC PIB values */
90
91 /* 802.15.4 acronym: Tdsym in usec */
92 u8 symbol_duration;
93 /* lifs and sifs periods timing */
94 u16 lifs_period;
95 u16 sifs_period;
96
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040097 struct device dev;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040098
Alexander Aring48961672014-10-25 05:25:10 +020099 char priv[0] __aligned(NETDEV_ALIGN);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400100};
101
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100102struct wpan_dev {
103 struct wpan_phy *wpan_phy;
Alexander Aring190ac1c2014-11-09 08:36:49 +0100104 int iftype;
Alexander Aring863e88f2014-11-09 08:36:45 +0100105
Alexander Aringfcf39e62014-11-09 08:36:50 +0100106 /* the remainder of this struct should be private to cfg802154 */
107 struct list_head list;
108 struct net_device *netdev;
109
110 u32 identifier;
111
Alexander Aring863e88f2014-11-09 08:36:45 +0100112 /* MAC PIB */
113 __le16 pan_id;
114 __le16 short_addr;
115 __le64 extended_addr;
116
117 /* MAC BSN field */
118 u8 bsn;
119 /* MAC DSN field */
120 u8 dsn;
121
122 u8 min_be;
123 u8 max_be;
124 u8 csma_retries;
125 s8 frame_retries;
126
127 bool lbt;
128
129 bool promiscuous_mode;
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100130};
131
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +0300132#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
133
Alexander Aringa5dd1d72014-11-02 04:18:35 +0100134struct wpan_phy *
Alexander Aringf6013792014-11-09 08:36:47 +0100135wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400136static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
137{
138 phy->dev.parent = dev;
139}
Alexander Aringe72740d2014-10-25 05:25:11 +0200140
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400141int wpan_phy_register(struct wpan_phy *phy);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400142void wpan_phy_unregister(struct wpan_phy *phy);
143void wpan_phy_free(struct wpan_phy *phy);
Dmitry Eremin-Solenikov1c889f42009-09-15 16:57:04 +0400144/* Same semantics as for class_for_each_device */
145int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400146
147static inline void *wpan_phy_priv(struct wpan_phy *phy)
148{
149 BUG_ON(!phy);
150 return &phy->priv;
151}
152
153struct wpan_phy *wpan_phy_find(const char *str);
Dmitry Eremin-Solenikov69d9ab92009-09-14 18:11:03 +0400154
155static inline void wpan_phy_put(struct wpan_phy *phy)
156{
157 put_device(&phy->dev);
158}
159
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400160static inline const char *wpan_phy_name(struct wpan_phy *phy)
161{
162 return dev_name(&phy->dev);
163}
Alexander Aring5ad60d32014-10-25 09:41:02 +0200164
165#endif /* __NET_CFG802154_H */