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