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