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