xref: /wlan-driver/fw-api/hw/qca6290/v2/rxpt_classify_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 //
20 // DO NOT EDIT!  This file is automatically generated
21 //               These definitions are tied to a particular hardware layout
22 
23 
24 #ifndef _RXPT_CLASSIFY_INFO_H_
25 #define _RXPT_CLASSIFY_INFO_H_
26 #if !defined(__ASSEMBLER__)
27 #endif
28 
29 
30 // ################ START SUMMARY #################
31 //
32 //	Dword	Fields
33 //	0	reo_destination_indication[4:0], use_flow_id_toeplitz_clfy[5], reserved_0a[31:6]
34 //
35 // ################ END SUMMARY #################
36 
37 #define NUM_OF_DWORDS_RXPT_CLASSIFY_INFO 1
38 
39 struct rxpt_classify_info {
40              uint32_t reo_destination_indication      :  5, //[4:0]
41                       use_flow_id_toeplitz_clfy       :  1, //[5]
42                       reserved_0a                     : 26; //[31:6]
43 };
44 
45 /*
46 
47 reo_destination_indication
48 
49 			The ID of the REO exit ring where the MSDU frame shall
50 			push after (MPDU level) reordering has finished.
51 
52 
53 
54 			<enum 0 reo_destination_tcl> Reo will push the frame
55 			into the REO2TCL ring
56 
57 			<enum 1 reo_destination_sw1> Reo will push the frame
58 			into the REO2SW1 ring
59 
60 			<enum 2 reo_destination_sw2> Reo will push the frame
61 			into the REO2SW1 ring
62 
63 			<enum 3 reo_destination_sw3> Reo will push the frame
64 			into the REO2SW1 ring
65 
66 			<enum 4 reo_destination_sw4> Reo will push the frame
67 			into the REO2SW1 ring
68 
69 			<enum 5 reo_destination_release> Reo will push the frame
70 			into the REO_release ring
71 
72 			<enum 6 reo_destination_fw> Reo will push the frame into
73 			the REO2FW ring
74 
75 			<enum 7 reo_destination_7> REO remaps this
76 
77 			<enum 8 reo_destination_8> REO remaps this <enum 9
78 			reo_destination_9> REO remaps this <enum 10
79 			reo_destination_10> REO remaps this
80 
81 			<enum 11 reo_destination_11> REO remaps this
82 
83 			<enum 12 reo_destination_12> REO remaps this <enum 13
84 			reo_destination_13> REO remaps this
85 
86 			<enum 14 reo_destination_14> REO remaps this
87 
88 			<enum 15 reo_destination_15> REO remaps this
89 
90 			<enum 16 reo_destination_16> REO remaps this
91 
92 			<enum 17 reo_destination_17> REO remaps this
93 
94 			<enum 18 reo_destination_18> REO remaps this
95 
96 			<enum 19 reo_destination_19> REO remaps this
97 
98 			<enum 20 reo_destination_20> REO remaps this
99 
100 			<enum 21 reo_destination_21> REO remaps this
101 
102 			<enum 22 reo_destination_22> REO remaps this
103 
104 			<enum 23 reo_destination_23> REO remaps this
105 
106 			<enum 24 reo_destination_24> REO remaps this
107 
108 			<enum 25 reo_destination_25> REO remaps this
109 
110 			<enum 26 reo_destination_26> REO remaps this
111 
112 			<enum 27 reo_destination_27> REO remaps this
113 
114 			<enum 28 reo_destination_28> REO remaps this
115 
116 			<enum 29 reo_destination_29> REO remaps this
117 
118 			<enum 30 reo_destination_30> REO remaps this
119 
120 			<enum 31 reo_destination_31> REO remaps this
121 
122 
123 
124 			<legal all>
125 
126 use_flow_id_toeplitz_clfy
127 
128 			indication to Rx OLE to enable classification based on
129 			'flow_id_toeplitz' from Common Parser, in case flow search
130 			fails
131 
132 			<legal all>
133 
134 reserved_0a
135 
136 			<legal 0>
137 */
138 
139 
140 /* Description		RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION
141 
142 			The ID of the REO exit ring where the MSDU frame shall
143 			push after (MPDU level) reordering has finished.
144 
145 
146 
147 			<enum 0 reo_destination_tcl> Reo will push the frame
148 			into the REO2TCL ring
149 
150 			<enum 1 reo_destination_sw1> Reo will push the frame
151 			into the REO2SW1 ring
152 
153 			<enum 2 reo_destination_sw2> Reo will push the frame
154 			into the REO2SW1 ring
155 
156 			<enum 3 reo_destination_sw3> Reo will push the frame
157 			into the REO2SW1 ring
158 
159 			<enum 4 reo_destination_sw4> Reo will push the frame
160 			into the REO2SW1 ring
161 
162 			<enum 5 reo_destination_release> Reo will push the frame
163 			into the REO_release ring
164 
165 			<enum 6 reo_destination_fw> Reo will push the frame into
166 			the REO2FW ring
167 
168 			<enum 7 reo_destination_7> REO remaps this
169 
170 			<enum 8 reo_destination_8> REO remaps this <enum 9
171 			reo_destination_9> REO remaps this <enum 10
172 			reo_destination_10> REO remaps this
173 
174 			<enum 11 reo_destination_11> REO remaps this
175 
176 			<enum 12 reo_destination_12> REO remaps this <enum 13
177 			reo_destination_13> REO remaps this
178 
179 			<enum 14 reo_destination_14> REO remaps this
180 
181 			<enum 15 reo_destination_15> REO remaps this
182 
183 			<enum 16 reo_destination_16> REO remaps this
184 
185 			<enum 17 reo_destination_17> REO remaps this
186 
187 			<enum 18 reo_destination_18> REO remaps this
188 
189 			<enum 19 reo_destination_19> REO remaps this
190 
191 			<enum 20 reo_destination_20> REO remaps this
192 
193 			<enum 21 reo_destination_21> REO remaps this
194 
195 			<enum 22 reo_destination_22> REO remaps this
196 
197 			<enum 23 reo_destination_23> REO remaps this
198 
199 			<enum 24 reo_destination_24> REO remaps this
200 
201 			<enum 25 reo_destination_25> REO remaps this
202 
203 			<enum 26 reo_destination_26> REO remaps this
204 
205 			<enum 27 reo_destination_27> REO remaps this
206 
207 			<enum 28 reo_destination_28> REO remaps this
208 
209 			<enum 29 reo_destination_29> REO remaps this
210 
211 			<enum 30 reo_destination_30> REO remaps this
212 
213 			<enum 31 reo_destination_31> REO remaps this
214 
215 
216 
217 			<legal all>
218 */
219 #define RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION_OFFSET       0x00000000
220 #define RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION_LSB          0
221 #define RXPT_CLASSIFY_INFO_0_REO_DESTINATION_INDICATION_MASK         0x0000001f
222 
223 /* Description		RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY
224 
225 			indication to Rx OLE to enable classification based on
226 			'flow_id_toeplitz' from Common Parser, in case flow search
227 			fails
228 
229 			<legal all>
230 */
231 #define RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY_OFFSET        0x00000000
232 #define RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY_LSB           5
233 #define RXPT_CLASSIFY_INFO_0_USE_FLOW_ID_TOEPLITZ_CLFY_MASK          0x00000020
234 
235 /* Description		RXPT_CLASSIFY_INFO_0_RESERVED_0A
236 
237 			<legal 0>
238 */
239 #define RXPT_CLASSIFY_INFO_0_RESERVED_0A_OFFSET                      0x00000000
240 #define RXPT_CLASSIFY_INFO_0_RESERVED_0A_LSB                         6
241 #define RXPT_CLASSIFY_INFO_0_RESERVED_0A_MASK                        0xffffffc0
242 
243 
244 #endif // _RXPT_CLASSIFY_INFO_H_
245