xref: /wlan-driver/fw-api/hw/qca6390/v1/rx_rxpcu_classification_overview.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018 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 _RX_RXPCU_CLASSIFICATION_OVERVIEW_H_
20*5113495bSYour Name #define _RX_RXPCU_CLASSIFICATION_OVERVIEW_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name // ################ START SUMMARY #################
26*5113495bSYour Name //
27*5113495bSYour Name //	Dword	Fields
28*5113495bSYour Name //	0	filter_pass_mpdus[0], filter_pass_mpdus_fcs_ok[1], monitor_direct_mpdus[2], monitor_direct_mpdus_fcs_ok[3], monitor_other_mpdus[4], monitor_other_mpdus_fcs_ok[5], phyrx_abort_received[6], reserved_0[15:7], phy_ppdu_id[31:16]
29*5113495bSYour Name //
30*5113495bSYour Name // ################ END SUMMARY #################
31*5113495bSYour Name 
32*5113495bSYour Name #define NUM_OF_DWORDS_RX_RXPCU_CLASSIFICATION_OVERVIEW 1
33*5113495bSYour Name 
34*5113495bSYour Name struct rx_rxpcu_classification_overview {
35*5113495bSYour Name              uint32_t filter_pass_mpdus               :  1, //[0]
36*5113495bSYour Name                       filter_pass_mpdus_fcs_ok        :  1, //[1]
37*5113495bSYour Name                       monitor_direct_mpdus            :  1, //[2]
38*5113495bSYour Name                       monitor_direct_mpdus_fcs_ok     :  1, //[3]
39*5113495bSYour Name                       monitor_other_mpdus             :  1, //[4]
40*5113495bSYour Name                       monitor_other_mpdus_fcs_ok      :  1, //[5]
41*5113495bSYour Name                       phyrx_abort_received            :  1, //[6]
42*5113495bSYour Name                       reserved_0                      :  9, //[15:7]
43*5113495bSYour Name                       phy_ppdu_id                     : 16; //[31:16]
44*5113495bSYour Name };
45*5113495bSYour Name 
46*5113495bSYour Name /*
47*5113495bSYour Name 
48*5113495bSYour Name filter_pass_mpdus
49*5113495bSYour Name 
50*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
51*5113495bSYour Name 			received. FCS might or might not have been passing.
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
56*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
57*5113495bSYour Name 			users.
58*5113495bSYour Name 
59*5113495bSYour Name 			<legal all>
60*5113495bSYour Name 
61*5113495bSYour Name filter_pass_mpdus_fcs_ok
62*5113495bSYour Name 
63*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
64*5113495bSYour Name 			received that has a correct FCS.
65*5113495bSYour Name 
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
69*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
70*5113495bSYour Name 			users.
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 			<legal all>
75*5113495bSYour Name 
76*5113495bSYour Name monitor_direct_mpdus
77*5113495bSYour Name 
78*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
79*5113495bSYour Name 			received. FCS might or might not have been passing
80*5113495bSYour Name 
81*5113495bSYour Name 
82*5113495bSYour Name 
83*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
84*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
85*5113495bSYour Name 			users.
86*5113495bSYour Name 
87*5113495bSYour Name 			<legal all>
88*5113495bSYour Name 
89*5113495bSYour Name monitor_direct_mpdus_fcs_ok
90*5113495bSYour Name 
91*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
92*5113495bSYour Name 			received that has a correct FCS.
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
97*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
98*5113495bSYour Name 			users.
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 			<legal all>
103*5113495bSYour Name 
104*5113495bSYour Name monitor_other_mpdus
105*5113495bSYour Name 
106*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
107*5113495bSYour Name 			received. FCS might or might not have been passing.
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
112*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
113*5113495bSYour Name 			users.
114*5113495bSYour Name 
115*5113495bSYour Name 			<legal all>
116*5113495bSYour Name 
117*5113495bSYour Name monitor_other_mpdus_fcs_ok
118*5113495bSYour Name 
119*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
120*5113495bSYour Name 			received that has a correct FCS.
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
125*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
126*5113495bSYour Name 			users.
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal all>
129*5113495bSYour Name 
130*5113495bSYour Name phyrx_abort_received
131*5113495bSYour Name 
132*5113495bSYour Name 			When set, PPDU reception was aborted by the PHY
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal all>
135*5113495bSYour Name 
136*5113495bSYour Name reserved_0
137*5113495bSYour Name 
138*5113495bSYour Name 			<legal 0>
139*5113495bSYour Name 
140*5113495bSYour Name phy_ppdu_id
141*5113495bSYour Name 
142*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
143*5113495bSYour Name 			received. The counter value wraps around
144*5113495bSYour Name 
145*5113495bSYour Name 			<legal all>
146*5113495bSYour Name */
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS
150*5113495bSYour Name 
151*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
152*5113495bSYour Name 			received. FCS might or might not have been passing.
153*5113495bSYour Name 
154*5113495bSYour Name 
155*5113495bSYour Name 
156*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
157*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
158*5113495bSYour Name 			users.
159*5113495bSYour Name 
160*5113495bSYour Name 			<legal all>
161*5113495bSYour Name */
162*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_OFFSET  0x00000000
163*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_LSB     0
164*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_MASK    0x00000001
165*5113495bSYour Name 
166*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK
167*5113495bSYour Name 
168*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
169*5113495bSYour Name 			received that has a correct FCS.
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
174*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
175*5113495bSYour Name 			users.
176*5113495bSYour Name 
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 			<legal all>
180*5113495bSYour Name */
181*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK_OFFSET 0x00000000
182*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK_LSB 1
183*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK_MASK 0x00000002
184*5113495bSYour Name 
185*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS
186*5113495bSYour Name 
187*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
188*5113495bSYour Name 			received. FCS might or might not have been passing
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name 
192*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
193*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
194*5113495bSYour Name 			users.
195*5113495bSYour Name 
196*5113495bSYour Name 			<legal all>
197*5113495bSYour Name */
198*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_OFFSET 0x00000000
199*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_LSB  2
200*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_MASK 0x00000004
201*5113495bSYour Name 
202*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK
203*5113495bSYour Name 
204*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
205*5113495bSYour Name 			received that has a correct FCS.
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
210*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
211*5113495bSYour Name 			users.
212*5113495bSYour Name 
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name 			<legal all>
216*5113495bSYour Name */
217*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK_OFFSET 0x00000000
218*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK_LSB 3
219*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK_MASK 0x00000008
220*5113495bSYour Name 
221*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS
222*5113495bSYour Name 
223*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
224*5113495bSYour Name 			received. FCS might or might not have been passing.
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
229*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
230*5113495bSYour Name 			users.
231*5113495bSYour Name 
232*5113495bSYour Name 			<legal all>
233*5113495bSYour Name */
234*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_OFFSET 0x00000000
235*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_LSB   4
236*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_MASK  0x00000010
237*5113495bSYour Name 
238*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK
239*5113495bSYour Name 
240*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
241*5113495bSYour Name 			received that has a correct FCS.
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and
246*5113495bSYour Name 			RX_PPDU_END_STATUS_DONE, this field is the OR of all the
247*5113495bSYour Name 			users.
248*5113495bSYour Name 
249*5113495bSYour Name 			<legal all>
250*5113495bSYour Name */
251*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK_OFFSET 0x00000000
252*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK_LSB 5
253*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK_MASK 0x00000020
254*5113495bSYour Name 
255*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHYRX_ABORT_RECEIVED
256*5113495bSYour Name 
257*5113495bSYour Name 			When set, PPDU reception was aborted by the PHY
258*5113495bSYour Name 
259*5113495bSYour Name 			<legal all>
260*5113495bSYour Name */
261*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHYRX_ABORT_RECEIVED_OFFSET 0x00000000
262*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHYRX_ABORT_RECEIVED_LSB  6
263*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHYRX_ABORT_RECEIVED_MASK 0x00000040
264*5113495bSYour Name 
265*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0
266*5113495bSYour Name 
267*5113495bSYour Name 			<legal 0>
268*5113495bSYour Name */
269*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0_OFFSET         0x00000000
270*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0_LSB            7
271*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0_MASK           0x0000ff80
272*5113495bSYour Name 
273*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID
274*5113495bSYour Name 
275*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
276*5113495bSYour Name 			received. The counter value wraps around
277*5113495bSYour Name 
278*5113495bSYour Name 			<legal all>
279*5113495bSYour Name */
280*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID_OFFSET        0x00000000
281*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID_LSB           16
282*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID_MASK          0xffff0000
283*5113495bSYour Name 
284*5113495bSYour Name 
285*5113495bSYour Name #endif // _RX_RXPCU_CLASSIFICATION_OVERVIEW_H_
286