xref: /wlan-driver/fw-api/hw/qcn6432/eht_sig_usr_ofdma_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 _EHT_SIG_USR_OFDMA_INFO_H_
18*5113495bSYour Name #define _EHT_SIG_USR_OFDMA_INFO_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #define NUM_OF_DWORDS_EHT_SIG_USR_OFDMA_INFO 2
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name struct eht_sig_usr_ofdma_info {
26*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
27*5113495bSYour Name              uint32_t sta_id                                                  : 11, // [10:0]
28*5113495bSYour Name                       sta_mcs                                                 :  4, // [14:11]
29*5113495bSYour Name                       validate_0a                                             :  1, // [15:15]
30*5113495bSYour Name                       nss                                                     :  4, // [19:16]
31*5113495bSYour Name                       txbf                                                    :  1, // [20:20]
32*5113495bSYour Name                       sta_coding                                              :  1, // [21:21]
33*5113495bSYour Name                       reserved_0b                                             :  1, // [22:22]
34*5113495bSYour Name                       rx_integrity_check_passed                               :  1, // [23:23]
35*5113495bSYour Name                       subband80_cc_mask                                       :  8; // [31:24]
36*5113495bSYour Name              uint32_t user_order_subband80_0                                  :  8, // [7:0]
37*5113495bSYour Name                       user_order_subband80_1                                  :  8, // [15:8]
38*5113495bSYour Name                       user_order_subband80_2                                  :  8, // [23:16]
39*5113495bSYour Name                       user_order_subband80_3                                  :  8; // [31:24]
40*5113495bSYour Name #else
41*5113495bSYour Name              uint32_t subband80_cc_mask                                       :  8, // [31:24]
42*5113495bSYour Name                       rx_integrity_check_passed                               :  1, // [23:23]
43*5113495bSYour Name                       reserved_0b                                             :  1, // [22:22]
44*5113495bSYour Name                       sta_coding                                              :  1, // [21:21]
45*5113495bSYour Name                       txbf                                                    :  1, // [20:20]
46*5113495bSYour Name                       nss                                                     :  4, // [19:16]
47*5113495bSYour Name                       validate_0a                                             :  1, // [15:15]
48*5113495bSYour Name                       sta_mcs                                                 :  4, // [14:11]
49*5113495bSYour Name                       sta_id                                                  : 11; // [10:0]
50*5113495bSYour Name              uint32_t user_order_subband80_3                                  :  8, // [31:24]
51*5113495bSYour Name                       user_order_subband80_2                                  :  8, // [23:16]
52*5113495bSYour Name                       user_order_subband80_1                                  :  8, // [15:8]
53*5113495bSYour Name                       user_order_subband80_0                                  :  8; // [7:0]
54*5113495bSYour Name #endif
55*5113495bSYour Name };
56*5113495bSYour Name 
57*5113495bSYour Name 
58*5113495bSYour Name /* Description		STA_ID
59*5113495bSYour Name 
60*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
61*5113495bSYour Name 			are TBD
62*5113495bSYour Name */
63*5113495bSYour Name 
64*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_ID_OFFSET                                        0x00000000
65*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_ID_LSB                                           0
66*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_ID_MSB                                           10
67*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_ID_MASK                                          0x000007ff
68*5113495bSYour Name 
69*5113495bSYour Name 
70*5113495bSYour Name /* Description		STA_MCS
71*5113495bSYour Name 
72*5113495bSYour Name 			Indicates the data MCS
73*5113495bSYour Name 			0 - 13: MCS 0 - 13
74*5113495bSYour Name 			14: validate
75*5113495bSYour Name 			15: MCS 0 with DCM
76*5113495bSYour Name 			<legal 0-13, 15>
77*5113495bSYour Name */
78*5113495bSYour Name 
79*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_OFFSET                                       0x00000000
80*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_LSB                                          11
81*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_MSB                                          14
82*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_MASK                                         0x00007800
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name /* Description		VALIDATE_0A
86*5113495bSYour Name 
87*5113495bSYour Name 			Note: spec indicates this shall be set to 1
88*5113495bSYour Name 			<legal 1>
89*5113495bSYour Name */
90*5113495bSYour Name 
91*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_OFFSET                                   0x00000000
92*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_LSB                                      15
93*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_MSB                                      15
94*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_MASK                                     0x00008000
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name /* Description		NSS
98*5113495bSYour Name 
99*5113495bSYour Name 			Number of spatial streams for this user
100*5113495bSYour Name 
101*5113495bSYour Name 			The actual number of streams is 1 larger than indicated
102*5113495bSYour Name 			in this field.
103*5113495bSYour Name 			<legal all>
104*5113495bSYour Name */
105*5113495bSYour Name 
106*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_NSS_OFFSET                                           0x00000000
107*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_NSS_LSB                                              16
108*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_NSS_MSB                                              19
109*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_NSS_MASK                                             0x000f0000
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name /* Description		TXBF
113*5113495bSYour Name 
114*5113495bSYour Name 			Indicates whether beamforming is applied
115*5113495bSYour Name 			0: No beamforming
116*5113495bSYour Name 			1: beamforming
117*5113495bSYour Name 			<legal all>
118*5113495bSYour Name */
119*5113495bSYour Name 
120*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_TXBF_OFFSET                                          0x00000000
121*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_TXBF_LSB                                             20
122*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_TXBF_MSB                                             20
123*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_TXBF_MASK                                            0x00100000
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name /* Description		STA_CODING
127*5113495bSYour Name 
128*5113495bSYour Name 			Distinguishes between BCC/LDPC
129*5113495bSYour Name 
130*5113495bSYour Name 			0: BCC
131*5113495bSYour Name 			1: LDPC
132*5113495bSYour Name 			<legal all>
133*5113495bSYour Name */
134*5113495bSYour Name 
135*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_OFFSET                                    0x00000000
136*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_LSB                                       21
137*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_MSB                                       21
138*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_MASK                                      0x00200000
139*5113495bSYour Name 
140*5113495bSYour Name 
141*5113495bSYour Name /* Description		RESERVED_0B
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal 0>
144*5113495bSYour Name */
145*5113495bSYour Name 
146*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_OFFSET                                   0x00000000
147*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_LSB                                      22
148*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_MSB                                      22
149*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_MASK                                     0x00400000
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
153*5113495bSYour Name 
154*5113495bSYour Name 			TX side: Set to 0
155*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
156*5113495bSYour Name 			 codeblock containing this EHT-SIG user info has passed,
157*5113495bSYour Name 			else set to 0
158*5113495bSYour Name 
159*5113495bSYour Name 			<legal all>
160*5113495bSYour Name */
161*5113495bSYour Name 
162*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                     0x00000000
163*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                        23
164*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                        23
165*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                       0x00800000
166*5113495bSYour Name 
167*5113495bSYour Name 
168*5113495bSYour Name /* Description		SUBBAND80_CC_MASK
169*5113495bSYour Name 
170*5113495bSYour Name 			RX side: Set to 0
171*5113495bSYour Name 			TX side: Indicates what content channels of what 80 MHz
172*5113495bSYour Name 			subbands this User field can go to
173*5113495bSYour Name 			Bit 0: lowest 80 MHz content channel 0
174*5113495bSYour Name 			Bit 1: lowest 80 MHz content channel 1
175*5113495bSYour Name 			Bit 2: 2nd lowest 80 MHz content channel 0
176*5113495bSYour Name 			...
177*5113495bSYour Name 			Bit 7: highest 80 MHz content channel 1
178*5113495bSYour Name 			<legal all>
179*5113495bSYour Name */
180*5113495bSYour Name 
181*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_OFFSET                             0x00000000
182*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_LSB                                24
183*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_MSB                                31
184*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_MASK                               0xff000000
185*5113495bSYour Name 
186*5113495bSYour Name 
187*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_0
188*5113495bSYour Name 
189*5113495bSYour Name 			RX side: Set to 0
190*5113495bSYour Name 			TX side: Ordering index of the User field within the lowest
191*5113495bSYour Name 			 80 MHz
192*5113495bSYour Name 			Gaps between the ordering indices of User fields indicate
193*5113495bSYour Name 			 that the microcode shall generate "unallocated RU" User
194*5113495bSYour Name 			 fields (STAID=2046) to fill the gaps.
195*5113495bSYour Name 			<legal all>
196*5113495bSYour Name */
197*5113495bSYour Name 
198*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_OFFSET                        0x00000004
199*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_LSB                           0
200*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_MSB                           7
201*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_MASK                          0x000000ff
202*5113495bSYour Name 
203*5113495bSYour Name 
204*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_1
205*5113495bSYour Name 
206*5113495bSYour Name 			RX side: Set to 0
207*5113495bSYour Name 			TX side: Ordering index of the User field within the 2nd
208*5113495bSYour Name 			 lowest 80 MHz
209*5113495bSYour Name 			See 'user_order_subband80_0.'
210*5113495bSYour Name 			<legal all>
211*5113495bSYour Name */
212*5113495bSYour Name 
213*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_OFFSET                        0x00000004
214*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_LSB                           8
215*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_MSB                           15
216*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_MASK                          0x0000ff00
217*5113495bSYour Name 
218*5113495bSYour Name 
219*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_2
220*5113495bSYour Name 
221*5113495bSYour Name 			RX side: Set to 0
222*5113495bSYour Name 			TX side: Ordering index of the User field within the 2nd
223*5113495bSYour Name 			 highest 80 MHz
224*5113495bSYour Name 			See 'user_order_subband80_0.'
225*5113495bSYour Name 			<legal all>
226*5113495bSYour Name */
227*5113495bSYour Name 
228*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_OFFSET                        0x00000004
229*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_LSB                           16
230*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_MSB                           23
231*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_MASK                          0x00ff0000
232*5113495bSYour Name 
233*5113495bSYour Name 
234*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_3
235*5113495bSYour Name 
236*5113495bSYour Name 			RX side: Set to 0
237*5113495bSYour Name 			TX side: Ordering index of the User field within the highest
238*5113495bSYour Name 			 80 MHz
239*5113495bSYour Name 			See 'user_order_subband80_0.'
240*5113495bSYour Name 			<legal all>
241*5113495bSYour Name */
242*5113495bSYour Name 
243*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_OFFSET                        0x00000004
244*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_LSB                           24
245*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_MSB                           31
246*5113495bSYour Name #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_MASK                          0xff000000
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name #endif   // EHT_SIG_USR_OFDMA_INFO
251