xref: /wlan-driver/fw-api/hw/qca5332/rx_ppdu_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 _RX_PPDU_ACK_REPORT_H_
27*5113495bSYour Name #define _RX_PPDU_ACK_REPORT_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #include "ack_report.h"
32*5113495bSYour Name #define NUM_OF_DWORDS_RX_PPDU_ACK_REPORT 2
33*5113495bSYour Name 
34*5113495bSYour Name #define NUM_OF_QWORDS_RX_PPDU_ACK_REPORT 1
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name struct rx_ppdu_ack_report {
38*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
39*5113495bSYour Name              struct   ack_report                                                ack_report_details;
40*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
41*5113495bSYour Name #else
42*5113495bSYour Name              struct   ack_report                                                ack_report_details;
43*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
44*5113495bSYour Name #endif
45*5113495bSYour Name };
46*5113495bSYour Name 
47*5113495bSYour Name 
48*5113495bSYour Name /* Description		ACK_REPORT_DETAILS
49*5113495bSYour Name 
50*5113495bSYour Name 			Info indicating why the received frame needed a SIFS response.
51*5113495bSYour Name 
52*5113495bSYour Name */
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name /* Description		SELFGEN_RESPONSE_REASON
56*5113495bSYour Name 
57*5113495bSYour Name 			Field that indicates why the received frame needs a response
58*5113495bSYour Name 			 in SIFS time. The possible responses are listed in order.
59*5113495bSYour Name 
60*5113495bSYour Name 
61*5113495bSYour Name 			<enum 0     CTS_frame>
62*5113495bSYour Name 			<enum 1     ACK_frame>
63*5113495bSYour Name 			<enum 2     BA_frame >
64*5113495bSYour Name 			<enum 3     Qboost_trigger> Qboost trigger received
65*5113495bSYour Name 			<enum 4     PSPOLL_trigger> PSPOLL trigger received
66*5113495bSYour Name 			<enum 5     UAPSD_trigger > Unscheduled APSD  trigger received
67*5113495bSYour Name 
68*5113495bSYour Name 			<enum 6     CBF_frame> the CBF frame needs to be send as
69*5113495bSYour Name 			 a result of NDP or BRPOLL
70*5113495bSYour Name 			<enum 7     ax_su_trigger> 11ax trigger received for this
71*5113495bSYour Name 			 device
72*5113495bSYour Name 			<enum 8     ax_wildcard_trigger> 11ax wildcardtrigger has
73*5113495bSYour Name 			 been received
74*5113495bSYour Name 			<enum 9     ax_unassoc_wildcard_trigger> 11ax wildcard trigger
75*5113495bSYour Name 			 for unassociated STAs has been received
76*5113495bSYour Name 			<enum 12     eht_su_trigger> EHT R1 trigger received for
77*5113495bSYour Name 			 this device
78*5113495bSYour Name 
79*5113495bSYour Name 			<enum 10     MU_UL_response_to_response>
80*5113495bSYour Name 
81*5113495bSYour Name 			<enum 11     Ranging_NDP_LMR_frames> Ranging NDP + LMR need
82*5113495bSYour Name 			 to be sent in response to ranging NDPA + NDP
83*5113495bSYour Name 
84*5113495bSYour Name 			<legal 0-12>
85*5113495bSYour Name */
86*5113495bSYour Name 
87*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SELFGEN_RESPONSE_REASON_OFFSET        0x0000000000000000
88*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SELFGEN_RESPONSE_REASON_LSB           0
89*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SELFGEN_RESPONSE_REASON_MSB           3
90*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SELFGEN_RESPONSE_REASON_MASK          0x000000000000000f
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name /* Description		AX_TRIGGER_TYPE
94*5113495bSYour Name 
95*5113495bSYour Name 			Field Only valid when selfgen_response_reason is an 11ax
96*5113495bSYour Name 			 related trigger
97*5113495bSYour Name 
98*5113495bSYour Name 			The 11AX trigger type/ trigger number:
99*5113495bSYour Name 			It identifies which trigger was received.
100*5113495bSYour Name 			<enum 0 ax_trigger_basic>
101*5113495bSYour Name 			<enum 1 ax_trigger_brpoll>
102*5113495bSYour Name 			<enum 2 ax_trigger_mu_bar>
103*5113495bSYour Name 			<enum 3 ax_trigger_mu_rts>
104*5113495bSYour Name 			<enum 4 ax_trigger_buffer_size>
105*5113495bSYour Name 			<enum 5 ax_trigger_gcr_mu_bar>
106*5113495bSYour Name 			<enum 6 ax_trigger_BQRP>
107*5113495bSYour Name 			<enum 7 ax_trigger_NDP_fb_report_poll>
108*5113495bSYour Name 			<enum 8 ax_tb_ranging_trigger>
109*5113495bSYour Name 			<enum 9 ax_trigger_reserved_9>
110*5113495bSYour Name 			<enum 10 ax_trigger_reserved_10>
111*5113495bSYour Name 			<enum 11 ax_trigger_reserved_11>
112*5113495bSYour Name 			<enum 12 ax_trigger_reserved_12>
113*5113495bSYour Name 			<enum 13 ax_trigger_reserved_13>
114*5113495bSYour Name 			<enum 14 ax_trigger_reserved_14>
115*5113495bSYour Name 			<enum 15 ax_trigger_reserved_15>
116*5113495bSYour Name 
117*5113495bSYour Name 			<legal all>
118*5113495bSYour Name */
119*5113495bSYour Name 
120*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_AX_TRIGGER_TYPE_OFFSET                0x0000000000000000
121*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_AX_TRIGGER_TYPE_LSB                   4
122*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_AX_TRIGGER_TYPE_MSB                   7
123*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_AX_TRIGGER_TYPE_MASK                  0x00000000000000f0
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name /* Description		SR_PPDU
127*5113495bSYour Name 
128*5113495bSYour Name 			Field only valid with SRP Responder support (not PoR in
129*5113495bSYour Name 			Moselle/Maple/Spruce)
130*5113495bSYour Name 
131*5113495bSYour Name 			Indicates if the received frame was sent using SRP as indicated
132*5113495bSYour Name 			 by the 'SR PPDU' bit in the 'CAS Control' in the 'HE A-Control'
133*5113495bSYour Name 			in one of the MPDUs received
134*5113495bSYour Name 			<legal all>
135*5113495bSYour Name */
136*5113495bSYour Name 
137*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SR_PPDU_OFFSET                        0x0000000000000000
138*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SR_PPDU_LSB                           8
139*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SR_PPDU_MSB                           8
140*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_SR_PPDU_MASK                          0x0000000000000100
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name /* Description		RESERVED
144*5113495bSYour Name 
145*5113495bSYour Name 			<legal 0>
146*5113495bSYour Name */
147*5113495bSYour Name 
148*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_RESERVED_OFFSET                       0x0000000000000000
149*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_RESERVED_LSB                          9
150*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_RESERVED_MSB                          15
151*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_RESERVED_MASK                         0x000000000000fe00
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name /* Description		FRAME_CONTROL
155*5113495bSYour Name 
156*5113495bSYour Name 			Field not valid when selfgen_response_reason is MU_UL_response_to_response
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name 			For SU receptions:
160*5113495bSYour Name 			frame control field of the received frame
161*5113495bSYour Name 
162*5113495bSYour Name 			In 11ah Mode of Operation, for non-NDP frames the BW information
163*5113495bSYour Name 			 is extracted from Frame Control fields [11:8].
164*5113495bSYour Name 
165*5113495bSYour Name 			Decode is as follows
166*5113495bSYour Name 
167*5113495bSYour Name 			Bits[11] - Dynamic/Static
168*5113495bSYour Name 			Bits[10:8] - Channel BW
169*5113495bSYour Name */
170*5113495bSYour Name 
171*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_FRAME_CONTROL_OFFSET                  0x0000000000000000
172*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_FRAME_CONTROL_LSB                     16
173*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_FRAME_CONTROL_MSB                     31
174*5113495bSYour Name #define RX_PPDU_ACK_REPORT_ACK_REPORT_DETAILS_FRAME_CONTROL_MASK                    0x00000000ffff0000
175*5113495bSYour Name 
176*5113495bSYour Name 
177*5113495bSYour Name /* Description		TLV64_PADDING
178*5113495bSYour Name 
179*5113495bSYour Name 			Automatic DWORD padding inserted while converting TLV32
180*5113495bSYour Name 			to TLV64 for 64 bit ARCH
181*5113495bSYour Name 			<legal 0>
182*5113495bSYour Name */
183*5113495bSYour Name 
184*5113495bSYour Name #define RX_PPDU_ACK_REPORT_TLV64_PADDING_OFFSET                                     0x0000000000000000
185*5113495bSYour Name #define RX_PPDU_ACK_REPORT_TLV64_PADDING_LSB                                        32
186*5113495bSYour Name #define RX_PPDU_ACK_REPORT_TLV64_PADDING_MSB                                        63
187*5113495bSYour Name #define RX_PPDU_ACK_REPORT_TLV64_PADDING_MASK                                       0xffffffff00000000
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name #endif   // RX_PPDU_ACK_REPORT
192