1 /*- 2 * Copyright (c) 2020-2023 The FreeBSD Foundation 3 * Copyright (c) 2020-2021 Bjoern A. Zeeb 4 * 5 * This software was developed by Björn Zeeb under sponsorship from 6 * the FreeBSD Foundation. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 /* 31 * Public functions are called linuxkpi_*(). 32 * Internal (static) functions are called lkpi_*(). 33 * 34 * The internal structures holding metadata over public structures are also 35 * called lkpi_xxx (usually with a member at the end called xxx). 36 * Note: we do not replicate the structure names but the general variable names 37 * for these (e.g., struct hw -> struct lkpi_hw, struct sta -> struct lkpi_sta). 38 * There are macros to access one from the other. 39 * We call the internal versions lxxx (e.g., hw -> lhw, sta -> lsta). 40 */ 41 42 #ifndef _LKPI_SRC_LINUX_80211_H 43 #define _LKPI_SRC_LINUX_80211_H 44 45 /* #define LINUXKPI_DEBUG_80211 */ 46 47 #ifndef D80211_TODO 48 #define D80211_TODO 0x00000001 49 #endif 50 #ifndef D80211_IMPROVE 51 #define D80211_IMPROVE 0x00000002 52 #endif 53 #define D80211_IMPROVE_TXQ 0x00000004 54 #define D80211_TRACE 0x00000010 55 #define D80211_TRACEOK 0x00000020 56 #define D80211_TRACE_TX 0x00000100 57 #define D80211_TRACE_TX_DUMP 0x00000200 58 #define D80211_TRACE_RX 0x00001000 59 #define D80211_TRACE_RX_DUMP 0x00002000 60 #define D80211_TRACE_RX_BEACONS 0x00004000 61 #define D80211_TRACEX (D80211_TRACE_TX|D80211_TRACE_RX) 62 #define D80211_TRACEX_DUMP (D80211_TRACE_TX_DUMP|D80211_TRACE_RX_DUMP) 63 #define D80211_TRACE_STA 0x00010000 64 #define D80211_TRACE_MO 0x00100000 65 #define D80211_TRACE_MODE 0x0f000000 66 #define D80211_TRACE_MODE_HT 0x01000000 67 #define D80211_TRACE_MODE_VHT 0x02000000 68 #define D80211_TRACE_MODE_HE 0x04000000 69 #define D80211_TRACE_MODE_EHT 0x08000000 70 71 #define IMPROVE_TXQ(...) \ 72 if (linuxkpi_debug_80211 & D80211_IMPROVE_TXQ) \ 73 printf("%s:%d: XXX LKPI80211 IMPROVE_TXQ\n", __func__, __LINE__) 74 75 #define IMPROVE_HT(...) \ 76 if (linuxkpi_debug_80211 & D80211_TRACE_MODE_HT) \ 77 printf("%s:%d: XXX LKPI80211 IMPROVE_HT\n", __func__, __LINE__) 78 79 struct lkpi_radiotap_tx_hdr { 80 struct ieee80211_radiotap_header wt_ihdr; 81 uint8_t wt_flags; 82 uint8_t wt_rate; 83 uint16_t wt_chan_freq; 84 uint16_t wt_chan_flags; 85 } __packed; 86 #define LKPI_RTAP_TX_FLAGS_PRESENT \ 87 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 88 (1 << IEEE80211_RADIOTAP_RATE) | \ 89 (1 << IEEE80211_RADIOTAP_CHANNEL)) 90 91 struct lkpi_radiotap_rx_hdr { 92 struct ieee80211_radiotap_header wr_ihdr; 93 uint64_t wr_tsft; 94 uint8_t wr_flags; 95 uint8_t wr_rate; 96 uint16_t wr_chan_freq; 97 uint16_t wr_chan_flags; 98 int8_t wr_dbm_antsignal; 99 int8_t wr_dbm_antnoise; 100 } __packed __aligned(8); 101 #define LKPI_RTAP_RX_FLAGS_PRESENT \ 102 ((1 << IEEE80211_RADIOTAP_TSFT) | \ 103 (1 << IEEE80211_RADIOTAP_FLAGS) | \ 104 (1 << IEEE80211_RADIOTAP_RATE) | \ 105 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 106 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) | \ 107 (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE)) 108 109 struct lkpi_txq { 110 TAILQ_ENTRY(lkpi_txq) txq_entry; 111 112 bool seen_dequeue; 113 bool stopped; 114 uint32_t txq_generation; 115 struct sk_buff_head skbq; 116 117 /* Must be last! */ 118 struct ieee80211_txq txq __aligned(CACHE_LINE_SIZE); 119 }; 120 #define TXQ_TO_LTXQ(_txq) container_of(_txq, struct lkpi_txq, txq) 121 122 123 struct lkpi_sta { 124 TAILQ_ENTRY(lkpi_sta) lsta_entry; 125 struct ieee80211_node *ni; 126 127 /* Deferred TX path. */ 128 /* Eventually we might want to migrate this into net80211 entirely. */ 129 /* XXX-BZ can we use sta->txq[] instead directly? */ 130 struct task txq_task; 131 struct mbufq txq; 132 struct mtx txq_mtx; 133 134 struct ieee80211_key_conf *kc; 135 enum ieee80211_sta_state state; 136 bool added_to_drv; /* Driver knows; i.e. we called ...(). */ 137 bool in_mgd; /* XXX-BZ should this be per-vif? */ 138 139 /* Must be last! */ 140 struct ieee80211_sta sta __aligned(CACHE_LINE_SIZE); 141 }; 142 #define STA_TO_LSTA(_sta) container_of(_sta, struct lkpi_sta, sta) 143 #define LSTA_TO_STA(_lsta) (&(_lsta)->sta) 144 145 struct lkpi_vif { 146 TAILQ_ENTRY(lkpi_vif) lvif_entry; 147 struct ieee80211vap iv_vap; 148 149 struct mtx mtx; 150 struct wireless_dev wdev; 151 152 /* Other local stuff. */ 153 int (*iv_newstate)(struct ieee80211vap *, 154 enum ieee80211_state, int); 155 struct ieee80211_node * (*iv_update_bss)(struct ieee80211vap *, 156 struct ieee80211_node *); 157 TAILQ_HEAD(, lkpi_sta) lsta_head; 158 bool added_to_drv; /* Driver knows; i.e. we called add_interface(). */ 159 160 bool hw_queue_stopped[IEEE80211_NUM_ACS]; 161 162 /* Must be last! */ 163 struct ieee80211_vif vif __aligned(CACHE_LINE_SIZE); 164 }; 165 #define VAP_TO_LVIF(_vap) container_of(_vap, struct lkpi_vif, iv_vap) 166 #define LVIF_TO_VAP(_lvif) (&(_lvif)->iv_vap) 167 #define VIF_TO_LVIF(_vif) container_of(_vif, struct lkpi_vif, vif) 168 #define LVIF_TO_VIF(_lvif) (&(_lvif)->vif) 169 170 171 struct lkpi_hw { /* name it mac80211_sc? */ 172 const struct ieee80211_ops *ops; 173 struct ieee80211_scan_request *hw_req; 174 struct workqueue_struct *workq; 175 176 /* FreeBSD specific compat. */ 177 /* Linux device is in hw.wiphy->dev after SET_IEEE80211_DEV(). */ 178 struct ieee80211com *ic; 179 struct lkpi_radiotap_tx_hdr rtap_tx; 180 struct lkpi_radiotap_rx_hdr rtap_rx; 181 182 TAILQ_HEAD(, lkpi_vif) lvif_head; 183 struct sx lvif_sx; 184 185 struct sx sx; 186 187 uint32_t txq_generation[IEEE80211_NUM_ACS]; 188 TAILQ_HEAD(, lkpi_txq) scheduled_txqs[IEEE80211_NUM_ACS]; 189 190 /* Scan functions we overload to handle depending on scan mode. */ 191 void (*ic_scan_curchan)(struct ieee80211_scan_state *, 192 unsigned long); 193 void (*ic_scan_mindwell)(struct ieee80211_scan_state *); 194 195 /* Node functions we overload to sync state. */ 196 struct ieee80211_node * (*ic_node_alloc)(struct ieee80211vap *, 197 const uint8_t [IEEE80211_ADDR_LEN]); 198 int (*ic_node_init)(struct ieee80211_node *); 199 void (*ic_node_cleanup)(struct ieee80211_node *); 200 void (*ic_node_free)(struct ieee80211_node *); 201 202 /* HT and later functions. */ 203 int (*ic_recv_action)(struct ieee80211_node *, 204 const struct ieee80211_frame *, 205 const uint8_t *, const uint8_t *); 206 int (*ic_send_action)(struct ieee80211_node *, 207 int, int, void *); 208 int (*ic_ampdu_enable)(struct ieee80211_node *, 209 struct ieee80211_tx_ampdu *); 210 int (*ic_addba_request)(struct ieee80211_node *, 211 struct ieee80211_tx_ampdu *, int, int, int); 212 int (*ic_addba_response)(struct ieee80211_node *, 213 struct ieee80211_tx_ampdu *, int, int, int); 214 void (*ic_addba_stop)(struct ieee80211_node *, 215 struct ieee80211_tx_ampdu *); 216 void (*ic_addba_response_timeout)(struct ieee80211_node *, 217 struct ieee80211_tx_ampdu *); 218 void (*ic_bar_response)(struct ieee80211_node *, 219 struct ieee80211_tx_ampdu *, int); 220 int (*ic_ampdu_rx_start)(struct ieee80211_node *, 221 struct ieee80211_rx_ampdu *, int, int, int); 222 void (*ic_ampdu_rx_stop)(struct ieee80211_node *, 223 struct ieee80211_rx_ampdu *); 224 225 #define LKPI_MAC80211_DRV_STARTED 0x00000001 226 uint32_t sc_flags; 227 #define LKPI_LHW_SCAN_RUNNING 0x00000001 228 #define LKPI_LHW_SCAN_HW 0x00000002 229 uint32_t scan_flags; 230 struct mtx scan_mtx; 231 232 int supbands; /* Number of supported bands. */ 233 int max_rates; /* Maximum number of bitrates supported in any channel. */ 234 int scan_ie_len; /* Length of common per-band scan IEs. */ 235 236 bool update_mc; 237 bool update_wme; 238 239 /* Must be last! */ 240 struct ieee80211_hw hw __aligned(CACHE_LINE_SIZE); 241 }; 242 #define LHW_TO_HW(_lhw) (&(_lhw)->hw) 243 #define HW_TO_LHW(_hw) container_of(_hw, struct lkpi_hw, hw) 244 245 struct lkpi_chanctx { 246 bool added_to_drv; /* Managed by MO */ 247 struct ieee80211_chanctx_conf conf __aligned(CACHE_LINE_SIZE); 248 }; 249 #define LCHANCTX_TO_CHANCTX_CONF(_lchanctx) \ 250 (&(_lchanctx)->conf) 251 #define CHANCTX_CONF_TO_LCHANCTX(_conf) \ 252 container_of(_conf, struct lkpi_chanctx, conf) 253 254 struct lkpi_wiphy { 255 const struct cfg80211_ops *ops; 256 257 /* Must be last! */ 258 struct wiphy wiphy __aligned(CACHE_LINE_SIZE); 259 }; 260 #define WIPHY_TO_LWIPHY(_wiphy) container_of(_wiphy, struct lkpi_wiphy, wiphy) 261 #define LWIPHY_TO_WIPHY(_lwiphy) (&(_lwiphy)->wiphy) 262 263 #define LKPI_80211_LHW_LOCK_INIT(_lhw) \ 264 sx_init_flags(&(_lhw)->sx, "lhw", SX_RECURSE); 265 #define LKPI_80211_LHW_LOCK_DESTROY(_lhw) \ 266 sx_destroy(&(_lhw)->sx); 267 #define LKPI_80211_LHW_LOCK(_lhw) \ 268 sx_xlock(&(_lhw)->sx) 269 #define LKPI_80211_LHW_UNLOCK(_lhw) \ 270 sx_xunlock(&(_lhw)->sx) 271 #define LKPI_80211_LHW_LOCK_ASSERT(_lhw) \ 272 sx_assert(&(_lhw)->sx, SA_LOCKED) 273 #define LKPI_80211_LHW_UNLOCK_ASSERT(_lhw) \ 274 sx_assert(&(_lhw)->sx, SA_UNLOCKED) 275 276 #define LKPI_80211_LHW_SCAN_LOCK_INIT(_lhw) \ 277 mtx_init(&(_lhw)->scan_mtx, "lhw-scan", NULL, MTX_DEF | MTX_RECURSE); 278 #define LKPI_80211_LHW_SCAN_LOCK_DESTROY(_lhw) \ 279 mtx_destroy(&(_lhw)->scan_mtx); 280 #define LKPI_80211_LHW_SCAN_LOCK(_lhw) \ 281 mtx_lock(&(_lhw)->scan_mtx) 282 #define LKPI_80211_LHW_SCAN_UNLOCK(_lhw) \ 283 mtx_unlock(&(_lhw)->scan_mtx) 284 #define LKPI_80211_LHW_SCAN_LOCK_ASSERT(_lhw) \ 285 mtx_assert(&(_lhw)->scan_mtx, MA_OWNED) 286 #define LKPI_80211_LHW_SCAN_UNLOCK_ASSERT(_lhw) \ 287 mtx_assert(&(_lhw)->scan_mtx, MA_NOTOWNED) 288 289 #define LKPI_80211_LHW_LVIF_LOCK(_lhw) sx_xlock(&(_lhw)->lvif_sx) 290 #define LKPI_80211_LHW_LVIF_UNLOCK(_lhw) sx_xunlock(&(_lhw)->lvif_sx) 291 292 #define LKPI_80211_LVIF_LOCK(_lvif) mtx_lock(&(_lvif)->mtx) 293 #define LKPI_80211_LVIF_UNLOCK(_lvif) mtx_unlock(&(_lvif)->mtx) 294 295 #define LKPI_80211_LSTA_LOCK(_lsta) mtx_lock(&(_lsta)->txq_mtx) 296 #define LKPI_80211_LSTA_UNLOCK(_lsta) mtx_unlock(&(_lsta)->txq_mtx) 297 298 299 int lkpi_80211_mo_start(struct ieee80211_hw *); 300 void lkpi_80211_mo_stop(struct ieee80211_hw *); 301 int lkpi_80211_mo_get_antenna(struct ieee80211_hw *, u32 *, u32 *); 302 int lkpi_80211_mo_set_frag_threshold(struct ieee80211_hw *, uint32_t); 303 int lkpi_80211_mo_set_rts_threshold(struct ieee80211_hw *, uint32_t); 304 int lkpi_80211_mo_add_interface(struct ieee80211_hw *, struct ieee80211_vif *); 305 void lkpi_80211_mo_remove_interface(struct ieee80211_hw *, struct ieee80211_vif *); 306 int lkpi_80211_mo_hw_scan(struct ieee80211_hw *, struct ieee80211_vif *, 307 struct ieee80211_scan_request *); 308 void lkpi_80211_mo_cancel_hw_scan(struct ieee80211_hw *, struct ieee80211_vif *); 309 void lkpi_80211_mo_sw_scan_complete(struct ieee80211_hw *, struct ieee80211_vif *); 310 void lkpi_80211_mo_sw_scan_start(struct ieee80211_hw *, struct ieee80211_vif *, 311 const u8 *); 312 u64 lkpi_80211_mo_prepare_multicast(struct ieee80211_hw *, 313 struct netdev_hw_addr_list *); 314 void lkpi_80211_mo_configure_filter(struct ieee80211_hw *, unsigned int, 315 unsigned int *, u64); 316 int lkpi_80211_mo_sta_state(struct ieee80211_hw *, struct ieee80211_vif *, 317 struct lkpi_sta *, enum ieee80211_sta_state); 318 int lkpi_80211_mo_config(struct ieee80211_hw *, uint32_t); 319 int lkpi_80211_mo_assign_vif_chanctx(struct ieee80211_hw *, struct ieee80211_vif *, 320 struct ieee80211_bss_conf *, struct ieee80211_chanctx_conf *); 321 void lkpi_80211_mo_unassign_vif_chanctx(struct ieee80211_hw *, struct ieee80211_vif *, 322 struct ieee80211_bss_conf *, struct ieee80211_chanctx_conf **); 323 int lkpi_80211_mo_add_chanctx(struct ieee80211_hw *, struct ieee80211_chanctx_conf *); 324 void lkpi_80211_mo_change_chanctx(struct ieee80211_hw *, 325 struct ieee80211_chanctx_conf *, uint32_t); 326 void lkpi_80211_mo_remove_chanctx(struct ieee80211_hw *, 327 struct ieee80211_chanctx_conf *); 328 void lkpi_80211_mo_bss_info_changed(struct ieee80211_hw *, struct ieee80211_vif *, 329 struct ieee80211_bss_conf *, uint64_t); 330 int lkpi_80211_mo_conf_tx(struct ieee80211_hw *, struct ieee80211_vif *, 331 uint32_t, uint16_t, const struct ieee80211_tx_queue_params *); 332 void lkpi_80211_mo_flush(struct ieee80211_hw *, struct ieee80211_vif *, 333 uint32_t, bool); 334 void lkpi_80211_mo_mgd_prepare_tx(struct ieee80211_hw *, struct ieee80211_vif *, 335 struct ieee80211_prep_tx_info *); 336 void lkpi_80211_mo_mgd_complete_tx(struct ieee80211_hw *, struct ieee80211_vif *, 337 struct ieee80211_prep_tx_info *); 338 void lkpi_80211_mo_tx(struct ieee80211_hw *, struct ieee80211_tx_control *, 339 struct sk_buff *); 340 void lkpi_80211_mo_wake_tx_queue(struct ieee80211_hw *, struct ieee80211_txq *); 341 void lkpi_80211_mo_sync_rx_queues(struct ieee80211_hw *); 342 void lkpi_80211_mo_sta_pre_rcu_remove(struct ieee80211_hw *, 343 struct ieee80211_vif *, struct ieee80211_sta *); 344 int lkpi_80211_mo_set_key(struct ieee80211_hw *, enum set_key_cmd, 345 struct ieee80211_vif *, struct ieee80211_sta *, 346 struct ieee80211_key_conf *); 347 int lkpi_80211_mo_ampdu_action(struct ieee80211_hw *, struct ieee80211_vif *, 348 struct ieee80211_ampdu_params *); 349 350 351 #endif /* _LKPI_SRC_LINUX_80211_H */ 352