xref: /wlan-driver/fw-api/hw/qca6490/v1/rx_msdu_desc_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 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 //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _RX_MSDU_DESC_INFO_H_
25*5113495bSYour Name #define _RX_MSDU_DESC_INFO_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	first_msdu_in_mpdu_flag[0], last_msdu_in_mpdu_flag[1], msdu_continuation[2], msdu_length[16:3], reo_destination_indication[21:17], msdu_drop[22], sa_is_valid[23], sa_idx_timeout[24], da_is_valid[25], da_is_mcbc[26], da_idx_timeout[27], reserved_0a[31:28]
34*5113495bSYour Name //	1	reserved_1a[31:0]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_RX_MSDU_DESC_INFO 2
39*5113495bSYour Name 
40*5113495bSYour Name struct rx_msdu_desc_info {
41*5113495bSYour Name              uint32_t first_msdu_in_mpdu_flag         :  1, //[0]
42*5113495bSYour Name                       last_msdu_in_mpdu_flag          :  1, //[1]
43*5113495bSYour Name                       msdu_continuation               :  1, //[2]
44*5113495bSYour Name                       msdu_length                     : 14, //[16:3]
45*5113495bSYour Name                       reo_destination_indication      :  5, //[21:17]
46*5113495bSYour Name                       msdu_drop                       :  1, //[22]
47*5113495bSYour Name                       sa_is_valid                     :  1, //[23]
48*5113495bSYour Name                       sa_idx_timeout                  :  1, //[24]
49*5113495bSYour Name                       da_is_valid                     :  1, //[25]
50*5113495bSYour Name                       da_is_mcbc                      :  1, //[26]
51*5113495bSYour Name                       da_idx_timeout                  :  1, //[27]
52*5113495bSYour Name                       reserved_0a                     :  4; //[31:28]
53*5113495bSYour Name              uint32_t reserved_1a                     : 32; //[31:0]
54*5113495bSYour Name };
55*5113495bSYour Name 
56*5113495bSYour Name /*
57*5113495bSYour Name 
58*5113495bSYour Name first_msdu_in_mpdu_flag
59*5113495bSYour Name 
60*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
61*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
62*5113495bSYour Name 			buffer used by the MSDU
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name 			<enum 0 Not_first_msdu> This is not the first MSDU in
67*5113495bSYour Name 			the MPDU.
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 1 first_msdu> This MSDU is the first one in the
70*5113495bSYour Name 			MPDU.
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 			<legal all>
75*5113495bSYour Name 
76*5113495bSYour Name last_msdu_in_mpdu_flag
77*5113495bSYour Name 
78*5113495bSYour Name 			Consumer: WBM/REO/SW/FW
79*5113495bSYour Name 
80*5113495bSYour Name 			Producer: RXDMA
81*5113495bSYour Name 
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
85*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
86*5113495bSYour Name 			buffer used by the MSDU
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 			<enum 0 Not_last_msdu> There are more MSDUs linked to
91*5113495bSYour Name 			this MSDU that belongs to this MPDU
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 1 Last_msdu> this MSDU is the last one in the
94*5113495bSYour Name 			MPDU. This setting is only allowed in combination with
95*5113495bSYour Name 			'Msdu_continuation' set to 0. This implies that when an msdu
96*5113495bSYour Name 			is spread out over multiple buffers and thus
97*5113495bSYour Name 			msdu_continuation is set, only for the very last buffer of
98*5113495bSYour Name 			the msdu, can the 'last_msdu_in_mpdu_flag' be set.
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 			When both first_msdu_in_mpdu_flag and
103*5113495bSYour Name 			last_msdu_in_mpdu_flag are set, the MPDU that this MSDU
104*5113495bSYour Name 			belongs to only contains a single MSDU.
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name 			<legal all>
111*5113495bSYour Name 
112*5113495bSYour Name msdu_continuation
113*5113495bSYour Name 
114*5113495bSYour Name 			When set, this MSDU buffer was not able to hold the
115*5113495bSYour Name 			entire MSDU. The next buffer will therefor contain
116*5113495bSYour Name 			additional information related to this MSDU.
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 			<legal all>
121*5113495bSYour Name 
122*5113495bSYour Name msdu_length
123*5113495bSYour Name 
124*5113495bSYour Name 			Parsed from RX_MSDU_START TLV . In the case MSDU spans
125*5113495bSYour Name 			over multiple buffers, this field will be valid in the First
126*5113495bSYour Name 			buffer used by MSDU.
127*5113495bSYour Name 
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name 			Full MSDU length in bytes after decapsulation.
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name 			This field is still valid for MPDU frames without
135*5113495bSYour Name 			A-MSDU.  It still represents MSDU length after decapsulation
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 			Or in case of RAW MPDUs, it indicates the length of the
140*5113495bSYour Name 			entire MPDU (without FCS field)
141*5113495bSYour Name 
142*5113495bSYour Name 			<legal all>
143*5113495bSYour Name 
144*5113495bSYour Name reo_destination_indication
145*5113495bSYour Name 
146*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
147*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
148*5113495bSYour Name 			buffer used by the MSDU
149*5113495bSYour Name 
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
153*5113495bSYour Name 			push after (MPDU level) reordering has finished.
154*5113495bSYour Name 
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
158*5113495bSYour Name 			into the REO2TCL ring
159*5113495bSYour Name 
160*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
161*5113495bSYour Name 			into the REO2SW1 ring
162*5113495bSYour Name 
163*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
164*5113495bSYour Name 			into the REO2SW2 ring
165*5113495bSYour Name 
166*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
167*5113495bSYour Name 			into the REO2SW3 ring
168*5113495bSYour Name 
169*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
170*5113495bSYour Name 			into the REO2SW4 ring
171*5113495bSYour Name 
172*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
173*5113495bSYour Name 			into the REO_release ring
174*5113495bSYour Name 
175*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
176*5113495bSYour Name 			the REO2FW ring
177*5113495bSYour Name 
178*5113495bSYour Name 			<enum 7 reo_destination_sw5> Reo will push the frame
179*5113495bSYour Name 			into the REO2SW5 ring
180*5113495bSYour Name 
181*5113495bSYour Name 			<enum 8 reo_destination_sw6> Reo will push the frame
182*5113495bSYour Name 			into the REO2SW6 ring
183*5113495bSYour Name 
184*5113495bSYour Name 			 <enum 9 reo_destination_9> REO remaps this <enum 10
185*5113495bSYour Name 			reo_destination_10> REO remaps this
186*5113495bSYour Name 
187*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
188*5113495bSYour Name 
189*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
190*5113495bSYour Name 			reo_destination_13> REO remaps this
191*5113495bSYour Name 
192*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
193*5113495bSYour Name 
194*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
195*5113495bSYour Name 
196*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
197*5113495bSYour Name 
198*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
199*5113495bSYour Name 
200*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
201*5113495bSYour Name 
202*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
203*5113495bSYour Name 
204*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
205*5113495bSYour Name 
206*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
209*5113495bSYour Name 
210*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
211*5113495bSYour Name 
212*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
213*5113495bSYour Name 
214*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
215*5113495bSYour Name 
216*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
217*5113495bSYour Name 
218*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
219*5113495bSYour Name 
220*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
221*5113495bSYour Name 
222*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
223*5113495bSYour Name 
224*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
225*5113495bSYour Name 
226*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
227*5113495bSYour Name 
228*5113495bSYour Name 
229*5113495bSYour Name 
230*5113495bSYour Name 			<legal all>
231*5113495bSYour Name 
232*5113495bSYour Name msdu_drop
233*5113495bSYour Name 
234*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
235*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
236*5113495bSYour Name 			buffer used by the MSDU
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 			When set, REO shall drop this MSDU and not forward it to
241*5113495bSYour Name 			any other ring...
242*5113495bSYour Name 
243*5113495bSYour Name 			<legal all>
244*5113495bSYour Name 
245*5113495bSYour Name sa_is_valid
246*5113495bSYour Name 
247*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
248*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
249*5113495bSYour Name 			buffer used by the MSDU
250*5113495bSYour Name 
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name 			Indicates that OLE found a valid SA entry for this MSDU
254*5113495bSYour Name 
255*5113495bSYour Name 			<legal all>
256*5113495bSYour Name 
257*5113495bSYour Name sa_idx_timeout
258*5113495bSYour Name 
259*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
260*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
261*5113495bSYour Name 			buffer used by the MSDU
262*5113495bSYour Name 
263*5113495bSYour Name 
264*5113495bSYour Name 
265*5113495bSYour Name 			Indicates an unsuccessful MAC source address search due
266*5113495bSYour Name 			to the expiring of the search timer for this MSDU
267*5113495bSYour Name 
268*5113495bSYour Name 			<legal all>
269*5113495bSYour Name 
270*5113495bSYour Name da_is_valid
271*5113495bSYour Name 
272*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
273*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
274*5113495bSYour Name 			buffer used by the MSDU
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 
278*5113495bSYour Name 			Indicates that OLE found a valid DA entry for this MSDU
279*5113495bSYour Name 
280*5113495bSYour Name 			<legal all>
281*5113495bSYour Name 
282*5113495bSYour Name da_is_mcbc
283*5113495bSYour Name 
284*5113495bSYour Name 			Field Only valid if da_is_valid is set
285*5113495bSYour Name 
286*5113495bSYour Name 
287*5113495bSYour Name 
288*5113495bSYour Name 			Indicates the DA address was a Multicast of Broadcast
289*5113495bSYour Name 			address for this MSDU
290*5113495bSYour Name 
291*5113495bSYour Name 			<legal all>
292*5113495bSYour Name 
293*5113495bSYour Name da_idx_timeout
294*5113495bSYour Name 
295*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
296*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
297*5113495bSYour Name 			buffer used by the MSDU
298*5113495bSYour Name 
299*5113495bSYour Name 
300*5113495bSYour Name 
301*5113495bSYour Name 			Indicates an unsuccessful MAC destination address search
302*5113495bSYour Name 			due to the expiring of the search timer for this MSDU
303*5113495bSYour Name 
304*5113495bSYour Name 			<legal all>
305*5113495bSYour Name 
306*5113495bSYour Name reserved_0a
307*5113495bSYour Name 
308*5113495bSYour Name 			<legal 0>
309*5113495bSYour Name 
310*5113495bSYour Name reserved_1a
311*5113495bSYour Name 
312*5113495bSYour Name 			<legal 0>
313*5113495bSYour Name */
314*5113495bSYour Name 
315*5113495bSYour Name 
316*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_FIRST_MSDU_IN_MPDU_FLAG
317*5113495bSYour Name 
318*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
319*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
320*5113495bSYour Name 			buffer used by the MSDU
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 
324*5113495bSYour Name 			<enum 0 Not_first_msdu> This is not the first MSDU in
325*5113495bSYour Name 			the MPDU.
326*5113495bSYour Name 
327*5113495bSYour Name 			<enum 1 first_msdu> This MSDU is the first one in the
328*5113495bSYour Name 			MPDU.
329*5113495bSYour Name 
330*5113495bSYour Name 
331*5113495bSYour Name 
332*5113495bSYour Name 			<legal all>
333*5113495bSYour Name */
334*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_FIRST_MSDU_IN_MPDU_FLAG_OFFSET           0x00000000
335*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_FIRST_MSDU_IN_MPDU_FLAG_LSB              0
336*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_FIRST_MSDU_IN_MPDU_FLAG_MASK             0x00000001
337*5113495bSYour Name 
338*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_LAST_MSDU_IN_MPDU_FLAG
339*5113495bSYour Name 
340*5113495bSYour Name 			Consumer: WBM/REO/SW/FW
341*5113495bSYour Name 
342*5113495bSYour Name 			Producer: RXDMA
343*5113495bSYour Name 
344*5113495bSYour Name 
345*5113495bSYour Name 
346*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
347*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
348*5113495bSYour Name 			buffer used by the MSDU
349*5113495bSYour Name 
350*5113495bSYour Name 
351*5113495bSYour Name 
352*5113495bSYour Name 			<enum 0 Not_last_msdu> There are more MSDUs linked to
353*5113495bSYour Name 			this MSDU that belongs to this MPDU
354*5113495bSYour Name 
355*5113495bSYour Name 			<enum 1 Last_msdu> this MSDU is the last one in the
356*5113495bSYour Name 			MPDU. This setting is only allowed in combination with
357*5113495bSYour Name 			'Msdu_continuation' set to 0. This implies that when an msdu
358*5113495bSYour Name 			is spread out over multiple buffers and thus
359*5113495bSYour Name 			msdu_continuation is set, only for the very last buffer of
360*5113495bSYour Name 			the msdu, can the 'last_msdu_in_mpdu_flag' be set.
361*5113495bSYour Name 
362*5113495bSYour Name 
363*5113495bSYour Name 
364*5113495bSYour Name 			When both first_msdu_in_mpdu_flag and
365*5113495bSYour Name 			last_msdu_in_mpdu_flag are set, the MPDU that this MSDU
366*5113495bSYour Name 			belongs to only contains a single MSDU.
367*5113495bSYour Name 
368*5113495bSYour Name 
369*5113495bSYour Name 
370*5113495bSYour Name 
371*5113495bSYour Name 
372*5113495bSYour Name 			<legal all>
373*5113495bSYour Name */
374*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_LAST_MSDU_IN_MPDU_FLAG_OFFSET            0x00000000
375*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_LAST_MSDU_IN_MPDU_FLAG_LSB               1
376*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_LAST_MSDU_IN_MPDU_FLAG_MASK              0x00000002
377*5113495bSYour Name 
378*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_MSDU_CONTINUATION
379*5113495bSYour Name 
380*5113495bSYour Name 			When set, this MSDU buffer was not able to hold the
381*5113495bSYour Name 			entire MSDU. The next buffer will therefor contain
382*5113495bSYour Name 			additional information related to this MSDU.
383*5113495bSYour Name 
384*5113495bSYour Name 
385*5113495bSYour Name 
386*5113495bSYour Name 			<legal all>
387*5113495bSYour Name */
388*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_CONTINUATION_OFFSET                 0x00000000
389*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_CONTINUATION_LSB                    2
390*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_CONTINUATION_MASK                   0x00000004
391*5113495bSYour Name 
392*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_MSDU_LENGTH
393*5113495bSYour Name 
394*5113495bSYour Name 			Parsed from RX_MSDU_START TLV . In the case MSDU spans
395*5113495bSYour Name 			over multiple buffers, this field will be valid in the First
396*5113495bSYour Name 			buffer used by MSDU.
397*5113495bSYour Name 
398*5113495bSYour Name 
399*5113495bSYour Name 
400*5113495bSYour Name 			Full MSDU length in bytes after decapsulation.
401*5113495bSYour Name 
402*5113495bSYour Name 
403*5113495bSYour Name 
404*5113495bSYour Name 			This field is still valid for MPDU frames without
405*5113495bSYour Name 			A-MSDU.  It still represents MSDU length after decapsulation
406*5113495bSYour Name 
407*5113495bSYour Name 
408*5113495bSYour Name 
409*5113495bSYour Name 			Or in case of RAW MPDUs, it indicates the length of the
410*5113495bSYour Name 			entire MPDU (without FCS field)
411*5113495bSYour Name 
412*5113495bSYour Name 			<legal all>
413*5113495bSYour Name */
414*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_LENGTH_OFFSET                       0x00000000
415*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_LENGTH_LSB                          3
416*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_LENGTH_MASK                         0x0001fff8
417*5113495bSYour Name 
418*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_REO_DESTINATION_INDICATION
419*5113495bSYour Name 
420*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
421*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
422*5113495bSYour Name 			buffer used by the MSDU
423*5113495bSYour Name 
424*5113495bSYour Name 
425*5113495bSYour Name 
426*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
427*5113495bSYour Name 			push after (MPDU level) reordering has finished.
428*5113495bSYour Name 
429*5113495bSYour Name 
430*5113495bSYour Name 
431*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
432*5113495bSYour Name 			into the REO2TCL ring
433*5113495bSYour Name 
434*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
435*5113495bSYour Name 			into the REO2SW1 ring
436*5113495bSYour Name 
437*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
438*5113495bSYour Name 			into the REO2SW2 ring
439*5113495bSYour Name 
440*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
441*5113495bSYour Name 			into the REO2SW3 ring
442*5113495bSYour Name 
443*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
444*5113495bSYour Name 			into the REO2SW4 ring
445*5113495bSYour Name 
446*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
447*5113495bSYour Name 			into the REO_release ring
448*5113495bSYour Name 
449*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
450*5113495bSYour Name 			the REO2FW ring
451*5113495bSYour Name 
452*5113495bSYour Name 			<enum 7 reo_destination_sw5> Reo will push the frame
453*5113495bSYour Name 			into the REO2SW5 ring
454*5113495bSYour Name 
455*5113495bSYour Name 			<enum 8 reo_destination_sw6> Reo will push the frame
456*5113495bSYour Name 			into the REO2SW6 ring
457*5113495bSYour Name 
458*5113495bSYour Name 			 <enum 9 reo_destination_9> REO remaps this <enum 10
459*5113495bSYour Name 			reo_destination_10> REO remaps this
460*5113495bSYour Name 
461*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
462*5113495bSYour Name 
463*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
464*5113495bSYour Name 			reo_destination_13> REO remaps this
465*5113495bSYour Name 
466*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
467*5113495bSYour Name 
468*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
469*5113495bSYour Name 
470*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
471*5113495bSYour Name 
472*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
473*5113495bSYour Name 
474*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
475*5113495bSYour Name 
476*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
477*5113495bSYour Name 
478*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
479*5113495bSYour Name 
480*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
481*5113495bSYour Name 
482*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
483*5113495bSYour Name 
484*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
485*5113495bSYour Name 
486*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
487*5113495bSYour Name 
488*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
489*5113495bSYour Name 
490*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
491*5113495bSYour Name 
492*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
493*5113495bSYour Name 
494*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
495*5113495bSYour Name 
496*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
497*5113495bSYour Name 
498*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
499*5113495bSYour Name 
500*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
501*5113495bSYour Name 
502*5113495bSYour Name 
503*5113495bSYour Name 
504*5113495bSYour Name 			<legal all>
505*5113495bSYour Name */
506*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_REO_DESTINATION_INDICATION_OFFSET        0x00000000
507*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_REO_DESTINATION_INDICATION_LSB           17
508*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_REO_DESTINATION_INDICATION_MASK          0x003e0000
509*5113495bSYour Name 
510*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_MSDU_DROP
511*5113495bSYour Name 
512*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
513*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
514*5113495bSYour Name 			buffer used by the MSDU
515*5113495bSYour Name 
516*5113495bSYour Name 
517*5113495bSYour Name 
518*5113495bSYour Name 			When set, REO shall drop this MSDU and not forward it to
519*5113495bSYour Name 			any other ring...
520*5113495bSYour Name 
521*5113495bSYour Name 			<legal all>
522*5113495bSYour Name */
523*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_DROP_OFFSET                         0x00000000
524*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_DROP_LSB                            22
525*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_MSDU_DROP_MASK                           0x00400000
526*5113495bSYour Name 
527*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_SA_IS_VALID
528*5113495bSYour Name 
529*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
530*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
531*5113495bSYour Name 			buffer used by the MSDU
532*5113495bSYour Name 
533*5113495bSYour Name 
534*5113495bSYour Name 
535*5113495bSYour Name 			Indicates that OLE found a valid SA entry for this MSDU
536*5113495bSYour Name 
537*5113495bSYour Name 			<legal all>
538*5113495bSYour Name */
539*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_SA_IS_VALID_OFFSET                       0x00000000
540*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_SA_IS_VALID_LSB                          23
541*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_SA_IS_VALID_MASK                         0x00800000
542*5113495bSYour Name 
543*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_SA_IDX_TIMEOUT
544*5113495bSYour Name 
545*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
546*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
547*5113495bSYour Name 			buffer used by the MSDU
548*5113495bSYour Name 
549*5113495bSYour Name 
550*5113495bSYour Name 
551*5113495bSYour Name 			Indicates an unsuccessful MAC source address search due
552*5113495bSYour Name 			to the expiring of the search timer for this MSDU
553*5113495bSYour Name 
554*5113495bSYour Name 			<legal all>
555*5113495bSYour Name */
556*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_SA_IDX_TIMEOUT_OFFSET                    0x00000000
557*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_SA_IDX_TIMEOUT_LSB                       24
558*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_SA_IDX_TIMEOUT_MASK                      0x01000000
559*5113495bSYour Name 
560*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_DA_IS_VALID
561*5113495bSYour Name 
562*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
563*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
564*5113495bSYour Name 			buffer used by the MSDU
565*5113495bSYour Name 
566*5113495bSYour Name 
567*5113495bSYour Name 
568*5113495bSYour Name 			Indicates that OLE found a valid DA entry for this MSDU
569*5113495bSYour Name 
570*5113495bSYour Name 			<legal all>
571*5113495bSYour Name */
572*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IS_VALID_OFFSET                       0x00000000
573*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IS_VALID_LSB                          25
574*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IS_VALID_MASK                         0x02000000
575*5113495bSYour Name 
576*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_DA_IS_MCBC
577*5113495bSYour Name 
578*5113495bSYour Name 			Field Only valid if da_is_valid is set
579*5113495bSYour Name 
580*5113495bSYour Name 
581*5113495bSYour Name 
582*5113495bSYour Name 			Indicates the DA address was a Multicast of Broadcast
583*5113495bSYour Name 			address for this MSDU
584*5113495bSYour Name 
585*5113495bSYour Name 			<legal all>
586*5113495bSYour Name */
587*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IS_MCBC_OFFSET                        0x00000000
588*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IS_MCBC_LSB                           26
589*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IS_MCBC_MASK                          0x04000000
590*5113495bSYour Name 
591*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_DA_IDX_TIMEOUT
592*5113495bSYour Name 
593*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
594*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
595*5113495bSYour Name 			buffer used by the MSDU
596*5113495bSYour Name 
597*5113495bSYour Name 
598*5113495bSYour Name 
599*5113495bSYour Name 			Indicates an unsuccessful MAC destination address search
600*5113495bSYour Name 			due to the expiring of the search timer for this MSDU
601*5113495bSYour Name 
602*5113495bSYour Name 			<legal all>
603*5113495bSYour Name */
604*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IDX_TIMEOUT_OFFSET                    0x00000000
605*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IDX_TIMEOUT_LSB                       27
606*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_DA_IDX_TIMEOUT_MASK                      0x08000000
607*5113495bSYour Name 
608*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_0_RESERVED_0A
609*5113495bSYour Name 
610*5113495bSYour Name 			<legal 0>
611*5113495bSYour Name */
612*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_RESERVED_0A_OFFSET                       0x00000000
613*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_RESERVED_0A_LSB                          28
614*5113495bSYour Name #define RX_MSDU_DESC_INFO_0_RESERVED_0A_MASK                         0xf0000000
615*5113495bSYour Name 
616*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_1_RESERVED_1A
617*5113495bSYour Name 
618*5113495bSYour Name 			<legal 0>
619*5113495bSYour Name */
620*5113495bSYour Name #define RX_MSDU_DESC_INFO_1_RESERVED_1A_OFFSET                       0x00000004
621*5113495bSYour Name #define RX_MSDU_DESC_INFO_1_RESERVED_1A_LSB                          0
622*5113495bSYour Name #define RX_MSDU_DESC_INFO_1_RESERVED_1A_MASK                         0xffffffff
623*5113495bSYour Name 
624*5113495bSYour Name 
625*5113495bSYour Name #endif // _RX_MSDU_DESC_INFO_H_
626