xref: /wlan-driver/fw-api/hw/qca6290/v1/rx_rxpcu_classification_overview.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2017 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], reserved_0[15:6], 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                       reserved_0                      : 10, //[15:6]
42*5113495bSYour Name                       phy_ppdu_id                     : 16; //[31:16]
43*5113495bSYour Name };
44*5113495bSYour Name 
45*5113495bSYour Name /*
46*5113495bSYour Name 
47*5113495bSYour Name filter_pass_mpdus
48*5113495bSYour Name 
49*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
50*5113495bSYour Name 			received. FCS might or might not have been passing
51*5113495bSYour Name 
52*5113495bSYour Name 			<legal all>
53*5113495bSYour Name 
54*5113495bSYour Name filter_pass_mpdus_fcs_ok
55*5113495bSYour Name 
56*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
57*5113495bSYour Name 			received that has a correct FCS.
58*5113495bSYour Name 
59*5113495bSYour Name 			<legal all>
60*5113495bSYour Name 
61*5113495bSYour Name monitor_direct_mpdus
62*5113495bSYour Name 
63*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
64*5113495bSYour Name 			received. FCS might or might not have been passing
65*5113495bSYour Name 
66*5113495bSYour Name 			<legal all>
67*5113495bSYour Name 
68*5113495bSYour Name monitor_direct_mpdus_fcs_ok
69*5113495bSYour Name 
70*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
71*5113495bSYour Name 			received that has a correct FCS.
72*5113495bSYour Name 
73*5113495bSYour Name 			<legal all>
74*5113495bSYour Name 
75*5113495bSYour Name monitor_other_mpdus
76*5113495bSYour Name 
77*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
78*5113495bSYour Name 			received. FCS might or might not have been passing
79*5113495bSYour Name 
80*5113495bSYour Name 			<legal all>
81*5113495bSYour Name 
82*5113495bSYour Name monitor_other_mpdus_fcs_ok
83*5113495bSYour Name 
84*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
85*5113495bSYour Name 			received that has a correct FCS.
86*5113495bSYour Name 
87*5113495bSYour Name 			<legal all>
88*5113495bSYour Name 
89*5113495bSYour Name reserved_0
90*5113495bSYour Name 
91*5113495bSYour Name 			<legal 0>
92*5113495bSYour Name 
93*5113495bSYour Name phy_ppdu_id
94*5113495bSYour Name 
95*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
96*5113495bSYour Name 			received. The counter value wraps around
97*5113495bSYour Name 
98*5113495bSYour Name 			<legal all>
99*5113495bSYour Name */
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS
103*5113495bSYour Name 
104*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
105*5113495bSYour Name 			received. FCS might or might not have been passing
106*5113495bSYour Name 
107*5113495bSYour Name 			<legal all>
108*5113495bSYour Name */
109*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_OFFSET  0x00000000
110*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_LSB     0
111*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_MASK    0x00000001
112*5113495bSYour Name 
113*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK
114*5113495bSYour Name 
115*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been
116*5113495bSYour Name 			received that has a correct FCS.
117*5113495bSYour Name 
118*5113495bSYour Name 			<legal all>
119*5113495bSYour Name */
120*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK_OFFSET 0x00000000
121*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK_LSB 1
122*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_FILTER_PASS_MPDUS_FCS_OK_MASK 0x00000002
123*5113495bSYour Name 
124*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS
125*5113495bSYour Name 
126*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
127*5113495bSYour Name 			received. FCS might or might not have been passing
128*5113495bSYour Name 
129*5113495bSYour Name 			<legal all>
130*5113495bSYour Name */
131*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_OFFSET 0x00000000
132*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_LSB  2
133*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_MASK 0x00000004
134*5113495bSYour Name 
135*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK
136*5113495bSYour Name 
137*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
138*5113495bSYour Name 			received that has a correct FCS.
139*5113495bSYour Name 
140*5113495bSYour Name 			<legal all>
141*5113495bSYour Name */
142*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK_OFFSET 0x00000000
143*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK_LSB 3
144*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_DIRECT_MPDUS_FCS_OK_MASK 0x00000008
145*5113495bSYour Name 
146*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS
147*5113495bSYour Name 
148*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
149*5113495bSYour Name 			received. FCS might or might not have been passing
150*5113495bSYour Name 
151*5113495bSYour Name 			<legal all>
152*5113495bSYour Name */
153*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_OFFSET 0x00000000
154*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_LSB   4
155*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_MASK  0x00000010
156*5113495bSYour Name 
157*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK
158*5113495bSYour Name 
159*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been
160*5113495bSYour Name 			received that has a correct FCS.
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal all>
163*5113495bSYour Name */
164*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK_OFFSET 0x00000000
165*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK_LSB 5
166*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_MONITOR_OTHER_MPDUS_FCS_OK_MASK 0x00000020
167*5113495bSYour Name 
168*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0
169*5113495bSYour Name 
170*5113495bSYour Name 			<legal 0>
171*5113495bSYour Name */
172*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0_OFFSET         0x00000000
173*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0_LSB            6
174*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_RESERVED_0_MASK           0x0000ffc0
175*5113495bSYour Name 
176*5113495bSYour Name /* Description		RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID
177*5113495bSYour Name 
178*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
179*5113495bSYour Name 			received. The counter value wraps around
180*5113495bSYour Name 
181*5113495bSYour Name 			<legal all>
182*5113495bSYour Name */
183*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID_OFFSET        0x00000000
184*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID_LSB           16
185*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_0_PHY_PPDU_ID_MASK          0xffff0000
186*5113495bSYour Name 
187*5113495bSYour Name 
188*5113495bSYour Name #endif // _RX_RXPCU_CLASSIFICATION_OVERVIEW_H_
189