xref: /wlan-driver/fw-api/hw/qca6490/v1/receive_user_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _RECEIVE_USER_INFO_H_
25*5113495bSYour Name #define _RECEIVE_USER_INFO_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	phy_ppdu_id[15:0], user_rssi[23:16], pkt_type[27:24], stbc[28], reception_type[31:29]
34*5113495bSYour Name //	1	rate_mcs[3:0], sgi[5:4], receive_bandwidth[7:6], mimo_ss_bitmap[15:8], ofdma_ru_allocation[23:16], ofdma_user_index[30:24], ofdma_content_channel[31]
35*5113495bSYour Name //	2	ldpc[0], ru_width[7:1], reserved_2a[31:8]
36*5113495bSYour Name //
37*5113495bSYour Name // ################ END SUMMARY #################
38*5113495bSYour Name 
39*5113495bSYour Name #define NUM_OF_DWORDS_RECEIVE_USER_INFO 3
40*5113495bSYour Name 
41*5113495bSYour Name struct receive_user_info {
42*5113495bSYour Name              uint32_t phy_ppdu_id                     : 16, //[15:0]
43*5113495bSYour Name                       user_rssi                       :  8, //[23:16]
44*5113495bSYour Name                       pkt_type                        :  4, //[27:24]
45*5113495bSYour Name                       stbc                            :  1, //[28]
46*5113495bSYour Name                       reception_type                  :  3; //[31:29]
47*5113495bSYour Name              uint32_t rate_mcs                        :  4, //[3:0]
48*5113495bSYour Name                       sgi                             :  2, //[5:4]
49*5113495bSYour Name                       receive_bandwidth               :  2, //[7:6]
50*5113495bSYour Name                       mimo_ss_bitmap                  :  8, //[15:8]
51*5113495bSYour Name                       ofdma_ru_allocation             :  8, //[23:16]
52*5113495bSYour Name                       ofdma_user_index                :  7, //[30:24]
53*5113495bSYour Name                       ofdma_content_channel           :  1; //[31]
54*5113495bSYour Name              uint32_t ldpc                            :  1, //[0]
55*5113495bSYour Name                       ru_width                        :  7, //[7:1]
56*5113495bSYour Name                       reserved_2a                     : 24; //[31:8]
57*5113495bSYour Name };
58*5113495bSYour Name 
59*5113495bSYour Name /*
60*5113495bSYour Name 
61*5113495bSYour Name phy_ppdu_id
62*5113495bSYour Name 
63*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
64*5113495bSYour Name 			received. The counter value wraps around
65*5113495bSYour Name 
66*5113495bSYour Name 			<legal all>
67*5113495bSYour Name 
68*5113495bSYour Name user_rssi
69*5113495bSYour Name 
70*5113495bSYour Name 			RSSI for this user
71*5113495bSYour Name 
72*5113495bSYour Name 			Frequency domain RSSI measurement for this user. Based
73*5113495bSYour Name 			on the channel estimate.
74*5113495bSYour Name 
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 			<legal all>
78*5113495bSYour Name 
79*5113495bSYour Name pkt_type
80*5113495bSYour Name 
81*5113495bSYour Name 			Packet type:
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
86*5113495bSYour Name 
87*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
88*5113495bSYour Name 
89*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
90*5113495bSYour Name 
91*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
94*5113495bSYour Name 
95*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
96*5113495bSYour Name 
97*5113495bSYour Name stbc
98*5113495bSYour Name 
99*5113495bSYour Name 			When set, use STBC transmission rates
100*5113495bSYour Name 
101*5113495bSYour Name reception_type
102*5113495bSYour Name 
103*5113495bSYour Name 			Indicates what type of reception this is.
104*5113495bSYour Name 
105*5113495bSYour Name 			<enum 0     reception_type_SU > Basic SU reception (not
106*5113495bSYour Name 			part of OFDMA or MU-MIMO)
107*5113495bSYour Name 
108*5113495bSYour Name 			<enum 1     reception_type_MU_MIMO > This is related to
109*5113495bSYour Name 			DL type of reception
110*5113495bSYour Name 
111*5113495bSYour Name 			<enum 2     reception_type_MU_OFDMA >  This is related
112*5113495bSYour Name 			to DL type of reception
113*5113495bSYour Name 
114*5113495bSYour Name 			<enum 3     reception_type_MU_OFDMA_MIMO >  This is
115*5113495bSYour Name 			related to DL type of reception
116*5113495bSYour Name 
117*5113495bSYour Name 			<enum 4     reception_type_UL_MU_MIMO > This is related
118*5113495bSYour Name 			to UL type of reception
119*5113495bSYour Name 
120*5113495bSYour Name 			<enum 5     reception_type_UL_MU_OFDMA >  This is
121*5113495bSYour Name 			related to UL type of reception
122*5113495bSYour Name 
123*5113495bSYour Name 			<enum 6     reception_type_UL_MU_OFDMA_MIMO >  This is
124*5113495bSYour Name 			related to UL type of reception
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal 0-6>
129*5113495bSYour Name 
130*5113495bSYour Name rate_mcs
131*5113495bSYour Name 
132*5113495bSYour Name 			For details, refer to  MCS_TYPE description
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal all>
135*5113495bSYour Name 
136*5113495bSYour Name sgi
137*5113495bSYour Name 
138*5113495bSYour Name 			Field only valid when pkt type is HT, VHT or HE.
139*5113495bSYour Name 
140*5113495bSYour Name 
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 0     gi_0_8_us > Legacy normal GI.  Can also be
143*5113495bSYour Name 			used for HE
144*5113495bSYour Name 
145*5113495bSYour Name 			<enum 1     gi_0_4_us > Legacy short GI.  Can also be
146*5113495bSYour Name 			used for HE
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 2     gi_1_6_us > HE related GI
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 3     gi_3_2_us > HE related GI
151*5113495bSYour Name 
152*5113495bSYour Name 			<legal 0 - 3>
153*5113495bSYour Name 
154*5113495bSYour Name receive_bandwidth
155*5113495bSYour Name 
156*5113495bSYour Name 			Full receive Bandwidth
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name 			<enum 0     full_rx_bw_20_mhz>
161*5113495bSYour Name 
162*5113495bSYour Name 			<enum 1      full_rx_bw_40_mhz>
163*5113495bSYour Name 
164*5113495bSYour Name 			<enum 2      full_rx_bw_80_mhz>
165*5113495bSYour Name 
166*5113495bSYour Name 			<enum 3      full_rx_bw_160_mhz>
167*5113495bSYour Name 
168*5113495bSYour Name 
169*5113495bSYour Name 
170*5113495bSYour Name 			<legal 0-3>
171*5113495bSYour Name 
172*5113495bSYour Name mimo_ss_bitmap
173*5113495bSYour Name 
174*5113495bSYour Name 			Bitmap, with each bit indicating if the related spatial
175*5113495bSYour Name 			stream is used for this STA
176*5113495bSYour Name 
177*5113495bSYour Name 			LSB related to SS 0
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 			0: spatial stream not used for this reception
182*5113495bSYour Name 
183*5113495bSYour Name 			1: spatial stream used for this reception
184*5113495bSYour Name 
185*5113495bSYour Name 
186*5113495bSYour Name 
187*5113495bSYour Name 			<legal all>
188*5113495bSYour Name 
189*5113495bSYour Name ofdma_ru_allocation
190*5113495bSYour Name 
191*5113495bSYour Name 			Field only valid in case of OFDMA type receptions (DL
192*5113495bSYour Name 			and UL)
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 			Indicates the RU number associated with this user.
197*5113495bSYour Name 
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name 			In case of reception where the transmission was DL MU
201*5113495bSYour Name 			OFDMA, this field provides the RU pattern. Note that fields
202*5113495bSYour Name 			ofdma_user_index and ofdma_content_channel are needed to
203*5113495bSYour Name 			determine which RU (within a 40 MHz channel) was actually
204*5113495bSYour Name 			assigned to this user, but this does not give info on which
205*5113495bSYour Name 			40 MHz channel was assigned to this user. Please refer
206*5113495bSYour Name 			DL_ofdma_ru_* in PHYRX_PKT_END_INFO for complete RU info for
207*5113495bSYour Name 			this user.
208*5113495bSYour Name 
209*5113495bSYour Name 
210*5113495bSYour Name 
211*5113495bSYour Name 			In case of reception where the transmission was UL MU
212*5113495bSYour Name 			OFDMA, PHY is recommended to insert the RU start index in
213*5113495bSYour Name 			this field. Note that PHY may insert the RU width in
214*5113495bSYour Name 			Reserved_2a[6:0].
215*5113495bSYour Name 
216*5113495bSYour Name 			<legal all>
217*5113495bSYour Name 
218*5113495bSYour Name ofdma_user_index
219*5113495bSYour Name 
220*5113495bSYour Name 			Field only valid in the of DL MU OFDMA reception
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name 
224*5113495bSYour Name 			The user number within the RU_allocation.
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 			This is needed for SW to determine the exact RU position
229*5113495bSYour Name 			within the reception.
230*5113495bSYour Name 
231*5113495bSYour Name 			<legal all>
232*5113495bSYour Name 
233*5113495bSYour Name ofdma_content_channel
234*5113495bSYour Name 
235*5113495bSYour Name 			Field only valid in the of DL MU OFDMA/MIMO reception
236*5113495bSYour Name 
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name 			In case of DL MU reception, this field indicates the
240*5113495bSYour Name 			content channel number where PHY found the RU information
241*5113495bSYour Name 			for this user
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 			This is needed for SW to determine the exact RU position
246*5113495bSYour Name 			within the reception.
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 			<enum 0      content_channel_1>
251*5113495bSYour Name 
252*5113495bSYour Name 			<enum 1      content_channel_2>
253*5113495bSYour Name 
254*5113495bSYour Name 
255*5113495bSYour Name 
256*5113495bSYour Name 			<legal all>
257*5113495bSYour Name 
258*5113495bSYour Name ldpc
259*5113495bSYour Name 
260*5113495bSYour Name 			When set, use LDPC transmission rates were used.
261*5113495bSYour Name 
262*5113495bSYour Name 			<legal all>
263*5113495bSYour Name 
264*5113495bSYour Name ru_width
265*5113495bSYour Name 
266*5113495bSYour Name 			In case of UL OFDMA reception, PHY is recommended to
267*5113495bSYour Name 			insert the RU width
268*5113495bSYour Name 
269*5113495bSYour Name 			In Hastings80: was using Reserved_2a[6:0].
270*5113495bSYour Name 
271*5113495bSYour Name 			<legal 1 - 74>
272*5113495bSYour Name 
273*5113495bSYour Name reserved_2a
274*5113495bSYour Name 
275*5113495bSYour Name 			<legal 0>
276*5113495bSYour Name */
277*5113495bSYour Name 
278*5113495bSYour Name 
279*5113495bSYour Name /* Description		RECEIVE_USER_INFO_0_PHY_PPDU_ID
280*5113495bSYour Name 
281*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
282*5113495bSYour Name 			received. The counter value wraps around
283*5113495bSYour Name 
284*5113495bSYour Name 			<legal all>
285*5113495bSYour Name */
286*5113495bSYour Name #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_OFFSET                       0x00000000
287*5113495bSYour Name #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_LSB                          0
288*5113495bSYour Name #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_MASK                         0x0000ffff
289*5113495bSYour Name 
290*5113495bSYour Name /* Description		RECEIVE_USER_INFO_0_USER_RSSI
291*5113495bSYour Name 
292*5113495bSYour Name 			RSSI for this user
293*5113495bSYour Name 
294*5113495bSYour Name 			Frequency domain RSSI measurement for this user. Based
295*5113495bSYour Name 			on the channel estimate.
296*5113495bSYour Name 
297*5113495bSYour Name 
298*5113495bSYour Name 
299*5113495bSYour Name 			<legal all>
300*5113495bSYour Name */
301*5113495bSYour Name #define RECEIVE_USER_INFO_0_USER_RSSI_OFFSET                         0x00000000
302*5113495bSYour Name #define RECEIVE_USER_INFO_0_USER_RSSI_LSB                            16
303*5113495bSYour Name #define RECEIVE_USER_INFO_0_USER_RSSI_MASK                           0x00ff0000
304*5113495bSYour Name 
305*5113495bSYour Name /* Description		RECEIVE_USER_INFO_0_PKT_TYPE
306*5113495bSYour Name 
307*5113495bSYour Name 			Packet type:
308*5113495bSYour Name 
309*5113495bSYour Name 
310*5113495bSYour Name 
311*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
312*5113495bSYour Name 
313*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
314*5113495bSYour Name 
315*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
316*5113495bSYour Name 
317*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
318*5113495bSYour Name 
319*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
320*5113495bSYour Name 
321*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
322*5113495bSYour Name */
323*5113495bSYour Name #define RECEIVE_USER_INFO_0_PKT_TYPE_OFFSET                          0x00000000
324*5113495bSYour Name #define RECEIVE_USER_INFO_0_PKT_TYPE_LSB                             24
325*5113495bSYour Name #define RECEIVE_USER_INFO_0_PKT_TYPE_MASK                            0x0f000000
326*5113495bSYour Name 
327*5113495bSYour Name /* Description		RECEIVE_USER_INFO_0_STBC
328*5113495bSYour Name 
329*5113495bSYour Name 			When set, use STBC transmission rates
330*5113495bSYour Name */
331*5113495bSYour Name #define RECEIVE_USER_INFO_0_STBC_OFFSET                              0x00000000
332*5113495bSYour Name #define RECEIVE_USER_INFO_0_STBC_LSB                                 28
333*5113495bSYour Name #define RECEIVE_USER_INFO_0_STBC_MASK                                0x10000000
334*5113495bSYour Name 
335*5113495bSYour Name /* Description		RECEIVE_USER_INFO_0_RECEPTION_TYPE
336*5113495bSYour Name 
337*5113495bSYour Name 			Indicates what type of reception this is.
338*5113495bSYour Name 
339*5113495bSYour Name 			<enum 0     reception_type_SU > Basic SU reception (not
340*5113495bSYour Name 			part of OFDMA or MU-MIMO)
341*5113495bSYour Name 
342*5113495bSYour Name 			<enum 1     reception_type_MU_MIMO > This is related to
343*5113495bSYour Name 			DL type of reception
344*5113495bSYour Name 
345*5113495bSYour Name 			<enum 2     reception_type_MU_OFDMA >  This is related
346*5113495bSYour Name 			to DL type of reception
347*5113495bSYour Name 
348*5113495bSYour Name 			<enum 3     reception_type_MU_OFDMA_MIMO >  This is
349*5113495bSYour Name 			related to DL type of reception
350*5113495bSYour Name 
351*5113495bSYour Name 			<enum 4     reception_type_UL_MU_MIMO > This is related
352*5113495bSYour Name 			to UL type of reception
353*5113495bSYour Name 
354*5113495bSYour Name 			<enum 5     reception_type_UL_MU_OFDMA >  This is
355*5113495bSYour Name 			related to UL type of reception
356*5113495bSYour Name 
357*5113495bSYour Name 			<enum 6     reception_type_UL_MU_OFDMA_MIMO >  This is
358*5113495bSYour Name 			related to UL type of reception
359*5113495bSYour Name 
360*5113495bSYour Name 
361*5113495bSYour Name 
362*5113495bSYour Name 			<legal 0-6>
363*5113495bSYour Name */
364*5113495bSYour Name #define RECEIVE_USER_INFO_0_RECEPTION_TYPE_OFFSET                    0x00000000
365*5113495bSYour Name #define RECEIVE_USER_INFO_0_RECEPTION_TYPE_LSB                       29
366*5113495bSYour Name #define RECEIVE_USER_INFO_0_RECEPTION_TYPE_MASK                      0xe0000000
367*5113495bSYour Name 
368*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_RATE_MCS
369*5113495bSYour Name 
370*5113495bSYour Name 			For details, refer to  MCS_TYPE description
371*5113495bSYour Name 
372*5113495bSYour Name 			<legal all>
373*5113495bSYour Name */
374*5113495bSYour Name #define RECEIVE_USER_INFO_1_RATE_MCS_OFFSET                          0x00000004
375*5113495bSYour Name #define RECEIVE_USER_INFO_1_RATE_MCS_LSB                             0
376*5113495bSYour Name #define RECEIVE_USER_INFO_1_RATE_MCS_MASK                            0x0000000f
377*5113495bSYour Name 
378*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_SGI
379*5113495bSYour Name 
380*5113495bSYour Name 			Field only valid when pkt type is HT, VHT or HE.
381*5113495bSYour Name 
382*5113495bSYour Name 
383*5113495bSYour Name 
384*5113495bSYour Name 			<enum 0     gi_0_8_us > Legacy normal GI.  Can also be
385*5113495bSYour Name 			used for HE
386*5113495bSYour Name 
387*5113495bSYour Name 			<enum 1     gi_0_4_us > Legacy short GI.  Can also be
388*5113495bSYour Name 			used for HE
389*5113495bSYour Name 
390*5113495bSYour Name 			<enum 2     gi_1_6_us > HE related GI
391*5113495bSYour Name 
392*5113495bSYour Name 			<enum 3     gi_3_2_us > HE related GI
393*5113495bSYour Name 
394*5113495bSYour Name 			<legal 0 - 3>
395*5113495bSYour Name */
396*5113495bSYour Name #define RECEIVE_USER_INFO_1_SGI_OFFSET                               0x00000004
397*5113495bSYour Name #define RECEIVE_USER_INFO_1_SGI_LSB                                  4
398*5113495bSYour Name #define RECEIVE_USER_INFO_1_SGI_MASK                                 0x00000030
399*5113495bSYour Name 
400*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH
401*5113495bSYour Name 
402*5113495bSYour Name 			Full receive Bandwidth
403*5113495bSYour Name 
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name 			<enum 0     full_rx_bw_20_mhz>
407*5113495bSYour Name 
408*5113495bSYour Name 			<enum 1      full_rx_bw_40_mhz>
409*5113495bSYour Name 
410*5113495bSYour Name 			<enum 2      full_rx_bw_80_mhz>
411*5113495bSYour Name 
412*5113495bSYour Name 			<enum 3      full_rx_bw_160_mhz>
413*5113495bSYour Name 
414*5113495bSYour Name 
415*5113495bSYour Name 
416*5113495bSYour Name 			<legal 0-3>
417*5113495bSYour Name */
418*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_OFFSET                 0x00000004
419*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_LSB                    6
420*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_MASK                   0x000000c0
421*5113495bSYour Name 
422*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_MIMO_SS_BITMAP
423*5113495bSYour Name 
424*5113495bSYour Name 			Bitmap, with each bit indicating if the related spatial
425*5113495bSYour Name 			stream is used for this STA
426*5113495bSYour Name 
427*5113495bSYour Name 			LSB related to SS 0
428*5113495bSYour Name 
429*5113495bSYour Name 
430*5113495bSYour Name 
431*5113495bSYour Name 			0: spatial stream not used for this reception
432*5113495bSYour Name 
433*5113495bSYour Name 			1: spatial stream used for this reception
434*5113495bSYour Name 
435*5113495bSYour Name 
436*5113495bSYour Name 
437*5113495bSYour Name 			<legal all>
438*5113495bSYour Name */
439*5113495bSYour Name #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_OFFSET                    0x00000004
440*5113495bSYour Name #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_LSB                       8
441*5113495bSYour Name #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_MASK                      0x0000ff00
442*5113495bSYour Name 
443*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION
444*5113495bSYour Name 
445*5113495bSYour Name 			Field only valid in case of OFDMA type receptions (DL
446*5113495bSYour Name 			and UL)
447*5113495bSYour Name 
448*5113495bSYour Name 
449*5113495bSYour Name 
450*5113495bSYour Name 			Indicates the RU number associated with this user.
451*5113495bSYour Name 
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 			In case of reception where the transmission was DL MU
455*5113495bSYour Name 			OFDMA, this field provides the RU pattern. Note that fields
456*5113495bSYour Name 			ofdma_user_index and ofdma_content_channel are needed to
457*5113495bSYour Name 			determine which RU (within a 40 MHz channel) was actually
458*5113495bSYour Name 			assigned to this user, but this does not give info on which
459*5113495bSYour Name 			40 MHz channel was assigned to this user. Please refer
460*5113495bSYour Name 			DL_ofdma_ru_* in PHYRX_PKT_END_INFO for complete RU info for
461*5113495bSYour Name 			this user.
462*5113495bSYour Name 
463*5113495bSYour Name 
464*5113495bSYour Name 
465*5113495bSYour Name 			In case of reception where the transmission was UL MU
466*5113495bSYour Name 			OFDMA, PHY is recommended to insert the RU start index in
467*5113495bSYour Name 			this field. Note that PHY may insert the RU width in
468*5113495bSYour Name 			Reserved_2a[6:0].
469*5113495bSYour Name 
470*5113495bSYour Name 			<legal all>
471*5113495bSYour Name */
472*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION_OFFSET               0x00000004
473*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION_LSB                  16
474*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION_MASK                 0x00ff0000
475*5113495bSYour Name 
476*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_OFDMA_USER_INDEX
477*5113495bSYour Name 
478*5113495bSYour Name 			Field only valid in the of DL MU OFDMA reception
479*5113495bSYour Name 
480*5113495bSYour Name 
481*5113495bSYour Name 
482*5113495bSYour Name 			The user number within the RU_allocation.
483*5113495bSYour Name 
484*5113495bSYour Name 
485*5113495bSYour Name 
486*5113495bSYour Name 			This is needed for SW to determine the exact RU position
487*5113495bSYour Name 			within the reception.
488*5113495bSYour Name 
489*5113495bSYour Name 			<legal all>
490*5113495bSYour Name */
491*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_USER_INDEX_OFFSET                  0x00000004
492*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_USER_INDEX_LSB                     24
493*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_USER_INDEX_MASK                    0x7f000000
494*5113495bSYour Name 
495*5113495bSYour Name /* Description		RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL
496*5113495bSYour Name 
497*5113495bSYour Name 			Field only valid in the of DL MU OFDMA/MIMO reception
498*5113495bSYour Name 
499*5113495bSYour Name 
500*5113495bSYour Name 
501*5113495bSYour Name 			In case of DL MU reception, this field indicates the
502*5113495bSYour Name 			content channel number where PHY found the RU information
503*5113495bSYour Name 			for this user
504*5113495bSYour Name 
505*5113495bSYour Name 
506*5113495bSYour Name 
507*5113495bSYour Name 			This is needed for SW to determine the exact RU position
508*5113495bSYour Name 			within the reception.
509*5113495bSYour Name 
510*5113495bSYour Name 
511*5113495bSYour Name 
512*5113495bSYour Name 			<enum 0      content_channel_1>
513*5113495bSYour Name 
514*5113495bSYour Name 			<enum 1      content_channel_2>
515*5113495bSYour Name 
516*5113495bSYour Name 
517*5113495bSYour Name 
518*5113495bSYour Name 			<legal all>
519*5113495bSYour Name */
520*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL_OFFSET             0x00000004
521*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL_LSB                31
522*5113495bSYour Name #define RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL_MASK               0x80000000
523*5113495bSYour Name 
524*5113495bSYour Name /* Description		RECEIVE_USER_INFO_2_LDPC
525*5113495bSYour Name 
526*5113495bSYour Name 			When set, use LDPC transmission rates were used.
527*5113495bSYour Name 
528*5113495bSYour Name 			<legal all>
529*5113495bSYour Name */
530*5113495bSYour Name #define RECEIVE_USER_INFO_2_LDPC_OFFSET                              0x00000008
531*5113495bSYour Name #define RECEIVE_USER_INFO_2_LDPC_LSB                                 0
532*5113495bSYour Name #define RECEIVE_USER_INFO_2_LDPC_MASK                                0x00000001
533*5113495bSYour Name 
534*5113495bSYour Name /* Description		RECEIVE_USER_INFO_2_RU_WIDTH
535*5113495bSYour Name 
536*5113495bSYour Name 			In case of UL OFDMA reception, PHY is recommended to
537*5113495bSYour Name 			insert the RU width
538*5113495bSYour Name 
539*5113495bSYour Name 			In Hastings80: was using Reserved_2a[6:0].
540*5113495bSYour Name 
541*5113495bSYour Name 			<legal 1 - 74>
542*5113495bSYour Name */
543*5113495bSYour Name #define RECEIVE_USER_INFO_2_RU_WIDTH_OFFSET                          0x00000008
544*5113495bSYour Name #define RECEIVE_USER_INFO_2_RU_WIDTH_LSB                             1
545*5113495bSYour Name #define RECEIVE_USER_INFO_2_RU_WIDTH_MASK                            0x000000fe
546*5113495bSYour Name 
547*5113495bSYour Name /* Description		RECEIVE_USER_INFO_2_RESERVED_2A
548*5113495bSYour Name 
549*5113495bSYour Name 			<legal 0>
550*5113495bSYour Name */
551*5113495bSYour Name #define RECEIVE_USER_INFO_2_RESERVED_2A_OFFSET                       0x00000008
552*5113495bSYour Name #define RECEIVE_USER_INFO_2_RESERVED_2A_LSB                          8
553*5113495bSYour Name #define RECEIVE_USER_INFO_2_RESERVED_2A_MASK                         0xffffff00
554*5113495bSYour Name 
555*5113495bSYour Name 
556*5113495bSYour Name #endif // _RECEIVE_USER_INFO_H_
557