| 1 |
/* SPDX-License-Identifier: GPL-2.0-only */ |
| 2 |
/* |
| 3 |
* Copyright (C) 2007-2012 Siemens AG |
| 4 |
* |
| 5 |
* Written by: |
| 6 |
* Pavel Smolenskiy <[email protected]> |
| 7 |
* Maxim Gorbachyov <[email protected]> |
| 8 |
* Dmitry Eremin-Solenikov <[email protected]> |
| 9 |
* Alexander Smirnov <[email protected]> |
| 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 |
enum ieee802154_ongoing { |
| 25 |
IEEE802154_IS_SCANNING = BIT(0), |
| 26 |
IEEE802154_IS_BEACONING = BIT(1), |
| 27 |
IEEE802154_IS_ASSOCIATING = BIT(2), |
| 28 |
}; |
| 29 |
|
| 30 |
/* mac802154 device private data */ |
| 31 |
struct ieee802154_local { |
| 32 |
struct ieee802154_hw hw; |
| 33 |
const struct ieee802154_ops *ops; |
| 34 |
|
| 35 |
/* hardware address filter */ |
| 36 |
struct ieee802154_hw_addr_filt addr_filt; |
| 37 |
/* ieee802154 phy */ |
| 38 |
struct wpan_phy *phy; |
| 39 |
|
| 40 |
int open_count; |
| 41 |
|
| 42 |
/* As in mac80211 slaves list is modified: |
| 43 |
* 1) under the RTNL |
| 44 |
* 2) protected by slaves_mtx; |
| 45 |
* 3) in an RCU manner |
| 46 |
* |
| 47 |
* So atomic readers can use any of this protection methods. |
| 48 |
*/ |
| 49 |
struct list_head interfaces; |
| 50 |
struct mutex iflist_mtx; |
| 51 |
|
| 52 |
/* Data related workqueue */ |
| 53 |
struct workqueue_struct *workqueue; |
| 54 |
/* MAC commands related workqueue */ |
| 55 |
struct workqueue_struct *mac_wq; |
| 56 |
|
| 57 |
struct hrtimer ifs_timer; |
| 58 |
|
| 59 |
/* Scanning */ |
| 60 |
u8 scan_page; |
| 61 |
u8 scan_channel; |
| 62 |
struct ieee802154_beacon_req_frame scan_beacon_req; |
| 63 |
struct cfg802154_scan_request __rcu *scan_req; |
| 64 |
struct delayed_work scan_work; |
| 65 |
|
| 66 |
/* Beaconing */ |
| 67 |
unsigned int beacon_interval; |
| 68 |
struct ieee802154_beacon_frame beacon; |
| 69 |
struct cfg802154_beacon_request __rcu *beacon_req; |
| 70 |
struct delayed_work beacon_work; |
| 71 |
|
| 72 |
/* Asynchronous tasks */ |
| 73 |
struct list_head rx_beacon_list; |
| 74 |
struct work_struct rx_beacon_work; |
| 75 |
struct list_head rx_mac_cmd_list; |
| 76 |
struct work_struct rx_mac_cmd_work; |
| 77 |
|
| 78 |
/* Association */ |
| 79 |
struct ieee802154_pan_device *assoc_dev; |
| 80 |
struct completion assoc_done; |
| 81 |
__le16 assoc_addr; |
| 82 |
u8 assoc_status; |
| 83 |
struct work_struct assoc_work; |
| 84 |
|
| 85 |
bool started; |
| 86 |
bool suspended; |
| 87 |
unsigned long ongoing; |
| 88 |
|
| 89 |
struct tasklet_struct tasklet; |
| 90 |
struct sk_buff_head skb_queue; |
| 91 |
|
| 92 |
struct sk_buff *tx_skb; |
| 93 |
struct work_struct sync_tx_work; |
| 94 |
/* A negative Linux error code or a null/positive MLME error status */ |
| 95 |
int tx_result; |
| 96 |
}; |
| 97 |
|
| 98 |
enum { |
| 99 |
IEEE802154_RX_MSG = 1, |
| 100 |
}; |
| 101 |
|
| 102 |
enum ieee802154_sdata_state_bits { |
| 103 |
SDATA_STATE_RUNNING, |
| 104 |
}; |
| 105 |
|
| 106 |
/* Slave interface definition. |
| 107 |
* |
| 108 |
* Slaves represent typical network interfaces available from userspace. |
| 109 |
* Each ieee802154 device/transceiver may have several slaves and able |
| 110 |
* to be associated with several networks at the same time. |
| 111 |
*/ |
| 112 |
struct ieee802154_sub_if_data { |
| 113 |
struct list_head list; /* the ieee802154_priv->slaves list */ |
| 114 |
|
| 115 |
struct wpan_dev wpan_dev; |
| 116 |
|
| 117 |
struct ieee802154_local *local; |
| 118 |
struct net_device *dev; |
| 119 |
|
| 120 |
/* Each interface starts and works in nominal state at a given filtering |
| 121 |
* level given by iface_default_filtering, which is set once for all at |
| 122 |
* the interface creation and should not evolve over time. For some MAC |
| 123 |
* operations however, the filtering level may change temporarily, as |
| 124 |
* reflected in the required_filtering field. The actual filtering at |
| 125 |
* the PHY level may be different and is shown in struct wpan_phy. |
| 126 |
*/ |
| 127 |
enum ieee802154_filtering_level iface_default_filtering; |
| 128 |
enum ieee802154_filtering_level required_filtering; |
| 129 |
|
| 130 |
unsigned long state; |
| 131 |
char name[IFNAMSIZ]; |
| 132 |
|
| 133 |
/* protects sec from concurrent access by netlink. access by |
| 134 |
* encrypt/decrypt/header_create safe without additional protection. |
| 135 |
*/ |
| 136 |
struct mutex sec_mtx; |
| 137 |
|
| 138 |
struct mac802154_llsec sec; |
| 139 |
}; |
| 140 |
|
| 141 |
/* utility functions/constants */ |
| 142 |
extern const void *const mac802154_wpan_phy_privid; /* for wpan_phy privid */ |
| 143 |
|
| 144 |
static inline struct ieee802154_local * |
| 145 |
hw_to_local(struct ieee802154_hw *hw) |
| 146 |
{ |
| 147 |
return container_of(hw, struct ieee802154_local, hw); |
| 148 |
} |
| 149 |
|
| 150 |
static inline struct ieee802154_sub_if_data * |
| 151 |
IEEE802154_DEV_TO_SUB_IF(const struct net_device *dev) |
| 152 |
{ |
| 153 |
return netdev_priv(dev); |
| 154 |
} |
| 155 |
|
| 156 |
static inline struct ieee802154_sub_if_data * |
| 157 |
IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev *wpan_dev) |
| 158 |
{ |
| 159 |
return container_of(wpan_dev, struct ieee802154_sub_if_data, wpan_dev); |
| 160 |
} |
| 161 |
|
| 162 |
static inline bool |
| 163 |
ieee802154_sdata_running(struct ieee802154_sub_if_data *sdata) |
| 164 |
{ |
| 165 |
return test_bit(SDATA_STATE_RUNNING, &sdata->state); |
| 166 |
} |
| 167 |
|
| 168 |
static inline int ieee802154_get_mac_cmd(struct sk_buff *skb, u8 *mac_cmd) |
| 169 |
{ |
| 170 |
struct ieee802154_mac_cmd_pl mac_pl; |
| 171 |
int ret; |
| 172 |
|
| 173 |
if (mac_cb(skb)->type != IEEE802154_FC_TYPE_MAC_CMD) |
| 174 |
return -EINVAL; |
| 175 |
|
| 176 |
ret = ieee802154_mac_cmd_pl_pull(skb, &mac_pl); |
| 177 |
if (ret) |
| 178 |
return ret; |
| 179 |
|
| 180 |
*mac_cmd = mac_pl.cmd_id; |
| 181 |
return 0; |
| 182 |
} |
| 183 |
|
| 184 |
extern struct ieee802154_mlme_ops mac802154_mlme_wpan; |
| 185 |
|
| 186 |
void ieee802154_rx(struct ieee802154_local *local, struct sk_buff *skb); |
| 187 |
void ieee802154_xmit_sync_worker(struct work_struct *work); |
| 188 |
int ieee802154_sync_and_hold_queue(struct ieee802154_local *local); |
| 189 |
int ieee802154_mlme_op_pre(struct ieee802154_local *local); |
| 190 |
int ieee802154_mlme_tx(struct ieee802154_local *local, |
| 191 |
struct ieee802154_sub_if_data *sdata, |
| 192 |
struct sk_buff *skb); |
| 193 |
int ieee802154_mlme_tx_locked(struct ieee802154_local *local, |
| 194 |
struct ieee802154_sub_if_data *sdata, |
| 195 |
struct sk_buff *skb); |
| 196 |
void ieee802154_mlme_op_post(struct ieee802154_local *local); |
| 197 |
int ieee802154_mlme_tx_one_locked(struct ieee802154_local *local, |
| 198 |
struct ieee802154_sub_if_data *sdata, |
| 199 |
struct sk_buff *skb); |
| 200 |
netdev_tx_t |
| 201 |
ieee802154_monitor_start_xmit(struct sk_buff *skb, struct net_device *dev); |
| 202 |
netdev_tx_t |
| 203 |
ieee802154_subif_start_xmit(struct sk_buff *skb, struct net_device *dev); |
| 204 |
enum hrtimer_restart ieee802154_xmit_ifs_timer(struct hrtimer *timer); |
| 205 |
|
| 206 |
/** |
| 207 |
* ieee802154_hold_queue - hold ieee802154 queue |
| 208 |
* @local: main mac object |
| 209 |
* |
| 210 |
* Hold a queue by incrementing an atomic counter and requesting the netif |
| 211 |
* queues to be stopped. The queues cannot be woken up while the counter has not |
| 212 |
* been reset with as any ieee802154_release_queue() calls as needed. |
| 213 |
*/ |
| 214 |
void ieee802154_hold_queue(struct ieee802154_local *local); |
| 215 |
|
| 216 |
/** |
| 217 |
* ieee802154_release_queue - release ieee802154 queue |
| 218 |
* @local: main mac object |
| 219 |
* |
| 220 |
* Release a queue which is held by decrementing an atomic counter and wake it |
| 221 |
* up only if the counter reaches 0. |
| 222 |
*/ |
| 223 |
void ieee802154_release_queue(struct ieee802154_local *local); |
| 224 |
|
| 225 |
/** |
| 226 |
* ieee802154_disable_queue - disable ieee802154 queue |
| 227 |
* @local: main mac object |
| 228 |
* |
| 229 |
* When trying to sync the Tx queue, we cannot just stop the queue |
| 230 |
* (which is basically a bit being set without proper lock handling) |
| 231 |
* because it would be racy. We actually need to call netif_tx_disable() |
| 232 |
* instead, which is done by this helper. Restarting the queue can |
| 233 |
* however still be done with a regular wake call. |
| 234 |
*/ |
| 235 |
void ieee802154_disable_queue(struct ieee802154_local *local); |
| 236 |
|
| 237 |
/* MIB callbacks */ |
| 238 |
void mac802154_dev_set_page_channel(struct net_device *dev, u8 page, u8 chan); |
| 239 |
|
| 240 |
int mac802154_get_params(struct net_device *dev, |
| 241 |
struct ieee802154_llsec_params *params); |
| 242 |
int mac802154_set_params(struct net_device *dev, |
| 243 |
const struct ieee802154_llsec_params *params, |
| 244 |
int changed); |
| 245 |
|
| 246 |
int mac802154_add_key(struct net_device *dev, |
| 247 |
const struct ieee802154_llsec_key_id *id, |
| 248 |
const struct ieee802154_llsec_key *key); |
| 249 |
int mac802154_del_key(struct net_device *dev, |
| 250 |
const struct ieee802154_llsec_key_id *id); |
| 251 |
|
| 252 |
int mac802154_add_dev(struct net_device *dev, |
| 253 |
const struct ieee802154_llsec_device *llsec_dev); |
| 254 |
int mac802154_del_dev(struct net_device *dev, __le64 dev_addr); |
| 255 |
|
| 256 |
int mac802154_add_devkey(struct net_device *dev, |
| 257 |
__le64 device_addr, |
| 258 |
const struct ieee802154_llsec_device_key *key); |
| 259 |
int mac802154_del_devkey(struct net_device *dev, |
| 260 |
__le64 device_addr, |
| 261 |
const struct ieee802154_llsec_device_key *key); |
| 262 |
|
| 263 |
int mac802154_add_seclevel(struct net_device *dev, |
| 264 |
const struct ieee802154_llsec_seclevel *sl); |
| 265 |
int mac802154_del_seclevel(struct net_device *dev, |
| 266 |
const struct ieee802154_llsec_seclevel *sl); |
| 267 |
|
| 268 |
void mac802154_lock_table(struct net_device *dev); |
| 269 |
void mac802154_get_table(struct net_device *dev, |
| 270 |
struct ieee802154_llsec_table **t); |
| 271 |
void mac802154_unlock_table(struct net_device *dev); |
| 272 |
|
| 273 |
int mac802154_wpan_update_llsec(struct net_device *dev); |
| 274 |
|
| 275 |
/* PAN management handling */ |
| 276 |
void mac802154_scan_worker(struct work_struct *work); |
| 277 |
int mac802154_trigger_scan_locked(struct ieee802154_sub_if_data *sdata, |
| 278 |
struct cfg802154_scan_request *request); |
| 279 |
int mac802154_abort_scan_locked(struct ieee802154_local *local, |
| 280 |
struct ieee802154_sub_if_data *sdata); |
| 281 |
int mac802154_process_beacon(struct ieee802154_local *local, |
| 282 |
struct sk_buff *skb, |
| 283 |
u8 page, u8 channel); |
| 284 |
void mac802154_rx_beacon_worker(struct work_struct *work); |
| 285 |
|
| 286 |
static inline bool mac802154_is_scanning(struct ieee802154_local *local) |
| 287 |
{ |
| 288 |
return test_bit(IEEE802154_IS_SCANNING, &local->ongoing); |
| 289 |
} |
| 290 |
|
| 291 |
void mac802154_beacon_worker(struct work_struct *work); |
| 292 |
int mac802154_send_beacons_locked(struct ieee802154_sub_if_data *sdata, |
| 293 |
struct cfg802154_beacon_request *request); |
| 294 |
int mac802154_stop_beacons_locked(struct ieee802154_local *local, |
| 295 |
struct ieee802154_sub_if_data *sdata); |
| 296 |
|
| 297 |
static inline bool mac802154_is_beaconing(struct ieee802154_local *local) |
| 298 |
{ |
| 299 |
return test_bit(IEEE802154_IS_BEACONING, &local->ongoing); |
| 300 |
} |
| 301 |
|
| 302 |
void mac802154_rx_mac_cmd_worker(struct work_struct *work); |
| 303 |
|
| 304 |
int mac802154_perform_association(struct ieee802154_sub_if_data *sdata, |
| 305 |
struct ieee802154_pan_device *coord, |
| 306 |
__le16 *short_addr); |
| 307 |
int mac802154_process_association_resp(struct ieee802154_sub_if_data *sdata, |
| 308 |
struct sk_buff *skb); |
| 309 |
|
| 310 |
static inline bool mac802154_is_associating(struct ieee802154_local *local) |
| 311 |
{ |
| 312 |
return test_bit(IEEE802154_IS_ASSOCIATING, &local->ongoing); |
| 313 |
} |
| 314 |
|
| 315 |
int mac802154_send_disassociation_notif(struct ieee802154_sub_if_data *sdata, |
| 316 |
struct ieee802154_pan_device *target, |
| 317 |
u8 reason); |
| 318 |
int mac802154_process_disassociation_notif(struct ieee802154_sub_if_data *sdata, |
| 319 |
struct sk_buff *skb); |
| 320 |
int mac802154_process_association_req(struct ieee802154_sub_if_data *sdata, |
| 321 |
struct sk_buff *skb); |
| 322 |
|
| 323 |
/* interface handling */ |
| 324 |
int ieee802154_iface_init(void); |
| 325 |
void ieee802154_iface_exit(void); |
| 326 |
void ieee802154_if_remove(struct ieee802154_sub_if_data *sdata); |
| 327 |
struct net_device * |
| 328 |
ieee802154_if_add(struct ieee802154_local *local, const char *name, |
| 329 |
unsigned char name_assign_type, enum nl802154_iftype type, |
| 330 |
__le64 extended_addr); |
| 331 |
void ieee802154_remove_interfaces(struct ieee802154_local *local); |
| 332 |
void ieee802154_stop_device(struct ieee802154_local *local); |
| 333 |
|
| 334 |
#endif /* __IEEE802154_I_H */ |