xref: /wlan-driver/fw-api/hw/qca8074/v2/phyrx_ht_sig.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020 The Linux Foundation. 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 // $ATH_LICENSE_HW_HDR_C$
18*5113495bSYour Name //
19*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
20*5113495bSYour Name //               These definitions are tied to a particular hardware layout
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name #ifndef _PHYRX_HT_SIG_H_
24*5113495bSYour Name #define _PHYRX_HT_SIG_H_
25*5113495bSYour Name #if !defined(__ASSEMBLER__)
26*5113495bSYour Name #endif
27*5113495bSYour Name 
28*5113495bSYour Name #include "ht_sig_info.h"
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0-1	struct ht_sig_info phyrx_ht_sig_info_details;
34*5113495bSYour Name //
35*5113495bSYour Name // ################ END SUMMARY #################
36*5113495bSYour Name 
37*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_HT_SIG 2
38*5113495bSYour Name 
39*5113495bSYour Name struct phyrx_ht_sig {
40*5113495bSYour Name     struct            ht_sig_info                       phyrx_ht_sig_info_details;
41*5113495bSYour Name };
42*5113495bSYour Name 
43*5113495bSYour Name /*
44*5113495bSYour Name 
45*5113495bSYour Name struct ht_sig_info phyrx_ht_sig_info_details
46*5113495bSYour Name 
47*5113495bSYour Name 			See detailed description of the STRUCT
48*5113495bSYour Name */
49*5113495bSYour Name 
50*5113495bSYour Name 
51*5113495bSYour Name  /* EXTERNAL REFERENCE : struct ht_sig_info phyrx_ht_sig_info_details */
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name /* Description		PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_MCS
55*5113495bSYour Name 
56*5113495bSYour Name 			Modulation Coding Scheme:
57*5113495bSYour Name 
58*5113495bSYour Name 			0-7 are used for single stream
59*5113495bSYour Name 
60*5113495bSYour Name 			8-15 are used for 2 streams
61*5113495bSYour Name 
62*5113495bSYour Name 			16-23 are used for 3 streams
63*5113495bSYour Name 
64*5113495bSYour Name 			24-31 are used for 4 streams
65*5113495bSYour Name 
66*5113495bSYour Name 			32 is used for duplicate HT20 (unsupported)
67*5113495bSYour Name 
68*5113495bSYour Name 			33-76 is used for unequal modulation (unsupported)
69*5113495bSYour Name 
70*5113495bSYour Name 			77-127 is reserved.
71*5113495bSYour Name 
72*5113495bSYour Name 			<legal 0-31>
73*5113495bSYour Name */
74*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_MCS_OFFSET          0x00000000
75*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_MCS_LSB             0
76*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_MCS_MASK            0x0000007f
77*5113495bSYour Name 
78*5113495bSYour Name /* Description		PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_CBW
79*5113495bSYour Name 
80*5113495bSYour Name 			Packet bandwidth:
81*5113495bSYour Name 
82*5113495bSYour Name 			<enum 0     ht_20_mhz>
83*5113495bSYour Name 
84*5113495bSYour Name 			<enum 1     ht_40_mhz>
85*5113495bSYour Name 
86*5113495bSYour Name 			<legal 0-1>
87*5113495bSYour Name */
88*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_CBW_OFFSET          0x00000000
89*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_CBW_LSB             7
90*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_CBW_MASK            0x00000080
91*5113495bSYour Name 
92*5113495bSYour Name /* Description		PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_LENGTH
93*5113495bSYour Name 
94*5113495bSYour Name 			This is the MPDU or A-MPDU length in octets of the PPDU
95*5113495bSYour Name 
96*5113495bSYour Name 			<legal all>
97*5113495bSYour Name */
98*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_LENGTH_OFFSET       0x00000000
99*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_LENGTH_LSB          8
100*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_LENGTH_MASK         0x00ffff00
101*5113495bSYour Name 
102*5113495bSYour Name /* Description		PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_0
103*5113495bSYour Name 
104*5113495bSYour Name 			This field is not part of HT-SIG
105*5113495bSYour Name 
106*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
107*5113495bSYour Name 			the PHY <legal 0>
108*5113495bSYour Name */
109*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_0_OFFSET   0x00000000
110*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_0_LSB      24
111*5113495bSYour Name #define PHYRX_HT_SIG_0_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_0_MASK     0xff000000
112*5113495bSYour Name 
113*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SMOOTHING
114*5113495bSYour Name 
115*5113495bSYour Name 			Field indicates if smoothing is needed
116*5113495bSYour Name 
117*5113495bSYour Name 			E_num 0     do_smoothing Unsupported setting: indicates
118*5113495bSYour Name 			smoothing is often used for beamforming
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name 			<legal 1>
122*5113495bSYour Name */
123*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SMOOTHING_OFFSET    0x00000004
124*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SMOOTHING_LSB       0
125*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SMOOTHING_MASK      0x00000001
126*5113495bSYour Name 
127*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NOT_SOUNDING
128*5113495bSYour Name 
129*5113495bSYour Name 			E_num 0     sounding Unsupported setting: indicates
130*5113495bSYour Name 			sounding is used
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 1     no_sounding>  Indicates no sounding is used
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal 1>
135*5113495bSYour Name */
136*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_OFFSET 0x00000004
137*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_LSB    1
138*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NOT_SOUNDING_MASK   0x00000002
139*5113495bSYour Name 
140*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_HT_RESERVED
141*5113495bSYour Name 
142*5113495bSYour Name 			Reserved: Should be set to 1 by the MAC and ignored by
143*5113495bSYour Name 			the PHY
144*5113495bSYour Name 
145*5113495bSYour Name 			<legal 1>
146*5113495bSYour Name */
147*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_HT_RESERVED_OFFSET  0x00000004
148*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_HT_RESERVED_LSB     2
149*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_HT_RESERVED_MASK    0x00000004
150*5113495bSYour Name 
151*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_AGGREGATION
152*5113495bSYour Name 
153*5113495bSYour Name 			<enum 0     mpdu> Indicates MPDU format
154*5113495bSYour Name 
155*5113495bSYour Name 			<enum 1     a_mpdu> Indicates A-MPDU format
156*5113495bSYour Name 
157*5113495bSYour Name 			<legal 0-1>
158*5113495bSYour Name */
159*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_AGGREGATION_OFFSET  0x00000004
160*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_AGGREGATION_LSB     3
161*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_AGGREGATION_MASK    0x00000008
162*5113495bSYour Name 
163*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_STBC
164*5113495bSYour Name 
165*5113495bSYour Name 			<enum 0     no_stbc> Indicates no STBC
166*5113495bSYour Name 
167*5113495bSYour Name 			<enum 1     1_str_stbc> Indicates 1 stream STBC
168*5113495bSYour Name 
169*5113495bSYour Name 			E_num 2     2_str_stbc Indicates 2 stream STBC
170*5113495bSYour Name 			(Unsupported)
171*5113495bSYour Name 
172*5113495bSYour Name 			<legal 0-1>
173*5113495bSYour Name */
174*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_STBC_OFFSET         0x00000004
175*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_STBC_LSB            4
176*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_STBC_MASK           0x00000030
177*5113495bSYour Name 
178*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_FEC_CODING
179*5113495bSYour Name 
180*5113495bSYour Name 			<enum 0     ht_bcc>  Indicates BCC coding
181*5113495bSYour Name 
182*5113495bSYour Name 			<enum 1     ht_ldpc>  Indicates LDPC coding
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal 0-1>
185*5113495bSYour Name */
186*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_FEC_CODING_OFFSET   0x00000004
187*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_FEC_CODING_LSB      6
188*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_FEC_CODING_MASK     0x00000040
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SHORT_GI
191*5113495bSYour Name 
192*5113495bSYour Name 			<enum 0     ht_normal_gi>  Indicates normal guard
193*5113495bSYour Name 			interval
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 			<legal 0-1>
197*5113495bSYour Name */
198*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SHORT_GI_OFFSET     0x00000004
199*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SHORT_GI_LSB        7
200*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SHORT_GI_MASK       0x00000080
201*5113495bSYour Name 
202*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR
203*5113495bSYour Name 
204*5113495bSYour Name 			Number of extension spatial streams: (Used for TxBF)
205*5113495bSYour Name 
206*5113495bSYour Name 			<enum 0     0_ext_sp_str>  No extension spatial streams
207*5113495bSYour Name 
208*5113495bSYour Name 			E_num 1     1_ext_sp_str  Not supported: 1 extension
209*5113495bSYour Name 			spatial streams
210*5113495bSYour Name 
211*5113495bSYour Name 			E_num 2     2_ext_sp_str  Not supported:  2 extension
212*5113495bSYour Name 			spatial streams
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal 0>
215*5113495bSYour Name */
216*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_OFFSET 0x00000004
217*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_LSB  8
218*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_NUM_EXT_SP_STR_MASK 0x00000300
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_CRC
221*5113495bSYour Name 
222*5113495bSYour Name 			The CRC protects the HT-SIG (HT-SIG[0][23:0] and
223*5113495bSYour Name 			HT-SIG[1][9:0]. The generator polynomial is G(D) = D8 + D2 +
224*5113495bSYour Name 			D + 1.  <legal all>
225*5113495bSYour Name */
226*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_CRC_OFFSET          0x00000004
227*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_CRC_LSB             10
228*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_CRC_MASK            0x0003fc00
229*5113495bSYour Name 
230*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL
231*5113495bSYour Name 
232*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush
233*5113495bSYour Name 			the BCC encoder and decoder.  <legal 0>
234*5113495bSYour Name */
235*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_OFFSET  0x00000004
236*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_LSB     18
237*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_SIGNAL_TAIL_MASK    0x00fc0000
238*5113495bSYour Name 
239*5113495bSYour Name /* Description		PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_1
240*5113495bSYour Name 
241*5113495bSYour Name 			This field is not part of HT-SIG:
242*5113495bSYour Name 
243*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
244*5113495bSYour Name 			the PHY.  <legal 0>
245*5113495bSYour Name */
246*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_1_OFFSET   0x00000004
247*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_1_LSB      24
248*5113495bSYour Name #define PHYRX_HT_SIG_1_PHYRX_HT_SIG_INFO_DETAILS_RESERVED_1_MASK     0xff000000
249*5113495bSYour Name 
250*5113495bSYour Name 
251*5113495bSYour Name #endif // _PHYRX_HT_SIG_H_
252