xref: /wlan-driver/fw-api/hw/qcn6432/eht_sig_usr_mu_mimo_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_MU_MIMO_INFO_H_
18*5113495bSYour Name #define _EHT_SIG_USR_MU_MIMO_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_MU_MIMO_INFO 2
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name struct eht_sig_usr_mu_mimo_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                       sta_coding                                              :  1, // [15:15]
30*5113495bSYour Name                       sta_spatial_config                                      :  6, // [21:16]
31*5113495bSYour Name                       reserved_0a                                             :  1, // [22:22]
32*5113495bSYour Name                       rx_integrity_check_passed                               :  1, // [23:23]
33*5113495bSYour Name                       subband80_cc_mask                                       :  8; // [31:24]
34*5113495bSYour Name              uint32_t user_order_subband80_0                                  :  8, // [7:0]
35*5113495bSYour Name                       user_order_subband80_1                                  :  8, // [15:8]
36*5113495bSYour Name                       user_order_subband80_2                                  :  8, // [23:16]
37*5113495bSYour Name                       user_order_subband80_3                                  :  8; // [31:24]
38*5113495bSYour Name #else
39*5113495bSYour Name              uint32_t subband80_cc_mask                                       :  8, // [31:24]
40*5113495bSYour Name                       rx_integrity_check_passed                               :  1, // [23:23]
41*5113495bSYour Name                       reserved_0a                                             :  1, // [22:22]
42*5113495bSYour Name                       sta_spatial_config                                      :  6, // [21:16]
43*5113495bSYour Name                       sta_coding                                              :  1, // [15:15]
44*5113495bSYour Name                       sta_mcs                                                 :  4, // [14:11]
45*5113495bSYour Name                       sta_id                                                  : 11; // [10:0]
46*5113495bSYour Name              uint32_t user_order_subband80_3                                  :  8, // [31:24]
47*5113495bSYour Name                       user_order_subband80_2                                  :  8, // [23:16]
48*5113495bSYour Name                       user_order_subband80_1                                  :  8, // [15:8]
49*5113495bSYour Name                       user_order_subband80_0                                  :  8; // [7:0]
50*5113495bSYour Name #endif
51*5113495bSYour Name };
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name /* Description		STA_ID
55*5113495bSYour Name 
56*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
57*5113495bSYour Name 			are TBD
58*5113495bSYour Name */
59*5113495bSYour Name 
60*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_ID_OFFSET                                      0x00000000
61*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_ID_LSB                                         0
62*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_ID_MSB                                         10
63*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_ID_MASK                                        0x000007ff
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name /* Description		STA_MCS
67*5113495bSYour Name 
68*5113495bSYour Name 			Indicates the data MCS
69*5113495bSYour Name 			0 - 13: MCS 0 - 13
70*5113495bSYour Name 			14: validate
71*5113495bSYour Name 			15: MCS 0 with DCM
72*5113495bSYour Name 			<legal 0-13, 15>
73*5113495bSYour Name */
74*5113495bSYour Name 
75*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_MCS_OFFSET                                     0x00000000
76*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_MCS_LSB                                        11
77*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_MCS_MSB                                        14
78*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_MCS_MASK                                       0x00007800
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name /* Description		STA_CODING
82*5113495bSYour Name 
83*5113495bSYour Name 			Distinguishes between BCC/LDPC
84*5113495bSYour Name 
85*5113495bSYour Name 			0: BCC
86*5113495bSYour Name 			1: LDPC
87*5113495bSYour Name 			<legal all>
88*5113495bSYour Name */
89*5113495bSYour Name 
90*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_CODING_OFFSET                                  0x00000000
91*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_CODING_LSB                                     15
92*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_CODING_MSB                                     15
93*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_CODING_MASK                                    0x00008000
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name /* Description		STA_SPATIAL_CONFIG
97*5113495bSYour Name 
98*5113495bSYour Name 			Number of assigned spatial streams and their corresponding
99*5113495bSYour Name 			 index.
100*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
101*5113495bSYour Name 			 allocation is also signaled.
102*5113495bSYour Name */
103*5113495bSYour Name 
104*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_SPATIAL_CONFIG_OFFSET                          0x00000000
105*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_SPATIAL_CONFIG_LSB                             16
106*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_SPATIAL_CONFIG_MSB                             21
107*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_STA_SPATIAL_CONFIG_MASK                            0x003f0000
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name /* Description		RESERVED_0A
111*5113495bSYour Name 
112*5113495bSYour Name 			<legal 0>
113*5113495bSYour Name */
114*5113495bSYour Name 
115*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RESERVED_0A_OFFSET                                 0x00000000
116*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RESERVED_0A_LSB                                    22
117*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RESERVED_0A_MSB                                    22
118*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RESERVED_0A_MASK                                   0x00400000
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
122*5113495bSYour Name 
123*5113495bSYour Name 			TX side: Set to 0
124*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
125*5113495bSYour Name 			 codeblock containing this EHT-SIG user info has passed,
126*5113495bSYour Name 			else set to 0
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal all>
129*5113495bSYour Name */
130*5113495bSYour Name 
131*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                   0x00000000
132*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                      23
133*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                      23
134*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                     0x00800000
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name /* Description		SUBBAND80_CC_MASK
138*5113495bSYour Name 
139*5113495bSYour Name 			RX side: Set to 0
140*5113495bSYour Name 			TX side: Indicates what content channels of what 80 MHz
141*5113495bSYour Name 			subbands this User field can go to
142*5113495bSYour Name 			Bit 0: lowest 80 MHz content channel 0
143*5113495bSYour Name 			Bit 1: lowest 80 MHz content channel 1
144*5113495bSYour Name 			Bit 2: 2nd lowest 80 MHz content channel 0
145*5113495bSYour Name 			...
146*5113495bSYour Name 			Bit 7: highest 80 MHz content channel 1
147*5113495bSYour Name 			<legal all>
148*5113495bSYour Name */
149*5113495bSYour Name 
150*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_SUBBAND80_CC_MASK_OFFSET                           0x00000000
151*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_SUBBAND80_CC_MASK_LSB                              24
152*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_SUBBAND80_CC_MASK_MSB                              31
153*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_SUBBAND80_CC_MASK_MASK                             0xff000000
154*5113495bSYour Name 
155*5113495bSYour Name 
156*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_0
157*5113495bSYour Name 
158*5113495bSYour Name 			RX side: Set to 0
159*5113495bSYour Name 			TX side: Ordering index of the User field within the lowest
160*5113495bSYour Name 			 80 MHz
161*5113495bSYour Name 			Gaps between the ordering indices of User fields indicate
162*5113495bSYour Name 			 that the microcode shall generate "unallocated RU" User
163*5113495bSYour Name 			 fields (STAID=2046) to fill the gaps.
164*5113495bSYour Name 			<legal all>
165*5113495bSYour Name */
166*5113495bSYour Name 
167*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_0_OFFSET                      0x00000004
168*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_0_LSB                         0
169*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_0_MSB                         7
170*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_0_MASK                        0x000000ff
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_1
174*5113495bSYour Name 
175*5113495bSYour Name 			RX side: Set to 0
176*5113495bSYour Name 			TX side: Ordering index of the User field within the 2nd
177*5113495bSYour Name 			 lowest 80 MHz
178*5113495bSYour Name 			See 'user_order_subband80_0.'
179*5113495bSYour Name 			<legal all>
180*5113495bSYour Name */
181*5113495bSYour Name 
182*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_1_OFFSET                      0x00000004
183*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_1_LSB                         8
184*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_1_MSB                         15
185*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_1_MASK                        0x0000ff00
186*5113495bSYour Name 
187*5113495bSYour Name 
188*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_2
189*5113495bSYour Name 
190*5113495bSYour Name 			RX side: Set to 0
191*5113495bSYour Name 			TX side: Ordering index of the User field within the 2nd
192*5113495bSYour Name 			 highest 80 MHz
193*5113495bSYour Name 			See 'user_order_subband80_0.'
194*5113495bSYour Name 			<legal all>
195*5113495bSYour Name */
196*5113495bSYour Name 
197*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_2_OFFSET                      0x00000004
198*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_2_LSB                         16
199*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_2_MSB                         23
200*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_2_MASK                        0x00ff0000
201*5113495bSYour Name 
202*5113495bSYour Name 
203*5113495bSYour Name /* Description		USER_ORDER_SUBBAND80_3
204*5113495bSYour Name 
205*5113495bSYour Name 			RX side: Set to 0
206*5113495bSYour Name 			TX side: Ordering index of the User field within the highest
207*5113495bSYour Name 			 80 MHz
208*5113495bSYour Name 			See 'user_order_subband80_0.'
209*5113495bSYour Name 			<legal all>
210*5113495bSYour Name */
211*5113495bSYour Name 
212*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_3_OFFSET                      0x00000004
213*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_3_LSB                         24
214*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_3_MSB                         31
215*5113495bSYour Name #define EHT_SIG_USR_MU_MIMO_INFO_USER_ORDER_SUBBAND80_3_MASK                        0xff000000
216*5113495bSYour Name 
217*5113495bSYour Name 
218*5113495bSYour Name 
219*5113495bSYour Name #endif   // EHT_SIG_USR_MU_MIMO_INFO
220