xref: /wlan-driver/fw-api/hw/qcn6432/mactx_ht_sig.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 _MACTX_HT_SIG_H_
18*5113495bSYour Name #define _MACTX_HT_SIG_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "ht_sig_info.h"
23*5113495bSYour Name #define NUM_OF_DWORDS_MACTX_HT_SIG 2
24*5113495bSYour Name 
25*5113495bSYour Name #define NUM_OF_QWORDS_MACTX_HT_SIG 1
26*5113495bSYour Name 
27*5113495bSYour Name 
28*5113495bSYour Name struct mactx_ht_sig {
29*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
30*5113495bSYour Name              struct   ht_sig_info                                               mactx_ht_sig_info_details;
31*5113495bSYour Name #else
32*5113495bSYour Name              struct   ht_sig_info                                               mactx_ht_sig_info_details;
33*5113495bSYour Name #endif
34*5113495bSYour Name };
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name /* Description		MACTX_HT_SIG_INFO_DETAILS
38*5113495bSYour Name 
39*5113495bSYour Name 			See detailed description of the STRUCT
40*5113495bSYour Name */
41*5113495bSYour Name 
42*5113495bSYour Name 
43*5113495bSYour Name /* Description		MCS
44*5113495bSYour Name 
45*5113495bSYour Name 			Modulation Coding Scheme:
46*5113495bSYour Name 			0-7 are used for single stream
47*5113495bSYour Name 			8-15 are used for 2 streams
48*5113495bSYour Name 			16-23 are used for 3 streams
49*5113495bSYour Name 			24-31 are used for 4 streams
50*5113495bSYour Name 			32 is used for duplicate HT20 (unsupported)
51*5113495bSYour Name 			33-76 is used for unequal modulation (unsupported)
52*5113495bSYour Name 			77-127 is reserved.
53*5113495bSYour Name 			<legal 0-31>
54*5113495bSYour Name */
55*5113495bSYour Name 
56*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_MCS_OFFSET                           0x0000000000000000
57*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_MCS_LSB                              0
58*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_MCS_MSB                              6
59*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_MCS_MASK                             0x000000000000007f
60*5113495bSYour Name 
61*5113495bSYour Name 
62*5113495bSYour Name /* Description		CBW
63*5113495bSYour Name 
64*5113495bSYour Name 			Packet bandwidth:
65*5113495bSYour Name 			<enum 0     ht_20_mhz>
66*5113495bSYour Name 			<enum 1     ht_40_mhz>
67*5113495bSYour Name 			<legal 0-1>
68*5113495bSYour Name */
69*5113495bSYour Name 
70*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CBW_OFFSET                           0x0000000000000000
71*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CBW_LSB                              7
72*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CBW_MSB                              7
73*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CBW_MASK                             0x0000000000000080
74*5113495bSYour Name 
75*5113495bSYour Name 
76*5113495bSYour Name /* Description		LENGTH
77*5113495bSYour Name 
78*5113495bSYour Name 			This is the MPDU or A-MPDU length in octets of the PPDU
79*5113495bSYour Name 			<legal all>
80*5113495bSYour Name */
81*5113495bSYour Name 
82*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_LENGTH_OFFSET                        0x0000000000000000
83*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_LENGTH_LSB                           8
84*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_LENGTH_MSB                           23
85*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_LENGTH_MASK                          0x0000000000ffff00
86*5113495bSYour Name 
87*5113495bSYour Name 
88*5113495bSYour Name /* Description		RESERVED_0
89*5113495bSYour Name 
90*5113495bSYour Name 			This field is not part of HT-SIG
91*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by the
92*5113495bSYour Name 			 PHY <legal 0>
93*5113495bSYour Name */
94*5113495bSYour Name 
95*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_0_OFFSET                    0x0000000000000000
96*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_0_LSB                       24
97*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_0_MSB                       31
98*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_0_MASK                      0x00000000ff000000
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name /* Description		SMOOTHING
102*5113495bSYour Name 
103*5113495bSYour Name 			Field indicates if smoothing is needed
104*5113495bSYour Name 			E_num 0     do_smoothing Unsupported setting: indicates
105*5113495bSYour Name 			smoothing is often used for beamforming
106*5113495bSYour Name 			<enum 1     no_smoothing> Indicates no smoothing is used
107*5113495bSYour Name 
108*5113495bSYour Name 			<legal 1>
109*5113495bSYour Name */
110*5113495bSYour Name 
111*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SMOOTHING_OFFSET                     0x0000000000000000
112*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SMOOTHING_LSB                        32
113*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SMOOTHING_MSB                        32
114*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SMOOTHING_MASK                       0x0000000100000000
115*5113495bSYour Name 
116*5113495bSYour Name 
117*5113495bSYour Name /* Description		NOT_SOUNDING
118*5113495bSYour Name 
119*5113495bSYour Name 			E_num 0     sounding Unsupported setting: indicates sounding
120*5113495bSYour Name 			 is used
121*5113495bSYour Name 			<enum 1     no_sounding>  Indicates no sounding is used
122*5113495bSYour Name 			<legal 1>
123*5113495bSYour Name */
124*5113495bSYour Name 
125*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_OFFSET                  0x0000000000000000
126*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_LSB                     33
127*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_MSB                     33
128*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_MASK                    0x0000000200000000
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name /* Description		HT_RESERVED
132*5113495bSYour Name 
133*5113495bSYour Name 			Reserved: Should be set to 1 by the MAC and ignored by the
134*5113495bSYour Name 			 PHY
135*5113495bSYour Name 			<legal 1>
136*5113495bSYour Name */
137*5113495bSYour Name 
138*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_HT_RESERVED_OFFSET                   0x0000000000000000
139*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_HT_RESERVED_LSB                      34
140*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_HT_RESERVED_MSB                      34
141*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_HT_RESERVED_MASK                     0x0000000400000000
142*5113495bSYour Name 
143*5113495bSYour Name 
144*5113495bSYour Name /* Description		AGGREGATION
145*5113495bSYour Name 
146*5113495bSYour Name 			<enum 0     mpdu> Indicates MPDU format
147*5113495bSYour Name 			<enum 1     a_mpdu> Indicates A-MPDU format
148*5113495bSYour Name 			<legal 0-1>
149*5113495bSYour Name */
150*5113495bSYour Name 
151*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_AGGREGATION_OFFSET                   0x0000000000000000
152*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_AGGREGATION_LSB                      35
153*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_AGGREGATION_MSB                      35
154*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_AGGREGATION_MASK                     0x0000000800000000
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name /* Description		STBC
158*5113495bSYour Name 
159*5113495bSYour Name 			<enum 0     no_stbc> Indicates no STBC
160*5113495bSYour Name 			<enum 1     1_str_stbc> Indicates 1 stream STBC
161*5113495bSYour Name 			E_num 2     2_str_stbc Indicates 2 stream STBC (Unsupported)
162*5113495bSYour Name 
163*5113495bSYour Name 			<legal 0-1>
164*5113495bSYour Name */
165*5113495bSYour Name 
166*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_STBC_OFFSET                          0x0000000000000000
167*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_STBC_LSB                             36
168*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_STBC_MSB                             37
169*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_STBC_MASK                            0x0000003000000000
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name /* Description		FEC_CODING
173*5113495bSYour Name 
174*5113495bSYour Name 			<enum 0     ht_bcc>  Indicates BCC coding
175*5113495bSYour Name 			<enum 1     ht_ldpc>  Indicates LDPC coding
176*5113495bSYour Name 			<legal 0-1>
177*5113495bSYour Name */
178*5113495bSYour Name 
179*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_FEC_CODING_OFFSET                    0x0000000000000000
180*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_FEC_CODING_LSB                       38
181*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_FEC_CODING_MSB                       38
182*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_FEC_CODING_MASK                      0x0000004000000000
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name /* Description		SHORT_GI
186*5113495bSYour Name 
187*5113495bSYour Name 			<enum 0     ht_normal_gi>  Indicates normal guard interval
188*5113495bSYour Name 
189*5113495bSYour Name 			<enum 1     ht_short_gi>  Indicates short guard interval
190*5113495bSYour Name 
191*5113495bSYour Name 			<legal 0-1>
192*5113495bSYour Name */
193*5113495bSYour Name 
194*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SHORT_GI_OFFSET                      0x0000000000000000
195*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SHORT_GI_LSB                         39
196*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SHORT_GI_MSB                         39
197*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SHORT_GI_MASK                        0x0000008000000000
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name /* Description		NUM_EXT_SP_STR
201*5113495bSYour Name 
202*5113495bSYour Name 			Number of extension spatial streams: (Used for TxBF)
203*5113495bSYour Name 			<enum 0     0_ext_sp_str>  No extension spatial streams
204*5113495bSYour Name 			E_num 1     1_ext_sp_str  Not supported: 1 extension spatial
205*5113495bSYour Name 			 streams
206*5113495bSYour Name 			E_num 2     2_ext_sp_str  Not supported:  2 extension spatial
207*5113495bSYour Name 			 streams
208*5113495bSYour Name 			<legal 0>
209*5113495bSYour Name */
210*5113495bSYour Name 
211*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_OFFSET                0x0000000000000000
212*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_LSB                   40
213*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_MSB                   41
214*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_MASK                  0x0000030000000000
215*5113495bSYour Name 
216*5113495bSYour Name 
217*5113495bSYour Name /* Description		CRC
218*5113495bSYour Name 
219*5113495bSYour Name 			The CRC protects the HT-SIG (HT-SIG[0][23:0] and HT-SIG[1][9:0].
220*5113495bSYour Name 			The generator polynomial is G(D) = D8 + D2 + D + 1.  <legal
221*5113495bSYour Name 			 all>
222*5113495bSYour Name */
223*5113495bSYour Name 
224*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CRC_OFFSET                           0x0000000000000000
225*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CRC_LSB                              42
226*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CRC_MSB                              49
227*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_CRC_MASK                             0x0003fc0000000000
228*5113495bSYour Name 
229*5113495bSYour Name 
230*5113495bSYour Name /* Description		SIGNAL_TAIL
231*5113495bSYour Name 
232*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush the
233*5113495bSYour Name 			 BCC encoder and decoder.  <legal 0>
234*5113495bSYour Name */
235*5113495bSYour Name 
236*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_OFFSET                   0x0000000000000000
237*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_LSB                      50
238*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_MSB                      55
239*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_MASK                     0x00fc000000000000
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name /* Description		RESERVED_1
243*5113495bSYour Name 
244*5113495bSYour Name 			This field is not part of HT-SIG:
245*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by the
246*5113495bSYour Name 			 PHY.  <legal 0>
247*5113495bSYour Name */
248*5113495bSYour Name 
249*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_1_OFFSET                    0x0000000000000000
250*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_1_LSB                       56
251*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_1_MSB                       62
252*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RESERVED_1_MASK                      0x7f00000000000000
253*5113495bSYour Name 
254*5113495bSYour Name 
255*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
256*5113495bSYour Name 
257*5113495bSYour Name 			TX side: Set to 0
258*5113495bSYour Name 			RX side: Set to 1 if PHY determines the HT-SIG CRC check
259*5113495bSYour Name 			 has passed, else set to 0
260*5113495bSYour Name 
261*5113495bSYour Name 			<legal all>
262*5113495bSYour Name */
263*5113495bSYour Name 
264*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_OFFSET     0x0000000000000000
265*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_LSB        63
266*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MSB        63
267*5113495bSYour Name #define MACTX_HT_SIG_MACTX_HT_SIG_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MASK       0x8000000000000000
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name 
271*5113495bSYour Name #endif   // MACTX_HT_SIG
272