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