xref: /wlan-driver/fw-api/hw/qca6290/11ax/v1/rxpt_classify_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-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 _RXPT_CLASSIFY_INFO_H_
20*5113495bSYour Name #define _RXPT_CLASSIFY_INFO_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	reo_destination_indication[4:0], use_toeplitz_hash_2_clfy[5], use_toeplitz_hash_4_clfy[6], use_flow_id_toeplitz_clfy[7], reserved_0a[31:8]
29*5113495bSYour Name //
30*5113495bSYour Name // ################ END SUMMARY #################
31*5113495bSYour Name 
32*5113495bSYour Name #define NUM_OF_DWORDS_RXPT_CLASSIFY_INFO 1
33*5113495bSYour Name 
34*5113495bSYour Name struct rxpt_classify_info {
35*5113495bSYour Name              uint32_t reo_destination_indication      :  5, //[4:0]
36*5113495bSYour Name                       use_toeplitz_hash_2_clfy        :  1, //[5]
37*5113495bSYour Name                       use_toeplitz_hash_4_clfy        :  1, //[6]
38*5113495bSYour Name                       use_flow_id_toeplitz_clfy       :  1, //[7]
39*5113495bSYour Name                       reserved_0a                     : 24; //[31:8]
40*5113495bSYour Name };
41*5113495bSYour Name 
42*5113495bSYour Name /*
43*5113495bSYour Name 
44*5113495bSYour Name reo_destination_indication
45*5113495bSYour Name 
46*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
47*5113495bSYour Name 			push after (MPDU level) reordering has finished.
48*5113495bSYour Name 
49*5113495bSYour Name 
50*5113495bSYour Name 
51*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
52*5113495bSYour Name 			into the REO2TCL ring
53*5113495bSYour Name 
54*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
55*5113495bSYour Name 			into the REO2SW1 ring
56*5113495bSYour Name 
57*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
58*5113495bSYour Name 			into the REO2SW1 ring
59*5113495bSYour Name 
60*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
61*5113495bSYour Name 			into the REO2SW1 ring
62*5113495bSYour Name 
63*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
64*5113495bSYour Name 			into the REO2SW1 ring
65*5113495bSYour Name 
66*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
67*5113495bSYour Name 			into the REO_release ring
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
70*5113495bSYour Name 			the REO2FW ring
71*5113495bSYour Name 
72*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
73*5113495bSYour Name 
74*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
75*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
76*5113495bSYour Name 			reo_destination_10> REO remaps this
77*5113495bSYour Name 
78*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
79*5113495bSYour Name 
80*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
81*5113495bSYour Name 			reo_destination_13> REO remaps this
82*5113495bSYour Name 
83*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
84*5113495bSYour Name 
85*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
86*5113495bSYour Name 
87*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
88*5113495bSYour Name 
89*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
90*5113495bSYour Name 
91*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
94*5113495bSYour Name 
95*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
96*5113495bSYour Name 
97*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
98*5113495bSYour Name 
99*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
100*5113495bSYour Name 
101*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
102*5113495bSYour Name 
103*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
104*5113495bSYour Name 
105*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
106*5113495bSYour Name 
107*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
108*5113495bSYour Name 
109*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
110*5113495bSYour Name 
111*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
112*5113495bSYour Name 
113*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
114*5113495bSYour Name 
115*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
116*5113495bSYour Name 
117*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name 			<legal all>
122*5113495bSYour Name 
123*5113495bSYour Name use_toeplitz_hash_2_clfy
124*5113495bSYour Name 
125*5113495bSYour Name 			indication to Rx OLE to enable classification based on
126*5113495bSYour Name 			'hash_2_toeplitz' .
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal all>
129*5113495bSYour Name 
130*5113495bSYour Name use_toeplitz_hash_4_clfy
131*5113495bSYour Name 
132*5113495bSYour Name 			indication to Rx OLE to enable classification based on
133*5113495bSYour Name 			'hash_4_toeplitz' .
134*5113495bSYour Name 
135*5113495bSYour Name 			<legal all>
136*5113495bSYour Name 
137*5113495bSYour Name use_flow_id_toeplitz_clfy
138*5113495bSYour Name 
139*5113495bSYour Name 			indication to Rx OLE to enable classification based on
140*5113495bSYour Name 			'flow_id_toeplitz' from Common Parser, in case flow search
141*5113495bSYour Name 			fails
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal all>
144*5113495bSYour Name 
145*5113495bSYour Name reserved_0a
146*5113495bSYour Name 
147*5113495bSYour Name 			<legal 0>
148*5113495bSYour Name */
149*5113495bSYour Name 
150*5113495bSYour Name 
151*5113495bSYour Name /* Description		RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION
152*5113495bSYour Name 
153*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
154*5113495bSYour Name 			push after (MPDU level) reordering has finished.
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
159*5113495bSYour Name 			into the REO2TCL ring
160*5113495bSYour Name 
161*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
162*5113495bSYour Name 			into the REO2SW1 ring
163*5113495bSYour Name 
164*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
165*5113495bSYour Name 			into the REO2SW1 ring
166*5113495bSYour Name 
167*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
168*5113495bSYour Name 			into the REO2SW1 ring
169*5113495bSYour Name 
170*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
171*5113495bSYour Name 			into the REO2SW1 ring
172*5113495bSYour Name 
173*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
174*5113495bSYour Name 			into the REO_release ring
175*5113495bSYour Name 
176*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
177*5113495bSYour Name 			the REO2FW ring
178*5113495bSYour Name 
179*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
180*5113495bSYour Name 
181*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
182*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
183*5113495bSYour Name 			reo_destination_10> REO remaps this
184*5113495bSYour Name 
185*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
186*5113495bSYour Name 
187*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
188*5113495bSYour Name 			reo_destination_13> REO remaps this
189*5113495bSYour Name 
190*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
191*5113495bSYour Name 
192*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
193*5113495bSYour Name 
194*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
195*5113495bSYour Name 
196*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
197*5113495bSYour Name 
198*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
199*5113495bSYour Name 
200*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
201*5113495bSYour Name 
202*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
203*5113495bSYour Name 
204*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
205*5113495bSYour Name 
206*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
209*5113495bSYour Name 
210*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
211*5113495bSYour Name 
212*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
213*5113495bSYour Name 
214*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
215*5113495bSYour Name 
216*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
217*5113495bSYour Name 
218*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
219*5113495bSYour Name 
220*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
221*5113495bSYour Name 
222*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
223*5113495bSYour Name 
224*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 			<legal all>
229*5113495bSYour Name */
230*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION_OFFSET       0x00000000
231*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION_LSB          0
232*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION_MASK         0x0000001f
233*5113495bSYour Name 
234*5113495bSYour Name /* Description		RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_2_CLFY
235*5113495bSYour Name 
236*5113495bSYour Name 			indication to Rx OLE to enable classification based on
237*5113495bSYour Name 			'hash_2_toeplitz' .
238*5113495bSYour Name 
239*5113495bSYour Name 			<legal all>
240*5113495bSYour Name */
241*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_2_CLFY_OFFSET         0x00000000
242*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_2_CLFY_LSB            5
243*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_2_CLFY_MASK           0x00000020
244*5113495bSYour Name 
245*5113495bSYour Name /* Description		RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_4_CLFY
246*5113495bSYour Name 
247*5113495bSYour Name 			indication to Rx OLE to enable classification based on
248*5113495bSYour Name 			'hash_4_toeplitz' .
249*5113495bSYour Name 
250*5113495bSYour Name 			<legal all>
251*5113495bSYour Name */
252*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_4_CLFY_OFFSET         0x00000000
253*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_4_CLFY_LSB            6
254*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_TOEPLITZ_HASH_4_CLFY_MASK           0x00000040
255*5113495bSYour Name 
256*5113495bSYour Name /* Description		RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY
257*5113495bSYour Name 
258*5113495bSYour Name 			indication to Rx OLE to enable classification based on
259*5113495bSYour Name 			'flow_id_toeplitz' from Common Parser, in case flow search
260*5113495bSYour Name 			fails
261*5113495bSYour Name 
262*5113495bSYour Name 			<legal all>
263*5113495bSYour Name */
264*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY_OFFSET        0x00000000
265*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY_LSB           7
266*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY_MASK          0x00000080
267*5113495bSYour Name 
268*5113495bSYour Name /* Description		RXPT_CLASSIFY_INFO_0_RESERVED_0A
269*5113495bSYour Name 
270*5113495bSYour Name 			<legal 0>
271*5113495bSYour Name */
272*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_RESERVED_0A_OFFSET                      0x00000000
273*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_RESERVED_0A_LSB                         8
274*5113495bSYour Name #define RXPT_CLASSIFY_INFO_0_RESERVED_0A_MASK                        0xffffff00
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name #endif // _RXPT_CLASSIFY_INFO_H_
278