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