xref: /wlan-driver/fw-api/hw/qca5332/eht_sig_usr_su_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _EHT_SIG_USR_SU_INFO_H_
27*5113495bSYour Name #define _EHT_SIG_USR_SU_INFO_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_EHT_SIG_USR_SU_INFO 1
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct eht_sig_usr_su_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t sta_id                                                  : 11, // [10:0]
37*5113495bSYour Name                       sta_mcs                                                 :  4, // [14:11]
38*5113495bSYour Name                       validate_0a                                             :  1, // [15:15]
39*5113495bSYour Name                       nss                                                     :  4, // [19:16]
40*5113495bSYour Name                       txbf                                                    :  1, // [20:20]
41*5113495bSYour Name                       sta_coding                                              :  1, // [21:21]
42*5113495bSYour Name                       reserved_0b                                             :  9, // [30:22]
43*5113495bSYour Name                       rx_integrity_check_passed                               :  1; // [31:31]
44*5113495bSYour Name #else
45*5113495bSYour Name              uint32_t rx_integrity_check_passed                               :  1, // [31:31]
46*5113495bSYour Name                       reserved_0b                                             :  9, // [30:22]
47*5113495bSYour Name                       sta_coding                                              :  1, // [21:21]
48*5113495bSYour Name                       txbf                                                    :  1, // [20:20]
49*5113495bSYour Name                       nss                                                     :  4, // [19:16]
50*5113495bSYour Name                       validate_0a                                             :  1, // [15:15]
51*5113495bSYour Name                       sta_mcs                                                 :  4, // [14:11]
52*5113495bSYour Name                       sta_id                                                  : 11; // [10:0]
53*5113495bSYour Name #endif
54*5113495bSYour Name };
55*5113495bSYour Name 
56*5113495bSYour Name 
57*5113495bSYour Name /* Description		STA_ID
58*5113495bSYour Name 
59*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
60*5113495bSYour Name 			are TBD
61*5113495bSYour Name */
62*5113495bSYour Name 
63*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_ID_OFFSET                                           0x00000000
64*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_ID_LSB                                              0
65*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_ID_MSB                                              10
66*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_ID_MASK                                             0x000007ff
67*5113495bSYour Name 
68*5113495bSYour Name 
69*5113495bSYour Name /* Description		STA_MCS
70*5113495bSYour Name 
71*5113495bSYour Name 			Indicates the data MCS
72*5113495bSYour Name 			0 - 13: MCS 0 - 13
73*5113495bSYour Name 			14: MCS 0 with DCM and 2x duplicate
74*5113495bSYour Name 			15: MCS 0 with DCM
75*5113495bSYour Name 			<legal all>
76*5113495bSYour Name */
77*5113495bSYour Name 
78*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_MCS_OFFSET                                          0x00000000
79*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_MCS_LSB                                             11
80*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_MCS_MSB                                             14
81*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_MCS_MASK                                            0x00007800
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name /* Description		VALIDATE_0A
85*5113495bSYour Name 
86*5113495bSYour Name 			Note: spec indicates this shall be set to 1
87*5113495bSYour Name 			<legal 1>
88*5113495bSYour Name */
89*5113495bSYour Name 
90*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_VALIDATE_0A_OFFSET                                      0x00000000
91*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_VALIDATE_0A_LSB                                         15
92*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_VALIDATE_0A_MSB                                         15
93*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_VALIDATE_0A_MASK                                        0x00008000
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name /* Description		NSS
97*5113495bSYour Name 
98*5113495bSYour Name 			Number of spatial streams for this user
99*5113495bSYour Name 
100*5113495bSYour Name 			The actual number of streams is 1 larger than indicated
101*5113495bSYour Name 			in this field.
102*5113495bSYour Name 			<legal all>
103*5113495bSYour Name */
104*5113495bSYour Name 
105*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_NSS_OFFSET                                              0x00000000
106*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_NSS_LSB                                                 16
107*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_NSS_MSB                                                 19
108*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_NSS_MASK                                                0x000f0000
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name /* Description		TXBF
112*5113495bSYour Name 
113*5113495bSYour Name 			Indicates whether beamforming is applied
114*5113495bSYour Name 			0: No beamforming
115*5113495bSYour Name 			1: beamforming
116*5113495bSYour Name 			<legal all>
117*5113495bSYour Name */
118*5113495bSYour Name 
119*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_TXBF_OFFSET                                             0x00000000
120*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_TXBF_LSB                                                20
121*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_TXBF_MSB                                                20
122*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_TXBF_MASK                                               0x00100000
123*5113495bSYour Name 
124*5113495bSYour Name 
125*5113495bSYour Name /* Description		STA_CODING
126*5113495bSYour Name 
127*5113495bSYour Name 			Distinguishes between BCC/LDPC
128*5113495bSYour Name 
129*5113495bSYour Name 			0: BCC
130*5113495bSYour Name 			1: LDPC
131*5113495bSYour Name 			<legal all>
132*5113495bSYour Name */
133*5113495bSYour Name 
134*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_CODING_OFFSET                                       0x00000000
135*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_CODING_LSB                                          21
136*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_CODING_MSB                                          21
137*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_STA_CODING_MASK                                         0x00200000
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name /* Description		RESERVED_0B
141*5113495bSYour Name 
142*5113495bSYour Name 			<legal 0>
143*5113495bSYour Name */
144*5113495bSYour Name 
145*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RESERVED_0B_OFFSET                                      0x00000000
146*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RESERVED_0B_LSB                                         22
147*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RESERVED_0B_MSB                                         30
148*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RESERVED_0B_MASK                                        0x7fc00000
149*5113495bSYour Name 
150*5113495bSYour Name 
151*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
152*5113495bSYour Name 
153*5113495bSYour Name 			TX side: Set to 0
154*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
155*5113495bSYour Name 			 codeblock containing this EHT-SIG user info has passed,
156*5113495bSYour Name 			else set to 0
157*5113495bSYour Name 
158*5113495bSYour Name 			<legal all>
159*5113495bSYour Name */
160*5113495bSYour Name 
161*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                        0x00000000
162*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                           31
163*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                           31
164*5113495bSYour Name #define EHT_SIG_USR_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                          0x80000000
165*5113495bSYour Name 
166*5113495bSYour Name 
167*5113495bSYour Name 
168*5113495bSYour Name #endif   // EHT_SIG_USR_SU_INFO
169