1 /* 2 * Copyright (c) 2016-2018 The Linux Foundation. All rights reserved. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for 5 * any purpose with or without fee is hereby granted, provided that the 6 * above copyright notice and this permission notice appear in all 7 * copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 10 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 11 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 12 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 13 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 14 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 15 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 16 * PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #ifndef __CDP_TXRX_MOB_DEF_H 20 #define __CDP_TXRX_MOB_DEF_H 21 #include <sir_types.h> 22 #include <htt.h> 23 24 #define TX_WMM_AC_NUM 4 25 26 #define OL_TXQ_PAUSE_REASON_FW (1 << 0) 27 #define OL_TXQ_PAUSE_REASON_PEER_UNAUTHORIZED (1 << 1) 28 #define OL_TXQ_PAUSE_REASON_TX_ABORT (1 << 2) 29 #define OL_TXQ_PAUSE_REASON_VDEV_STOP (1 << 3) 30 #define OL_TXQ_PAUSE_REASON_THERMAL_MITIGATION (1 << 4) 31 32 #define OL_TXRX_INVALID_NUM_PEERS (-1) 33 34 #define OL_TXRX_MAC_ADDR_LEN 6 35 36 37 /* Maximum number of station supported by data path, including BC. */ 38 #define WLAN_MAX_STA_COUNT (HAL_NUM_STA) 39 40 /* The symbolic station ID return to HDD to specify the packet is bc/mc */ 41 #define WLAN_RX_BCMC_STA_ID (WLAN_MAX_STA_COUNT + 1) 42 43 /* The symbolic station ID return to HDD to specify the packet is 44 to soft-AP itself */ 45 #define WLAN_RX_SAP_SELF_STA_ID (WLAN_MAX_STA_COUNT + 2) 46 47 /* is 802.11 address multicast/broadcast? */ 48 #define IEEE80211_IS_MULTICAST(_a) (*(_a) & 0x01) 49 50 #define MAX_PEERS 32 51 52 /* 53 * Bins used for reporting delay histogram: 54 * bin 0: 0 - 10 ms delay 55 * bin 1: 10 - 20 ms delay 56 * bin 2: 20 - 40 ms delay 57 * bin 3: 40 - 80 ms delay 58 * bin 4: 80 - 160 ms delay 59 * bin 5: > 160 ms delay 60 */ 61 #define QCA_TX_DELAY_HIST_REPORT_BINS 6 62 63 /* BA actions */ 64 #define IEEE80211_ACTION_BA_ADDBA_REQUEST 0 /* ADDBA request */ 65 #define IEEE80211_ACTION_BA_ADDBA_RESPONSE 1 /* ADDBA response */ 66 #define IEEE80211_ACTION_BA_DELBA 2 /* DELBA */ 67 68 #define IEEE80211_BA_POLICY_DELAYED 0 69 #define IEEE80211_BA_POLICY_IMMEDIATE 1 70 #define IEEE80211_BA_AMSDU_SUPPORTED 1 71 72 /** 73 * enum netif_action_type - Type of actions on netif queues 74 * @WLAN_STOP_ALL_NETIF_QUEUE: stop all netif queues 75 * @WLAN_START_ALL_NETIF_QUEUE: start all netif queues 76 * @WLAN_WAKE_ALL_NETIF_QUEUE: wake all netif queues 77 * @WLAN_STOP_ALL_NETIF_QUEUE_N_CARRIER: stop all queues and off carrier 78 * @WLAN_START_ALL_NETIF_QUEUE_N_CARRIER: start all queues and on carrier 79 * @WLAN_NETIF_TX_DISABLE: disable tx 80 * @WLAN_NETIF_TX_DISABLE_N_CARRIER: disable tx and off carrier 81 * @WLAN_NETIF_CARRIER_ON: on carrier 82 * @WLAN_NETIF_CARRIER_OFF: off carrier 83 * @WLAN_NETIF_PRIORITY_QUEUE_ON: start priority netif queues 84 * @WLAN_NETIF_PRIORITY_QUEUE_OFF: stop priority netif queues 85 * @WLAN_WAKE_NON_PRIORITY_QUEUE: wake non priority netif queues 86 * @WLAN_STOP_NON_PRIORITY_QUEUE: stop non priority netif queues 87 */ 88 enum netif_action_type { 89 WLAN_STOP_ALL_NETIF_QUEUE = 1, 90 WLAN_START_ALL_NETIF_QUEUE, 91 WLAN_WAKE_ALL_NETIF_QUEUE, 92 WLAN_STOP_ALL_NETIF_QUEUE_N_CARRIER, 93 WLAN_START_ALL_NETIF_QUEUE_N_CARRIER, 94 WLAN_NETIF_TX_DISABLE, 95 WLAN_NETIF_TX_DISABLE_N_CARRIER, 96 WLAN_NETIF_CARRIER_ON, 97 WLAN_NETIF_CARRIER_OFF, 98 WLAN_NETIF_PRIORITY_QUEUE_ON, 99 WLAN_NETIF_PRIORITY_QUEUE_OFF, 100 WLAN_NETIF_VO_QUEUE_ON, 101 WLAN_NETIF_VO_QUEUE_OFF, 102 WLAN_NETIF_VI_QUEUE_ON, 103 WLAN_NETIF_VI_QUEUE_OFF, 104 WLAN_NETIF_BE_BK_QUEUE_OFF, 105 WLAN_WAKE_NON_PRIORITY_QUEUE, 106 WLAN_STOP_NON_PRIORITY_QUEUE, 107 WLAN_NETIF_ACTION_TYPE_MAX, 108 }; 109 110 /** 111 * enum netif_reason_type - reason for netif queue action 112 * @WLAN_CONTROL_PATH: action from control path 113 * @WLAN_DATA_FLOW_CONTROL: because of flow control 114 * @WLAN_FW_PAUSE: because of firmware pause 115 * @WLAN_TX_ABORT: because of tx abort 116 * @WLAN_VDEV_STOP: because of vdev stop 117 * @WLAN_PEER_UNAUTHORISED: because of peer is unauthorised 118 * @WLAN_THERMAL_MITIGATION: because of thermal mitigation 119 */ 120 enum netif_reason_type { 121 WLAN_CONTROL_PATH = 1, 122 WLAN_DATA_FLOW_CONTROL, 123 WLAN_FW_PAUSE, 124 WLAN_TX_ABORT, 125 WLAN_VDEV_STOP, 126 WLAN_PEER_UNAUTHORISED, 127 WLAN_THERMAL_MITIGATION, 128 WLAN_DATA_FLOW_CONTROL_PRIORITY, 129 WLAN_REASON_TYPE_MAX, 130 }; 131 132 enum ol_rx_err_type { 133 OL_RX_ERR_DEFRAG_MIC, 134 OL_RX_ERR_PN, 135 OL_RX_ERR_UNKNOWN_PEER, 136 OL_RX_ERR_MALFORMED, 137 OL_RX_ERR_TKIP_MIC, 138 OL_RX_ERR_DECRYPT, 139 OL_RX_ERR_MPDU_LENGTH, 140 OL_RX_ERR_ENCRYPT_REQUIRED, 141 OL_RX_ERR_DUP, 142 OL_RX_ERR_UNKNOWN, 143 OL_RX_ERR_FCS, 144 OL_RX_ERR_PRIVACY, 145 OL_RX_ERR_NONE_FRAG, 146 OL_RX_ERR_NONE = 0xFF 147 }; 148 149 enum throttle_level { 150 THROTTLE_LEVEL_0, 151 THROTTLE_LEVEL_1, 152 THROTTLE_LEVEL_2, 153 THROTTLE_LEVEL_3, 154 /* Invalid */ 155 THROTTLE_LEVEL_MAX, 156 }; 157 158 enum { 159 OL_TX_WMM_AC_BE, 160 OL_TX_WMM_AC_BK, 161 OL_TX_WMM_AC_VI, 162 OL_TX_WMM_AC_VO, 163 OL_TX_NUM_WMM_AC 164 }; 165 166 /** 167 * @enum ol_tx_spec 168 * @brief indicate what non-standard transmission actions to apply 169 * @details 170 * Indicate one or more of the following: 171 * - The tx frame already has a complete 802.11 header. 172 * Thus, skip 802.3/native-WiFi to 802.11 header encapsulation and 173 * A-MSDU aggregation. 174 * - The tx frame should not be aggregated (A-MPDU or A-MSDU) 175 * - The tx frame is already encrypted - don't attempt encryption. 176 * - The tx frame is a segment of a TCP jumbo frame. 177 * - This tx frame should not be unmapped and freed by the txrx layer 178 * after transmission, but instead given to a registered tx completion 179 * callback. 180 * More than one of these specification can apply, though typically 181 * only a single specification is applied to a tx frame. 182 * A compound specification can be created, as a bit-OR of these 183 * specifications. 184 */ 185 enum ol_tx_spec { 186 OL_TX_SPEC_STD = 0x0, /* do regular processing */ 187 OL_TX_SPEC_RAW = 0x1, /* skip encap + A-MSDU aggr */ 188 OL_TX_SPEC_NO_AGGR = 0x2, /* skip encap + all aggr */ 189 OL_TX_SPEC_NO_ENCRYPT = 0x4, /* skip encap + encrypt */ 190 OL_TX_SPEC_TSO = 0x8, /* TCP segmented */ 191 OL_TX_SPEC_NWIFI_NO_ENCRYPT = 0x10, /* skip encrypt for nwifi */ 192 OL_TX_SPEC_NO_FREE = 0x20, /* give to cb rather than free */ 193 }; 194 195 /** 196 * @enum peer_debug_id_type: debug ids to track peer get_ref and release_ref 197 * @brief Unique peer debug IDs to track the callers. Each new usage can add to 198 * this enum list to create a new "PEER_DEBUG_ID_". 199 * @PEER_DEBUG_ID_OL_INTERNAL: debug id for OL internal usage 200 * @PEER_DEBUG_ID_WMA_PKT_DROP: debug id for wma_is_pkt_drop_candidate API 201 * @PEER_DEBUG_ID_WMA_ADDBA_REQ: debug id for ADDBA request 202 * @PEER_DEBUG_ID_WMA_DELBA_REQ: debug id for DELBA request 203 * @PEER_DEBUG_ID_LIM_SEND_ADDBA_RESP: debug id for send ADDBA response 204 * @PEER_DEBUG_ID_OL_RX_THREAD: debug id for rx thread 205 * @PEER_DEBUG_ID_WMA_CCMP_REPLAY_ATTACK: debug id for CCMP replay 206 * @PEER_DEBUG_ID_WMA_DEL_BSS:debug id for remove BSS 207 * @PEER_DEBUG_ID_WMA_VDEV_STOP_RESP:debug id for vdev stop response handler 208 * @PEER_DEBUG_ID_OL_PEER_MAP:debug id for peer map/unmap 209 * @PEER_DEBUG_ID_OL_PEER_ATTACH: debug id for peer attach/detach 210 * @PEER_DEBUG_ID_OL_TXQ_VDEV_FL: debug id for vdev flush 211 * @PEER_DEBUG_ID_OL_HASH_ERS:debug id for peer find hash erase 212 * @PEER_DEBUG_ID_MAX: debug id MAX 213 */ 214 enum peer_debug_id_type { 215 PEER_DEBUG_ID_OL_INTERNAL, 216 PEER_DEBUG_ID_WMA_PKT_DROP, 217 PEER_DEBUG_ID_WMA_ADDBA_REQ, 218 PEER_DEBUG_ID_WMA_DELBA_REQ, 219 PEER_DEBUG_ID_LIM_SEND_ADDBA_RESP, 220 PEER_DEBUG_ID_OL_RX_THREAD, 221 PEER_DEBUG_ID_WMA_CCMP_REPLAY_ATTACK, 222 PEER_DEBUG_ID_WMA_DEL_BSS, 223 PEER_DEBUG_ID_WMA_VDEV_STOP_RESP, 224 PEER_DEBUG_ID_OL_PEER_MAP, 225 PEER_DEBUG_ID_OL_PEER_ATTACH, 226 PEER_DEBUG_ID_OL_TXQ_VDEV_FL, 227 PEER_DEBUG_ID_OL_HASH_ERS, 228 PEER_DEBUG_ID_MAX 229 }; 230 231 /** 232 * struct ol_txrx_desc_type - txrx descriptor type 233 * @sta_id: sta id 234 * @is_qos_enabled: is station qos enabled 235 * @is_wapi_supported: is station wapi supported 236 */ 237 struct ol_txrx_desc_type { 238 uint8_t sta_id; 239 uint8_t is_qos_enabled; 240 uint8_t is_wapi_supported; 241 }; 242 243 /** 244 * struct ol_tx_sched_wrr_ac_specs_t - the wrr ac specs params structure 245 * @wrr_skip_weight: map to ol_tx_sched_wrr_adv_category_info_t.specs. 246 * wrr_skip_weight 247 * @credit_threshold: map to ol_tx_sched_wrr_adv_category_info_t.specs. 248 * credit_threshold 249 * @send_limit: map to ol_tx_sched_wrr_adv_category_info_t.specs. 250 * send_limit 251 * @credit_reserve: map to ol_tx_sched_wrr_adv_category_info_t.specs. 252 * credit_reserve 253 * @discard_weight: map to ol_tx_sched_wrr_adv_category_info_t.specs. 254 * discard_weight 255 * 256 * This structure is for wrr ac specs params set from user, it will update 257 * its content corresponding to the ol_tx_sched_wrr_adv_category_info_t.specs. 258 */ 259 struct ol_tx_sched_wrr_ac_specs_t { 260 int wrr_skip_weight; 261 uint32_t credit_threshold; 262 uint16_t send_limit; 263 int credit_reserve; 264 int discard_weight; 265 }; 266 267 /** 268 * struct txrx_pdev_cfg_param_t - configuration information 269 * passed to the data path 270 */ 271 struct txrx_pdev_cfg_param_t { 272 uint8_t is_full_reorder_offload; 273 /* IPA Micro controller data path offload enable flag */ 274 uint8_t is_uc_offload_enabled; 275 /* IPA Micro controller data path offload TX buffer count */ 276 uint32_t uc_tx_buffer_count; 277 /* IPA Micro controller data path offload TX buffer size */ 278 uint32_t uc_tx_buffer_size; 279 /* IPA Micro controller data path offload RX indication ring count */ 280 uint32_t uc_rx_indication_ring_count; 281 /* IPA Micro controller data path offload TX partition base */ 282 uint32_t uc_tx_partition_base; 283 /* IP, TCP and UDP checksum offload */ 284 bool ip_tcp_udp_checksum_offload; 285 /* Rx processing in thread from TXRX */ 286 bool enable_rxthread; 287 /* CE classification enabled through INI */ 288 bool ce_classify_enabled; 289 #ifdef QCA_LL_TX_FLOW_CONTROL_V2 290 /* Threshold to stop queue in percentage */ 291 uint32_t tx_flow_stop_queue_th; 292 /* Start queue offset in percentage */ 293 uint32_t tx_flow_start_queue_offset; 294 #endif 295 296 struct ol_tx_sched_wrr_ac_specs_t ac_specs[TX_WMM_AC_NUM]; 297 bool gro_enable; 298 bool tso_enable; 299 bool lro_enable; 300 bool enable_data_stall_detection; 301 bool enable_flow_steering; 302 bool disable_intra_bss_fwd; 303 }; 304 305 #ifdef IPA_OFFLOAD 306 /** 307 * ol_txrx_ipa_resources - Resources needed for IPA 308 */ 309 struct ol_txrx_ipa_resources { 310 qdf_shared_mem_t *ce_sr; 311 uint32_t ce_sr_ring_size; 312 qdf_dma_addr_t ce_reg_paddr; 313 314 qdf_shared_mem_t *tx_comp_ring; 315 uint32_t tx_num_alloc_buffer; 316 317 qdf_shared_mem_t *rx_rdy_ring; 318 qdf_shared_mem_t *rx_proc_done_idx; 319 320 qdf_shared_mem_t *rx2_rdy_ring; 321 qdf_shared_mem_t *rx2_proc_done_idx; 322 323 /* IPA UC doorbell registers paddr */ 324 qdf_dma_addr_t tx_comp_doorbell_dmaaddr; 325 qdf_dma_addr_t rx_ready_doorbell_dmaaddr; 326 327 uint32_t tx_pipe_handle; 328 uint32_t rx_pipe_handle; 329 }; 330 #endif 331 332 struct ol_txrx_ocb_chan_info { 333 uint32_t chan_freq; 334 uint16_t disable_rx_stats_hdr:1; 335 }; 336 337 /** 338 * ol_mic_error_info - carries the information associated with 339 * a MIC error 340 * @vdev_id: virtual device ID 341 * @key_id: Key ID 342 * @pn: packet number 343 * @sa: source address 344 * @da: destination address 345 * @ta: transmitter address 346 */ 347 struct ol_mic_error_info { 348 uint8_t vdev_id; 349 uint32_t key_id; 350 uint64_t pn; 351 uint8_t sa[OL_TXRX_MAC_ADDR_LEN]; 352 uint8_t da[OL_TXRX_MAC_ADDR_LEN]; 353 uint8_t ta[OL_TXRX_MAC_ADDR_LEN]; 354 }; 355 356 /** 357 * ol_error_info - carries the information associated with an 358 * error indicated by the firmware 359 * @mic_err: MIC error information 360 */ 361 struct ol_error_info { 362 union { 363 struct ol_mic_error_info mic_err; 364 } u; 365 }; 366 367 368 /** 369 * struct ol_txrx_ocb_set_chan - txrx OCB channel info 370 * @ocb_channel_count: Channel count 371 * @ocb_channel_info: OCB channel info 372 */ 373 struct ol_txrx_ocb_set_chan { 374 uint32_t ocb_channel_count; 375 struct ol_txrx_ocb_chan_info *ocb_channel_info; 376 }; 377 378 /** 379 * @brief Parameter type to pass WMM setting to ol_txrx_set_wmm_param 380 * @details 381 * The struct is used to specify informaiton to update TX WMM scheduler. 382 */ 383 struct ol_tx_ac_param_t { 384 uint32_t aifs; 385 uint32_t cwmin; 386 uint32_t cwmax; 387 }; 388 389 struct ol_tx_wmm_param_t { 390 struct ol_tx_ac_param_t ac[OL_TX_NUM_WMM_AC]; 391 }; 392 393 struct ieee80211_ba_parameterset { 394 #if _BYTE_ORDER == _BIG_ENDIAN 395 uint16_t buffersize:10, /* B6-15 buffer size */ 396 tid:4, /* B2-5 TID */ 397 bapolicy:1, /* B1 block ack policy */ 398 amsdusupported:1; /* B0 amsdu supported */ 399 #else 400 uint16_t amsdusupported:1, /* B0 amsdu supported */ 401 bapolicy:1, /* B1 block ack policy */ 402 tid:4, /* B2-5 TID */ 403 buffersize:10; /* B6-15 buffer size */ 404 #endif 405 } __packed; 406 407 struct ieee80211_ba_seqctrl { 408 #if _BYTE_ORDER == _BIG_ENDIAN 409 uint16_t startseqnum:12, /* B4-15 starting sequence number */ 410 fragnum:4; /* B0-3 fragment number */ 411 #else 412 uint16_t fragnum:4, /* B0-3 fragment number */ 413 startseqnum:12; /* B4-15 starting sequence number */ 414 #endif 415 } __packed; 416 417 struct ieee80211_delba_parameterset { 418 #if _BYTE_ORDER == _BIG_ENDIAN 419 uint16_t tid:4, /* B12-15 tid */ 420 initiator:1, /* B11 initiator */ 421 reserved0:11; /* B0-10 reserved */ 422 #else 423 uint16_t reserved0:11, /* B0-10 reserved */ 424 initiator:1, /* B11 initiator */ 425 tid:4; /* B12-15 tid */ 426 #endif 427 } __packed; 428 429 /** 430 * ol_txrx_vdev_peer_remove_cb - wma_remove_peer callback 431 */ 432 typedef void (*ol_txrx_vdev_peer_remove_cb)(void *handle, uint8_t *bssid, 433 uint8_t vdev_id, void *peer); 434 435 /** 436 * @typedef tx_pause_callback 437 * @brief OSIF function registered with the data path 438 */ 439 typedef void (*tx_pause_callback)(uint8_t vdev_id, 440 enum netif_action_type action, 441 enum netif_reason_type reason); 442 443 typedef void (*ipa_uc_op_cb_type)(uint8_t *op_msg, 444 void *osif_ctxt); 445 446 /** 447 * struct ol_rx_inv_peer_params - rx invalid peer data parameters 448 * @vdev_id: Virtual device ID 449 * @ra: RX data receiver MAC address 450 * @ta: RX data transmitter MAC address 451 */ 452 struct ol_rx_inv_peer_params { 453 uint8_t vdev_id; 454 uint8_t ra[OL_TXRX_MAC_ADDR_LEN]; 455 uint8_t ta[OL_TXRX_MAC_ADDR_LEN]; 456 }; 457 458 #endif /* __CDP_TXRX_MOB_DEF_H */ 459