1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. 3*5113495bSYour Name * 4*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for any 5*5113495bSYour Name * purpose with or without fee is hereby granted, provided that the above 6*5113495bSYour Name * copyright notice and this permission notice appear in all copies. 7*5113495bSYour Name * 8*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9*5113495bSYour Name * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10*5113495bSYour Name * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11*5113495bSYour Name * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12*5113495bSYour Name * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13*5113495bSYour Name * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14*5113495bSYour Name * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15*5113495bSYour Name */ 16*5113495bSYour Name 17*5113495bSYour Name #ifndef _TX_FES_STATUS_USER_RESPONSE_H_ 18*5113495bSYour Name #define _TX_FES_STATUS_USER_RESPONSE_H_ 19*5113495bSYour Name #if !defined(__ASSEMBLER__) 20*5113495bSYour Name #endif 21*5113495bSYour Name 22*5113495bSYour Name #include "phytx_abort_request_info.h" 23*5113495bSYour Name #define NUM_OF_DWORDS_TX_FES_STATUS_USER_RESPONSE 2 24*5113495bSYour Name 25*5113495bSYour Name #define NUM_OF_QWORDS_TX_FES_STATUS_USER_RESPONSE 1 26*5113495bSYour Name 27*5113495bSYour Name 28*5113495bSYour Name struct tx_fes_status_user_response { 29*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 30*5113495bSYour Name uint32_t fes_transmit_result : 4, // [3:0] 31*5113495bSYour Name reserved_0 : 28; // [31:4] 32*5113495bSYour Name struct phytx_abort_request_info phytx_abort_request_info_details; 33*5113495bSYour Name uint16_t reserved_after_struct16 : 16; // [31:16] 34*5113495bSYour Name #else 35*5113495bSYour Name uint32_t reserved_0 : 28, // [31:4] 36*5113495bSYour Name fes_transmit_result : 4; // [3:0] 37*5113495bSYour Name uint32_t reserved_after_struct16 : 16; // [31:16] 38*5113495bSYour Name struct phytx_abort_request_info phytx_abort_request_info_details; 39*5113495bSYour Name #endif 40*5113495bSYour Name }; 41*5113495bSYour Name 42*5113495bSYour Name 43*5113495bSYour Name /* Description FES_TRANSMIT_RESULT 44*5113495bSYour Name 45*5113495bSYour Name Transmit result: 46*5113495bSYour Name 47*5113495bSYour Name <enum 0 tx_ok> Successful transmission of entire Frame exchange 48*5113495bSYour Name sequence 49*5113495bSYour Name <enum 1 prot_resp_rx_timeout> 50*5113495bSYour Name No Protection response frame received so timeout is triggered. 51*5113495bSYour Name 52*5113495bSYour Name <enum 2 ppdu_resp_rx_timeout> No PPDU response frame received 53*5113495bSYour Name so timeout is triggered. 54*5113495bSYour Name <enum 3 resp_frame_crc_err> Response frame was received 55*5113495bSYour Name with an invalid FCS. 56*5113495bSYour Name <enum 4 SU_Response_type_mismatch> Response frame is received 57*5113495bSYour Name without CRC error but it's not matched with expected SU_Response_type. 58*5113495bSYour Name 59*5113495bSYour Name <enum 5 cbf_mimo_ctrl_mismatch> Set if CBF is received without 60*5113495bSYour Name any error but the Nr, Nc, BW, type or token in VHT MIMO 61*5113495bSYour Name control field is not matched with expected values which 62*5113495bSYour Name are specified by TX_FES_SETUP.cbf_* fields. 63*5113495bSYour Name <enum 7 MU_Response_type_mismatch> Response frame is received 64*5113495bSYour Name without CRC error but it's not matched with expected SU_Response_type. 65*5113495bSYour Name 66*5113495bSYour Name <enum 8 MU_Response_mpdu_not_valid> For this user, no MPDU 67*5113495bSYour Name was received at all, or all received MPDUs had an FCS error. 68*5113495bSYour Name 69*5113495bSYour Name 70*5113495bSYour Name <enum 9 MU_UL_not_enough_user_response> An MU UL response 71*5113495bSYour Name reception was expected. That response came but the threshold 72*5113495bSYour Name for number of successful user receptions was not met. 73*5113495bSYour Name NOTE: This e-num will only be used in the TX_FES_STATUS_END 74*5113495bSYour Name TLV... 75*5113495bSYour Name <enum 10 Transmit_data_null_ratio_not_met> transmission 76*5113495bSYour Name was successful and proper responses have been received. 77*5113495bSYour Name But the required ratio between useful MPDU data and null 78*5113495bSYour Name delimiters was not met as specified by field : Fes_continuation_ratio_threshold. 79*5113495bSYour Name The FES (and potentially the SIFS burst) shall be terminated 80*5113495bSYour Name by the SCHeduler 81*5113495bSYour Name NOTE: This e-num will only be used in the TX_FES_STATUS_END 82*5113495bSYour Name TLV... 83*5113495bSYour Name 84*5113495bSYour Name <enum 6 TB_ranging_resp_timeout> A TB ranging response was 85*5113495bSYour Name expected for a sounding TF, but the response did not arrive 86*5113495bSYour Name and timeout is triggered. 87*5113495bSYour Name NOTE: This e-num will only be used in the TX_FES_STATUS_END 88*5113495bSYour Name TLV... 89*5113495bSYour Name <enum 11 tb_ranging_resp_mismatch> A TB ranging response 90*5113495bSYour Name was expected for a sounding TF, but the reception did not 91*5113495bSYour Name match the expected response. 92*5113495bSYour Name NOTE: This e-num will only be used in the TX_FES_STATUS_END 93*5113495bSYour Name TLV... 94*5113495bSYour Name 95*5113495bSYour Name <legal 0-11> 96*5113495bSYour Name */ 97*5113495bSYour Name 98*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_FES_TRANSMIT_RESULT_OFFSET 0x0000000000000000 99*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_FES_TRANSMIT_RESULT_LSB 0 100*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_FES_TRANSMIT_RESULT_MSB 3 101*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_FES_TRANSMIT_RESULT_MASK 0x000000000000000f 102*5113495bSYour Name 103*5113495bSYour Name 104*5113495bSYour Name /* Description RESERVED_0 105*5113495bSYour Name 106*5113495bSYour Name Bits [15:4]: BAR_start_sequence_number: 107*5113495bSYour Name 108*5113495bSYour Name Starting sequence number to be overwritten by TXPCU for 109*5113495bSYour Name BAR or MU-BAR Trigger, to be copied from 'MPDU_QUEUE_OVERVIEW' 110*5113495bSYour Name by TXPCU 111*5113495bSYour Name 112*5113495bSYour Name Bit [16]: BAR_SSN_overwrite_enable: 113*5113495bSYour Name 114*5113495bSYour Name Enable for TXPCU overwrite of the starting sequence number 115*5113495bSYour Name for BAR or MU-BAR Trigger, to be copied from 'TX_QUEUE_EXTENSION' 116*5113495bSYour Name by TXPCU 117*5113495bSYour Name 118*5113495bSYour Name <legal 0-8191> 119*5113495bSYour Name */ 120*5113495bSYour Name 121*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_0_OFFSET 0x0000000000000000 122*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_0_LSB 4 123*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_0_MSB 31 124*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_0_MASK 0x00000000fffffff0 125*5113495bSYour Name 126*5113495bSYour Name 127*5113495bSYour Name /* Description PHYTX_ABORT_REQUEST_INFO_DETAILS 128*5113495bSYour Name 129*5113495bSYour Name The reason why PHYTX is requesting an abort 130*5113495bSYour Name */ 131*5113495bSYour Name 132*5113495bSYour Name 133*5113495bSYour Name /* Description PHYTX_ABORT_REASON 134*5113495bSYour Name 135*5113495bSYour Name Reason for early termination of TX packet by the PHY 136*5113495bSYour Name 137*5113495bSYour Name <enum_type PHYTX_ABORT_ENUM> 138*5113495bSYour Name */ 139*5113495bSYour Name 140*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_PHYTX_ABORT_REASON_OFFSET 0x0000000000000000 141*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_PHYTX_ABORT_REASON_LSB 32 142*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_PHYTX_ABORT_REASON_MSB 39 143*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_PHYTX_ABORT_REASON_MASK 0x000000ff00000000 144*5113495bSYour Name 145*5113495bSYour Name 146*5113495bSYour Name /* Description USER_NUMBER 147*5113495bSYour Name 148*5113495bSYour Name For some errors, the user for which this error was detected 149*5113495bSYour Name can be indicated in this field. 150*5113495bSYour Name <legal 0-36> 151*5113495bSYour Name */ 152*5113495bSYour Name 153*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_USER_NUMBER_OFFSET 0x0000000000000000 154*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_USER_NUMBER_LSB 40 155*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_USER_NUMBER_MSB 45 156*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_USER_NUMBER_MASK 0x00003f0000000000 157*5113495bSYour Name 158*5113495bSYour Name 159*5113495bSYour Name /* Description RESERVED 160*5113495bSYour Name 161*5113495bSYour Name <legal 0> 162*5113495bSYour Name */ 163*5113495bSYour Name 164*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_RESERVED_OFFSET 0x0000000000000000 165*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_RESERVED_LSB 46 166*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_RESERVED_MSB 47 167*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_PHYTX_ABORT_REQUEST_INFO_DETAILS_RESERVED_MASK 0x0000c00000000000 168*5113495bSYour Name 169*5113495bSYour Name 170*5113495bSYour Name /* Description RESERVED_AFTER_STRUCT16 171*5113495bSYour Name 172*5113495bSYour Name <legal 0> 173*5113495bSYour Name */ 174*5113495bSYour Name 175*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_AFTER_STRUCT16_OFFSET 0x0000000000000000 176*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_AFTER_STRUCT16_LSB 48 177*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_AFTER_STRUCT16_MSB 63 178*5113495bSYour Name #define TX_FES_STATUS_USER_RESPONSE_RESERVED_AFTER_STRUCT16_MASK 0xffff000000000000 179*5113495bSYour Name 180*5113495bSYour Name 181*5113495bSYour Name 182*5113495bSYour Name #endif // TX_FES_STATUS_USER_RESPONSE 183