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