xref: /openbmc/linux/net/mac802154/ieee802154_i.h (revision 6a551c11)
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 	bool suspended;
60 
61 	struct tasklet_struct tasklet;
62 	struct sk_buff_head skb_queue;
63 
64 	struct sk_buff *tx_skb;
65 	struct work_struct tx_work;
66 };
67 
68 enum {
69 	IEEE802154_RX_MSG        = 1,
70 };
71 
72 enum ieee802154_sdata_state_bits {
73 	SDATA_STATE_RUNNING,
74 };
75 
76 /* Slave interface definition.
77  *
78  * Slaves represent typical network interfaces available from userspace.
79  * Each ieee802154 device/transceiver may have several slaves and able
80  * to be associated with several networks at the same time.
81  */
82 struct ieee802154_sub_if_data {
83 	struct list_head list; /* the ieee802154_priv->slaves list */
84 
85 	struct wpan_dev wpan_dev;
86 
87 	struct ieee802154_local *local;
88 	struct net_device *dev;
89 
90 	unsigned long state;
91 	char name[IFNAMSIZ];
92 
93 	/* protects sec from concurrent access by netlink. access by
94 	 * encrypt/decrypt/header_create safe without additional protection.
95 	 */
96 	struct mutex sec_mtx;
97 
98 	struct mac802154_llsec sec;
99 };
100 
101 /* utility functions/constants */
102 extern const void *const mac802154_wpan_phy_privid; /*  for wpan_phy privid */
103 
104 static inline struct ieee802154_local *
105 hw_to_local(struct ieee802154_hw *hw)
106 {
107 	return container_of(hw, struct ieee802154_local, hw);
108 }
109 
110 static inline struct ieee802154_sub_if_data *
111 IEEE802154_DEV_TO_SUB_IF(const struct net_device *dev)
112 {
113 	return netdev_priv(dev);
114 }
115 
116 static inline struct ieee802154_sub_if_data *
117 IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev *wpan_dev)
118 {
119 	return container_of(wpan_dev, struct ieee802154_sub_if_data, wpan_dev);
120 }
121 
122 static inline bool
123 ieee802154_sdata_running(struct ieee802154_sub_if_data *sdata)
124 {
125 	return test_bit(SDATA_STATE_RUNNING, &sdata->state);
126 }
127 
128 extern struct ieee802154_mlme_ops mac802154_mlme_wpan;
129 
130 void ieee802154_rx(struct ieee802154_local *local, struct sk_buff *skb);
131 void ieee802154_xmit_worker(struct work_struct *work);
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_page_channel(struct net_device *dev, u8 page, u8 chan);
140 
141 int mac802154_get_params(struct net_device *dev,
142 			 struct ieee802154_llsec_params *params);
143 int mac802154_set_params(struct net_device *dev,
144 			 const struct ieee802154_llsec_params *params,
145 			 int changed);
146 
147 int mac802154_add_key(struct net_device *dev,
148 		      const struct ieee802154_llsec_key_id *id,
149 		      const struct ieee802154_llsec_key *key);
150 int mac802154_del_key(struct net_device *dev,
151 		      const struct ieee802154_llsec_key_id *id);
152 
153 int mac802154_add_dev(struct net_device *dev,
154 		      const struct ieee802154_llsec_device *llsec_dev);
155 int mac802154_del_dev(struct net_device *dev, __le64 dev_addr);
156 
157 int mac802154_add_devkey(struct net_device *dev,
158 			 __le64 device_addr,
159 			 const struct ieee802154_llsec_device_key *key);
160 int mac802154_del_devkey(struct net_device *dev,
161 			 __le64 device_addr,
162 			 const struct ieee802154_llsec_device_key *key);
163 
164 int mac802154_add_seclevel(struct net_device *dev,
165 			   const struct ieee802154_llsec_seclevel *sl);
166 int mac802154_del_seclevel(struct net_device *dev,
167 			   const struct ieee802154_llsec_seclevel *sl);
168 
169 void mac802154_lock_table(struct net_device *dev);
170 void mac802154_get_table(struct net_device *dev,
171 			 struct ieee802154_llsec_table **t);
172 void mac802154_unlock_table(struct net_device *dev);
173 
174 int mac802154_wpan_update_llsec(struct net_device *dev);
175 
176 /* interface handling */
177 int ieee802154_iface_init(void);
178 void ieee802154_iface_exit(void);
179 void ieee802154_if_remove(struct ieee802154_sub_if_data *sdata);
180 struct net_device *
181 ieee802154_if_add(struct ieee802154_local *local, const char *name,
182 		  unsigned char name_assign_type, enum nl802154_iftype type,
183 		  __le64 extended_addr);
184 void ieee802154_remove_interfaces(struct ieee802154_local *local);
185 void ieee802154_stop_device(struct ieee802154_local *local);
186 
187 #endif /* __IEEE802154_I_H */
188