xref: /wlan-driver/fw-api/hw/qcn6432/receive_user_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
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 _RECEIVE_USER_INFO_H_
18*5113495bSYour Name #define _RECEIVE_USER_INFO_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #define NUM_OF_DWORDS_RECEIVE_USER_INFO 8
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name struct receive_user_info {
26*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
27*5113495bSYour Name              uint32_t phy_ppdu_id                                             : 16, // [15:0]
28*5113495bSYour Name                       user_rssi                                               :  8, // [23:16]
29*5113495bSYour Name                       pkt_type                                                :  4, // [27:24]
30*5113495bSYour Name                       stbc                                                    :  1, // [28:28]
31*5113495bSYour Name                       reception_type                                          :  3; // [31:29]
32*5113495bSYour Name              uint32_t rate_mcs                                                :  4, // [3:0]
33*5113495bSYour Name                       sgi                                                     :  2, // [5:4]
34*5113495bSYour Name                       he_ranging_ndp                                          :  1, // [6:6]
35*5113495bSYour Name                       reserved_1a                                             :  1, // [7:7]
36*5113495bSYour Name                       mimo_ss_bitmap                                          :  8, // [15:8]
37*5113495bSYour Name                       receive_bandwidth                                       :  3, // [18:16]
38*5113495bSYour Name                       reserved_1b                                             :  5, // [23:19]
39*5113495bSYour Name                       dl_ofdma_user_index                                     :  8; // [31:24]
40*5113495bSYour Name              uint32_t dl_ofdma_content_channel                                :  1, // [0:0]
41*5113495bSYour Name                       reserved_2a                                             :  7, // [7:1]
42*5113495bSYour Name                       nss                                                     :  3, // [10:8]
43*5113495bSYour Name                       stream_offset                                           :  3, // [13:11]
44*5113495bSYour Name                       sta_dcm                                                 :  1, // [14:14]
45*5113495bSYour Name                       ldpc                                                    :  1, // [15:15]
46*5113495bSYour Name                       ru_type_80_0                                            :  4, // [19:16]
47*5113495bSYour Name                       ru_type_80_1                                            :  4, // [23:20]
48*5113495bSYour Name                       ru_type_80_2                                            :  4, // [27:24]
49*5113495bSYour Name                       ru_type_80_3                                            :  4; // [31:28]
50*5113495bSYour Name              uint32_t ru_start_index_80_0                                     :  6, // [5:0]
51*5113495bSYour Name                       reserved_3a                                             :  2, // [7:6]
52*5113495bSYour Name                       ru_start_index_80_1                                     :  6, // [13:8]
53*5113495bSYour Name                       reserved_3b                                             :  2, // [15:14]
54*5113495bSYour Name                       ru_start_index_80_2                                     :  6, // [21:16]
55*5113495bSYour Name                       reserved_3c                                             :  2, // [23:22]
56*5113495bSYour Name                       ru_start_index_80_3                                     :  6, // [29:24]
57*5113495bSYour Name                       reserved_3d                                             :  2; // [31:30]
58*5113495bSYour Name              uint32_t user_fd_rssi_seg0                                       : 32; // [31:0]
59*5113495bSYour Name              uint32_t user_fd_rssi_seg1                                       : 32; // [31:0]
60*5113495bSYour Name              uint32_t user_fd_rssi_seg2                                       : 32; // [31:0]
61*5113495bSYour Name              uint32_t user_fd_rssi_seg3                                       : 32; // [31:0]
62*5113495bSYour Name #else
63*5113495bSYour Name              uint32_t reception_type                                          :  3, // [31:29]
64*5113495bSYour Name                       stbc                                                    :  1, // [28:28]
65*5113495bSYour Name                       pkt_type                                                :  4, // [27:24]
66*5113495bSYour Name                       user_rssi                                               :  8, // [23:16]
67*5113495bSYour Name                       phy_ppdu_id                                             : 16; // [15:0]
68*5113495bSYour Name              uint32_t dl_ofdma_user_index                                     :  8, // [31:24]
69*5113495bSYour Name                       reserved_1b                                             :  5, // [23:19]
70*5113495bSYour Name                       receive_bandwidth                                       :  3, // [18:16]
71*5113495bSYour Name                       mimo_ss_bitmap                                          :  8, // [15:8]
72*5113495bSYour Name                       reserved_1a                                             :  1, // [7:7]
73*5113495bSYour Name                       he_ranging_ndp                                          :  1, // [6:6]
74*5113495bSYour Name                       sgi                                                     :  2, // [5:4]
75*5113495bSYour Name                       rate_mcs                                                :  4; // [3:0]
76*5113495bSYour Name              uint32_t ru_type_80_3                                            :  4, // [31:28]
77*5113495bSYour Name                       ru_type_80_2                                            :  4, // [27:24]
78*5113495bSYour Name                       ru_type_80_1                                            :  4, // [23:20]
79*5113495bSYour Name                       ru_type_80_0                                            :  4, // [19:16]
80*5113495bSYour Name                       ldpc                                                    :  1, // [15:15]
81*5113495bSYour Name                       sta_dcm                                                 :  1, // [14:14]
82*5113495bSYour Name                       stream_offset                                           :  3, // [13:11]
83*5113495bSYour Name                       nss                                                     :  3, // [10:8]
84*5113495bSYour Name                       reserved_2a                                             :  7, // [7:1]
85*5113495bSYour Name                       dl_ofdma_content_channel                                :  1; // [0:0]
86*5113495bSYour Name              uint32_t reserved_3d                                             :  2, // [31:30]
87*5113495bSYour Name                       ru_start_index_80_3                                     :  6, // [29:24]
88*5113495bSYour Name                       reserved_3c                                             :  2, // [23:22]
89*5113495bSYour Name                       ru_start_index_80_2                                     :  6, // [21:16]
90*5113495bSYour Name                       reserved_3b                                             :  2, // [15:14]
91*5113495bSYour Name                       ru_start_index_80_1                                     :  6, // [13:8]
92*5113495bSYour Name                       reserved_3a                                             :  2, // [7:6]
93*5113495bSYour Name                       ru_start_index_80_0                                     :  6; // [5:0]
94*5113495bSYour Name              uint32_t user_fd_rssi_seg0                                       : 32; // [31:0]
95*5113495bSYour Name              uint32_t user_fd_rssi_seg1                                       : 32; // [31:0]
96*5113495bSYour Name              uint32_t user_fd_rssi_seg2                                       : 32; // [31:0]
97*5113495bSYour Name              uint32_t user_fd_rssi_seg3                                       : 32; // [31:0]
98*5113495bSYour Name #endif
99*5113495bSYour Name };
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name /* Description		PHY_PPDU_ID
103*5113495bSYour Name 
104*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
105*5113495bSYour Name 			received. The counter value wraps around
106*5113495bSYour Name 			<legal all>
107*5113495bSYour Name */
108*5113495bSYour Name 
109*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_OFFSET                                        0x00000000
110*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_LSB                                           0
111*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_MSB                                           15
112*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_MASK                                          0x0000ffff
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name /* Description		USER_RSSI
116*5113495bSYour Name 
117*5113495bSYour Name 			RSSI for this user
118*5113495bSYour Name 			Frequency domain RSSI measurement for this user. Based on
119*5113495bSYour Name 			 the channel estimate.
120*5113495bSYour Name 
121*5113495bSYour Name 			<legal all>
122*5113495bSYour Name */
123*5113495bSYour Name 
124*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_OFFSET                                          0x00000000
125*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_LSB                                             16
126*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_MSB                                             23
127*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_MASK                                            0x00ff0000
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name /* Description		PKT_TYPE
131*5113495bSYour Name 
132*5113495bSYour Name 			Packet type:
133*5113495bSYour Name 
134*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
135*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
136*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
137*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
138*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
139*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
140*5113495bSYour Name 			<enum 6 dot11be>802.11be PPDU type
141*5113495bSYour Name 			<enum 7 dot11az>802.11az (ranging) PPDU type
142*5113495bSYour Name 			<enum 8 dot11n_gf>802.11n Green Field PPDU type (unsupported
143*5113495bSYour Name 			 & aborted)
144*5113495bSYour Name */
145*5113495bSYour Name 
146*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_OFFSET                                           0x00000000
147*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_LSB                                              24
148*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_MSB                                              27
149*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_MASK                                             0x0f000000
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name /* Description		STBC
153*5113495bSYour Name 
154*5113495bSYour Name 			When set, use STBC transmission rates
155*5113495bSYour Name */
156*5113495bSYour Name 
157*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_OFFSET                                               0x00000000
158*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_LSB                                                  28
159*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_MSB                                                  28
160*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_MASK                                                 0x10000000
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name /* Description		RECEPTION_TYPE
164*5113495bSYour Name 
165*5113495bSYour Name 			Indicates what type of reception this is.
166*5113495bSYour Name 			<enum 0     reception_type_SU > Basic SU reception (not
167*5113495bSYour Name 			part of OFDMA or MU-MIMO)
168*5113495bSYour Name 			<enum 1     reception_type_MU_MIMO > This is related to
169*5113495bSYour Name 			DL type of reception
170*5113495bSYour Name 			<enum 2     reception_type_MU_OFDMA >  This is related to
171*5113495bSYour Name 			 DL type of reception
172*5113495bSYour Name 			<enum 3     reception_type_MU_OFDMA_MIMO >  This is related
173*5113495bSYour Name 			 to DL type of reception
174*5113495bSYour Name 			<enum 4     reception_type_UL_MU_MIMO > This is related
175*5113495bSYour Name 			to UL type of reception
176*5113495bSYour Name 			<enum 5     reception_type_UL_MU_OFDMA >  This is related
177*5113495bSYour Name 			 to UL type of reception
178*5113495bSYour Name 			<enum 6     reception_type_UL_MU_OFDMA_MIMO >  This is related
179*5113495bSYour Name 			 to UL type of reception
180*5113495bSYour Name 
181*5113495bSYour Name 			<legal 0-6>
182*5113495bSYour Name */
183*5113495bSYour Name 
184*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_OFFSET                                     0x00000000
185*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_LSB                                        29
186*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_MSB                                        31
187*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_MASK                                       0xe0000000
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		RATE_MCS
191*5113495bSYour Name 
192*5113495bSYour Name 			For details, refer to  MCS_TYPE description
193*5113495bSYour Name 			<legal all>
194*5113495bSYour Name */
195*5113495bSYour Name 
196*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_OFFSET                                           0x00000004
197*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_LSB                                              0
198*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_MSB                                              3
199*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_MASK                                             0x0000000f
200*5113495bSYour Name 
201*5113495bSYour Name 
202*5113495bSYour Name /* Description		SGI
203*5113495bSYour Name 
204*5113495bSYour Name 			Field only valid when pkt type is HT, VHT or HE.
205*5113495bSYour Name 
206*5113495bSYour Name 			<enum 0     gi_0_8_us > Legacy normal GI.  Can also be used
207*5113495bSYour Name 			 for HE
208*5113495bSYour Name 			<enum 1     gi_0_4_us > Legacy short GI.  Can also be used
209*5113495bSYour Name 			 for HE
210*5113495bSYour Name 			<enum 2     gi_1_6_us > HE related GI
211*5113495bSYour Name 			<enum 3     gi_3_2_us > HE related GI
212*5113495bSYour Name 			<legal 0 - 3>
213*5113495bSYour Name */
214*5113495bSYour Name 
215*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_OFFSET                                                0x00000004
216*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_LSB                                                   4
217*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_MSB                                                   5
218*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_MASK                                                  0x00000030
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name /* Description		HE_RANGING_NDP
222*5113495bSYour Name 
223*5113495bSYour Name 			Set to 1 for expected HE TB ranging NDP Rx in response to
224*5113495bSYour Name 			 sounding/secure sounding ranging Trigger Tx
225*5113495bSYour Name 
226*5113495bSYour Name 			<legal all>
227*5113495bSYour Name */
228*5113495bSYour Name 
229*5113495bSYour Name #define RECEIVE_USER_INFO_HE_RANGING_NDP_OFFSET                                     0x00000004
230*5113495bSYour Name #define RECEIVE_USER_INFO_HE_RANGING_NDP_LSB                                        6
231*5113495bSYour Name #define RECEIVE_USER_INFO_HE_RANGING_NDP_MSB                                        6
232*5113495bSYour Name #define RECEIVE_USER_INFO_HE_RANGING_NDP_MASK                                       0x00000040
233*5113495bSYour Name 
234*5113495bSYour Name 
235*5113495bSYour Name /* Description		RESERVED_1A
236*5113495bSYour Name 
237*5113495bSYour Name 			<legal 0>
238*5113495bSYour Name */
239*5113495bSYour Name 
240*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_OFFSET                                        0x00000004
241*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_LSB                                           7
242*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_MSB                                           7
243*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_MASK                                          0x00000080
244*5113495bSYour Name 
245*5113495bSYour Name 
246*5113495bSYour Name /* Description		MIMO_SS_BITMAP
247*5113495bSYour Name 
248*5113495bSYour Name 			Bitmap, with each bit indicating if the related spatial
249*5113495bSYour Name 			stream is used for this STA
250*5113495bSYour Name 			LSB related to SS 0
251*5113495bSYour Name 
252*5113495bSYour Name 			0: spatial stream not used for this reception
253*5113495bSYour Name 			1: spatial stream used for this reception
254*5113495bSYour Name 
255*5113495bSYour Name 			<legal all>
256*5113495bSYour Name */
257*5113495bSYour Name 
258*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_OFFSET                                     0x00000004
259*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_LSB                                        8
260*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_MSB                                        15
261*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_MASK                                       0x0000ff00
262*5113495bSYour Name 
263*5113495bSYour Name 
264*5113495bSYour Name /* Description		RECEIVE_BANDWIDTH
265*5113495bSYour Name 
266*5113495bSYour Name 			Full receive Bandwidth
267*5113495bSYour Name 
268*5113495bSYour Name 			<enum 0 20_mhz>20 Mhz BW
269*5113495bSYour Name 			<enum 1 40_mhz>40 Mhz BW
270*5113495bSYour Name 			<enum 2 80_mhz>80 Mhz BW
271*5113495bSYour Name 			<enum 3 160_mhz>160 Mhz BW
272*5113495bSYour Name 			<enum 4 320_mhz>320 Mhz BW
273*5113495bSYour Name 			<enum 5 240_mhz>240 Mhz BW
274*5113495bSYour Name */
275*5113495bSYour Name 
276*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_OFFSET                                  0x00000004
277*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_LSB                                     16
278*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_MSB                                     18
279*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_MASK                                    0x00070000
280*5113495bSYour Name 
281*5113495bSYour Name 
282*5113495bSYour Name /* Description		RESERVED_1B
283*5113495bSYour Name 
284*5113495bSYour Name 			<legal 0>
285*5113495bSYour Name */
286*5113495bSYour Name 
287*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_OFFSET                                        0x00000004
288*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_LSB                                           19
289*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_MSB                                           23
290*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_MASK                                          0x00f80000
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name /* Description		DL_OFDMA_USER_INDEX
294*5113495bSYour Name 
295*5113495bSYour Name 			Field only valid in the of DL MU OFDMA reception
296*5113495bSYour Name 
297*5113495bSYour Name 			The user number within the RU_allocation.
298*5113495bSYour Name 
299*5113495bSYour Name 			This is needed for SW to determine the exact RU position
300*5113495bSYour Name 			 within the reception.
301*5113495bSYour Name 			<legal all>
302*5113495bSYour Name */
303*5113495bSYour Name 
304*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_OFFSET                                0x00000004
305*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_LSB                                   24
306*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_MSB                                   31
307*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_MASK                                  0xff000000
308*5113495bSYour Name 
309*5113495bSYour Name 
310*5113495bSYour Name /* Description		DL_OFDMA_CONTENT_CHANNEL
311*5113495bSYour Name 
312*5113495bSYour Name 			Field only valid in the of DL MU OFDMA/MIMO reception
313*5113495bSYour Name 
314*5113495bSYour Name 			In case of DL MU reception, this field indicates the content
315*5113495bSYour Name 			 channel number where PHY found the RU information for this
316*5113495bSYour Name 			 user
317*5113495bSYour Name 
318*5113495bSYour Name 			This is needed for SW to determine the exact RU position
319*5113495bSYour Name 			 within the reception.
320*5113495bSYour Name 
321*5113495bSYour Name 			<enum 0      content_channel_1>
322*5113495bSYour Name 			<enum 1      content_channel_2>
323*5113495bSYour Name 
324*5113495bSYour Name 			<legal all>
325*5113495bSYour Name */
326*5113495bSYour Name 
327*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_OFFSET                           0x00000008
328*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_LSB                              0
329*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_MSB                              0
330*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_MASK                             0x00000001
331*5113495bSYour Name 
332*5113495bSYour Name 
333*5113495bSYour Name /* Description		RESERVED_2A
334*5113495bSYour Name 
335*5113495bSYour Name 			<legal 0>
336*5113495bSYour Name */
337*5113495bSYour Name 
338*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_OFFSET                                        0x00000008
339*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_LSB                                           1
340*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_MSB                                           7
341*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_MASK                                          0x000000fe
342*5113495bSYour Name 
343*5113495bSYour Name 
344*5113495bSYour Name /* Description		NSS
345*5113495bSYour Name 
346*5113495bSYour Name 			Field only valid in case of Uplink_receive_type == mimo_only
347*5113495bSYour Name 			 OR ofdma_mimo
348*5113495bSYour Name 
349*5113495bSYour Name 			Number of Spatial Streams occupied by the User
350*5113495bSYour Name 
351*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
352*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
353*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
354*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
355*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
356*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
357*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
358*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
359*5113495bSYour Name */
360*5113495bSYour Name 
361*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_OFFSET                                                0x00000008
362*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_LSB                                                   8
363*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_MSB                                                   10
364*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_MASK                                                  0x00000700
365*5113495bSYour Name 
366*5113495bSYour Name 
367*5113495bSYour Name /* Description		STREAM_OFFSET
368*5113495bSYour Name 
369*5113495bSYour Name 			Field only valid in case of Uplink_receive_type == mimo_only
370*5113495bSYour Name 			 OR ofdma_mimo
371*5113495bSYour Name 
372*5113495bSYour Name 			Stream Offset from which the User occupies the Streams
373*5113495bSYour Name 
374*5113495bSYour Name 			Note MAC:
375*5113495bSYour Name 			directly from pdg_fes_setup, based on BW
376*5113495bSYour Name */
377*5113495bSYour Name 
378*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_OFFSET                                      0x00000008
379*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_LSB                                         11
380*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_MSB                                         13
381*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_MASK                                        0x00003800
382*5113495bSYour Name 
383*5113495bSYour Name 
384*5113495bSYour Name /* Description		STA_DCM
385*5113495bSYour Name 
386*5113495bSYour Name 			Indicates whether dual sub-carrier modulation is applied
387*5113495bSYour Name 
388*5113495bSYour Name 			0: No DCM
389*5113495bSYour Name 			1:DCM
390*5113495bSYour Name 			<legal all>
391*5113495bSYour Name */
392*5113495bSYour Name 
393*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_OFFSET                                            0x00000008
394*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_LSB                                               14
395*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_MSB                                               14
396*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_MASK                                              0x00004000
397*5113495bSYour Name 
398*5113495bSYour Name 
399*5113495bSYour Name /* Description		LDPC
400*5113495bSYour Name 
401*5113495bSYour Name 			When set, use LDPC transmission rates were used.
402*5113495bSYour Name 			<legal all>
403*5113495bSYour Name */
404*5113495bSYour Name 
405*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_OFFSET                                               0x00000008
406*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_LSB                                                  15
407*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_MSB                                                  15
408*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_MASK                                                 0x00008000
409*5113495bSYour Name 
410*5113495bSYour Name 
411*5113495bSYour Name /* Description		RU_TYPE_80_0
412*5113495bSYour Name 
413*5113495bSYour Name 			Indicates the size of the RU in the first 80 MHz sub-band
414*5113495bSYour Name 
415*5113495bSYour Name 			<enum 0 RU_26_per80>
416*5113495bSYour Name 			<enum 1 RU_52_per80>
417*5113495bSYour Name 			<enum 2 RU_78_per80>
418*5113495bSYour Name 			<enum 3 RU_106_per80>
419*5113495bSYour Name 			<enum 4 RU_132_per80>
420*5113495bSYour Name 			<enum 5 RU_242_per80>
421*5113495bSYour Name 			<enum 6 RU_484_per80>
422*5113495bSYour Name 			<enum 7 RU_726_per80>
423*5113495bSYour Name 			<enum 8 RU_996_per80>
424*5113495bSYour Name 			<enum 9 RU_996x2>
425*5113495bSYour Name 			<enum 10 RU_996x3>
426*5113495bSYour Name 			<enum 11 RU_996x4>
427*5113495bSYour Name 			<enum 12 RU_rsvd0> DO NOT USE
428*5113495bSYour Name 			<enum 13 RU_rsvd1> DO NOT USE
429*5113495bSYour Name 			<enum 14 RU_rsvd2> DO NOT USE
430*5113495bSYour Name 			<enum 15 RU_NONE> No RUs in this 80 MHz
431*5113495bSYour Name 			<legal 0-15>
432*5113495bSYour Name */
433*5113495bSYour Name 
434*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_OFFSET                                       0x00000008
435*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_LSB                                          16
436*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_MSB                                          19
437*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_MASK                                         0x000f0000
438*5113495bSYour Name 
439*5113495bSYour Name 
440*5113495bSYour Name /* Description		RU_TYPE_80_1
441*5113495bSYour Name 
442*5113495bSYour Name 			Indicates the size of the RU in the second 80 MHz sub-band
443*5113495bSYour Name 
444*5113495bSYour Name 			<enum 0 RU_26_per80>
445*5113495bSYour Name 			<enum 1 RU_52_per80>
446*5113495bSYour Name 			<enum 2 RU_78_per80>
447*5113495bSYour Name 			<enum 3 RU_106_per80>
448*5113495bSYour Name 			<enum 4 RU_132_per80>
449*5113495bSYour Name 			<enum 5 RU_242_per80>
450*5113495bSYour Name 			<enum 6 RU_484_per80>
451*5113495bSYour Name 			<enum 7 RU_726_per80>
452*5113495bSYour Name 			<enum 8 RU_996_per80>
453*5113495bSYour Name 			<enum 9 RU_996x2>
454*5113495bSYour Name 			<enum 10 RU_996x3>
455*5113495bSYour Name 			<enum 11 RU_996x4>
456*5113495bSYour Name 			<enum 12 RU_rsvd0> DO NOT USE
457*5113495bSYour Name 			<enum 13 RU_rsvd1> DO NOT USE
458*5113495bSYour Name 			<enum 14 RU_rsvd2> DO NOT USE
459*5113495bSYour Name 			<enum 15 RU_NONE> No RUs in this 80 MHz
460*5113495bSYour Name 			<legal 0-15>
461*5113495bSYour Name */
462*5113495bSYour Name 
463*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_OFFSET                                       0x00000008
464*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_LSB                                          20
465*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_MSB                                          23
466*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_MASK                                         0x00f00000
467*5113495bSYour Name 
468*5113495bSYour Name 
469*5113495bSYour Name /* Description		RU_TYPE_80_2
470*5113495bSYour Name 
471*5113495bSYour Name 			Indicates the size of the RU in the third 80 MHz sub-band
472*5113495bSYour Name 
473*5113495bSYour Name 			<enum 0 RU_26_per80>
474*5113495bSYour Name 			<enum 1 RU_52_per80>
475*5113495bSYour Name 			<enum 2 RU_78_per80>
476*5113495bSYour Name 			<enum 3 RU_106_per80>
477*5113495bSYour Name 			<enum 4 RU_132_per80>
478*5113495bSYour Name 			<enum 5 RU_242_per80>
479*5113495bSYour Name 			<enum 6 RU_484_per80>
480*5113495bSYour Name 			<enum 7 RU_726_per80>
481*5113495bSYour Name 			<enum 8 RU_996_per80>
482*5113495bSYour Name 			<enum 9 RU_996x2>
483*5113495bSYour Name 			<enum 10 RU_996x3>
484*5113495bSYour Name 			<enum 11 RU_996x4>
485*5113495bSYour Name 			<enum 12 RU_rsvd0> DO NOT USE
486*5113495bSYour Name 			<enum 13 RU_rsvd1> DO NOT USE
487*5113495bSYour Name 			<enum 14 RU_rsvd2> DO NOT USE
488*5113495bSYour Name 			<enum 15 RU_NONE> No RUs in this 80 MHz
489*5113495bSYour Name 			<legal 0-15>
490*5113495bSYour Name */
491*5113495bSYour Name 
492*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_OFFSET                                       0x00000008
493*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_LSB                                          24
494*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_MSB                                          27
495*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_MASK                                         0x0f000000
496*5113495bSYour Name 
497*5113495bSYour Name 
498*5113495bSYour Name /* Description		RU_TYPE_80_3
499*5113495bSYour Name 
500*5113495bSYour Name 			Indicates the size of the RU in the fourth 80 MHz sub-band
501*5113495bSYour Name 
502*5113495bSYour Name 			<enum 0 RU_26_per80>
503*5113495bSYour Name 			<enum 1 RU_52_per80>
504*5113495bSYour Name 			<enum 2 RU_78_per80>
505*5113495bSYour Name 			<enum 3 RU_106_per80>
506*5113495bSYour Name 			<enum 4 RU_132_per80>
507*5113495bSYour Name 			<enum 5 RU_242_per80>
508*5113495bSYour Name 			<enum 6 RU_484_per80>
509*5113495bSYour Name 			<enum 7 RU_726_per80>
510*5113495bSYour Name 			<enum 8 RU_996_per80>
511*5113495bSYour Name 			<enum 9 RU_996x2>
512*5113495bSYour Name 			<enum 10 RU_996x3>
513*5113495bSYour Name 			<enum 11 RU_996x4>
514*5113495bSYour Name 			<enum 12 RU_rsvd0> DO NOT USE
515*5113495bSYour Name 			<enum 13 RU_rsvd1> DO NOT USE
516*5113495bSYour Name 			<enum 14 RU_rsvd2> DO NOT USE
517*5113495bSYour Name 			<enum 15 RU_NONE> No RUs in this 80 MHz
518*5113495bSYour Name 			<legal 0-15>
519*5113495bSYour Name */
520*5113495bSYour Name 
521*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_OFFSET                                       0x00000008
522*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_LSB                                          28
523*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_MSB                                          31
524*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_MASK                                         0xf0000000
525*5113495bSYour Name 
526*5113495bSYour Name 
527*5113495bSYour Name /* Description		RU_START_INDEX_80_0
528*5113495bSYour Name 
529*5113495bSYour Name 			RU index number to which User is assigned in the first 80
530*5113495bSYour Name 			 MHz
531*5113495bSYour Name 			RU numbering is over the entire BW, starting from 0 and
532*5113495bSYour Name 			in increasing frequency order and not primary-secondary
533*5113495bSYour Name 			order
534*5113495bSYour Name 			<legal 0-36>
535*5113495bSYour Name */
536*5113495bSYour Name 
537*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_OFFSET                                0x0000000c
538*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_LSB                                   0
539*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_MSB                                   5
540*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_MASK                                  0x0000003f
541*5113495bSYour Name 
542*5113495bSYour Name 
543*5113495bSYour Name /* Description		RESERVED_3A
544*5113495bSYour Name 
545*5113495bSYour Name 			<legal 0>
546*5113495bSYour Name */
547*5113495bSYour Name 
548*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_OFFSET                                        0x0000000c
549*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_LSB                                           6
550*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_MSB                                           7
551*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_MASK                                          0x000000c0
552*5113495bSYour Name 
553*5113495bSYour Name 
554*5113495bSYour Name /* Description		RU_START_INDEX_80_1
555*5113495bSYour Name 
556*5113495bSYour Name 			RU index number to which User is assigned in the second
557*5113495bSYour Name 			80 MHz
558*5113495bSYour Name 			RU numbering is over the entire BW, starting from 0 and
559*5113495bSYour Name 			in increasing frequency order and not primary-secondary
560*5113495bSYour Name 			order
561*5113495bSYour Name 			<legal 0-36>
562*5113495bSYour Name */
563*5113495bSYour Name 
564*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_OFFSET                                0x0000000c
565*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_LSB                                   8
566*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_MSB                                   13
567*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_MASK                                  0x00003f00
568*5113495bSYour Name 
569*5113495bSYour Name 
570*5113495bSYour Name /* Description		RESERVED_3B
571*5113495bSYour Name 
572*5113495bSYour Name 			<legal 0>
573*5113495bSYour Name */
574*5113495bSYour Name 
575*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_OFFSET                                        0x0000000c
576*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_LSB                                           14
577*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_MSB                                           15
578*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_MASK                                          0x0000c000
579*5113495bSYour Name 
580*5113495bSYour Name 
581*5113495bSYour Name /* Description		RU_START_INDEX_80_2
582*5113495bSYour Name 
583*5113495bSYour Name 			RU index number to which User is assigned in the third 80
584*5113495bSYour Name 			 MHz
585*5113495bSYour Name 			RU numbering is over the entire BW, starting from 0 and
586*5113495bSYour Name 			in increasing frequency order and not primary-secondary
587*5113495bSYour Name 			order
588*5113495bSYour Name 			<legal 0-36>
589*5113495bSYour Name */
590*5113495bSYour Name 
591*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_OFFSET                                0x0000000c
592*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_LSB                                   16
593*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_MSB                                   21
594*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_MASK                                  0x003f0000
595*5113495bSYour Name 
596*5113495bSYour Name 
597*5113495bSYour Name /* Description		RESERVED_3C
598*5113495bSYour Name 
599*5113495bSYour Name 			<legal 0>
600*5113495bSYour Name */
601*5113495bSYour Name 
602*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_OFFSET                                        0x0000000c
603*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_LSB                                           22
604*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_MSB                                           23
605*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_MASK                                          0x00c00000
606*5113495bSYour Name 
607*5113495bSYour Name 
608*5113495bSYour Name /* Description		RU_START_INDEX_80_3
609*5113495bSYour Name 
610*5113495bSYour Name 			RU index number to which User is assigned in the fourth
611*5113495bSYour Name 			80 MHz
612*5113495bSYour Name 			RU numbering is over the entire BW, starting from 0 and
613*5113495bSYour Name 			in increasing frequency order and not primary-secondary
614*5113495bSYour Name 			order
615*5113495bSYour Name 			<legal 0-36>
616*5113495bSYour Name */
617*5113495bSYour Name 
618*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_OFFSET                                0x0000000c
619*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_LSB                                   24
620*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_MSB                                   29
621*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_MASK                                  0x3f000000
622*5113495bSYour Name 
623*5113495bSYour Name 
624*5113495bSYour Name /* Description		RESERVED_3D
625*5113495bSYour Name 
626*5113495bSYour Name 			<legal 0>
627*5113495bSYour Name */
628*5113495bSYour Name 
629*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_OFFSET                                        0x0000000c
630*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_LSB                                           30
631*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_MSB                                           31
632*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_MASK                                          0xc0000000
633*5113495bSYour Name 
634*5113495bSYour Name 
635*5113495bSYour Name /* Description		USER_FD_RSSI_SEG0
636*5113495bSYour Name 
637*5113495bSYour Name 			Frequency domain RSSI measurement for the lowest 80 MHz
638*5113495bSYour Name 			subband of this user, per spatial stream
639*5113495bSYour Name 			[7:0]: first spatial stream
640*5113495bSYour Name 			...
641*5113495bSYour Name 			[31:24]: fourth spatial stream
642*5113495bSYour Name 
643*5113495bSYour Name 			<legal all>
644*5113495bSYour Name */
645*5113495bSYour Name 
646*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_OFFSET                                  0x00000010
647*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_LSB                                     0
648*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_MSB                                     31
649*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_MASK                                    0xffffffff
650*5113495bSYour Name 
651*5113495bSYour Name 
652*5113495bSYour Name /* Description		USER_FD_RSSI_SEG1
653*5113495bSYour Name 
654*5113495bSYour Name 			Frequency domain RSSI measurement for the second lowest
655*5113495bSYour Name 			80 MHz subband of this user, per spatial stream
656*5113495bSYour Name 			[7:0]: first spatial stream
657*5113495bSYour Name 			...
658*5113495bSYour Name 			[31:24]: fourth spatial stream
659*5113495bSYour Name 
660*5113495bSYour Name 			<legal all>
661*5113495bSYour Name */
662*5113495bSYour Name 
663*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_OFFSET                                  0x00000014
664*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_LSB                                     0
665*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_MSB                                     31
666*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_MASK                                    0xffffffff
667*5113495bSYour Name 
668*5113495bSYour Name 
669*5113495bSYour Name /* Description		USER_FD_RSSI_SEG2
670*5113495bSYour Name 
671*5113495bSYour Name 			Frequency domain RSSI measurement for the third lowest 80
672*5113495bSYour Name 			 MHz subband of this user, per spatial stream
673*5113495bSYour Name 			[7:0]: first spatial stream
674*5113495bSYour Name 			...
675*5113495bSYour Name 			[31:24]: fourth spatial stream
676*5113495bSYour Name 
677*5113495bSYour Name 			<legal all>
678*5113495bSYour Name */
679*5113495bSYour Name 
680*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_OFFSET                                  0x00000018
681*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_LSB                                     0
682*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_MSB                                     31
683*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_MASK                                    0xffffffff
684*5113495bSYour Name 
685*5113495bSYour Name 
686*5113495bSYour Name /* Description		USER_FD_RSSI_SEG3
687*5113495bSYour Name 
688*5113495bSYour Name 			Frequency domain RSSI measurement for the highest 80 MHz
689*5113495bSYour Name 			 subband of this user, per spatial stream
690*5113495bSYour Name 			[7:0]: first spatial stream
691*5113495bSYour Name 			...
692*5113495bSYour Name 			[31:24]: fourth spatial stream
693*5113495bSYour Name 
694*5113495bSYour Name 			<legal all>
695*5113495bSYour Name */
696*5113495bSYour Name 
697*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_OFFSET                                  0x0000001c
698*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_LSB                                     0
699*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_MSB                                     31
700*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_MASK                                    0xffffffff
701*5113495bSYour Name 
702*5113495bSYour Name 
703*5113495bSYour Name 
704*5113495bSYour Name #endif   // RECEIVE_USER_INFO
705