xref: /wlan-driver/fw-api/hw/qca5332/rx_frame_bitmap_req.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_FRAME_BITMAP_REQ_H_
27*5113495bSYour Name #define _RX_FRAME_BITMAP_REQ_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_RX_FRAME_BITMAP_REQ 2
32*5113495bSYour Name 
33*5113495bSYour Name #define NUM_OF_QWORDS_RX_FRAME_BITMAP_REQ 1
34*5113495bSYour Name 
35*5113495bSYour Name 
36*5113495bSYour Name struct rx_frame_bitmap_req {
37*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
38*5113495bSYour Name              uint32_t explicit_user_request                                   :  1, // [0:0]
39*5113495bSYour Name                       user_request_type                                       :  1, // [1:1]
40*5113495bSYour Name                       user_number                                             :  6, // [7:2]
41*5113495bSYour Name                       sw_peer_id                                              : 16, // [23:8]
42*5113495bSYour Name                       tid_specific_request                                    :  1, // [24:24]
43*5113495bSYour Name                       requested_tid                                           :  4, // [28:25]
44*5113495bSYour Name                       reserved_0                                              :  3; // [31:29]
45*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
46*5113495bSYour Name #else
47*5113495bSYour Name              uint32_t reserved_0                                              :  3, // [31:29]
48*5113495bSYour Name                       requested_tid                                           :  4, // [28:25]
49*5113495bSYour Name                       tid_specific_request                                    :  1, // [24:24]
50*5113495bSYour Name                       sw_peer_id                                              : 16, // [23:8]
51*5113495bSYour Name                       user_number                                             :  6, // [7:2]
52*5113495bSYour Name                       user_request_type                                       :  1, // [1:1]
53*5113495bSYour Name                       explicit_user_request                                   :  1; // [0:0]
54*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
55*5113495bSYour Name #endif
56*5113495bSYour Name };
57*5113495bSYour Name 
58*5113495bSYour Name 
59*5113495bSYour Name /* Description		EXPLICIT_USER_REQUEST
60*5113495bSYour Name 
61*5113495bSYour Name 			Note: TXCPU is allowed to interleave requests of the two
62*5113495bSYour Name 			 different types
63*5113495bSYour Name 
64*5113495bSYour Name 			Also, for either request, RXPCU shall clear the internal
65*5113495bSYour Name 			 flag that linked the bitmap to the just received frame
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name 			When set, TXPCU is asking for the bitmap for an explicit
69*5113495bSYour Name 			 user. This is typically only to be used after an MU OFDMA
70*5113495bSYour Name 			 or MU MIMO  reception. Note that this request can be used
71*5113495bSYour Name 			 to retrieve bitmaps that do not necessarily belong to the
72*5113495bSYour Name 			 just received PPDU, but might have been generated a while
73*5113495bSYour Name 			 ago.
74*5113495bSYour Name 
75*5113495bSYour Name 			When not set, it is up to RXPCU to decide which bitmap it
76*5113495bSYour Name 			 wants to give to TXPCU based on what is available (and
77*5113495bSYour Name 			has not been passed on the TXPCU in a previous request,
78*5113495bSYour Name 			which might have included a request in the 'Explicit_user_request'
79*5113495bSYour Name 			format). This type of request is typically (but not required
80*5113495bSYour Name 			 to be) used  in case of a non OFDMA reception, where a
81*5113495bSYour Name 			BA needs to be send back as response.
82*5113495bSYour Name 			It is mode is typically (but not required to be) used by
83*5113495bSYour Name 			 TXPCU in case of sending a Multi STA BA
84*5113495bSYour Name 			Note that this request can only be used to retrieve bitmaps
85*5113495bSYour Name 			 that are generated as result of the just received PPDU,
86*5113495bSYour Name 			and can not be used to retrieve bitmaps of earlier received
87*5113495bSYour Name 			 PPDUs.
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 			<legal all>
91*5113495bSYour Name */
92*5113495bSYour Name 
93*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_OFFSET                            0x0000000000000000
94*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_LSB                               0
95*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_MSB                               0
96*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_MASK                              0x0000000000000001
97*5113495bSYour Name 
98*5113495bSYour Name 
99*5113495bSYour Name /* Description		USER_REQUEST_TYPE
100*5113495bSYour Name 
101*5113495bSYour Name 			Field only valid when Explicit_user_request is set
102*5113495bSYour Name 
103*5113495bSYour Name 			<enum 0 bitmap_req_user_number_based> The request is based
104*5113495bSYour Name 			 on a user_number. This method is typically used in case
105*5113495bSYour Name 			 of SIFS response for Multi User BA
106*5113495bSYour Name 
107*5113495bSYour Name 			<enum 1 bitmap_req_sw_peer_id_based> The request is based
108*5113495bSYour Name 			 on the sw_peer_id.  This method is typically used in the
109*5113495bSYour Name 			 response to response scenario where TXPCU got a new scheduling
110*5113495bSYour Name 			 command for the response to response part, and SW now explicitly
111*5113495bSYour Name 			 indicates for which STAs a BA shall be requested.
112*5113495bSYour Name 			<legal all>
113*5113495bSYour Name */
114*5113495bSYour Name 
115*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_OFFSET                                0x0000000000000000
116*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_LSB                                   1
117*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_MSB                                   1
118*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_MASK                                  0x0000000000000002
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name /* Description		USER_NUMBER
122*5113495bSYour Name 
123*5113495bSYour Name 			Field only valid when Explicit_user_request is set
124*5113495bSYour Name 			and User_request_type is set to bitmap_req_user_number_based
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 			The user number for which the bitmap is requested.
128*5113495bSYour Name 			<legal all>
129*5113495bSYour Name */
130*5113495bSYour Name 
131*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_NUMBER_OFFSET                                      0x0000000000000000
132*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_NUMBER_LSB                                         2
133*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_NUMBER_MSB                                         7
134*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_USER_NUMBER_MASK                                        0x00000000000000fc
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name /* Description		SW_PEER_ID
138*5113495bSYour Name 
139*5113495bSYour Name 			Field only valid when Explicit_user_request is set
140*5113495bSYour Name 			and User_request_type is set to bitmap_req_sw_peer_id_based
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name 			The sw_peer_id for which the bitmap is requested.
144*5113495bSYour Name 			<legal all>
145*5113495bSYour Name */
146*5113495bSYour Name 
147*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_OFFSET                                       0x0000000000000000
148*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_LSB                                          8
149*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_MSB                                          23
150*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_MASK                                         0x0000000000ffff00
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name /* Description		TID_SPECIFIC_REQUEST
154*5113495bSYour Name 
155*5113495bSYour Name 			Field only valid when Explicit_user_request is set
156*5113495bSYour Name 
157*5113495bSYour Name 			When set, the request is going out for a specific TID, indicated
158*5113495bSYour Name 			 in field TID
159*5113495bSYour Name 
160*5113495bSYour Name 			When clear, it is up to RXPCU to determine in which order
161*5113495bSYour Name 			 it wants to return bitmaps to TXPCU. Note that these bitmaps
162*5113495bSYour Name 			 do need to all belong the the requested user, as Explicit_user_request
163*5113495bSYour Name 			 has also been set.
164*5113495bSYour Name 			<legal all>
165*5113495bSYour Name */
166*5113495bSYour Name 
167*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_OFFSET                             0x0000000000000000
168*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_LSB                                24
169*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_MSB                                24
170*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_MASK                               0x0000000001000000
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name /* Description		REQUESTED_TID
174*5113495bSYour Name 
175*5113495bSYour Name 			Field only valid when Explicit_user_request is set
176*5113495bSYour Name 			and User_request_type is set to bitmap_req_sw_peer_id_based
177*5113495bSYour Name 
178*5113495bSYour Name 			and Tid_specific_request is set
179*5113495bSYour Name 
180*5113495bSYour Name 			The TID for which a BA bitmap is requested
181*5113495bSYour Name 			<legal all>
182*5113495bSYour Name */
183*5113495bSYour Name 
184*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_OFFSET                                    0x0000000000000000
185*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_LSB                                       25
186*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_MSB                                       28
187*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_MASK                                      0x000000001e000000
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		RESERVED_0
191*5113495bSYour Name 
192*5113495bSYour Name 			<legal 0>
193*5113495bSYour Name */
194*5113495bSYour Name 
195*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_RESERVED_0_OFFSET                                       0x0000000000000000
196*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_RESERVED_0_LSB                                          29
197*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_RESERVED_0_MSB                                          31
198*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_RESERVED_0_MASK                                         0x00000000e0000000
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name /* Description		TLV64_PADDING
202*5113495bSYour Name 
203*5113495bSYour Name 			Automatic DWORD padding inserted while converting TLV32
204*5113495bSYour Name 			to TLV64 for 64 bit ARCH
205*5113495bSYour Name 			<legal 0>
206*5113495bSYour Name */
207*5113495bSYour Name 
208*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_OFFSET                                    0x0000000000000000
209*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_LSB                                       32
210*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_MSB                                       63
211*5113495bSYour Name #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_MASK                                      0xffffffff00000000
212*5113495bSYour Name 
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name #endif   // RX_FRAME_BITMAP_REQ
216