xref: /wlan-driver/fw-api/hw/qca5332/no_ack_report.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _NO_ACK_REPORT_H_
27*5113495bSYour Name #define _NO_ACK_REPORT_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_NO_ACK_REPORT 4
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct no_ack_report {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t no_ack_transmit_reason                                  :  4, // [3:0]
37*5113495bSYour Name                       macrx_abort_reason                                      :  4, // [7:4]
38*5113495bSYour Name                       phyrx_abort_reason                                      :  8, // [15:8]
39*5113495bSYour Name                       frame_control                                           : 16; // [31:16]
40*5113495bSYour Name              uint32_t rx_ppdu_duration                                        : 24, // [23:0]
41*5113495bSYour Name                       sr_ppdu_during_obss                                     :  1, // [24:24]
42*5113495bSYour Name                       selfgen_response_reason_to_sr_ppdu                      :  4, // [28:25]
43*5113495bSYour Name                       reserved_1                                              :  3; // [31:29]
44*5113495bSYour Name              uint32_t pre_bt_broadcast_status_details                         : 12, // [11:0]
45*5113495bSYour Name                       first_bt_broadcast_status_details                       : 12, // [23:12]
46*5113495bSYour Name                       reserved_2                                              :  8; // [31:24]
47*5113495bSYour Name              uint32_t second_bt_broadcast_status_details                      : 12, // [11:0]
48*5113495bSYour Name                       reserved_3                                              : 20; // [31:12]
49*5113495bSYour Name #else
50*5113495bSYour Name              uint32_t frame_control                                           : 16, // [31:16]
51*5113495bSYour Name                       phyrx_abort_reason                                      :  8, // [15:8]
52*5113495bSYour Name                       macrx_abort_reason                                      :  4, // [7:4]
53*5113495bSYour Name                       no_ack_transmit_reason                                  :  4; // [3:0]
54*5113495bSYour Name              uint32_t reserved_1                                              :  3, // [31:29]
55*5113495bSYour Name                       selfgen_response_reason_to_sr_ppdu                      :  4, // [28:25]
56*5113495bSYour Name                       sr_ppdu_during_obss                                     :  1, // [24:24]
57*5113495bSYour Name                       rx_ppdu_duration                                        : 24; // [23:0]
58*5113495bSYour Name              uint32_t reserved_2                                              :  8, // [31:24]
59*5113495bSYour Name                       first_bt_broadcast_status_details                       : 12, // [23:12]
60*5113495bSYour Name                       pre_bt_broadcast_status_details                         : 12; // [11:0]
61*5113495bSYour Name              uint32_t reserved_3                                              : 20, // [31:12]
62*5113495bSYour Name                       second_bt_broadcast_status_details                      : 12; // [11:0]
63*5113495bSYour Name #endif
64*5113495bSYour Name };
65*5113495bSYour Name 
66*5113495bSYour Name 
67*5113495bSYour Name /* Description		NO_ACK_TRANSMIT_REASON
68*5113495bSYour Name 
69*5113495bSYour Name 			Field that indicates why the received frame is not needing
70*5113495bSYour Name 			 any transmit response in SIFS time.
71*5113495bSYour Name 
72*5113495bSYour Name 			The possible responses are listed in order.
73*5113495bSYour Name 
74*5113495bSYour Name 			<enum 0     NO_ACK_FCS_errors > All received frames have
75*5113495bSYour Name 			 FCS errors.
76*5113495bSYour Name 			<enum 1     Unicast_no_ack_frame_received > All received
77*5113495bSYour Name 			 frames did not require a response.
78*5113495bSYour Name 			<enum 2     NO_ACK_Broadcast> Broadcast frame received
79*5113495bSYour Name 			<enum 3     NO_ACK_Multicast> Multicast frame received
80*5113495bSYour Name 			<enum 4     Not_directed> Frames received are not directed
81*5113495bSYour Name 			 to this device (based on addr1)
82*5113495bSYour Name 			<enum 5     AST_no_ack> The AST entry indicated that NO
83*5113495bSYour Name 			ACK shall be send
84*5113495bSYour Name 			<enum 6     PHY_GID_mismatch> PHY dropped the incoming frame
85*5113495bSYour Name 			 dur to GID mismatch
86*5113495bSYour Name 			<enum 7     PHY_AID_mismatch> PHY dropped the incoming frame
87*5113495bSYour Name 			 dur to AID mismatch
88*5113495bSYour Name 			<enum 8     NO_ACK_PHY_error> PHY reported an error during
89*5113495bSYour Name 			 reception. For details, see the 'phy_error...' fields
90*5113495bSYour Name 			<enum 9     RTS_bw_not_available> The requested BW for the
91*5113495bSYour Name 			 CTS response frame is not available
92*5113495bSYour Name 			<enum 10     NDPA_Frame> An NDPA frame got received
93*5113495bSYour Name 			<enum 11     NDP_Frame> An NDP frame got received
94*5113495bSYour Name 			<enum 12     Trigger_NAV_blocked> a trigger frame was received,
95*5113495bSYour Name 			but due to NAV setting, no response could be generated
96*5113495bSYour Name 			<enum 13     Trigger_no_AID> A trigger frame was received,
97*5113495bSYour Name 			but this device's AID was not in the list
98*5113495bSYour Name 			<enum 14     NO_ACK_MAC_ABORT_REQ > No ACK is needed as
99*5113495bSYour Name 			SW asked RXPCU to send a abort_request to the PHYRX
100*5113495bSYour Name 			<enum 15     no_response_other> placeholder in case non
101*5113495bSYour Name 			of the above properly cover the reasons
102*5113495bSYour Name 
103*5113495bSYour Name 			Also see the field SR_PPDU_during_OBSS.
104*5113495bSYour Name 			<legal 0-15>
105*5113495bSYour Name */
106*5113495bSYour Name 
107*5113495bSYour Name #define NO_ACK_REPORT_NO_ACK_TRANSMIT_REASON_OFFSET                                 0x00000000
108*5113495bSYour Name #define NO_ACK_REPORT_NO_ACK_TRANSMIT_REASON_LSB                                    0
109*5113495bSYour Name #define NO_ACK_REPORT_NO_ACK_TRANSMIT_REASON_MSB                                    3
110*5113495bSYour Name #define NO_ACK_REPORT_NO_ACK_TRANSMIT_REASON_MASK                                   0x0000000f
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name /* Description		MACRX_ABORT_REASON
114*5113495bSYour Name 
115*5113495bSYour Name 			Field only valid when No_ack_transmit_reason is set to NO_ACK_MAC_ABORT_REQ
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 			Error field received from MACRX_ABORT_REQUEST.Macrx_abort_reason[2:0]
119*5113495bSYour Name 
120*5113495bSYour Name 			 <Legal all>
121*5113495bSYour Name */
122*5113495bSYour Name 
123*5113495bSYour Name #define NO_ACK_REPORT_MACRX_ABORT_REASON_OFFSET                                     0x00000000
124*5113495bSYour Name #define NO_ACK_REPORT_MACRX_ABORT_REASON_LSB                                        4
125*5113495bSYour Name #define NO_ACK_REPORT_MACRX_ABORT_REASON_MSB                                        7
126*5113495bSYour Name #define NO_ACK_REPORT_MACRX_ABORT_REASON_MASK                                       0x000000f0
127*5113495bSYour Name 
128*5113495bSYour Name 
129*5113495bSYour Name /* Description		PHYRX_ABORT_REASON
130*5113495bSYour Name 
131*5113495bSYour Name 			Field only valid when No_ack_transmit_reason is set to NO_ACK_PHY_error
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name 			Error field received from PHYRX_ABORT_REQUEST.Phyrx_abort_reason
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 			<Legal all>
138*5113495bSYour Name */
139*5113495bSYour Name 
140*5113495bSYour Name #define NO_ACK_REPORT_PHYRX_ABORT_REASON_OFFSET                                     0x00000000
141*5113495bSYour Name #define NO_ACK_REPORT_PHYRX_ABORT_REASON_LSB                                        8
142*5113495bSYour Name #define NO_ACK_REPORT_PHYRX_ABORT_REASON_MSB                                        15
143*5113495bSYour Name #define NO_ACK_REPORT_PHYRX_ABORT_REASON_MASK                                       0x0000ff00
144*5113495bSYour Name 
145*5113495bSYour Name 
146*5113495bSYour Name /* Description		FRAME_CONTROL
147*5113495bSYour Name 
148*5113495bSYour Name 			frame control field of the received (first properly received)
149*5113495bSYour Name 			frame
150*5113495bSYour Name 
151*5113495bSYour Name 			<Legal all>
152*5113495bSYour Name */
153*5113495bSYour Name 
154*5113495bSYour Name #define NO_ACK_REPORT_FRAME_CONTROL_OFFSET                                          0x00000000
155*5113495bSYour Name #define NO_ACK_REPORT_FRAME_CONTROL_LSB                                             16
156*5113495bSYour Name #define NO_ACK_REPORT_FRAME_CONTROL_MSB                                             31
157*5113495bSYour Name #define NO_ACK_REPORT_FRAME_CONTROL_MASK                                            0xffff0000
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name /* Description		RX_PPDU_DURATION
161*5113495bSYour Name 
162*5113495bSYour Name 			The length of this PPDU reception in us
163*5113495bSYour Name 			<Legal all>
164*5113495bSYour Name */
165*5113495bSYour Name 
166*5113495bSYour Name #define NO_ACK_REPORT_RX_PPDU_DURATION_OFFSET                                       0x00000004
167*5113495bSYour Name #define NO_ACK_REPORT_RX_PPDU_DURATION_LSB                                          0
168*5113495bSYour Name #define NO_ACK_REPORT_RX_PPDU_DURATION_MSB                                          23
169*5113495bSYour Name #define NO_ACK_REPORT_RX_PPDU_DURATION_MASK                                         0x00ffffff
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name /* Description		SR_PPDU_DURING_OBSS
173*5113495bSYour Name 
174*5113495bSYour Name 			Field only valid with SRP Responder support (not PoR in
175*5113495bSYour Name 			Moselle/Maple/Spruce)
176*5113495bSYour Name 
177*5113495bSYour Name 			Indicates that the received frame was sent using SRP as
178*5113495bSYour Name 			indicated by the 'SR PPDU' bit in the 'CAS Control' in the
179*5113495bSYour Name 			 'HE A-Control' in one of the MPDUs received, and that the
180*5113495bSYour Name 			 response could not be generated due to OBSS traffic setting
181*5113495bSYour Name 			 the NAV
182*5113495bSYour Name 			<legal all>
183*5113495bSYour Name */
184*5113495bSYour Name 
185*5113495bSYour Name #define NO_ACK_REPORT_SR_PPDU_DURING_OBSS_OFFSET                                    0x00000004
186*5113495bSYour Name #define NO_ACK_REPORT_SR_PPDU_DURING_OBSS_LSB                                       24
187*5113495bSYour Name #define NO_ACK_REPORT_SR_PPDU_DURING_OBSS_MSB                                       24
188*5113495bSYour Name #define NO_ACK_REPORT_SR_PPDU_DURING_OBSS_MASK                                      0x01000000
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name /* Description		SELFGEN_RESPONSE_REASON_TO_SR_PPDU
192*5113495bSYour Name 
193*5113495bSYour Name 			Field only valid with SRP Responder support (not PoR in
194*5113495bSYour Name 			Moselle/Maple/Spruce)
195*5113495bSYour Name 
196*5113495bSYour Name 			This field indicates why the received SR PPDU needs a response
197*5113495bSYour Name 			 in SIFS time. The e-num used is the same as in the field
198*5113495bSYour Name 			 selfgen_response_reason in 'ACK_REPORT' structure although
199*5113495bSYour Name 			 some of these will be unused in case of an SR PPDU.
200*5113495bSYour Name 
201*5113495bSYour Name 			<enum 0     CTS_frame>
202*5113495bSYour Name 			<enum 1     ACK_frame>
203*5113495bSYour Name 			<enum 2     BA_frame >
204*5113495bSYour Name 			<enum 3     Qboost_trigger> Qboost trigger received
205*5113495bSYour Name 			<enum 4     PSPOLL_trigger> PSPOLL trigger received
206*5113495bSYour Name 			<enum 5     UAPSD_trigger > Unscheduled APSD  trigger received
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 6     CBF_frame> the CBF frame needs to be send as
209*5113495bSYour Name 			 a result of NDP or BRPOLL
210*5113495bSYour Name 			<enum 7     ax_su_trigger> 11ax trigger received for this
211*5113495bSYour Name 			 device
212*5113495bSYour Name 			<enum 8     ax_wildcard_trigger> 11ax wildcardtrigger has
213*5113495bSYour Name 			 been received
214*5113495bSYour Name 			<enum 9     ax_unassoc_wildcard_trigger> 11ax wildcard trigger
215*5113495bSYour Name 			 for unassociated STAs has been received
216*5113495bSYour Name 			<enum 12     eht_su_trigger> EHT R1 trigger received for
217*5113495bSYour Name 			 this device
218*5113495bSYour Name 			<enum 10     MU_UL_response_to_response>
219*5113495bSYour Name 
220*5113495bSYour Name 			<enum 11     Ranging_NDP_LMR_frames> Ranging NDP + LMR need
221*5113495bSYour Name 			 to be sent in response to ranging NDPA + NDP
222*5113495bSYour Name 
223*5113495bSYour Name 			<legal 0-12>
224*5113495bSYour Name */
225*5113495bSYour Name 
226*5113495bSYour Name #define NO_ACK_REPORT_SELFGEN_RESPONSE_REASON_TO_SR_PPDU_OFFSET                     0x00000004
227*5113495bSYour Name #define NO_ACK_REPORT_SELFGEN_RESPONSE_REASON_TO_SR_PPDU_LSB                        25
228*5113495bSYour Name #define NO_ACK_REPORT_SELFGEN_RESPONSE_REASON_TO_SR_PPDU_MSB                        28
229*5113495bSYour Name #define NO_ACK_REPORT_SELFGEN_RESPONSE_REASON_TO_SR_PPDU_MASK                       0x1e000000
230*5113495bSYour Name 
231*5113495bSYour Name 
232*5113495bSYour Name /* Description		RESERVED_1
233*5113495bSYour Name 
234*5113495bSYour Name 			<legal all>
235*5113495bSYour Name */
236*5113495bSYour Name 
237*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_1_OFFSET                                             0x00000004
238*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_1_LSB                                                29
239*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_1_MSB                                                31
240*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_1_MASK                                               0xe0000000
241*5113495bSYour Name 
242*5113495bSYour Name 
243*5113495bSYour Name /* Description		PRE_BT_BROADCAST_STATUS_DETAILS
244*5113495bSYour Name 
245*5113495bSYour Name 			Same contents as field "bt_broadcast_status_details" for
246*5113495bSYour Name 			 the first received COEX_STATUS_BROADCAST tlv during this
247*5113495bSYour Name 			 PPDU reception.
248*5113495bSYour Name 			After power up, this field is all initialized to 0
249*5113495bSYour Name 
250*5113495bSYour Name 			Bits: [31:28]: always 0
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name 			For detailed info see doc: TBD
254*5113495bSYour Name 			<legal all>
255*5113495bSYour Name */
256*5113495bSYour Name 
257*5113495bSYour Name #define NO_ACK_REPORT_PRE_BT_BROADCAST_STATUS_DETAILS_OFFSET                        0x00000008
258*5113495bSYour Name #define NO_ACK_REPORT_PRE_BT_BROADCAST_STATUS_DETAILS_LSB                           0
259*5113495bSYour Name #define NO_ACK_REPORT_PRE_BT_BROADCAST_STATUS_DETAILS_MSB                           11
260*5113495bSYour Name #define NO_ACK_REPORT_PRE_BT_BROADCAST_STATUS_DETAILS_MASK                          0x00000fff
261*5113495bSYour Name 
262*5113495bSYour Name 
263*5113495bSYour Name /* Description		FIRST_BT_BROADCAST_STATUS_DETAILS
264*5113495bSYour Name 
265*5113495bSYour Name 			Same contents as field "bt_broadcast_status_details" for
266*5113495bSYour Name 			 the first received COEX_STATUS_BROADCAST tlv during this
267*5113495bSYour Name 			 PPDU reception.
268*5113495bSYour Name 
269*5113495bSYour Name 			If no COEX_STATUS_BROADCAST tlv is received during this
270*5113495bSYour Name 			PPDU reception, this field will be set to 0
271*5113495bSYour Name 			<legal all>
272*5113495bSYour Name */
273*5113495bSYour Name 
274*5113495bSYour Name #define NO_ACK_REPORT_FIRST_BT_BROADCAST_STATUS_DETAILS_OFFSET                      0x00000008
275*5113495bSYour Name #define NO_ACK_REPORT_FIRST_BT_BROADCAST_STATUS_DETAILS_LSB                         12
276*5113495bSYour Name #define NO_ACK_REPORT_FIRST_BT_BROADCAST_STATUS_DETAILS_MSB                         23
277*5113495bSYour Name #define NO_ACK_REPORT_FIRST_BT_BROADCAST_STATUS_DETAILS_MASK                        0x00fff000
278*5113495bSYour Name 
279*5113495bSYour Name 
280*5113495bSYour Name /* Description		RESERVED_2
281*5113495bSYour Name 
282*5113495bSYour Name 			<legal 0>
283*5113495bSYour Name */
284*5113495bSYour Name 
285*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_2_OFFSET                                             0x00000008
286*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_2_LSB                                                24
287*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_2_MSB                                                31
288*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_2_MASK                                               0xff000000
289*5113495bSYour Name 
290*5113495bSYour Name 
291*5113495bSYour Name /* Description		SECOND_BT_BROADCAST_STATUS_DETAILS
292*5113495bSYour Name 
293*5113495bSYour Name 			Same contents as field "bt_broadcast_status_details" for
294*5113495bSYour Name 			 the second received COEX_STATUS_BROADCAST tlv during this
295*5113495bSYour Name 			 PPDU reception.
296*5113495bSYour Name 
297*5113495bSYour Name 			If no second COEX_STATUS_BROADCAST tlv is received during
298*5113495bSYour Name 			 this PPDU reception, this field will be set to 0
299*5113495bSYour Name 			<legal all>
300*5113495bSYour Name */
301*5113495bSYour Name 
302*5113495bSYour Name #define NO_ACK_REPORT_SECOND_BT_BROADCAST_STATUS_DETAILS_OFFSET                     0x0000000c
303*5113495bSYour Name #define NO_ACK_REPORT_SECOND_BT_BROADCAST_STATUS_DETAILS_LSB                        0
304*5113495bSYour Name #define NO_ACK_REPORT_SECOND_BT_BROADCAST_STATUS_DETAILS_MSB                        11
305*5113495bSYour Name #define NO_ACK_REPORT_SECOND_BT_BROADCAST_STATUS_DETAILS_MASK                       0x00000fff
306*5113495bSYour Name 
307*5113495bSYour Name 
308*5113495bSYour Name /* Description		RESERVED_3
309*5113495bSYour Name 
310*5113495bSYour Name 			<legal 0>
311*5113495bSYour Name */
312*5113495bSYour Name 
313*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_3_OFFSET                                             0x0000000c
314*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_3_LSB                                                12
315*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_3_MSB                                                31
316*5113495bSYour Name #define NO_ACK_REPORT_RESERVED_3_MASK                                               0xfffff000
317*5113495bSYour Name 
318*5113495bSYour Name 
319*5113495bSYour Name 
320*5113495bSYour Name #endif   // NO_ACK_REPORT
321