xref: /wlan-driver/fw-api/hw/qca6490/v1/phyrx_l_sig_a.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _PHYRX_L_SIG_A_H_
20*5113495bSYour Name #define _PHYRX_L_SIG_A_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "l_sig_a_info.h"
25*5113495bSYour Name 
26*5113495bSYour Name // ################ START SUMMARY #################
27*5113495bSYour Name //
28*5113495bSYour Name //	Dword	Fields
29*5113495bSYour Name //	0	struct l_sig_a_info phyrx_l_sig_a_info_details;
30*5113495bSYour Name //
31*5113495bSYour Name // ################ END SUMMARY #################
32*5113495bSYour Name 
33*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_L_SIG_A 1
34*5113495bSYour Name 
35*5113495bSYour Name struct phyrx_l_sig_a {
36*5113495bSYour Name     struct            l_sig_a_info                       phyrx_l_sig_a_info_details;
37*5113495bSYour Name };
38*5113495bSYour Name 
39*5113495bSYour Name /*
40*5113495bSYour Name 
41*5113495bSYour Name struct l_sig_a_info phyrx_l_sig_a_info_details
42*5113495bSYour Name 
43*5113495bSYour Name 			See detailed description of the STRUCT
44*5113495bSYour Name */
45*5113495bSYour Name 
46*5113495bSYour Name 
47*5113495bSYour Name  /* EXTERNAL REFERENCE : struct l_sig_a_info phyrx_l_sig_a_info_details */
48*5113495bSYour Name 
49*5113495bSYour Name 
50*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RATE
51*5113495bSYour Name 
52*5113495bSYour Name 			This format is originally defined for OFDM as a 4 bit
53*5113495bSYour Name 			field but the 5th bit was added to indicate 11b formatted
54*5113495bSYour Name 			frames.  In the standard bit [4] is specified as reserved.
55*5113495bSYour Name 			For 11b frames this L-SIG is transformed in the PHY into the
56*5113495bSYour Name 			11b preamble format.  The following are the rates:
57*5113495bSYour Name 
58*5113495bSYour Name 			<enum 8     ofdm_48_mbps> 64-QAM 2/3 (48 Mbps)
59*5113495bSYour Name 
60*5113495bSYour Name 			<enum 9     ofdm_24_mbps> 16-QAM 1/2 (24 Mbps)
61*5113495bSYour Name 
62*5113495bSYour Name 			<enum 10     ofdm_12_mbps> QPSK 1/2 (12 Mbps)
63*5113495bSYour Name 
64*5113495bSYour Name 			<enum 11     ofdm_6_mbps> BPSK 1/2 (6 Mbps)
65*5113495bSYour Name 
66*5113495bSYour Name 			<enum 12     ofdm_54_mbps> 64-QAM 3/4 (54 Mbps)
67*5113495bSYour Name 
68*5113495bSYour Name 			<enum 13     ofdm_36_mbps> 16-QAM 3/4 (36 Mbps)
69*5113495bSYour Name 
70*5113495bSYour Name 			<enum 14     ofdm_18_mbps> QPSK 1/2 (18 Mbps)
71*5113495bSYour Name 
72*5113495bSYour Name 			<enum 15     ofdm_9_mbps> BPSK 3/4 (9 Mbps)
73*5113495bSYour Name 
74*5113495bSYour Name 			<legal 8-15>
75*5113495bSYour Name */
76*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RATE_OFFSET       0x00000000
77*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RATE_LSB          0
78*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RATE_MASK         0x0000000f
79*5113495bSYour Name 
80*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LSIG_RESERVED
81*5113495bSYour Name 
82*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
83*5113495bSYour Name 			the PHY
84*5113495bSYour Name 
85*5113495bSYour Name 			<legal 0>
86*5113495bSYour Name */
87*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LSIG_RESERVED_OFFSET 0x00000000
88*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LSIG_RESERVED_LSB 4
89*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LSIG_RESERVED_MASK 0x00000010
90*5113495bSYour Name 
91*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LENGTH
92*5113495bSYour Name 
93*5113495bSYour Name 			The length indicates the number of octets in this MPDU.
94*5113495bSYour Name 			Note that when using mixed mode 11n preamble this length
95*5113495bSYour Name 			provides the spoofed length for the PPDU.  This length
96*5113495bSYour Name 			provides part of the information to derive the actually PPDU
97*5113495bSYour Name 			length.  For legacy OFDM and 11B frames the maximum length
98*5113495bSYour Name 			is
99*5113495bSYour Name 
100*5113495bSYour Name 			<legal all>
101*5113495bSYour Name */
102*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LENGTH_OFFSET     0x00000000
103*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LENGTH_LSB        5
104*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_LENGTH_MASK       0x0001ffe0
105*5113495bSYour Name 
106*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PARITY
107*5113495bSYour Name 
108*5113495bSYour Name 			11a/n/ac TX: This field provides even parity over the
109*5113495bSYour Name 			first 18 bits of the signal field which means that the sum
110*5113495bSYour Name 			of 1s in the signal field will always be even on
111*5113495bSYour Name 
112*5113495bSYour Name 			11a/n/ac RX: this field contains the received parity
113*5113495bSYour Name 			field from the L-SIG symbol for the current packet.
114*5113495bSYour Name 
115*5113495bSYour Name 			<legal 0-1>
116*5113495bSYour Name */
117*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PARITY_OFFSET     0x00000000
118*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PARITY_LSB        17
119*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PARITY_MASK       0x00020000
120*5113495bSYour Name 
121*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_TAIL
122*5113495bSYour Name 
123*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush
124*5113495bSYour Name 			the BCC encoder and decoder.  <legal 0>
125*5113495bSYour Name */
126*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_TAIL_OFFSET       0x00000000
127*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_TAIL_LSB          18
128*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_TAIL_MASK         0x00fc0000
129*5113495bSYour Name 
130*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PKT_TYPE
131*5113495bSYour Name 
132*5113495bSYour Name 			Only used on the RX side.
133*5113495bSYour Name 
134*5113495bSYour Name 			Note: This is not really part of L-SIG
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 			Packet type:
139*5113495bSYour Name 
140*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
143*5113495bSYour Name 
144*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
145*5113495bSYour Name 
146*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
151*5113495bSYour Name */
152*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PKT_TYPE_OFFSET   0x00000000
153*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PKT_TYPE_LSB      24
154*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_PKT_TYPE_MASK     0x0f000000
155*5113495bSYour Name 
156*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_CAPTURED_IMPLICIT_SOUNDING
157*5113495bSYour Name 
158*5113495bSYour Name 			Only used on the RX side.
159*5113495bSYour Name 
160*5113495bSYour Name 			Note: This is not really part of L-SIG
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name 
164*5113495bSYour Name 			This indicates that the PHY has captured implicit
165*5113495bSYour Name 			sounding.
166*5113495bSYour Name */
167*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_CAPTURED_IMPLICIT_SOUNDING_OFFSET 0x00000000
168*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_CAPTURED_IMPLICIT_SOUNDING_LSB 28
169*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_CAPTURED_IMPLICIT_SOUNDING_MASK 0x10000000
170*5113495bSYour Name 
171*5113495bSYour Name /* Description		PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RESERVED
172*5113495bSYour Name 
173*5113495bSYour Name 			Reserved: Should be set to 0 by the transmitting MAC and
174*5113495bSYour Name 			ignored by the PHY <legal 0>
175*5113495bSYour Name */
176*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RESERVED_OFFSET   0x00000000
177*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RESERVED_LSB      29
178*5113495bSYour Name #define PHYRX_L_SIG_A_0_PHYRX_L_SIG_A_INFO_DETAILS_RESERVED_MASK     0xe0000000
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name #endif // _PHYRX_L_SIG_A_H_
182