blob: 1e9795f116ba3600f9008d17d81a111be0899607 [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
17#ifndef WPAN_PHY_H
18#define WPAN_PHY_H
19
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
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040032struct wpan_phy {
33 struct mutex pib_lock;
34
35 /*
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010036 * This is a PIB according to 802.15.4-2011.
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040037 * We do not provide timing-related variables, as they
38 * aren't used outside of driver
39 */
40 u8 current_channel;
41 u8 current_page;
Dmitry Eremin-Solenikova0b4a732009-09-22 15:26:48 +040042 u32 channels_supported[32];
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010043 s8 transmit_power;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040044 u8 cca_mode;
Phoebe Buckheister4244db12014-02-17 11:34:14 +010045 u8 min_be;
46 u8 max_be;
47 u8 csma_retries;
48 s8 frame_retries;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040049
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +010050 bool lbt;
Phoebe Buckheister6ca00192014-02-17 11:34:12 +010051 s32 cca_ed_level;
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +010052
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040053 struct device dev;
54 int idx;
55
Dmitry Eremin-Solenikovbb1cafb2009-11-05 16:56:23 +030056 struct net_device *(*add_iface)(struct wpan_phy *phy,
[email protected]90c049b22012-05-15 20:50:27 +000057 const char *name, int type);
Dmitry Eremin-Solenikovbb1cafb2009-11-05 16:56:23 +030058 void (*del_iface)(struct wpan_phy *phy, struct net_device *dev);
59
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010060 int (*set_txpower)(struct wpan_phy *phy, int db);
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +010061 int (*set_lbt)(struct wpan_phy *phy, bool on);
Phoebe Buckheisterba08fea2014-02-17 11:34:11 +010062 int (*set_cca_mode)(struct wpan_phy *phy, u8 cca_mode);
Phoebe Buckheister6ca00192014-02-17 11:34:12 +010063 int (*set_cca_ed_level)(struct wpan_phy *phy, int level);
Phoebe Buckheister4244db12014-02-17 11:34:14 +010064 int (*set_csma_params)(struct wpan_phy *phy, u8 min_be, u8 max_be,
65 u8 retries);
66 int (*set_frame_retries)(struct wpan_phy *phy, s8 retries);
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +010067
Alexander Aring48961672014-10-25 05:25:10 +020068 char priv[0] __aligned(NETDEV_ALIGN);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040069};
70
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +030071#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
72
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040073struct wpan_phy *wpan_phy_alloc(size_t priv_size);
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +040074static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
75{
76 phy->dev.parent = dev;
77}
Alexander Aringe72740d2014-10-25 05:25:11 +020078
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +040079int wpan_phy_register(struct wpan_phy *phy);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040080void wpan_phy_unregister(struct wpan_phy *phy);
81void wpan_phy_free(struct wpan_phy *phy);
Dmitry Eremin-Solenikov1c889f42009-09-15 16:57:04 +040082/* Same semantics as for class_for_each_device */
83int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040084
85static inline void *wpan_phy_priv(struct wpan_phy *phy)
86{
87 BUG_ON(!phy);
88 return &phy->priv;
89}
90
91struct wpan_phy *wpan_phy_find(const char *str);
Dmitry Eremin-Solenikov69d9ab92009-09-14 18:11:03 +040092
93static inline void wpan_phy_put(struct wpan_phy *phy)
94{
95 put_device(&phy->dev);
96}
97
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040098static inline const char *wpan_phy_name(struct wpan_phy *phy)
99{
100 return dev_name(&phy->dev);
101}
102#endif