xref: /wlan-driver/fw-api/hw/qca5332/rx_rxpcu_classification_overview.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _RX_RXPCU_CLASSIFICATION_OVERVIEW_H_
27*5113495bSYour Name #define _RX_RXPCU_CLASSIFICATION_OVERVIEW_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_RX_RXPCU_CLASSIFICATION_OVERVIEW 1
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct rx_rxpcu_classification_overview {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t filter_pass_mpdus                                       :  1, // [0:0]
37*5113495bSYour Name                       filter_pass_mpdus_fcs_ok                                :  1, // [1:1]
38*5113495bSYour Name                       monitor_direct_mpdus                                    :  1, // [2:2]
39*5113495bSYour Name                       monitor_direct_mpdus_fcs_ok                             :  1, // [3:3]
40*5113495bSYour Name                       monitor_other_mpdus                                     :  1, // [4:4]
41*5113495bSYour Name                       monitor_other_mpdus_fcs_ok                              :  1, // [5:5]
42*5113495bSYour Name                       phyrx_abort_received                                    :  1, // [6:6]
43*5113495bSYour Name                       filter_pass_monitor_ovrd_mpdus                          :  1, // [7:7]
44*5113495bSYour Name                       filter_pass_monitor_ovrd_mpdus_fcs_ok                   :  1, // [8:8]
45*5113495bSYour Name                       reserved_0                                              :  7, // [15:9]
46*5113495bSYour Name                       phy_ppdu_id                                             : 16; // [31:16]
47*5113495bSYour Name #else
48*5113495bSYour Name              uint32_t phy_ppdu_id                                             : 16, // [31:16]
49*5113495bSYour Name                       reserved_0                                              :  7, // [15:9]
50*5113495bSYour Name                       filter_pass_monitor_ovrd_mpdus_fcs_ok                   :  1, // [8:8]
51*5113495bSYour Name                       filter_pass_monitor_ovrd_mpdus                          :  1, // [7:7]
52*5113495bSYour Name                       phyrx_abort_received                                    :  1, // [6:6]
53*5113495bSYour Name                       monitor_other_mpdus_fcs_ok                              :  1, // [5:5]
54*5113495bSYour Name                       monitor_other_mpdus                                     :  1, // [4:4]
55*5113495bSYour Name                       monitor_direct_mpdus_fcs_ok                             :  1, // [3:3]
56*5113495bSYour Name                       monitor_direct_mpdus                                    :  1, // [2:2]
57*5113495bSYour Name                       filter_pass_mpdus_fcs_ok                                :  1, // [1:1]
58*5113495bSYour Name                       filter_pass_mpdus                                       :  1; // [0:0]
59*5113495bSYour Name #endif
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name 
63*5113495bSYour Name /* Description		FILTER_PASS_MPDUS
64*5113495bSYour Name 
65*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been received.
66*5113495bSYour Name 			FCS might or might not have been passing.
67*5113495bSYour Name 
68*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
69*5113495bSYour Name 			this field is the "OR of all the users.
70*5113495bSYour Name 			<legal all>
71*5113495bSYour Name */
72*5113495bSYour Name 
73*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_OFFSET                   0x00000000
74*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_LSB                      0
75*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_MSB                      0
76*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_MASK                     0x00000001
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name /* Description		FILTER_PASS_MPDUS_FCS_OK
80*5113495bSYour Name 
81*5113495bSYour Name 			When set, at least one Filter Pass MPDU has been received
82*5113495bSYour Name 			 that has a correct FCS.
83*5113495bSYour Name 
84*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
85*5113495bSYour Name 			this field is the "OR of all the users.
86*5113495bSYour Name 
87*5113495bSYour Name 			<legal all>
88*5113495bSYour Name */
89*5113495bSYour Name 
90*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_FCS_OK_OFFSET            0x00000000
91*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_FCS_OK_LSB               1
92*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_FCS_OK_MSB               1
93*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MPDUS_FCS_OK_MASK              0x00000002
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name /* Description		MONITOR_DIRECT_MPDUS
97*5113495bSYour Name 
98*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been received.
99*5113495bSYour Name 			FCS might or might not have been passing
100*5113495bSYour Name 
101*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
102*5113495bSYour Name 			this field is the "OR of all the users.
103*5113495bSYour Name 			<legal all>
104*5113495bSYour Name */
105*5113495bSYour Name 
106*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_OFFSET                0x00000000
107*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_LSB                   2
108*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_MSB                   2
109*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_MASK                  0x00000004
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name /* Description		MONITOR_DIRECT_MPDUS_FCS_OK
113*5113495bSYour Name 
114*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been received
115*5113495bSYour Name 			 that has a correct FCS.
116*5113495bSYour Name 
117*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
118*5113495bSYour Name 			this field is the "OR of all the users.
119*5113495bSYour Name 
120*5113495bSYour Name 			<legal all>
121*5113495bSYour Name */
122*5113495bSYour Name 
123*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_FCS_OK_OFFSET         0x00000000
124*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_FCS_OK_LSB            3
125*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_FCS_OK_MSB            3
126*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_DIRECT_MPDUS_FCS_OK_MASK           0x00000008
127*5113495bSYour Name 
128*5113495bSYour Name 
129*5113495bSYour Name /* Description		MONITOR_OTHER_MPDUS
130*5113495bSYour Name 
131*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been received.
132*5113495bSYour Name 			FCS might or might not have been passing.
133*5113495bSYour Name 
134*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
135*5113495bSYour Name 			this field is the "OR of all the users.
136*5113495bSYour Name 			<legal all>
137*5113495bSYour Name */
138*5113495bSYour Name 
139*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_OFFSET                 0x00000000
140*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_LSB                    4
141*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_MSB                    4
142*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_MASK                   0x00000010
143*5113495bSYour Name 
144*5113495bSYour Name 
145*5113495bSYour Name /* Description		MONITOR_OTHER_MPDUS_FCS_OK
146*5113495bSYour Name 
147*5113495bSYour Name 			When set, at least one Monitor Direct MPDU has been received
148*5113495bSYour Name 			 that has a correct FCS.
149*5113495bSYour Name 
150*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
151*5113495bSYour Name 			this field is the "OR of all the users.
152*5113495bSYour Name 			<legal all>
153*5113495bSYour Name */
154*5113495bSYour Name 
155*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_FCS_OK_OFFSET          0x00000000
156*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_FCS_OK_LSB             5
157*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_FCS_OK_MSB             5
158*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_MONITOR_OTHER_MPDUS_FCS_OK_MASK            0x00000020
159*5113495bSYour Name 
160*5113495bSYour Name 
161*5113495bSYour Name /* Description		PHYRX_ABORT_RECEIVED
162*5113495bSYour Name 
163*5113495bSYour Name 			When set, PPDU reception was aborted by the PHY
164*5113495bSYour Name 			<legal all>
165*5113495bSYour Name */
166*5113495bSYour Name 
167*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHYRX_ABORT_RECEIVED_OFFSET                0x00000000
168*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHYRX_ABORT_RECEIVED_LSB                   6
169*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHYRX_ABORT_RECEIVED_MSB                   6
170*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHYRX_ABORT_RECEIVED_MASK                  0x00000040
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name /* Description		FILTER_PASS_MONITOR_OVRD_MPDUS
174*5113495bSYour Name 
175*5113495bSYour Name 			When set, at least one 'Filter Pass Monitor Override' MPDU
176*5113495bSYour Name 			 has been received. FCS might or might not have been passing.
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
180*5113495bSYour Name 			this field is the "OR of all the users.
181*5113495bSYour Name 			<legal all>
182*5113495bSYour Name */
183*5113495bSYour Name 
184*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_OFFSET      0x00000000
185*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_LSB         7
186*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_MSB         7
187*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_MASK        0x00000080
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		FILTER_PASS_MONITOR_OVRD_MPDUS_FCS_OK
191*5113495bSYour Name 
192*5113495bSYour Name 			When set, at least one 'Filter Pass Monitor Override' MPDU
193*5113495bSYour Name 			 has been received that has a correct FCS.
194*5113495bSYour Name 
195*5113495bSYour Name 			For MU UL, in  TLVs RX_PPDU_END and RX_PPDU_END_STATUS_DONE,
196*5113495bSYour Name 			this field is the "OR of all the users.
197*5113495bSYour Name 
198*5113495bSYour Name 			<legal all>
199*5113495bSYour Name */
200*5113495bSYour Name 
201*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_FCS_OK_OFFSET 0x00000000
202*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_FCS_OK_LSB  8
203*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_FCS_OK_MSB  8
204*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_FILTER_PASS_MONITOR_OVRD_MPDUS_FCS_OK_MASK 0x00000100
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name /* Description		RESERVED_0
208*5113495bSYour Name 
209*5113495bSYour Name 			<legal 0>
210*5113495bSYour Name */
211*5113495bSYour Name 
212*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_RESERVED_0_OFFSET                          0x00000000
213*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_RESERVED_0_LSB                             9
214*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_RESERVED_0_MSB                             15
215*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_RESERVED_0_MASK                            0x0000fe00
216*5113495bSYour Name 
217*5113495bSYour Name 
218*5113495bSYour Name /* Description		PHY_PPDU_ID
219*5113495bSYour Name 
220*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
221*5113495bSYour Name 			received. The counter value wraps around
222*5113495bSYour Name 			<legal all>
223*5113495bSYour Name */
224*5113495bSYour Name 
225*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHY_PPDU_ID_OFFSET                         0x00000000
226*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHY_PPDU_ID_LSB                            16
227*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHY_PPDU_ID_MSB                            31
228*5113495bSYour Name #define RX_RXPCU_CLASSIFICATION_OVERVIEW_PHY_PPDU_ID_MASK                           0xffff0000
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name 
232*5113495bSYour Name #endif   // RX_RXPCU_CLASSIFICATION_OVERVIEW
233