1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */ 2 /* 3 * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved. 4 * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved. 5 */ 6 #ifndef ATH12K_RX_DESC_H 7 #define ATH12K_RX_DESC_H 8 9 enum rx_desc_decap_type { 10 RX_DESC_DECAP_TYPE_RAW, 11 RX_DESC_DECAP_TYPE_NATIVE_WIFI, 12 RX_DESC_DECAP_TYPE_ETHERNET2_DIX, 13 RX_DESC_DECAP_TYPE_8023, 14 }; 15 16 enum rx_desc_decrypt_status_code { 17 RX_DESC_DECRYPT_STATUS_CODE_OK, 18 RX_DESC_DECRYPT_STATUS_CODE_UNPROTECTED_FRAME, 19 RX_DESC_DECRYPT_STATUS_CODE_DATA_ERR, 20 RX_DESC_DECRYPT_STATUS_CODE_KEY_INVALID, 21 RX_DESC_DECRYPT_STATUS_CODE_PEER_ENTRY_INVALID, 22 RX_DESC_DECRYPT_STATUS_CODE_OTHER, 23 }; 24 25 #define RX_MPDU_START_INFO0_REO_DEST_IND GENMASK(4, 0) 26 #define RX_MPDU_START_INFO0_LMAC_PEER_ID_MSB GENMASK(6, 5) 27 #define RX_MPDU_START_INFO0_FLOW_ID_TOEPLITZ BIT(7) 28 #define RX_MPDU_START_INFO0_PKT_SEL_FP_UCAST_DATA BIT(8) 29 #define RX_MPDU_START_INFO0_PKT_SEL_FP_MCAST_DATA BIT(9) 30 #define RX_MPDU_START_INFO0_PKT_SEL_FP_CTRL_BAR BIT(10) 31 #define RX_MPDU_START_INFO0_RXDMA0_SRC_RING_SEL GENMASK(13, 11) 32 #define RX_MPDU_START_INFO0_RXDMA0_DST_RING_SEL GENMASK(16, 14) 33 #define RX_MPDU_START_INFO0_MCAST_ECHO_DROP_EN BIT(17) 34 #define RX_MPDU_START_INFO0_WDS_LEARN_DETECT_EN BIT(18) 35 #define RX_MPDU_START_INFO0_INTRA_BSS_CHECK_EN BIT(19) 36 #define RX_MPDU_START_INFO0_USE_PPE BIT(20) 37 #define RX_MPDU_START_INFO0_PPE_ROUTING_EN BIT(21) 38 39 #define RX_MPDU_START_INFO1_REO_QUEUE_DESC_HI GENMASK(7, 0) 40 #define RX_MPDU_START_INFO1_RECV_QUEUE_NUM GENMASK(23, 8) 41 #define RX_MPDU_START_INFO1_PRE_DELIM_ERR_WARN BIT(24) 42 #define RX_MPDU_START_INFO1_FIRST_DELIM_ERR BIT(25) 43 44 #define RX_MPDU_START_INFO2_EPD_EN BIT(0) 45 #define RX_MPDU_START_INFO2_ALL_FRAME_ENCPD BIT(1) 46 #define RX_MPDU_START_INFO2_ENC_TYPE GENMASK(5, 2) 47 #define RX_MPDU_START_INFO2_VAR_WEP_KEY_WIDTH GENMASK(7, 6) 48 #define RX_MPDU_START_INFO2_MESH_STA GENMASK(9, 8) 49 #define RX_MPDU_START_INFO2_BSSID_HIT BIT(10) 50 #define RX_MPDU_START_INFO2_BSSID_NUM GENMASK(14, 11) 51 #define RX_MPDU_START_INFO2_TID GENMASK(18, 15) 52 53 #define RX_MPDU_START_INFO3_RXPCU_MPDU_FLTR GENMASK(1, 0) 54 #define RX_MPDU_START_INFO3_SW_FRAME_GRP_ID GENMASK(8, 2) 55 #define RX_MPDU_START_INFO3_NDP_FRAME BIT(9) 56 #define RX_MPDU_START_INFO3_PHY_ERR BIT(10) 57 #define RX_MPDU_START_INFO3_PHY_ERR_MPDU_HDR BIT(11) 58 #define RX_MPDU_START_INFO3_PROTO_VER_ERR BIT(12) 59 #define RX_MPDU_START_INFO3_AST_LOOKUP_VALID BIT(13) 60 #define RX_MPDU_START_INFO3_RANGING BIT(14) 61 62 #define RX_MPDU_START_INFO4_MPDU_FCTRL_VALID BIT(0) 63 #define RX_MPDU_START_INFO4_MPDU_DUR_VALID BIT(1) 64 #define RX_MPDU_START_INFO4_MAC_ADDR1_VALID BIT(2) 65 #define RX_MPDU_START_INFO4_MAC_ADDR2_VALID BIT(3) 66 #define RX_MPDU_START_INFO4_MAC_ADDR3_VALID BIT(4) 67 #define RX_MPDU_START_INFO4_MAC_ADDR4_VALID BIT(5) 68 #define RX_MPDU_START_INFO4_MPDU_SEQ_CTRL_VALID BIT(6) 69 #define RX_MPDU_START_INFO4_MPDU_QOS_CTRL_VALID BIT(7) 70 #define RX_MPDU_START_INFO4_MPDU_HT_CTRL_VALID BIT(8) 71 #define RX_MPDU_START_INFO4_ENCRYPT_INFO_VALID BIT(9) 72 #define RX_MPDU_START_INFO4_MPDU_FRAG_NUMBER GENMASK(13, 10) 73 #define RX_MPDU_START_INFO4_MORE_FRAG_FLAG BIT(14) 74 #define RX_MPDU_START_INFO4_FROM_DS BIT(16) 75 #define RX_MPDU_START_INFO4_TO_DS BIT(17) 76 #define RX_MPDU_START_INFO4_ENCRYPTED BIT(18) 77 #define RX_MPDU_START_INFO4_MPDU_RETRY BIT(19) 78 #define RX_MPDU_START_INFO4_MPDU_SEQ_NUM GENMASK(31, 20) 79 80 #define RX_MPDU_START_INFO5_KEY_ID GENMASK(7, 0) 81 #define RX_MPDU_START_INFO5_NEW_PEER_ENTRY BIT(8) 82 #define RX_MPDU_START_INFO5_DECRYPT_NEEDED BIT(9) 83 #define RX_MPDU_START_INFO5_DECAP_TYPE GENMASK(11, 10) 84 #define RX_MPDU_START_INFO5_VLAN_TAG_C_PADDING BIT(12) 85 #define RX_MPDU_START_INFO5_VLAN_TAG_S_PADDING BIT(13) 86 #define RX_MPDU_START_INFO5_STRIP_VLAN_TAG_C BIT(14) 87 #define RX_MPDU_START_INFO5_STRIP_VLAN_TAG_S BIT(15) 88 #define RX_MPDU_START_INFO5_PRE_DELIM_COUNT GENMASK(27, 16) 89 #define RX_MPDU_START_INFO5_AMPDU_FLAG BIT(28) 90 #define RX_MPDU_START_INFO5_BAR_FRAME BIT(29) 91 #define RX_MPDU_START_INFO5_RAW_MPDU BIT(30) 92 93 #define RX_MPDU_START_INFO6_MPDU_LEN GENMASK(13, 0) 94 #define RX_MPDU_START_INFO6_FIRST_MPDU BIT(14) 95 #define RX_MPDU_START_INFO6_MCAST_BCAST BIT(15) 96 #define RX_MPDU_START_INFO6_AST_IDX_NOT_FOUND BIT(16) 97 #define RX_MPDU_START_INFO6_AST_IDX_TIMEOUT BIT(17) 98 #define RX_MPDU_START_INFO6_POWER_MGMT BIT(18) 99 #define RX_MPDU_START_INFO6_NON_QOS BIT(19) 100 #define RX_MPDU_START_INFO6_NULL_DATA BIT(20) 101 #define RX_MPDU_START_INFO6_MGMT_TYPE BIT(21) 102 #define RX_MPDU_START_INFO6_CTRL_TYPE BIT(22) 103 #define RX_MPDU_START_INFO6_MORE_DATA BIT(23) 104 #define RX_MPDU_START_INFO6_EOSP BIT(24) 105 #define RX_MPDU_START_INFO6_FRAGMENT BIT(25) 106 #define RX_MPDU_START_INFO6_ORDER BIT(26) 107 #define RX_MPDU_START_INFO6_UAPSD_TRIGGER BIT(27) 108 #define RX_MPDU_START_INFO6_ENCRYPT_REQUIRED BIT(28) 109 #define RX_MPDU_START_INFO6_DIRECTED BIT(29) 110 #define RX_MPDU_START_INFO6_AMSDU_PRESENT BIT(30) 111 112 #define RX_MPDU_START_INFO7_VDEV_ID GENMASK(7, 0) 113 #define RX_MPDU_START_INFO7_SERVICE_CODE GENMASK(16, 8) 114 #define RX_MPDU_START_INFO7_PRIORITY_VALID BIT(17) 115 #define RX_MPDU_START_INFO7_SRC_INFO GENMASK(29, 18) 116 117 #define RX_MPDU_START_INFO8_AUTH_TO_SEND_WDS BIT(0) 118 119 struct rx_mpdu_start_qcn9274 { 120 __le32 info0; 121 __le32 reo_queue_desc_lo; 122 __le32 info1; 123 __le32 pn[4]; 124 __le32 info2; 125 __le32 peer_meta_data; 126 __le16 info3; 127 __le16 phy_ppdu_id; 128 __le16 ast_index; 129 __le16 sw_peer_id; 130 __le32 info4; 131 __le32 info5; 132 __le32 info6; 133 __le16 frame_ctrl; 134 __le16 duration; 135 u8 addr1[ETH_ALEN]; 136 u8 addr2[ETH_ALEN]; 137 u8 addr3[ETH_ALEN]; 138 __le16 seq_ctrl; 139 u8 addr4[ETH_ALEN]; 140 __le16 qos_ctrl; 141 __le32 ht_ctrl; 142 __le32 info7; 143 u8 multi_link_addr1[ETH_ALEN]; 144 u8 multi_link_addr2[ETH_ALEN]; 145 __le32 info8; 146 __le32 res0; 147 __le32 res1; 148 } __packed; 149 150 /* rx_mpdu_start 151 * 152 * reo_destination_indication 153 * The id of the reo exit ring where the msdu frame shall push 154 * after (MPDU level) reordering has finished. Values are defined 155 * in enum %HAL_RX_MSDU_DESC_REO_DEST_IND_. 156 * 157 * lmac_peer_id_msb 158 * 159 * If use_flow_id_toeplitz_clfy is set and lmac_peer_id_'sb 160 * is 2'b00, Rx OLE uses a REO destination indicati'n of {1'b1, 161 * hash[3:0]} using the chosen Toeplitz hash from Common Parser 162 * if flow search fails. 163 * If use_flow_id_toeplitz_clfy is set and lmac_peer_id_msb 164 * 's not 2'b00, Rx OLE uses a REO destination indication of 165 * {lmac_peer_id_msb, hash[2:0]} using the chosen Toeplitz 166 * hash from Common Parser if flow search fails. 167 * 168 * use_flow_id_toeplitz_clfy 169 * Indication to Rx OLE to enable REO destination routing based 170 * on the chosen Toeplitz hash from Common Parser, in case 171 * flow search fails 172 * 173 * pkt_selection_fp_ucast_data 174 * Filter pass Unicast data frame (matching rxpcu_filter_pass 175 * and sw_frame_group_Unicast_data) routing selection 176 * 177 * pkt_selection_fp_mcast_data 178 * Filter pass Multicast data frame (matching rxpcu_filter_pass 179 * and sw_frame_group_Multicast_data) routing selection 180 * 181 * pkt_selection_fp_ctrl_bar 182 * Filter pass BAR frame (matching rxpcu_filter_pass 183 * and sw_frame_group_ctrl_1000) routing selection 184 * 185 * rxdma0_src_ring_selection 186 * Field only valid when for the received frame type the corresponding 187 * pkt_selection_fp_... bit is set 188 * 189 * rxdma0_dst_ring_selection 190 * Field only valid when for the received frame type the corresponding 191 * pkt_selection_fp_... bit is set 192 * 193 * mcast_echo_drop_enable 194 * If set, for multicast packets, multicast echo check (i.e. 195 * SA search with mcast_echo_check = 1) shall be performed 196 * by RXOLE, and any multicast echo packets should be indicated 197 * to RXDMA for release to WBM 198 * 199 * wds_learning_detect_en 200 * If set, WDS learning detection based on SA search and notification 201 * to FW (using RXDMA0 status ring) is enabled and the "timestamp" 202 * field in address search failure cache-only entry should 203 * be used to avoid multiple WDS learning notifications. 204 * 205 * intrabss_check_en 206 * If set, intra-BSS routing detection is enabled 207 * 208 * use_ppe 209 * Indicates to RXDMA to ignore the REO_destination_indication 210 * and use a programmed value corresponding to the REO2PPE 211 * ring 212 * This override to REO2PPE for packets requiring multiple 213 * buffers shall be disabled based on an RXDMA configuration, 214 * as PPE may not support such packets. 215 * 216 * Supported only in full AP chips, not in client/soft 217 * chips 218 * 219 * ppe_routing_enable 220 * Global enable/disable bit for routing to PPE, used to disable 221 * PPE routing even if RXOLE CCE or flow search indicate 'Use_PPE' 222 * This is set by SW for peers which are being handled by a 223 * host SW/accelerator subsystem that also handles packet 224 * uffer management for WiFi-to-PPE routing. 225 * 226 * This is cleared by SW for peers which are being handled 227 * by a different subsystem, completely disabling WiFi-to-PPE 228 * routing for such peers. 229 * 230 * rx_reo_queue_desc_addr_lo 231 * Address (lower 32 bits) of the REO queue descriptor. 232 * 233 * rx_reo_queue_desc_addr_hi 234 * Address (upper 8 bits) of the REO queue descriptor. 235 * 236 * receive_queue_number 237 * Indicates the MPDU queue ID to which this MPDU link 238 * descriptor belongs. 239 * 240 * pre_delim_err_warning 241 * Indicates that a delimiter FCS error was found in between the 242 * previous MPDU and this MPDU. Note that this is just a warning, 243 * and does not mean that this MPDU is corrupted in any way. If 244 * it is, there will be other errors indicated such as FCS or 245 * decrypt errors. 246 * 247 * first_delim_err 248 * Indicates that the first delimiter had a FCS failure. 249 * 250 * pn 251 * The PN number. 252 * 253 * epd_en 254 * Field only valid when AST_based_lookup_valid == 1. 255 * In case of ndp or phy_err or AST_based_lookup_valid == 0, 256 * this field will be set to 0 257 * If set to one use EPD instead of LPD 258 * In case of ndp or phy_err, this field will never be set. 259 * 260 * all_frames_shall_be_encrypted 261 * In case of ndp or phy_err or AST_based_lookup_valid == 0, 262 * this field will be set to 0 263 * 264 * When set, all frames (data only ?) shall be encrypted. If 265 * not, RX CRYPTO shall set an error flag. 266 * 267 * 268 * encrypt_type 269 * In case of ndp or phy_err or AST_based_lookup_valid == 0, 270 * this field will be set to 0 271 * 272 * Indicates type of decrypt cipher used (as defined in the 273 * peer entry) 274 * 275 * wep_key_width_for_variable_key 276 * 277 * Field only valid when key_type is set to wep_varied_width. 278 * 279 * mesh_sta 280 * 281 * bssid_hit 282 * When set, the BSSID of the incoming frame matched one of 283 * the 8 BSSID register values 284 * bssid_number 285 * Field only valid when bssid_hit is set. 286 * This number indicates which one out of the 8 BSSID register 287 * values matched the incoming frame 288 * 289 * tid 290 * Field only valid when mpdu_qos_control_valid is set 291 * The TID field in the QoS control field 292 * 293 * peer_meta_data 294 * Meta data that SW has programmed in the Peer table entry 295 * of the transmitting STA. 296 * 297 * rxpcu_mpdu_filter_in_category 298 * Field indicates what the reason was that this mpdu frame 299 * was allowed to come into the receive path by rxpcu. Values 300 * are defined in enum %RX_DESC_RXPCU_FILTER_*. 301 * 302 * sw_frame_group_id 303 * SW processes frames based on certain classifications. Values 304 * are defined in enum %RX_DESC_SW_FRAME_GRP_ID_*. 305 * 306 * ndp_frame 307 * When set, the received frame was an NDP frame, and thus 308 * there will be no MPDU data. 309 * phy_err 310 * When set, a PHY error was received before MAC received any 311 * data, and thus there will be no MPDU data. 312 * 313 * phy_err_during_mpdu_header 314 * When set, a PHY error was received before MAC received the 315 * complete MPDU header which was needed for proper decoding 316 * 317 * protocol_version_err 318 * Set when RXPCU detected a version error in the Frame control 319 * field 320 * 321 * ast_based_lookup_valid 322 * When set, AST based lookup for this frame has found a valid 323 * result. 324 * 325 * ranging 326 * When set, a ranging NDPA or a ranging NDP was received. 327 * 328 * phy_ppdu_id 329 * A ppdu counter value that PHY increments for every PPDU 330 * received. The counter value wraps around. 331 * 332 * ast_index 333 * 334 * This field indicates the index of the AST entry corresponding 335 * to this MPDU. It is provided by the GSE module instantiated 336 * in RXPCU. 337 * A value of 0xFFFF indicates an invalid AST index, meaning 338 * that No AST entry was found or NO AST search was performed 339 * 340 * sw_peer_id 341 * In case of ndp or phy_err or AST_based_lookup_valid == 0, 342 * this field will be set to 0 343 * This field indicates a unique peer identifier. It is set 344 * equal to field 'sw_peer_id' from the AST entry 345 * 346 * frame_control_valid 347 * When set, the field Mpdu_Frame_control_field has valid information 348 * 349 * frame_duration_valid 350 * When set, the field Mpdu_duration_field has valid information 351 * 352 * mac_addr_ad1..4_valid 353 * When set, the fields mac_addr_adx_..... have valid information 354 * 355 * mpdu_seq_ctrl_valid 356 * 357 * When set, the fields mpdu_sequence_control_field and mpdu_sequence_number 358 * have valid information as well as field 359 * For MPDUs without a sequence control field, this field will 360 * not be set. 361 * 362 * mpdu_qos_ctrl_valid, mpdu_ht_ctrl_valid 363 * 364 * When set, the field mpdu_qos_control_field, mpdu_ht_control has valid 365 * information, For MPDUs without a QoS,HT control field, this field 366 * will not be set. 367 * 368 * frame_encryption_info_valid 369 * 370 * When set, the encryption related info fields, like IV and 371 * PN are valid 372 * For MPDUs that are not encrypted, this will not be set. 373 * 374 * mpdu_fragment_number 375 * 376 * Field only valid when Mpdu_sequence_control_valid is set 377 * AND Fragment_flag is set. The fragment number from the 802.11 header 378 * 379 * more_fragment_flag 380 * 381 * The More Fragment bit setting from the MPDU header of the 382 * received frame 383 * 384 * fr_ds 385 * 386 * Field only valid when Mpdu_frame_control_valid is set 387 * Set if the from DS bit is set in the frame control. 388 * 389 * to_ds 390 * 391 * Field only valid when Mpdu_frame_control_valid is set 392 * Set if the to DS bit is set in the frame control. 393 * 394 * encrypted 395 * 396 * Field only valid when Mpdu_frame_control_valid is set. 397 * Protected bit from the frame control. 398 * 399 * mpdu_retry 400 * Field only valid when Mpdu_frame_control_valid is set. 401 * Retry bit from the frame control. Only valid when first_msdu is set 402 * 403 * mpdu_sequence_number 404 * Field only valid when Mpdu_sequence_control_valid is set. 405 * 406 * The sequence number from the 802.11 header. 407 * key_id 408 * The key ID octet from the IV. 409 * Field only valid when Frame_encryption_info_valid is set 410 * 411 * new_peer_entry 412 * Set if new RX_PEER_ENTRY TLV follows. If clear, RX_PEER_ENTRY 413 * doesn't follow so RX DECRYPTION module either uses old peer 414 * entry or not decrypt. 415 * 416 * decrypt_needed 417 * When RXPCU sets bit 'ast_index_not_found or ast_index_timeout', 418 * RXPCU will also ensure that this bit is NOT set. CRYPTO for that 419 * reason only needs to evaluate this bit and non of the other ones 420 * 421 * decap_type 422 * Used by the OLE during decapsulation. Values are defined in 423 * enum %MPDU_START_DECAP_TYPE_*. 424 * 425 * rx_insert_vlan_c_tag_padding 426 * rx_insert_vlan_s_tag_padding 427 * Insert 4 byte of all zeros as VLAN tag or double VLAN tag if 428 * the rx payload does not have VLAN. 429 * 430 * strip_vlan_c_tag_decap 431 * strip_vlan_s_tag_decap 432 * Strip VLAN or double VLAN during decapsulation. 433 * 434 * pre_delim_count 435 * The number of delimiters before this MPDU. Note that this 436 * number is cleared at PPDU start. If this MPDU is the first 437 * received MPDU in the PPDU and this MPDU gets filtered-in, 438 * this field will indicate the number of delimiters located 439 * after the last MPDU in the previous PPDU. 440 * 441 * If this MPDU is located after the first received MPDU in 442 * an PPDU, this field will indicate the number of delimiters 443 * located between the previous MPDU and this MPDU. 444 * 445 * ampdu_flag 446 * Received frame was part of an A-MPDU. 447 * 448 * bar_frame 449 * Received frame is a BAR frame 450 * 451 * raw_mpdu 452 * Set when no 802.11 to nwifi/ethernet hdr conversion is done 453 * 454 * mpdu_length 455 * MPDU length before decapsulation. 456 * 457 * first_mpdu 458 * Indicates the first MSDU of the PPDU. If both first_mpdu 459 * and last_mpdu are set in the MSDU then this is a not an 460 * A-MPDU frame but a stand alone MPDU. Interior MPDU in an 461 * A-MPDU shall have both first_mpdu and last_mpdu bits set to 462 * 0. The PPDU start status will only be valid when this bit 463 * is set. 464 * 465 * mcast_bcast 466 * Multicast / broadcast indicator. Only set when the MAC 467 * address 1 bit 0 is set indicating mcast/bcast and the BSSID 468 * matches one of the 4 BSSID registers. Only set when 469 * first_msdu is set. 470 * 471 * ast_index_not_found 472 * Only valid when first_msdu is set. Indicates no AST matching 473 * entries within the max search count. 474 * 475 * ast_index_timeout 476 * Only valid when first_msdu is set. Indicates an unsuccessful 477 * search in the address search table due to timeout. 478 * 479 * power_mgmt 480 * Power management bit set in the 802.11 header. Only set 481 * when first_msdu is set. 482 * 483 * non_qos 484 * Set if packet is not a non-QoS data frame. Only set when 485 * first_msdu is set. 486 * 487 * null_data 488 * Set if frame type indicates either null data or QoS null 489 * data format. Only set when first_msdu is set. 490 * 491 * mgmt_type 492 * Set if packet is a management packet. Only set when 493 * first_msdu is set. 494 * 495 * ctrl_type 496 * Set if packet is a control packet. Only set when first_msdu 497 * is set. 498 * 499 * more_data 500 * Set if more bit in frame control is set. Only set when 501 * first_msdu is set. 502 * 503 * eosp 504 * Set if the EOSP (end of service period) bit in the QoS 505 * control field is set. Only set when first_msdu is set. 506 * 507 * 508 * fragment_flag 509 * Fragment indication 510 * 511 * order 512 * Set if the order bit in the frame control is set. Only 513 * set when first_msdu is set. 514 * 515 * u_apsd_trigger 516 * U-APSD trigger frame 517 * 518 * encrypt_required 519 * Indicates that this data type frame is not encrypted even if 520 * the policy for this MPDU requires encryption as indicated in 521 * the peer table key type. 522 * 523 * directed 524 * MPDU is a directed packet which means that the RA matched 525 * our STA addresses. In proxySTA it means that the TA matched 526 * an entry in our address search table with the corresponding 527 * 'no_ack' bit is the address search entry cleared. 528 * amsdu_present 529 * AMSDU present 530 * 531 * mpdu_frame_control_field 532 * Frame control field in header. Only valid when the field is marked valid. 533 * 534 * mpdu_duration_field 535 * Duration field in header. Only valid when the field is marked valid. 536 * 537 * mac_addr_adx 538 * MAC addresses in the received frame. Only valid when corresponding 539 * address valid bit is set 540 * 541 * mpdu_qos_control_field, mpdu_ht_control_field 542 * QoS/HT control fields from header. Valid only when corresponding fields 543 * are marked valid 544 * 545 * vdev_id 546 * Virtual device associated with this peer 547 * RXOLE uses this to determine intra-BSS routing. 548 * 549 * service_code 550 * Opaque service code between PPE and Wi-Fi 551 * This field gets passed on by REO to PPE in the EDMA descriptor 552 * ('REO_TO_PPE_RING'). 553 * 554 * priority_valid 555 * This field gets passed on by REO to PPE in the EDMA descriptor 556 * ('REO_TO_PPE_RING'). 557 * 558 * src_info 559 * Source (virtual) device/interface info. associated with 560 * this peer 561 * This field gets passed on by REO to PPE in the EDMA descriptor 562 * ('REO_TO_PPE_RING'). 563 * 564 * multi_link_addr_ad1_ad2_valid 565 * If set, Rx OLE shall convert Address1 and Address2 of received 566 * data frames to multi-link addresses during decapsulation to eth/nwifi 567 * 568 * multi_link_addr_ad1,ad2 569 * Multi-link receiver address1,2. Only valid when corresponding 570 * valid bit is set 571 * 572 * authorize_to_send_wds 573 * If not set, RXDMA shall perform error-routing for WDS packets 574 * as the sender is not authorized and might misuse WDS frame 575 * format to inject packets with arbitrary DA/SA. 576 * 577 */ 578 579 enum rx_msdu_start_pkt_type { 580 RX_MSDU_START_PKT_TYPE_11A, 581 RX_MSDU_START_PKT_TYPE_11B, 582 RX_MSDU_START_PKT_TYPE_11N, 583 RX_MSDU_START_PKT_TYPE_11AC, 584 RX_MSDU_START_PKT_TYPE_11AX, 585 }; 586 587 enum rx_msdu_start_sgi { 588 RX_MSDU_START_SGI_0_8_US, 589 RX_MSDU_START_SGI_0_4_US, 590 RX_MSDU_START_SGI_1_6_US, 591 RX_MSDU_START_SGI_3_2_US, 592 }; 593 594 enum rx_msdu_start_recv_bw { 595 RX_MSDU_START_RECV_BW_20MHZ, 596 RX_MSDU_START_RECV_BW_40MHZ, 597 RX_MSDU_START_RECV_BW_80MHZ, 598 RX_MSDU_START_RECV_BW_160MHZ, 599 }; 600 601 enum rx_msdu_start_reception_type { 602 RX_MSDU_START_RECEPTION_TYPE_SU, 603 RX_MSDU_START_RECEPTION_TYPE_DL_MU_MIMO, 604 RX_MSDU_START_RECEPTION_TYPE_DL_MU_OFDMA, 605 RX_MSDU_START_RECEPTION_TYPE_DL_MU_OFDMA_MIMO, 606 RX_MSDU_START_RECEPTION_TYPE_UL_MU_MIMO, 607 RX_MSDU_START_RECEPTION_TYPE_UL_MU_OFDMA, 608 RX_MSDU_START_RECEPTION_TYPE_UL_MU_OFDMA_MIMO, 609 }; 610 611 #define RX_MSDU_END_INFO0_RXPCU_MPDU_FITLER GENMASK(1, 0) 612 #define RX_MSDU_END_INFO0_SW_FRAME_GRP_ID GENMASK(8, 2) 613 614 #define RX_MSDU_END_INFO1_REPORTED_MPDU_LENGTH GENMASK(13, 0) 615 616 #define RX_MSDU_END_INFO2_CCE_SUPER_RULE GENMASK(13, 8) 617 #define RX_MSDU_END_INFO2_CCND_TRUNCATE BIT(14) 618 #define RX_MSDU_END_INFO2_CCND_CCE_DIS BIT(15) 619 620 #define RX_MSDU_END_INFO3_DA_OFFSET GENMASK(5, 0) 621 #define RX_MSDU_END_INFO3_SA_OFFSET GENMASK(11, 6) 622 #define RX_MSDU_END_INFO3_DA_OFFSET_VALID BIT(12) 623 #define RX_MSDU_END_INFO3_SA_OFFSET_VALID BIT(13) 624 625 #define RX_MSDU_END_INFO4_TCP_FLAG GENMASK(8, 0) 626 #define RX_MSDU_END_INFO4_LRO_ELIGIBLE BIT(9) 627 628 #define RX_MSDU_END_INFO5_SA_IDX_TIMEOUT BIT(0) 629 #define RX_MSDU_END_INFO5_DA_IDX_TIMEOUT BIT(1) 630 #define RX_MSDU_END_INFO5_TO_DS BIT(2) 631 #define RX_MSDU_END_INFO5_TID GENMASK(6, 3) 632 #define RX_MSDU_END_INFO5_SA_IS_VALID BIT(7) 633 #define RX_MSDU_END_INFO5_DA_IS_VALID BIT(8) 634 #define RX_MSDU_END_INFO5_DA_IS_MCBC BIT(9) 635 #define RX_MSDU_END_INFO5_L3_HDR_PADDING GENMASK(11, 10) 636 #define RX_MSDU_END_INFO5_FIRST_MSDU BIT(12) 637 #define RX_MSDU_END_INFO5_LAST_MSDU BIT(13) 638 #define RX_MSDU_END_INFO5_FROM_DS BIT(14) 639 #define RX_MSDU_END_INFO5_IP_CHKSUM_FAIL_COPY BIT(15) 640 641 #define RX_MSDU_END_INFO6_MSDU_DROP BIT(0) 642 #define RX_MSDU_END_INFO6_REO_DEST_IND GENMASK(5, 1) 643 #define RX_MSDU_END_INFO6_FLOW_IDX GENMASK(25, 6) 644 #define RX_MSDU_END_INFO6_USE_PPE BIT(26) 645 #define RX_MSDU_END_INFO6_MESH_STA GENMASK(28, 27) 646 #define RX_MSDU_END_INFO6_VLAN_CTAG_STRIPPED BIT(29) 647 #define RX_MSDU_END_INFO6_VLAN_STAG_STRIPPED BIT(30) 648 #define RX_MSDU_END_INFO6_FRAGMENT_FLAG BIT(31) 649 650 #define RX_MSDU_END_INFO7_AGGR_COUNT GENMASK(7, 0) 651 #define RX_MSDU_END_INFO7_FLOW_AGGR_CONTN BIT(8) 652 #define RX_MSDU_END_INFO7_FISA_TIMEOUT BIT(9) 653 #define RX_MSDU_END_INFO7_TCPUDP_CSUM_FAIL_CPY BIT(10) 654 #define RX_MSDU_END_INFO7_MSDU_LIMIT_ERROR BIT(11) 655 #define RX_MSDU_END_INFO7_FLOW_IDX_TIMEOUT BIT(12) 656 #define RX_MSDU_END_INFO7_FLOW_IDX_INVALID BIT(13) 657 #define RX_MSDU_END_INFO7_CCE_MATCH BIT(14) 658 #define RX_MSDU_END_INFO7_AMSDU_PARSER_ERR BIT(15) 659 660 #define RX_MSDU_END_INFO8_KEY_ID GENMASK(7, 0) 661 662 #define RX_MSDU_END_INFO9_SERVICE_CODE GENMASK(14, 6) 663 #define RX_MSDU_END_INFO9_PRIORITY_VALID BIT(15) 664 #define RX_MSDU_END_INFO9_INRA_BSS BIT(16) 665 #define RX_MSDU_END_INFO9_DEST_CHIP_ID GENMASK(18, 17) 666 #define RX_MSDU_END_INFO9_MCAST_ECHO BIT(19) 667 #define RX_MSDU_END_INFO9_WDS_LEARN_EVENT BIT(20) 668 #define RX_MSDU_END_INFO9_WDS_ROAM_EVENT BIT(21) 669 #define RX_MSDU_END_INFO9_WDS_KEEP_ALIVE_EVENT BIT(22) 670 671 #define RX_MSDU_END_INFO10_MSDU_LENGTH GENMASK(13, 0) 672 #define RX_MSDU_END_INFO10_STBC BIT(14) 673 #define RX_MSDU_END_INFO10_IPSEC_ESP BIT(15) 674 #define RX_MSDU_END_INFO10_L3_OFFSET GENMASK(22, 16) 675 #define RX_MSDU_END_INFO10_IPSEC_AH BIT(23) 676 #define RX_MSDU_END_INFO10_L4_OFFSET GENMASK(31, 24) 677 678 #define RX_MSDU_END_INFO11_MSDU_NUMBER GENMASK(7, 0) 679 #define RX_MSDU_END_INFO11_DECAP_FORMAT GENMASK(9, 8) 680 #define RX_MSDU_END_INFO11_IPV4 BIT(10) 681 #define RX_MSDU_END_INFO11_IPV6 BIT(11) 682 #define RX_MSDU_END_INFO11_TCP BIT(12) 683 #define RX_MSDU_END_INFO11_UDP BIT(13) 684 #define RX_MSDU_END_INFO11_IP_FRAG BIT(14) 685 #define RX_MSDU_END_INFO11_TCP_ONLY_ACK BIT(15) 686 #define RX_MSDU_END_INFO11_DA_IS_BCAST_MCAST BIT(16) 687 #define RX_MSDU_END_INFO11_SEL_TOEPLITZ_HASH GENMASK(18, 17) 688 #define RX_MSDU_END_INFO11_IP_FIXED_HDR_VALID BIT(19) 689 #define RX_MSDU_END_INFO11_IP_EXTN_HDR_VALID BIT(20) 690 #define RX_MSDU_END_INFO11_IP_TCP_UDP_HDR_VALID BIT(21) 691 #define RX_MSDU_END_INFO11_MESH_CTRL_PRESENT BIT(22) 692 #define RX_MSDU_END_INFO11_LDPC BIT(23) 693 #define RX_MSDU_END_INFO11_IP4_IP6_NXT_HDR GENMASK(31, 24) 694 695 #define RX_MSDU_END_INFO12_USER_RSSI GENMASK(7, 0) 696 #define RX_MSDU_END_INFO12_PKT_TYPE GENMASK(11, 8) 697 #define RX_MSDU_END_INFO12_SGI GENMASK(13, 12) 698 #define RX_MSDU_END_INFO12_RATE_MCS GENMASK(17, 14) 699 #define RX_MSDU_END_INFO12_RECV_BW GENMASK(20, 18) 700 #define RX_MSDU_END_INFO12_RECEPTION_TYPE GENMASK(23, 21) 701 #define RX_MSDU_END_INFO12_MIMO_SS_BITMAP GENMASK(30, 24) 702 #define RX_MSDU_END_INFO12_MIMO_DONE_COPY BIT(31) 703 704 #define RX_MSDU_END_INFO13_FIRST_MPDU BIT(0) 705 #define RX_MSDU_END_INFO13_MCAST_BCAST BIT(2) 706 #define RX_MSDU_END_INFO13_AST_IDX_NOT_FOUND BIT(3) 707 #define RX_MSDU_END_INFO13_AST_IDX_TIMEDOUT BIT(4) 708 #define RX_MSDU_END_INFO13_POWER_MGMT BIT(5) 709 #define RX_MSDU_END_INFO13_NON_QOS BIT(6) 710 #define RX_MSDU_END_INFO13_NULL_DATA BIT(7) 711 #define RX_MSDU_END_INFO13_MGMT_TYPE BIT(8) 712 #define RX_MSDU_END_INFO13_CTRL_TYPE BIT(9) 713 #define RX_MSDU_END_INFO13_MORE_DATA BIT(10) 714 #define RX_MSDU_END_INFO13_EOSP BIT(11) 715 #define RX_MSDU_END_INFO13_A_MSDU_ERROR BIT(12) 716 #define RX_MSDU_END_INFO13_ORDER BIT(14) 717 #define RX_MSDU_END_INFO13_WIFI_PARSER_ERR BIT(15) 718 #define RX_MSDU_END_INFO13_OVERFLOW_ERR BIT(16) 719 #define RX_MSDU_END_INFO13_MSDU_LEN_ERR BIT(17) 720 #define RX_MSDU_END_INFO13_TCP_UDP_CKSUM_FAIL BIT(18) 721 #define RX_MSDU_END_INFO13_IP_CKSUM_FAIL BIT(19) 722 #define RX_MSDU_END_INFO13_SA_IDX_INVALID BIT(20) 723 #define RX_MSDU_END_INFO13_DA_IDX_INVALID BIT(21) 724 #define RX_MSDU_END_INFO13_AMSDU_ADDR_MISMATCH BIT(22) 725 #define RX_MSDU_END_INFO13_RX_IN_TX_DECRYPT_BYP BIT(23) 726 #define RX_MSDU_END_INFO13_ENCRYPT_REQUIRED BIT(24) 727 #define RX_MSDU_END_INFO13_DIRECTED BIT(25) 728 #define RX_MSDU_END_INFO13_BUFFER_FRAGMENT BIT(26) 729 #define RX_MSDU_END_INFO13_MPDU_LEN_ERR BIT(27) 730 #define RX_MSDU_END_INFO13_TKIP_MIC_ERR BIT(28) 731 #define RX_MSDU_END_INFO13_DECRYPT_ERR BIT(29) 732 #define RX_MSDU_END_INFO13_UNDECRYPT_FRAME_ERR BIT(30) 733 #define RX_MSDU_END_INFO13_FCS_ERR BIT(31) 734 735 #define RX_MSDU_END_INFO14_DECRYPT_STATUS_CODE GENMASK(12, 10) 736 #define RX_MSDU_END_INFO14_RX_BITMAP_NOT_UPDED BIT(13) 737 #define RX_MSDU_END_INFO14_MSDU_DONE BIT(31) 738 739 struct rx_msdu_end_qcn9274 { 740 __le16 info0; 741 __le16 phy_ppdu_id; 742 __le16 ip_hdr_cksum; 743 __le16 info1; 744 __le16 info2; 745 __le16 cumulative_l3_checksum; 746 __le32 rule_indication0; 747 __le32 ipv6_options_crc; 748 __le16 info3; 749 __le16 l3_type; 750 __le32 rule_indication1; 751 __le32 tcp_seq_num; 752 __le32 tcp_ack_num; 753 __le16 info4; 754 __le16 window_size; 755 __le16 sa_sw_peer_id; 756 __le16 info5; 757 __le16 sa_idx; 758 __le16 da_idx_or_sw_peer_id; 759 __le32 info6; 760 __le32 fse_metadata; 761 __le16 cce_metadata; 762 __le16 tcp_udp_cksum; 763 __le16 info7; 764 __le16 cumulative_ip_length; 765 __le32 info8; 766 __le32 info9; 767 __le32 info10; 768 __le32 info11; 769 __le16 vlan_ctag_ci; 770 __le16 vlan_stag_ci; 771 __le32 peer_meta_data; 772 __le32 info12; 773 __le32 flow_id_toeplitz; 774 __le32 ppdu_start_timestamp_63_32; 775 __le32 phy_meta_data; 776 __le32 ppdu_start_timestamp_31_0; 777 __le32 toeplitz_hash_2_or_4; 778 __le16 res0; 779 __le16 sa_15_0; 780 __le32 sa_47_16; 781 __le32 info13; 782 __le32 info14; 783 } __packed; 784 785 /* rx_msdu_end 786 * 787 * rxpcu_mpdu_filter_in_category 788 * Field indicates what the reason was that this mpdu frame 789 * was allowed to come into the receive path by rxpcu. Values 790 * are defined in enum %RX_DESC_RXPCU_FILTER_*. 791 * 792 * sw_frame_group_id 793 * SW processes frames based on certain classifications. Values 794 * are defined in enum %RX_DESC_SW_FRAME_GRP_ID_*. 795 * 796 * phy_ppdu_id 797 * A ppdu counter value that PHY increments for every PPDU 798 * received. The counter value wraps around. 799 * 800 * ip_hdr_cksum 801 * This can include the IP header checksum or the pseudo 802 * header checksum used by TCP/UDP checksum. 803 * 804 * reported_mpdu_length 805 * MPDU length before decapsulation. Only valid when first_msdu is 806 * set. This field is taken directly from the length field of the 807 * A-MPDU delimiter or the preamble length field for non-A-MPDU 808 * frames. 809 * 810 * cce_super_rule 811 * Indicates the super filter rule. 812 * 813 * cce_classify_not_done_truncate 814 * Classification failed due to truncated frame. 815 * 816 * cce_classify_not_done_cce_dis 817 * Classification failed due to CCE global disable 818 * 819 * cumulative_l3_checksum 820 * FISA: IP header checksum including the total MSDU length 821 * that is part of this flow aggregated so far, reported if 822 * 'RXOLE_R0_FISA_CTRL. CHKSUM_CUM_IP_LEN_EN' is set 823 * 824 * rule_indication 825 * Bitmap indicating which of rules have matched. 826 * 827 * ipv6_options_crc 828 * 32 bit CRC computed out of IP v6 extension headers. 829 * 830 * da_offset 831 * Offset into MSDU buffer for DA. 832 * 833 * sa_offset 834 * Offset into MSDU buffer for SA. 835 * 836 * da_offset_valid 837 * da_offset field is valid. This will be set to 0 in case 838 * of a dynamic A-MSDU when DA is compressed. 839 * 840 * sa_offset_valid 841 * sa_offset field is valid. This will be set to 0 in case 842 * of a dynamic A-MSDU when SA is compressed. 843 * 844 * l3_type 845 * The 16-bit type value indicating the type of L3 later 846 * extracted from LLC/SNAP, set to zero if SNAP is not 847 * available. 848 * 849 * tcp_seq_number 850 * TCP sequence number. 851 * 852 * tcp_ack_number 853 * TCP acknowledge number. 854 * 855 * tcp_flag 856 * TCP flags {NS, CWR, ECE, URG, ACK, PSH, RST, SYN, FIN}. 857 * 858 * lro_eligible 859 * Computed out of TCP and IP fields to indicate that this 860 * MSDU is eligible for LRO. 861 * 862 * window_size 863 * TCP receive window size. 864 * 865 * sa_sw_peer_id 866 * sw_peer_id from the address search entry corresponding to the 867 * source address of the MSDU. 868 * 869 * sa_idx_timeout 870 * Indicates an unsuccessful MAC source address search due to the 871 * expiring of the search timer. 872 * 873 * da_idx_timeout 874 * Indicates an unsuccessful MAC destination address search due to 875 * the expiring of the search timer. 876 * 877 * to_ds 878 * Set if the to DS bit is set in the frame control. 879 * 880 * tid 881 * TID field in the QoS control field 882 * 883 * sa_is_valid 884 * Indicates that OLE found a valid SA entry. 885 * 886 * da_is_valid 887 * Indicates that OLE found a valid DA entry. 888 * 889 * da_is_mcbc 890 * Field Only valid if da_is_valid is set. Indicates the DA address 891 * was a Multicast of Broadcast address. 892 * 893 * l3_header_padding 894 * Number of bytes padded to make sure that the L3 header will 895 * always start of a Dword boundary. 896 * 897 * first_msdu 898 * Indicates the first MSDU of A-MSDU. If both first_msdu and 899 * last_msdu are set in the MSDU then this is a non-aggregated MSDU 900 * frame: normal MPDU. Interior MSDU in an A-MSDU shall have both 901 * first_mpdu and last_mpdu bits set to 0. 902 * 903 * last_msdu 904 * Indicates the last MSDU of the A-MSDU. MPDU end status is only 905 * valid when last_msdu is set. 906 * 907 * fr_ds 908 * Set if the from DS bit is set in the frame control. 909 * 910 * ip_chksum_fail_copy 911 * Indicates that the computed checksum did not match the 912 * checksum in the IP header. 913 * 914 * sa_idx 915 * The offset in the address table which matches the MAC source 916 * address. 917 * 918 * da_idx_or_sw_peer_id 919 * Based on a register configuration in RXOLE, this field will 920 * contain: 921 * The offset in the address table which matches the MAC destination 922 * address 923 * OR: 924 * sw_peer_id from the address search entry corresponding to 925 * the destination address of the MSDU 926 * 927 * msdu_drop 928 * REO shall drop this MSDU and not forward it to any other ring. 929 * 930 * The id of the reo exit ring where the msdu frame shall push 931 * after (MPDU level) reordering has finished. Values are defined 932 * in enum %HAL_RX_MSDU_DESC_REO_DEST_IND_. 933 * 934 * flow_idx 935 * Flow table index. 936 * 937 * use_ppe 938 * Indicates to RXDMA to ignore the REO_destination_indication 939 * and use a programmed value corresponding to the REO2PPE 940 * ring 941 * 942 * mesh_sta 943 * When set, this is a Mesh (11s) STA. 944 * 945 * vlan_ctag_stripped 946 * Set by RXOLE if it stripped 4-bytes of C-VLAN Tag from the 947 * packet 948 * 949 * vlan_stag_stripped 950 * Set by RXOLE if it stripped 4-bytes of S-VLAN Tag from the 951 * packet 952 * 953 * fragment_flag 954 * Indicates that this is an 802.11 fragment frame. This is 955 * set when either the more_frag bit is set in the frame control 956 * or the fragment number is not zero. Only set when first_msdu 957 * is set. 958 * 959 * fse_metadata 960 * FSE related meta data. 961 * 962 * cce_metadata 963 * CCE related meta data. 964 * 965 * tcp_udp_chksum 966 * The value of the computed TCP/UDP checksum. A mode bit 967 * selects whether this checksum is the full checksum or the 968 * partial checksum which does not include the pseudo header. 969 * 970 * aggregation_count 971 * Number of MSDU's aggregated so far 972 * 973 * flow_aggregation_continuation 974 * To indicate that this MSDU can be aggregated with 975 * the previous packet with the same flow id 976 * 977 * fisa_timeout 978 * To indicate that the aggregation has restarted for 979 * this flow due to timeout 980 * 981 * tcp_udp_chksum_fail 982 * Indicates that the computed checksum (tcp_udp_chksum) did 983 * not match the checksum in the TCP/UDP header. 984 * 985 * msdu_limit_error 986 * Indicates that the MSDU threshold was exceeded and thus all the 987 * rest of the MSDUs will not be scattered and will not be 988 * decapsulated but will be DMA'ed in RAW format as a single MSDU. 989 * 990 * flow_idx_timeout 991 * Indicates an unsuccessful flow search due to the expiring of 992 * the search timer. 993 * 994 * flow_idx_invalid 995 * flow id is not valid. 996 * 997 * cce_match 998 * Indicates that this status has a corresponding MSDU that 999 * requires FW processing. The OLE will have classification 1000 * ring mask registers which will indicate the ring(s) for 1001 * packets and descriptors which need FW attention. 1002 * 1003 * amsdu_parser_error 1004 * A-MSDU could not be properly de-agregated. 1005 * 1006 * cumulative_ip_length 1007 * Total MSDU length that is part of this flow aggregated 1008 * so far 1009 * 1010 * key_id 1011 * The key ID octet from the IV. Only valid when first_msdu is set. 1012 * 1013 * service_code 1014 * Opaque service code between PPE and Wi-Fi 1015 * 1016 * priority_valid 1017 * This field gets passed on by REO to PPE in the EDMA descriptor 1018 * 1019 * intra_bss 1020 * This packet needs intra-BSS routing by SW as the 'vdev_id' 1021 * for the destination is the same as 'vdev_id' (from 'RX_MPDU_PCU_START') 1022 * that this MSDU was got in. 1023 * 1024 * dest_chip_id 1025 * If intra_bss is set, copied by RXOLE from 'ADDR_SEARCH_ENTRY' 1026 * to support intra-BSS routing with multi-chip multi-link 1027 * operation. This indicates into which chip's TCL the packet should be 1028 * queueued 1029 * 1030 * multicast_echo 1031 * If set, this packet is a multicast echo, i.e. the DA is 1032 * multicast and Rx OLE SA search with mcast_echo_check = 1 1033 * passed. RXDMA should release such packets to WBM. 1034 * 1035 * wds_learning_event 1036 * If set, this packet has an SA search failure with WDS learning 1037 * enabled for the peer. RXOLE should route this TLV to the 1038 * RXDMA0 status ring to notify FW. 1039 * 1040 * wds_roaming_event 1041 * If set, this packet's SA 'Sw_peer_id' mismatches the 'Sw_peer_id' 1042 * of the peer through which the packet was got, indicating 1043 * the SA node has roamed. RXOLE should route this TLV to 1044 * the RXDMA0 status ring to notify FW. 1045 * 1046 * wds_keep_alive_event 1047 * If set, the AST timestamp for this packet's SA is older 1048 * than the current timestamp by more than a threshold programmed 1049 * in RXOLE. RXOLE should route this TLV to the RXDMA0 status 1050 * ring to notify FW to keep the AST entry for the SA alive. 1051 * 1052 * msdu_length 1053 * MSDU length in bytes after decapsulation. 1054 * This field is still valid for MPDU frames without A-MSDU. 1055 * It still represents MSDU length after decapsulation 1056 * 1057 * stbc 1058 * When set, use STBC transmission rates. 1059 * 1060 * ipsec_esp 1061 * Set if IPv4/v6 packet is using IPsec ESP. 1062 * 1063 * l3_offset 1064 * Depending upon mode bit, this field either indicates the 1065 * L3 offset in bytes from the start of the RX_HEADER or the IP 1066 * offset in bytes from the start of the packet after 1067 * decapsulation. The latter is only valid if ipv4_proto or 1068 * ipv6_proto is set. 1069 * 1070 * ipsec_ah 1071 * Set if IPv4/v6 packet is using IPsec AH 1072 * 1073 * l4_offset 1074 * Depending upon mode bit, this field either indicates the 1075 * L4 offset in bytes from the start of RX_HEADER (only valid 1076 * if either ipv4_proto or ipv6_proto is set to 1) or indicates 1077 * the offset in bytes to the start of TCP or UDP header from 1078 * the start of the IP header after decapsulation (Only valid if 1079 * tcp_proto or udp_proto is set). The value 0 indicates that 1080 * the offset is longer than 127 bytes. 1081 * 1082 * msdu_number 1083 * Indicates the MSDU number within a MPDU. This value is 1084 * reset to zero at the start of each MPDU. If the number of 1085 * MSDU exceeds 255 this number will wrap using modulo 256. 1086 * 1087 * decap_type 1088 * Indicates the format after decapsulation. Values are defined in 1089 * enum %MPDU_START_DECAP_TYPE_*. 1090 * 1091 * ipv4_proto 1092 * Set if L2 layer indicates IPv4 protocol. 1093 * 1094 * ipv6_proto 1095 * Set if L2 layer indicates IPv6 protocol. 1096 * 1097 * tcp_proto 1098 * Set if the ipv4_proto or ipv6_proto are set and the IP protocol 1099 * indicates TCP. 1100 * 1101 * udp_proto 1102 * Set if the ipv4_proto or ipv6_proto are set and the IP protocol 1103 * indicates UDP. 1104 * 1105 * ip_frag 1106 * Indicates that either the IP More frag bit is set or IP frag 1107 * number is non-zero. If set indicates that this is a fragmented 1108 * IP packet. 1109 * 1110 * tcp_only_ack 1111 * Set if only the TCP Ack bit is set in the TCP flags and if 1112 * the TCP payload is 0. 1113 * 1114 * da_is_bcast_mcast 1115 * The destination address is broadcast or multicast. 1116 * 1117 * toeplitz_hash 1118 * Actual chosen Hash. 1119 * 0 - Toeplitz hash of 2-tuple (IP source address, IP 1120 * destination address) 1121 * 1 - Toeplitz hash of 4-tuple (IP source address, 1122 * IP destination address, L4 (TCP/UDP) source port, 1123 * L4 (TCP/UDP) destination port) 1124 * 2 - Toeplitz of flow_id 1125 * 3 - Zero is used 1126 * 1127 * ip_fixed_header_valid 1128 * Fixed 20-byte IPv4 header or 40-byte IPv6 header parsed 1129 * fully within first 256 bytes of the packet 1130 * 1131 * ip_extn_header_valid 1132 * IPv6/IPv6 header, including IPv4 options and 1133 * recognizable extension headers parsed fully within first 256 1134 * bytes of the packet 1135 * 1136 * tcp_udp_header_valid 1137 * Fixed 20-byte TCP (excluding TCP options) or 8-byte UDP 1138 * header parsed fully within first 256 bytes of the packet 1139 * 1140 * mesh_control_present 1141 * When set, this MSDU includes the 'Mesh Control' field 1142 * 1143 * ldpc 1144 * 1145 * ip4_protocol_ip6_next_header 1146 * For IPv4, this is the 8 bit protocol field set). For IPv6 this 1147 * is the 8 bit next_header field. 1148 * 1149 * 1150 * vlan_ctag_ci 1151 * 2 bytes of C-VLAN Tag Control Information from WHO_L2_LLC 1152 * 1153 * vlan_stag_ci 1154 * 2 bytes of S-VLAN Tag Control Information from WHO_L2_LLC 1155 * in case of double VLAN 1156 * 1157 * peer_meta_data 1158 * Meta data that SW has programmed in the Peer table entry 1159 * of the transmitting STA. 1160 * 1161 * user_rssi 1162 * RSSI for this user 1163 * 1164 * pkt_type 1165 * Values are defined in enum %RX_MSDU_START_PKT_TYPE_*. 1166 * 1167 * sgi 1168 * Field only valid when pkt type is HT, VHT or HE. Values are 1169 * defined in enum %RX_MSDU_START_SGI_*. 1170 * 1171 * rate_mcs 1172 * MCS Rate used. 1173 * 1174 * receive_bandwidth 1175 * Full receive Bandwidth. Values are defined in enum 1176 * %RX_MSDU_START_RECV_*. 1177 * 1178 * reception_type 1179 * Indicates what type of reception this is and defined in enum 1180 * %RX_MSDU_START_RECEPTION_TYPE_*. 1181 * 1182 * mimo_ss_bitmap 1183 * Field only valid when 1184 * Reception_type is RX_MSDU_START_RECEPTION_TYPE_DL_MU_MIMO or 1185 * RX_MSDU_START_RECEPTION_TYPE_DL_MU_OFDMA_MIMO. 1186 * 1187 * Bitmap, with each bit indicating if the related spatial 1188 * stream is used for this STA 1189 * 1190 * LSB related to SS 0 1191 * 1192 * 0 - spatial stream not used for this reception 1193 * 1 - spatial stream used for this reception 1194 * 1195 * msdu_done_copy 1196 * If set indicates that the RX packet data, RX header data, 1197 * RX PPDU start descriptor, RX MPDU start/end descriptor, 1198 * RX MSDU start/end descriptors and RX Attention descriptor 1199 * are all valid. This bit is in the last 64-bit of the descriptor 1200 * expected to be subscribed in future hardware. 1201 * 1202 * flow_id_toeplitz 1203 * Toeplitz hash of 5-tuple 1204 * {IP source address, IP destination address, IP source port, IP 1205 * destination port, L4 protocol} in case of non-IPSec. 1206 * 1207 * In case of IPSec - Toeplitz hash of 4-tuple 1208 * {IP source address, IP destination address, SPI, L4 protocol} 1209 * 1210 * The relevant Toeplitz key registers are provided in RxOLE's 1211 * instance of common parser module. These registers are separate 1212 * from the Toeplitz keys used by ASE/FSE modules inside RxOLE. 1213 * The actual value will be passed on from common parser module 1214 * to RxOLE in one of the WHO_* TLVs. 1215 * 1216 * ppdu_start_timestamp 1217 * Timestamp that indicates when the PPDU that contained this MPDU 1218 * started on the medium. 1219 * 1220 * phy_meta_data 1221 * SW programmed Meta data provided by the PHY. Can be used for SW 1222 * to indicate the channel the device is on. 1223 * 1224 * toeplitz_hash_2_or_4 1225 * Controlled by multiple RxOLE registers for TCP/UDP over 1226 * IPv4/IPv6 - Either, Toeplitz hash computed over 2-tuple 1227 * IPv4 or IPv6 src/dest addresses is reported; or, Toeplitz 1228 * hash computed over 4-tuple IPv4 or IPv6 src/dest addresses 1229 * and src/dest ports is reported. The Flow_id_toeplitz hash 1230 * can also be reported here. Usually the hash reported here 1231 * is the one used for hash-based REO routing (see use_flow_id_toeplitz_clfy 1232 * in 'RXPT_CLASSIFY_INFO'). 1233 * 1234 * sa 1235 * Source MAC address 1236 * 1237 * first_mpdu 1238 * Indicates the first MSDU of the PPDU. If both first_mpdu 1239 * and last_mpdu are set in the MSDU then this is a not an 1240 * A-MPDU frame but a stand alone MPDU. Interior MPDU in an 1241 * A-MPDU shall have both first_mpdu and last_mpdu bits set to 1242 * 0. The PPDU start status will only be valid when this bit 1243 * is set. 1244 * 1245 * mcast_bcast 1246 * Multicast / broadcast indicator. Only set when the MAC 1247 * address 1 bit 0 is set indicating mcast/bcast and the BSSID 1248 * matches one of the 4 BSSID registers. Only set when 1249 * first_msdu is set. 1250 * 1251 * ast_index_not_found 1252 * Only valid when first_msdu is set. Indicates no AST matching 1253 * entries within the max search count. 1254 * 1255 * ast_index_timeout 1256 * Only valid when first_msdu is set. Indicates an unsuccessful 1257 * search in the address search table due to timeout. 1258 * 1259 * power_mgmt 1260 * Power management bit set in the 802.11 header. Only set 1261 * when first_msdu is set. 1262 * 1263 * non_qos 1264 * Set if packet is not a non-QoS data frame. Only set when 1265 * first_msdu is set. 1266 * 1267 * null_data 1268 * Set if frame type indicates either null data or QoS null 1269 * data format. Only set when first_msdu is set. 1270 * 1271 * mgmt_type 1272 * Set if packet is a management packet. Only set when 1273 * first_msdu is set. 1274 * 1275 * ctrl_type 1276 * Set if packet is a control packet. Only set when first_msdu 1277 * is set. 1278 * 1279 * more_data 1280 * Set if more bit in frame control is set. Only set when 1281 * first_msdu is set. 1282 * 1283 * eosp 1284 * Set if the EOSP (end of service period) bit in the QoS 1285 * control field is set. Only set when first_msdu is set. 1286 * 1287 * a_msdu_error 1288 * Set if number of MSDUs in A-MSDU is above a threshold or if the 1289 * size of the MSDU is invalid. This receive buffer will contain 1290 * all of the remainder of MSDUs in this MPDU w/o decapsulation. 1291 * 1292 * order 1293 * Set if the order bit in the frame control is set. Only 1294 * set when first_msdu is set. 1295 * 1296 * wifi_parser_error 1297 * Indicates that the WiFi frame has one of the following errors 1298 * 1299 * overflow_err 1300 * RXPCU Receive FIFO ran out of space to receive the full MPDU. 1301 * Therefore this MPDU is terminated early and is thus corrupted. 1302 * 1303 * This MPDU will not be ACKed. 1304 * 1305 * RXPCU might still be able to correctly receive the following 1306 * MPDUs in the PPDU if enough fifo space became available in time. 1307 * 1308 * mpdu_length_err 1309 * Set by RXPCU if the expected MPDU length does not correspond 1310 * with the actually received number of bytes in the MPDU. 1311 * 1312 * tcp_udp_chksum_fail 1313 * Indicates that the computed checksum (tcp_udp_chksum) did 1314 * not match the checksum in the TCP/UDP header. 1315 * 1316 * ip_chksum_fail 1317 * Indicates that the computed checksum did not match the 1318 * checksum in the IP header. 1319 * 1320 * sa_idx_invalid 1321 * Indicates no matching entry was found in the address search 1322 * table for the source MAC address. 1323 * 1324 * da_idx_invalid 1325 * Indicates no matching entry was found in the address search 1326 * table for the destination MAC address. 1327 * 1328 * amsdu_addr_mismatch 1329 * Indicates that an A-MSDU with 'from DS = 0' had an SA mismatching 1330 * TA or an A-MDU with 'to DS = 0' had a DA mismatching RA 1331 * 1332 * rx_in_tx_decrypt_byp 1333 * Indicates that RX packet is not decrypted as Crypto is busy 1334 * with TX packet processing. 1335 * 1336 * encrypt_required 1337 * Indicates that this data type frame is not encrypted even if 1338 * the policy for this MPDU requires encryption as indicated in 1339 * the peer table key type. 1340 * 1341 * directed 1342 * MPDU is a directed packet which means that the RA matched 1343 * our STA addresses. In proxySTA it means that the TA matched 1344 * an entry in our address search table with the corresponding 1345 * 'no_ack' bit is the address search entry cleared. 1346 * 1347 * buffer_fragment 1348 * Indicates that at least one of the rx buffers has been 1349 * fragmented. If set the FW should look at the rx_frag_info 1350 * descriptor described below. 1351 * 1352 * mpdu_length_err 1353 * Indicates that the MPDU was pre-maturely terminated 1354 * resulting in a truncated MPDU. Don't trust the MPDU length 1355 * field. 1356 * 1357 * tkip_mic_err 1358 * Indicates that the MPDU Michael integrity check failed 1359 * 1360 * decrypt_err 1361 * Indicates that the MPDU decrypt integrity check failed 1362 * 1363 * fcs_err 1364 * Indicates that the MPDU FCS check failed 1365 * 1366 * flow_idx_timeout 1367 * Indicates an unsuccessful flow search due to the expiring of 1368 * the search timer. 1369 * 1370 * flow_idx_invalid 1371 * flow id is not valid. 1372 * 1373 * decrypt_status_code 1374 * Field provides insight into the decryption performed. Values 1375 * are defined in enum %RX_DESC_DECRYPT_STATUS_CODE_*. 1376 * 1377 * rx_bitmap_not_updated 1378 * Frame is received, but RXPCU could not update the receive bitmap 1379 * due to (temporary) fifo constraints. 1380 * 1381 * msdu_done 1382 * If set indicates that the RX packet data, RX header data, RX 1383 * PPDU start descriptor, RX MPDU start/end descriptor, RX MSDU 1384 * start/end descriptors and RX Attention descriptor are all 1385 * valid. This bit must be in the last octet of the 1386 * descriptor. 1387 * 1388 */ 1389 1390 /* TODO: Move to compact TLV approach 1391 * By default these tlv's are not aligned to 128b boundary 1392 * Need to remove unused qwords and make them compact/aligned 1393 */ 1394 struct hal_rx_desc_qcn9274 { 1395 struct rx_msdu_end_qcn9274 msdu_end; 1396 struct rx_mpdu_start_qcn9274 mpdu_start; 1397 u8 msdu_payload[]; 1398 } __packed; 1399 1400 #define RX_BE_PADDING0_BYTES 8 1401 #define RX_BE_PADDING1_BYTES 8 1402 1403 #define HAL_RX_BE_PKT_HDR_TLV_LEN 112 1404 1405 struct rx_pkt_hdr_tlv { 1406 __le64 tag; 1407 __le64 phy_ppdu_id; 1408 u8 rx_pkt_hdr[HAL_RX_BE_PKT_HDR_TLV_LEN]; 1409 }; 1410 1411 struct hal_rx_desc_wcn7850 { 1412 __le64 msdu_end_tag; 1413 struct rx_msdu_end_qcn9274 msdu_end; 1414 u8 rx_padding0[RX_BE_PADDING0_BYTES]; 1415 __le64 mpdu_start_tag; 1416 struct rx_mpdu_start_qcn9274 mpdu_start; 1417 struct rx_pkt_hdr_tlv pkt_hdr_tlv; 1418 u8 msdu_payload[]; 1419 }; 1420 1421 struct hal_rx_desc { 1422 union { 1423 struct hal_rx_desc_qcn9274 qcn9274; 1424 struct hal_rx_desc_wcn7850 wcn7850; 1425 } u; 1426 } __packed; 1427 1428 #define MAX_USER_POS 8 1429 #define MAX_MU_GROUP_ID 64 1430 #define MAX_MU_GROUP_SHOW 16 1431 #define MAX_MU_GROUP_LENGTH (6 * MAX_MU_GROUP_SHOW) 1432 1433 #define HAL_RX_RU_ALLOC_TYPE_MAX 6 1434 #define RU_26 1 1435 #define RU_52 2 1436 #define RU_106 4 1437 #define RU_242 9 1438 #define RU_484 18 1439 #define RU_996 37 1440 1441 #endif /* ATH12K_RX_DESC_H */ 1442