xref: /linux/net/mac802154/ieee802154_i.h (revision 4949009eb8d40a441dcddcd96e101e77d31cf1b2)
1 /*
2  * Copyright (C) 2007-2012 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  *
13  * Written by:
14  * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
15  * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
16  * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
17  * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
18  */
19 #ifndef __IEEE802154_I_H
20 #define __IEEE802154_I_H
21 
22 #include <linux/mutex.h>
23 #include <linux/hrtimer.h>
24 #include <net/cfg802154.h>
25 #include <net/mac802154.h>
26 #include <net/nl802154.h>
27 #include <net/ieee802154_netdev.h>
28 
29 #include "llsec.h"
30 
31 /* mac802154 device private data */
32 struct ieee802154_local {
33 	struct ieee802154_hw hw;
34 	const struct ieee802154_ops *ops;
35 
36 	/* ieee802154 phy */
37 	struct wpan_phy *phy;
38 
39 	int open_count;
40 
41 	/* As in mac80211 slaves list is modified:
42 	 * 1) under the RTNL
43 	 * 2) protected by slaves_mtx;
44 	 * 3) in an RCU manner
45 	 *
46 	 * So atomic readers can use any of this protection methods.
47 	 */
48 	struct list_head	interfaces;
49 	struct mutex		iflist_mtx;
50 
51 	/* This one is used for scanning and other jobs not to be interfered
52 	 * with serial driver.
53 	 */
54 	struct workqueue_struct	*workqueue;
55 
56 	struct hrtimer ifs_timer;
57 
58 	bool started;
59 
60 	struct tasklet_struct tasklet;
61 	struct sk_buff_head skb_queue;
62 };
63 
64 enum {
65 	IEEE802154_RX_MSG        = 1,
66 };
67 
68 enum ieee802154_sdata_state_bits {
69 	SDATA_STATE_RUNNING,
70 };
71 
72 /* Slave interface definition.
73  *
74  * Slaves represent typical network interfaces available from userspace.
75  * Each ieee802154 device/transceiver may have several slaves and able
76  * to be associated with several networks at the same time.
77  */
78 struct ieee802154_sub_if_data {
79 	struct list_head list; /* the ieee802154_priv->slaves list */
80 
81 	struct wpan_dev wpan_dev;
82 
83 	struct ieee802154_local *local;
84 	struct net_device *dev;
85 
86 	unsigned long state;
87 	char name[IFNAMSIZ];
88 
89 	spinlock_t mib_lock;
90 
91 	/* protects sec from concurrent access by netlink. access by
92 	 * encrypt/decrypt/header_create safe without additional protection.
93 	 */
94 	struct mutex sec_mtx;
95 
96 	struct mac802154_llsec sec;
97 	/* must be last, dynamically sized area in this! */
98 	struct ieee802154_vif vif;
99 };
100 
101 #define MAC802154_CHAN_NONE		0xff /* No channel is assigned */
102 
103 /* utility functions/constants */
104 extern const void *const mac802154_wpan_phy_privid; /*  for wpan_phy privid */
105 
106 static inline struct ieee802154_local *
107 hw_to_local(struct ieee802154_hw *hw)
108 {
109 	return container_of(hw, struct ieee802154_local, hw);
110 }
111 
112 static inline struct ieee802154_sub_if_data *
113 IEEE802154_DEV_TO_SUB_IF(const struct net_device *dev)
114 {
115 	return netdev_priv(dev);
116 }
117 
118 static inline struct ieee802154_sub_if_data *
119 IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev *wpan_dev)
120 {
121 	return container_of(wpan_dev, struct ieee802154_sub_if_data, wpan_dev);
122 }
123 
124 static inline bool
125 ieee802154_sdata_running(struct ieee802154_sub_if_data *sdata)
126 {
127 	return test_bit(SDATA_STATE_RUNNING, &sdata->state);
128 }
129 
130 extern struct ieee802154_mlme_ops mac802154_mlme_wpan;
131 
132 netdev_tx_t
133 ieee802154_monitor_start_xmit(struct sk_buff *skb, struct net_device *dev);
134 netdev_tx_t
135 ieee802154_subif_start_xmit(struct sk_buff *skb, struct net_device *dev);
136 enum hrtimer_restart ieee802154_xmit_ifs_timer(struct hrtimer *timer);
137 
138 /* MIB callbacks */
139 void mac802154_dev_set_short_addr(struct net_device *dev, __le16 val);
140 __le16 mac802154_dev_get_short_addr(const struct net_device *dev);
141 __le16 mac802154_dev_get_pan_id(const struct net_device *dev);
142 void mac802154_dev_set_pan_id(struct net_device *dev, __le16 val);
143 void mac802154_dev_set_page_channel(struct net_device *dev, u8 page, u8 chan);
144 u8 mac802154_dev_get_dsn(const struct net_device *dev);
145 
146 int mac802154_get_params(struct net_device *dev,
147 			 struct ieee802154_llsec_params *params);
148 int mac802154_set_params(struct net_device *dev,
149 			 const struct ieee802154_llsec_params *params,
150 			 int changed);
151 
152 int mac802154_add_key(struct net_device *dev,
153 		      const struct ieee802154_llsec_key_id *id,
154 		      const struct ieee802154_llsec_key *key);
155 int mac802154_del_key(struct net_device *dev,
156 		      const struct ieee802154_llsec_key_id *id);
157 
158 int mac802154_add_dev(struct net_device *dev,
159 		      const struct ieee802154_llsec_device *llsec_dev);
160 int mac802154_del_dev(struct net_device *dev, __le64 dev_addr);
161 
162 int mac802154_add_devkey(struct net_device *dev,
163 			 __le64 device_addr,
164 			 const struct ieee802154_llsec_device_key *key);
165 int mac802154_del_devkey(struct net_device *dev,
166 			 __le64 device_addr,
167 			 const struct ieee802154_llsec_device_key *key);
168 
169 int mac802154_add_seclevel(struct net_device *dev,
170 			   const struct ieee802154_llsec_seclevel *sl);
171 int mac802154_del_seclevel(struct net_device *dev,
172 			   const struct ieee802154_llsec_seclevel *sl);
173 
174 void mac802154_lock_table(struct net_device *dev);
175 void mac802154_get_table(struct net_device *dev,
176 			 struct ieee802154_llsec_table **t);
177 void mac802154_unlock_table(struct net_device *dev);
178 
179 /* interface handling */
180 int ieee802154_iface_init(void);
181 void ieee802154_iface_exit(void);
182 void ieee802154_if_remove(struct ieee802154_sub_if_data *sdata);
183 struct net_device *
184 ieee802154_if_add(struct ieee802154_local *local, const char *name,
185 		  enum nl802154_iftype type, __le64 extended_addr);
186 void ieee802154_remove_interfaces(struct ieee802154_local *local);
187 
188 #endif /* __IEEE802154_I_H */
189