xref: /wlan-driver/fw-api/hw/qca8074/v2/reo_destination_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020 The Linux Foundation. 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 // $ATH_LICENSE_HW_HDR_C$
18*5113495bSYour Name //
19*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
20*5113495bSYour Name //               These definitions are tied to a particular hardware layout
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name #ifndef _REO_DESTINATION_RING_H_
24*5113495bSYour Name #define _REO_DESTINATION_RING_H_
25*5113495bSYour Name #if !defined(__ASSEMBLER__)
26*5113495bSYour Name #endif
27*5113495bSYour Name 
28*5113495bSYour Name #include "buffer_addr_info.h"
29*5113495bSYour Name #include "rx_mpdu_desc_info.h"
30*5113495bSYour Name #include "rx_msdu_desc_info.h"
31*5113495bSYour Name 
32*5113495bSYour Name // ################ START SUMMARY #################
33*5113495bSYour Name //
34*5113495bSYour Name //	Dword	Fields
35*5113495bSYour Name //	0-1	struct buffer_addr_info buf_or_link_desc_addr_info;
36*5113495bSYour Name //	2-3	struct rx_mpdu_desc_info rx_mpdu_desc_info_details;
37*5113495bSYour Name //	4-5	struct rx_msdu_desc_info rx_msdu_desc_info_details;
38*5113495bSYour Name //	6	rx_reo_queue_desc_addr_31_0[31:0]
39*5113495bSYour Name //	7	rx_reo_queue_desc_addr_39_32[7:0], reo_dest_buffer_type[8], reo_push_reason[10:9], reo_error_code[15:11], receive_queue_number[31:16]
40*5113495bSYour Name //	8	soft_reorder_info_valid[0], reorder_opcode[4:1], reorder_slot_index[12:5], mpdu_fragment_number[16:13], reserved_8a[31:17]
41*5113495bSYour Name //	9	reserved_9a[31:0]
42*5113495bSYour Name //	10	reserved_10a[31:0]
43*5113495bSYour Name //	11	reserved_11a[31:0]
44*5113495bSYour Name //	12	reserved_12a[31:0]
45*5113495bSYour Name //	13	reserved_13a[31:0]
46*5113495bSYour Name //	14	reserved_14a[31:0]
47*5113495bSYour Name //	15	reserved_15[19:0], ring_id[27:20], looping_count[31:28]
48*5113495bSYour Name //
49*5113495bSYour Name // ################ END SUMMARY #################
50*5113495bSYour Name 
51*5113495bSYour Name #define NUM_OF_DWORDS_REO_DESTINATION_RING 16
52*5113495bSYour Name 
53*5113495bSYour Name struct reo_destination_ring {
54*5113495bSYour Name     struct            buffer_addr_info                       buf_or_link_desc_addr_info;
55*5113495bSYour Name     struct            rx_mpdu_desc_info                       rx_mpdu_desc_info_details;
56*5113495bSYour Name     struct            rx_msdu_desc_info                       rx_msdu_desc_info_details;
57*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_31_0     : 32; //[31:0]
58*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_39_32    :  8, //[7:0]
59*5113495bSYour Name                       reo_dest_buffer_type            :  1, //[8]
60*5113495bSYour Name                       reo_push_reason                 :  2, //[10:9]
61*5113495bSYour Name                       reo_error_code                  :  5, //[15:11]
62*5113495bSYour Name                       receive_queue_number            : 16; //[31:16]
63*5113495bSYour Name              uint32_t soft_reorder_info_valid         :  1, //[0]
64*5113495bSYour Name                       reorder_opcode                  :  4, //[4:1]
65*5113495bSYour Name                       reorder_slot_index              :  8, //[12:5]
66*5113495bSYour Name                       mpdu_fragment_number            :  4, //[16:13]
67*5113495bSYour Name                       reserved_8a                     : 15; //[31:17]
68*5113495bSYour Name              uint32_t reserved_9a                     : 32; //[31:0]
69*5113495bSYour Name              uint32_t reserved_10a                    : 32; //[31:0]
70*5113495bSYour Name              uint32_t reserved_11a                    : 32; //[31:0]
71*5113495bSYour Name              uint32_t reserved_12a                    : 32; //[31:0]
72*5113495bSYour Name              uint32_t reserved_13a                    : 32; //[31:0]
73*5113495bSYour Name              uint32_t reserved_14a                    : 32; //[31:0]
74*5113495bSYour Name              uint32_t reserved_15                     : 20, //[19:0]
75*5113495bSYour Name                       ring_id                         :  8, //[27:20]
76*5113495bSYour Name                       looping_count                   :  4; //[31:28]
77*5113495bSYour Name };
78*5113495bSYour Name 
79*5113495bSYour Name /*
80*5113495bSYour Name 
81*5113495bSYour Name struct buffer_addr_info buf_or_link_desc_addr_info
82*5113495bSYour Name 
83*5113495bSYour Name 			Consumer: REO/SW/FW
84*5113495bSYour Name 
85*5113495bSYour Name 			Producer: RXDMA
86*5113495bSYour Name 
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 			Details of the physical address of the a buffer or MSDU
90*5113495bSYour Name 			link descriptor
91*5113495bSYour Name 
92*5113495bSYour Name struct rx_mpdu_desc_info rx_mpdu_desc_info_details
93*5113495bSYour Name 
94*5113495bSYour Name 			Consumer: REO/SW/FW
95*5113495bSYour Name 
96*5113495bSYour Name 			Producer: RXDMA
97*5113495bSYour Name 
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name 			General information related to the MPDU that is passed
101*5113495bSYour Name 			on from REO entrance ring to the REO destination ring
102*5113495bSYour Name 
103*5113495bSYour Name struct rx_msdu_desc_info rx_msdu_desc_info_details
104*5113495bSYour Name 
105*5113495bSYour Name 			General information related to the MSDU that is passed
106*5113495bSYour Name 			on from RXDMA all the way to to the REO destination ring.
107*5113495bSYour Name 
108*5113495bSYour Name rx_reo_queue_desc_addr_31_0
109*5113495bSYour Name 
110*5113495bSYour Name 			Consumer: REO
111*5113495bSYour Name 
112*5113495bSYour Name 			Producer: RXDMA
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor.
117*5113495bSYour Name 
118*5113495bSYour Name 			<legal all>
119*5113495bSYour Name 
120*5113495bSYour Name rx_reo_queue_desc_addr_39_32
121*5113495bSYour Name 
122*5113495bSYour Name 			Consumer: REO
123*5113495bSYour Name 
124*5113495bSYour Name 			Producer: RXDMA
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 
128*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor.
129*5113495bSYour Name 
130*5113495bSYour Name 			<legal all>
131*5113495bSYour Name 
132*5113495bSYour Name reo_dest_buffer_type
133*5113495bSYour Name 
134*5113495bSYour Name 			Indicates the type of address provided in the
135*5113495bSYour Name 			'Buf_or_link_desc_addr_info'
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 			<enum 0 MSDU_buf_address> The address of an MSDU buffer
140*5113495bSYour Name 
141*5113495bSYour Name 			<enum 1 MSDU_link_desc_address> The address of the MSDU
142*5113495bSYour Name 			link descriptor.
143*5113495bSYour Name 
144*5113495bSYour Name 
145*5113495bSYour Name 
146*5113495bSYour Name 			<legal all>
147*5113495bSYour Name 
148*5113495bSYour Name reo_push_reason
149*5113495bSYour Name 
150*5113495bSYour Name 			Indicates why REO pushed the frame to this exit ring
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an
155*5113495bSYour Name 			pushed this frame to this queue
156*5113495bSYour Name 
157*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
158*5113495bSYour Name 			this queue per received routing instructions. No error
159*5113495bSYour Name 			within REO was detected
160*5113495bSYour Name 
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 			<legal 0 - 1>
166*5113495bSYour Name 
167*5113495bSYour Name reo_error_code
168*5113495bSYour Name 
169*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to
170*5113495bSYour Name 			'reo_error_detected'.
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name 
174*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor
175*5113495bSYour Name 			provided in the REO_ENTRANCE ring is set to 0
176*5113495bSYour Name 
177*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor
178*5113495bSYour Name 			valid bit is NOT set
179*5113495bSYour Name 
180*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
181*5113495bSYour Name 			session having been setup.
182*5113495bSYour Name 
183*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to
184*5113495bSYour Name 			SSN, Retry bit set: duplicate frame
185*5113495bSYour Name 
186*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
187*5113495bSYour Name 
188*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
189*5113495bSYour Name 			frame) received with 2K jump in SN
190*5113495bSYour Name 
191*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump
192*5113495bSYour Name 			in SSN
193*5113495bSYour Name 
194*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data
195*5113495bSYour Name 			frame) received with SN falling within the OOR window
196*5113495bSYour Name 
197*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling
198*5113495bSYour Name 			within the OOR window
199*5113495bSYour Name 
200*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
201*5113495bSYour Name 			a BA session
202*5113495bSYour Name 
203*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with
204*5113495bSYour Name 			SSN equal to SN
205*5113495bSYour Name 
206*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
209*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set in
210*5113495bSYour Name 			the REO Queue descriptor
211*5113495bSYour Name 
212*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
213*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in the
214*5113495bSYour Name 			REO Queue descriptor
215*5113495bSYour Name 
216*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is
217*5113495bSYour Name 			forwarded as a result of the queue descriptor(address) being
218*5113495bSYour Name 			blocked as SW/FW seems to be currently in the process of
219*5113495bSYour Name 			making updates to this descriptor...
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name 			<legal 0-14>
224*5113495bSYour Name 
225*5113495bSYour Name receive_queue_number
226*5113495bSYour Name 
227*5113495bSYour Name 			This field indicates the REO MPDU reorder queue ID from
228*5113495bSYour Name 			which this frame originated. This field is populated from a
229*5113495bSYour Name 			field with the same name in the RX_REO_QUEUE descriptor.
230*5113495bSYour Name 
231*5113495bSYour Name 			<legal all>
232*5113495bSYour Name 
233*5113495bSYour Name soft_reorder_info_valid
234*5113495bSYour Name 
235*5113495bSYour Name 			When set, REO has been instructed to not perform the
236*5113495bSYour Name 			actual re-ordering of frames for this queue, but just to
237*5113495bSYour Name 			insert the reorder opcodes
238*5113495bSYour Name 
239*5113495bSYour Name 			<legal all>
240*5113495bSYour Name 
241*5113495bSYour Name reorder_opcode
242*5113495bSYour Name 
243*5113495bSYour Name 			Field is valid when 'Soft_reorder_info_valid' is set.
244*5113495bSYour Name 			This field is always valid for debug purpose as well.
245*5113495bSYour Name 
246*5113495bSYour Name 			Details are in the MLD.
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 			<enum 0 invalid>
251*5113495bSYour Name 
252*5113495bSYour Name 			<enum 1 fwdcur_fwdbuf>
253*5113495bSYour Name 
254*5113495bSYour Name 			<enum 2 fwdbuf_fwdcur>
255*5113495bSYour Name 
256*5113495bSYour Name 			<enum 3 qcur>
257*5113495bSYour Name 
258*5113495bSYour Name 			<enum 4 fwdbuf_qcur>
259*5113495bSYour Name 
260*5113495bSYour Name 			<enum 5 fwdbuf_drop>
261*5113495bSYour Name 
262*5113495bSYour Name 			<enum 6 fwdall_drop>
263*5113495bSYour Name 
264*5113495bSYour Name 			<enum 7 fwdall_qcur>
265*5113495bSYour Name 
266*5113495bSYour Name 			<enum 8 reserved_reo_opcode_1>
267*5113495bSYour Name 
268*5113495bSYour Name 			<enum 9 dropcur>  the error reason code is in
269*5113495bSYour Name 			reo_error_code field.
270*5113495bSYour Name 
271*5113495bSYour Name 			<enum 10 reserved_reo_opcode_2>
272*5113495bSYour Name 
273*5113495bSYour Name 			<enum 11 reserved_reo_opcode_3>
274*5113495bSYour Name 
275*5113495bSYour Name 			<enum 12 reserved_reo_opcode_4>
276*5113495bSYour Name 
277*5113495bSYour Name 			<enum 13 reserved_reo_opcode_5>
278*5113495bSYour Name 
279*5113495bSYour Name 			<enum 14 reserved_reo_opcode_6>
280*5113495bSYour Name 
281*5113495bSYour Name 			<enum 15 reserved_reo_opcode_7>
282*5113495bSYour Name 
283*5113495bSYour Name 
284*5113495bSYour Name 
285*5113495bSYour Name 			<legal all>
286*5113495bSYour Name 
287*5113495bSYour Name reorder_slot_index
288*5113495bSYour Name 
289*5113495bSYour Name 			Field only valid when 'Soft_reorder_info_valid' is set.
290*5113495bSYour Name 
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 			TODO: add description
294*5113495bSYour Name 
295*5113495bSYour Name 
296*5113495bSYour Name 
297*5113495bSYour Name 			<legal all>
298*5113495bSYour Name 
299*5113495bSYour Name mpdu_fragment_number
300*5113495bSYour Name 
301*5113495bSYour Name 			Field only valid when Rx_mpdu_desc_info_details.
302*5113495bSYour Name 
303*5113495bSYour Name 			Fragment_flag  is set.
304*5113495bSYour Name 
305*5113495bSYour Name 
306*5113495bSYour Name 
307*5113495bSYour Name 			The fragment number from the 802.11 header.
308*5113495bSYour Name 
309*5113495bSYour Name 
310*5113495bSYour Name 
311*5113495bSYour Name 			Note that the sequence number is embedded in field:
312*5113495bSYour Name 			Rx_mpdu_desc_info_details.
313*5113495bSYour Name 
314*5113495bSYour Name 			Mpdu_Sequence_number
315*5113495bSYour Name 
316*5113495bSYour Name 			<legal all>
317*5113495bSYour Name 
318*5113495bSYour Name reserved_8a
319*5113495bSYour Name 
320*5113495bSYour Name 			<legal 0>
321*5113495bSYour Name 
322*5113495bSYour Name reserved_9a
323*5113495bSYour Name 
324*5113495bSYour Name 			<legal 0>
325*5113495bSYour Name 
326*5113495bSYour Name reserved_10a
327*5113495bSYour Name 
328*5113495bSYour Name 			<legal 0>
329*5113495bSYour Name 
330*5113495bSYour Name reserved_11a
331*5113495bSYour Name 
332*5113495bSYour Name 			<legal 0>
333*5113495bSYour Name 
334*5113495bSYour Name reserved_12a
335*5113495bSYour Name 
336*5113495bSYour Name 			<legal 0>
337*5113495bSYour Name 
338*5113495bSYour Name reserved_13a
339*5113495bSYour Name 
340*5113495bSYour Name 			<legal 0>
341*5113495bSYour Name 
342*5113495bSYour Name reserved_14a
343*5113495bSYour Name 
344*5113495bSYour Name 			<legal 0>
345*5113495bSYour Name 
346*5113495bSYour Name reserved_15
347*5113495bSYour Name 
348*5113495bSYour Name 			<legal 0>
349*5113495bSYour Name 
350*5113495bSYour Name ring_id
351*5113495bSYour Name 
352*5113495bSYour Name 			The buffer pointer ring ID.
353*5113495bSYour Name 
354*5113495bSYour Name 			0 refers to the IDLE ring
355*5113495bSYour Name 
356*5113495bSYour Name 			1 - N refers to other rings
357*5113495bSYour Name 
358*5113495bSYour Name 
359*5113495bSYour Name 
360*5113495bSYour Name 			Helps with debugging when dumping ring contents.
361*5113495bSYour Name 
362*5113495bSYour Name 			<legal all>
363*5113495bSYour Name 
364*5113495bSYour Name looping_count
365*5113495bSYour Name 
366*5113495bSYour Name 			A count value that indicates the number of times the
367*5113495bSYour Name 			producer of entries into this Ring has looped around the
368*5113495bSYour Name 			ring.
369*5113495bSYour Name 
370*5113495bSYour Name 			At initialization time, this value is set to 0. On the
371*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
372*5113495bSYour Name 			reached allowed by the number of bits for this field, the
373*5113495bSYour Name 			count value continues with 0 again.
374*5113495bSYour Name 
375*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
376*5113495bSYour Name 			use this field to figure out up to where the producer of
377*5113495bSYour Name 			entries has created new entries. This eliminates the need to
378*5113495bSYour Name 			check where the head pointer' of the ring is located once
379*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
380*5113495bSYour Name 			entries have been put into this ring...
381*5113495bSYour Name 
382*5113495bSYour Name 
383*5113495bSYour Name 
384*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
385*5113495bSYour Name 			LSB bit of this count value.
386*5113495bSYour Name 
387*5113495bSYour Name 			<legal all>
388*5113495bSYour Name */
389*5113495bSYour Name 
390*5113495bSYour Name 
391*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info buf_or_link_desc_addr_info */
392*5113495bSYour Name 
393*5113495bSYour Name 
394*5113495bSYour Name /* Description		REO_DESTINATION_RING_0_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0
395*5113495bSYour Name 
396*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
397*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
398*5113495bSYour Name 
399*5113495bSYour Name 
400*5113495bSYour Name 
401*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
402*5113495bSYour Name 
403*5113495bSYour Name 			<legal all>
404*5113495bSYour Name */
405*5113495bSYour Name #define REO_DESTINATION_RING_0_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
406*5113495bSYour Name #define REO_DESTINATION_RING_0_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
407*5113495bSYour Name #define REO_DESTINATION_RING_0_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
408*5113495bSYour Name 
409*5113495bSYour Name /* Description		REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32
410*5113495bSYour Name 
411*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
412*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
413*5113495bSYour Name 
414*5113495bSYour Name 
415*5113495bSYour Name 
416*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
417*5113495bSYour Name 
418*5113495bSYour Name 			<legal all>
419*5113495bSYour Name */
420*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
421*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
422*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
423*5113495bSYour Name 
424*5113495bSYour Name /* Description		REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER
425*5113495bSYour Name 
426*5113495bSYour Name 			Consumer: WBM
427*5113495bSYour Name 
428*5113495bSYour Name 			Producer: SW/FW
429*5113495bSYour Name 
430*5113495bSYour Name 
431*5113495bSYour Name 
432*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
433*5113495bSYour Name 
434*5113495bSYour Name 
435*5113495bSYour Name 
436*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
437*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
438*5113495bSYour Name 			pointed to shall be returned after the frame has been
439*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
440*5113495bSYour Name 
441*5113495bSYour Name 
442*5113495bSYour Name 
443*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
444*5113495bSYour Name 			to the WMB buffer idle list
445*5113495bSYour Name 
446*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
447*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
448*5113495bSYour Name 
449*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
450*5113495bSYour Name 
451*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
452*5113495bSYour Name 			ring 0
453*5113495bSYour Name 
454*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
455*5113495bSYour Name 			ring 1
456*5113495bSYour Name 
457*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
458*5113495bSYour Name 			ring 2
459*5113495bSYour Name 
460*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
461*5113495bSYour Name 			ring 3
462*5113495bSYour Name 
463*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
464*5113495bSYour Name 			ring 3
465*5113495bSYour Name 
466*5113495bSYour Name 
467*5113495bSYour Name 
468*5113495bSYour Name 			<legal all>
469*5113495bSYour Name */
470*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
471*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
472*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000700
473*5113495bSYour Name 
474*5113495bSYour Name /* Description		REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE
475*5113495bSYour Name 
476*5113495bSYour Name 			Cookie field exclusively used by SW.
477*5113495bSYour Name 
478*5113495bSYour Name 
479*5113495bSYour Name 
480*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
481*5113495bSYour Name 
482*5113495bSYour Name 
483*5113495bSYour Name 
484*5113495bSYour Name 			HW ignores the contents, accept that it passes the
485*5113495bSYour Name 			programmed value on to other descriptors together with the
486*5113495bSYour Name 			physical address
487*5113495bSYour Name 
488*5113495bSYour Name 
489*5113495bSYour Name 
490*5113495bSYour Name 			Field can be used by SW to for example associate the
491*5113495bSYour Name 			buffers physical address with the virtual address
492*5113495bSYour Name 
493*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
494*5113495bSYour Name 			specification
495*5113495bSYour Name 
496*5113495bSYour Name 
497*5113495bSYour Name 
498*5113495bSYour Name 			NOTE:
499*5113495bSYour Name 
500*5113495bSYour Name 			The three most significant bits can have a special
501*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
502*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
503*5113495bSYour Name 
504*5113495bSYour Name 
505*5113495bSYour Name 
506*5113495bSYour Name 			In case of NON punctured transmission:
507*5113495bSYour Name 
508*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
509*5113495bSYour Name 
510*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
511*5113495bSYour Name 
512*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
513*5113495bSYour Name 
514*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
515*5113495bSYour Name 
516*5113495bSYour Name 
517*5113495bSYour Name 
518*5113495bSYour Name 			In case of punctured transmission:
519*5113495bSYour Name 
520*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
521*5113495bSYour Name 
522*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
523*5113495bSYour Name 
524*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
525*5113495bSYour Name 
526*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
527*5113495bSYour Name 
528*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
529*5113495bSYour Name 
530*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
531*5113495bSYour Name 
532*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
533*5113495bSYour Name 
534*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
535*5113495bSYour Name 
536*5113495bSYour Name 
537*5113495bSYour Name 
538*5113495bSYour Name 			Note: a punctured transmission is indicated by the
539*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
540*5113495bSYour Name 			TLV
541*5113495bSYour Name 
542*5113495bSYour Name 
543*5113495bSYour Name 
544*5113495bSYour Name 			<legal all>
545*5113495bSYour Name */
546*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
547*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB 11
548*5113495bSYour Name #define REO_DESTINATION_RING_1_BUF_OR_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff800
549*5113495bSYour Name 
550*5113495bSYour Name  /* EXTERNAL REFERENCE : struct rx_mpdu_desc_info rx_mpdu_desc_info_details */
551*5113495bSYour Name 
552*5113495bSYour Name 
553*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT
554*5113495bSYour Name 
555*5113495bSYour Name 			Consumer: REO/SW/FW
556*5113495bSYour Name 
557*5113495bSYour Name 			Producer: RXDMA
558*5113495bSYour Name 
559*5113495bSYour Name 
560*5113495bSYour Name 
561*5113495bSYour Name 			The number of MSDUs within the MPDU
562*5113495bSYour Name 
563*5113495bSYour Name 			<legal all>
564*5113495bSYour Name */
565*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_OFFSET 0x00000008
566*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_LSB 0
567*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MASK 0x000000ff
568*5113495bSYour Name 
569*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER
570*5113495bSYour Name 
571*5113495bSYour Name 			Consumer: REO/SW/FW
572*5113495bSYour Name 
573*5113495bSYour Name 			Producer: RXDMA
574*5113495bSYour Name 
575*5113495bSYour Name 
576*5113495bSYour Name 
577*5113495bSYour Name 			The field can have two different meanings based on the
578*5113495bSYour Name 			setting of field 'BAR_frame':
579*5113495bSYour Name 
580*5113495bSYour Name 
581*5113495bSYour Name 
582*5113495bSYour Name 			'BAR_frame' is NOT set:
583*5113495bSYour Name 
584*5113495bSYour Name 			The MPDU sequence number of the received frame.
585*5113495bSYour Name 
586*5113495bSYour Name 
587*5113495bSYour Name 
588*5113495bSYour Name 			'BAR_frame' is set.
589*5113495bSYour Name 
590*5113495bSYour Name 			The MPDU Start sequence number from the BAR frame
591*5113495bSYour Name 
592*5113495bSYour Name 			<legal all>
593*5113495bSYour Name */
594*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_OFFSET 0x00000008
595*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_LSB 8
596*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_MASK 0x000fff00
597*5113495bSYour Name 
598*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG
599*5113495bSYour Name 
600*5113495bSYour Name 			Consumer: REO/SW/FW
601*5113495bSYour Name 
602*5113495bSYour Name 			Producer: RXDMA
603*5113495bSYour Name 
604*5113495bSYour Name 
605*5113495bSYour Name 
606*5113495bSYour Name 			When set, this MPDU is a fragment and REO should forward
607*5113495bSYour Name 			this fragment MPDU to the REO destination ring without any
608*5113495bSYour Name 			reorder checks, pn checks or bitmap update. This implies
609*5113495bSYour Name 			that REO is forwarding the pointer to the MSDU link
610*5113495bSYour Name 			descriptor. The destination ring is coming from a
611*5113495bSYour Name 			programmable register setting in REO
612*5113495bSYour Name 
613*5113495bSYour Name 
614*5113495bSYour Name 
615*5113495bSYour Name 			<legal all>
616*5113495bSYour Name */
617*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_OFFSET 0x00000008
618*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_LSB 20
619*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MASK 0x00100000
620*5113495bSYour Name 
621*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT
622*5113495bSYour Name 
623*5113495bSYour Name 			Consumer: REO/SW/FW
624*5113495bSYour Name 
625*5113495bSYour Name 			Producer: RXDMA
626*5113495bSYour Name 
627*5113495bSYour Name 
628*5113495bSYour Name 
629*5113495bSYour Name 			The retry bit setting from the MPDU header of the
630*5113495bSYour Name 			received frame
631*5113495bSYour Name 
632*5113495bSYour Name 			<legal all>
633*5113495bSYour Name */
634*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_OFFSET 0x00000008
635*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_LSB 21
636*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MASK 0x00200000
637*5113495bSYour Name 
638*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG
639*5113495bSYour Name 
640*5113495bSYour Name 			Consumer: REO/SW/FW
641*5113495bSYour Name 
642*5113495bSYour Name 			Producer: RXDMA
643*5113495bSYour Name 
644*5113495bSYour Name 
645*5113495bSYour Name 
646*5113495bSYour Name 			When set, the MPDU was received as part of an A-MPDU.
647*5113495bSYour Name 
648*5113495bSYour Name 			<legal all>
649*5113495bSYour Name */
650*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_OFFSET 0x00000008
651*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_LSB 22
652*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MASK 0x00400000
653*5113495bSYour Name 
654*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME
655*5113495bSYour Name 
656*5113495bSYour Name 			Consumer: REO/SW/FW
657*5113495bSYour Name 
658*5113495bSYour Name 			Producer: RXDMA
659*5113495bSYour Name 
660*5113495bSYour Name 
661*5113495bSYour Name 
662*5113495bSYour Name 			When set, the received frame is a BAR frame. After
663*5113495bSYour Name 			processing, this frame shall be pushed to SW or deleted.
664*5113495bSYour Name 
665*5113495bSYour Name 			<legal all>
666*5113495bSYour Name */
667*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_OFFSET 0x00000008
668*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_LSB 23
669*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MASK 0x00800000
670*5113495bSYour Name 
671*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO
672*5113495bSYour Name 
673*5113495bSYour Name 			Consumer: REO/SW/FW
674*5113495bSYour Name 
675*5113495bSYour Name 			Producer: RXDMA
676*5113495bSYour Name 
677*5113495bSYour Name 
678*5113495bSYour Name 
679*5113495bSYour Name 			Copied here by RXDMA from RX_MPDU_END
680*5113495bSYour Name 
681*5113495bSYour Name 			When not set, REO will Not perform a PN sequence number
682*5113495bSYour Name 			check
683*5113495bSYour Name */
684*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET 0x00000008
685*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_LSB 24
686*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MASK 0x01000000
687*5113495bSYour Name 
688*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID
689*5113495bSYour Name 
690*5113495bSYour Name 			When set, OLE found a valid SA entry for all MSDUs in
691*5113495bSYour Name 			this MPDU
692*5113495bSYour Name 
693*5113495bSYour Name 			<legal all>
694*5113495bSYour Name */
695*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_OFFSET 0x00000008
696*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_LSB 25
697*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_MASK 0x02000000
698*5113495bSYour Name 
699*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT
700*5113495bSYour Name 
701*5113495bSYour Name 			When set, at least 1 MSDU within the MPDU has an
702*5113495bSYour Name 			unsuccessful MAC source address search due to the expiration
703*5113495bSYour Name 			of the search timer.
704*5113495bSYour Name 
705*5113495bSYour Name 			<legal all>
706*5113495bSYour Name */
707*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_OFFSET 0x00000008
708*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_LSB 26
709*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_MASK 0x04000000
710*5113495bSYour Name 
711*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID
712*5113495bSYour Name 
713*5113495bSYour Name 			When set, OLE found a valid DA entry for all MSDUs in
714*5113495bSYour Name 			this MPDU
715*5113495bSYour Name 
716*5113495bSYour Name 			<legal all>
717*5113495bSYour Name */
718*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_OFFSET 0x00000008
719*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_LSB 27
720*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_MASK 0x08000000
721*5113495bSYour Name 
722*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC
723*5113495bSYour Name 
724*5113495bSYour Name 			Field Only valid if da_is_valid is set
725*5113495bSYour Name 
726*5113495bSYour Name 
727*5113495bSYour Name 
728*5113495bSYour Name 			When set, at least one of the DA addresses is a
729*5113495bSYour Name 			Multicast or Broadcast address.
730*5113495bSYour Name 
731*5113495bSYour Name 			<legal all>
732*5113495bSYour Name */
733*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_OFFSET 0x00000008
734*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_LSB 28
735*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_MASK 0x10000000
736*5113495bSYour Name 
737*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT
738*5113495bSYour Name 
739*5113495bSYour Name 			When set, at least 1 MSDU within the MPDU has an
740*5113495bSYour Name 			unsuccessful MAC destination address search due to the
741*5113495bSYour Name 			expiration of the search timer.
742*5113495bSYour Name 
743*5113495bSYour Name 			<legal all>
744*5113495bSYour Name */
745*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_OFFSET 0x00000008
746*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_LSB 29
747*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_MASK 0x20000000
748*5113495bSYour Name 
749*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU
750*5113495bSYour Name 
751*5113495bSYour Name 			Field only valid when first_msdu_in_mpdu_flag is set.
752*5113495bSYour Name 
753*5113495bSYour Name 
754*5113495bSYour Name 
755*5113495bSYour Name 			When set, the contents in the MSDU buffer contains a
756*5113495bSYour Name 			'RAW' MPDU. This 'RAW' MPDU might be spread out over
757*5113495bSYour Name 			multiple MSDU buffers.
758*5113495bSYour Name 
759*5113495bSYour Name 			<legal all>
760*5113495bSYour Name */
761*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_OFFSET 0x00000008
762*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_LSB 30
763*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MASK 0x40000000
764*5113495bSYour Name 
765*5113495bSYour Name /* Description		REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG
766*5113495bSYour Name 
767*5113495bSYour Name 			The More Fragment bit setting from the MPDU header of
768*5113495bSYour Name 			the received frame
769*5113495bSYour Name 
770*5113495bSYour Name 
771*5113495bSYour Name 
772*5113495bSYour Name 			<legal all>
773*5113495bSYour Name */
774*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_OFFSET 0x00000008
775*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_LSB 31
776*5113495bSYour Name #define REO_DESTINATION_RING_2_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MASK 0x80000000
777*5113495bSYour Name 
778*5113495bSYour Name /* Description		REO_DESTINATION_RING_3_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA
779*5113495bSYour Name 
780*5113495bSYour Name 			Meta data that SW has programmed in the Peer table entry
781*5113495bSYour Name 			of the transmitting STA.
782*5113495bSYour Name 
783*5113495bSYour Name 			<legal all>
784*5113495bSYour Name */
785*5113495bSYour Name #define REO_DESTINATION_RING_3_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_OFFSET 0x0000000c
786*5113495bSYour Name #define REO_DESTINATION_RING_3_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_LSB 0
787*5113495bSYour Name #define REO_DESTINATION_RING_3_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MASK 0xffffffff
788*5113495bSYour Name 
789*5113495bSYour Name  /* EXTERNAL REFERENCE : struct rx_msdu_desc_info rx_msdu_desc_info_details */
790*5113495bSYour Name 
791*5113495bSYour Name 
792*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG
793*5113495bSYour Name 
794*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
795*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
796*5113495bSYour Name 			buffer used by the MSDU
797*5113495bSYour Name 
798*5113495bSYour Name 
799*5113495bSYour Name 
800*5113495bSYour Name 			<enum 0 Not_first_msdu> This is not the first MSDU in
801*5113495bSYour Name 			the MPDU.
802*5113495bSYour Name 
803*5113495bSYour Name 			<enum 1 first_msdu> This MSDU is the first one in the
804*5113495bSYour Name 			MPDU.
805*5113495bSYour Name 
806*5113495bSYour Name 
807*5113495bSYour Name 
808*5113495bSYour Name 			<legal all>
809*5113495bSYour Name */
810*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000010
811*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_LSB 0
812*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_MASK 0x00000001
813*5113495bSYour Name 
814*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG
815*5113495bSYour Name 
816*5113495bSYour Name 			Consumer: WBM/REO/SW/FW
817*5113495bSYour Name 
818*5113495bSYour Name 			Producer: RXDMA
819*5113495bSYour Name 
820*5113495bSYour Name 
821*5113495bSYour Name 
822*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
823*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
824*5113495bSYour Name 			buffer used by the MSDU
825*5113495bSYour Name 
826*5113495bSYour Name 
827*5113495bSYour Name 
828*5113495bSYour Name 			<enum 0 Not_last_msdu> There are more MSDUs linked to
829*5113495bSYour Name 			this MSDU that belongs to this MPDU
830*5113495bSYour Name 
831*5113495bSYour Name 			<enum 1 Last_msdu> this MSDU is the last one in the
832*5113495bSYour Name 			MPDU. This setting is only allowed in combination with
833*5113495bSYour Name 			'Msdu_continuation' set to 0. This implies that when an msdu
834*5113495bSYour Name 			is spread out over multiple buffers and thus
835*5113495bSYour Name 			msdu_continuation is set, only for the very last buffer of
836*5113495bSYour Name 			the msdu, can the 'last_msdu_in_mpdu_flag' be set.
837*5113495bSYour Name 
838*5113495bSYour Name 
839*5113495bSYour Name 
840*5113495bSYour Name 			When both first_msdu_in_mpdu_flag and
841*5113495bSYour Name 			last_msdu_in_mpdu_flag are set, the MPDU that this MSDU
842*5113495bSYour Name 			belongs to only contains a single MSDU.
843*5113495bSYour Name 
844*5113495bSYour Name 
845*5113495bSYour Name 
846*5113495bSYour Name 
847*5113495bSYour Name 
848*5113495bSYour Name 			<legal all>
849*5113495bSYour Name */
850*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000010
851*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_LSB 1
852*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_MASK 0x00000002
853*5113495bSYour Name 
854*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION
855*5113495bSYour Name 
856*5113495bSYour Name 			When set, this MSDU buffer was not able to hold the
857*5113495bSYour Name 			entire MSDU. The next buffer will therefor contain
858*5113495bSYour Name 			additional information related to this MSDU.
859*5113495bSYour Name 
860*5113495bSYour Name 
861*5113495bSYour Name 
862*5113495bSYour Name 			<legal all>
863*5113495bSYour Name */
864*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_OFFSET 0x00000010
865*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_LSB 2
866*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_MASK 0x00000004
867*5113495bSYour Name 
868*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH
869*5113495bSYour Name 
870*5113495bSYour Name 			Parsed from RX_MSDU_START TLV . In the case MSDU spans
871*5113495bSYour Name 			over multiple buffers, this field will be valid in the First
872*5113495bSYour Name 			buffer used by MSDU.
873*5113495bSYour Name 
874*5113495bSYour Name 
875*5113495bSYour Name 
876*5113495bSYour Name 			Full MSDU length in bytes after decapsulation.
877*5113495bSYour Name 
878*5113495bSYour Name 
879*5113495bSYour Name 
880*5113495bSYour Name 			This field is still valid for MPDU frames without
881*5113495bSYour Name 			A-MSDU.  It still represents MSDU length after decapsulation
882*5113495bSYour Name 
883*5113495bSYour Name 
884*5113495bSYour Name 
885*5113495bSYour Name 			Or in case of RAW MPDUs, it indicates the length of the
886*5113495bSYour Name 			entire MPDU (without FCS field)
887*5113495bSYour Name 
888*5113495bSYour Name 			<legal all>
889*5113495bSYour Name */
890*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_OFFSET 0x00000010
891*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_LSB 3
892*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_MASK 0x0001fff8
893*5113495bSYour Name 
894*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_REO_DESTINATION_INDICATION
895*5113495bSYour Name 
896*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
897*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
898*5113495bSYour Name 			buffer used by the MSDU
899*5113495bSYour Name 
900*5113495bSYour Name 
901*5113495bSYour Name 
902*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
903*5113495bSYour Name 			push after (MPDU level) reordering has finished.
904*5113495bSYour Name 
905*5113495bSYour Name 
906*5113495bSYour Name 
907*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
908*5113495bSYour Name 			into the REO2TCL ring
909*5113495bSYour Name 
910*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
911*5113495bSYour Name 			into the REO2SW1 ring
912*5113495bSYour Name 
913*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
914*5113495bSYour Name 			into the REO2SW1 ring
915*5113495bSYour Name 
916*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
917*5113495bSYour Name 			into the REO2SW1 ring
918*5113495bSYour Name 
919*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
920*5113495bSYour Name 			into the REO2SW1 ring
921*5113495bSYour Name 
922*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
923*5113495bSYour Name 			into the REO_release ring
924*5113495bSYour Name 
925*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
926*5113495bSYour Name 			the REO2FW ring
927*5113495bSYour Name 
928*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
929*5113495bSYour Name 
930*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
931*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
932*5113495bSYour Name 			reo_destination_10> REO remaps this
933*5113495bSYour Name 
934*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
935*5113495bSYour Name 
936*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
937*5113495bSYour Name 			reo_destination_13> REO remaps this
938*5113495bSYour Name 
939*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
940*5113495bSYour Name 
941*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
942*5113495bSYour Name 
943*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
944*5113495bSYour Name 
945*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
946*5113495bSYour Name 
947*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
948*5113495bSYour Name 
949*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
950*5113495bSYour Name 
951*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
952*5113495bSYour Name 
953*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
954*5113495bSYour Name 
955*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
956*5113495bSYour Name 
957*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
958*5113495bSYour Name 
959*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
960*5113495bSYour Name 
961*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
962*5113495bSYour Name 
963*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
964*5113495bSYour Name 
965*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
966*5113495bSYour Name 
967*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
968*5113495bSYour Name 
969*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
970*5113495bSYour Name 
971*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
972*5113495bSYour Name 
973*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
974*5113495bSYour Name 
975*5113495bSYour Name 
976*5113495bSYour Name 
977*5113495bSYour Name 			<legal all>
978*5113495bSYour Name */
979*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_REO_DESTINATION_INDICATION_OFFSET 0x00000010
980*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_REO_DESTINATION_INDICATION_LSB 17
981*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_REO_DESTINATION_INDICATION_MASK 0x003e0000
982*5113495bSYour Name 
983*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP
984*5113495bSYour Name 
985*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
986*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
987*5113495bSYour Name 			buffer used by the MSDU
988*5113495bSYour Name 
989*5113495bSYour Name 
990*5113495bSYour Name 
991*5113495bSYour Name 			When set, REO shall drop this MSDU and not forward it to
992*5113495bSYour Name 			any other ring...
993*5113495bSYour Name 
994*5113495bSYour Name 			<legal all>
995*5113495bSYour Name */
996*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_OFFSET 0x00000010
997*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_LSB 22
998*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_MASK 0x00400000
999*5113495bSYour Name 
1000*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID
1001*5113495bSYour Name 
1002*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
1003*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
1004*5113495bSYour Name 			buffer used by the MSDU
1005*5113495bSYour Name 
1006*5113495bSYour Name 
1007*5113495bSYour Name 
1008*5113495bSYour Name 			Indicates that OLE found a valid SA entry for this MSDU
1009*5113495bSYour Name 
1010*5113495bSYour Name 			<legal all>
1011*5113495bSYour Name */
1012*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_OFFSET 0x00000010
1013*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_LSB 23
1014*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_MASK 0x00800000
1015*5113495bSYour Name 
1016*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT
1017*5113495bSYour Name 
1018*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
1019*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
1020*5113495bSYour Name 			buffer used by the MSDU
1021*5113495bSYour Name 
1022*5113495bSYour Name 
1023*5113495bSYour Name 
1024*5113495bSYour Name 			Indicates an unsuccessful MAC source address search due
1025*5113495bSYour Name 			to the expiring of the search timer for this MSDU
1026*5113495bSYour Name 
1027*5113495bSYour Name 			<legal all>
1028*5113495bSYour Name */
1029*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_OFFSET 0x00000010
1030*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_LSB 24
1031*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_MASK 0x01000000
1032*5113495bSYour Name 
1033*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID
1034*5113495bSYour Name 
1035*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
1036*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
1037*5113495bSYour Name 			buffer used by the MSDU
1038*5113495bSYour Name 
1039*5113495bSYour Name 
1040*5113495bSYour Name 
1041*5113495bSYour Name 			Indicates that OLE found a valid DA entry for this MSDU
1042*5113495bSYour Name 
1043*5113495bSYour Name 			<legal all>
1044*5113495bSYour Name */
1045*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_OFFSET 0x00000010
1046*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_LSB 25
1047*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_MASK 0x02000000
1048*5113495bSYour Name 
1049*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC
1050*5113495bSYour Name 
1051*5113495bSYour Name 			Field Only valid if da_is_valid is set
1052*5113495bSYour Name 
1053*5113495bSYour Name 
1054*5113495bSYour Name 
1055*5113495bSYour Name 			Indicates the DA address was a Multicast of Broadcast
1056*5113495bSYour Name 			address for this MSDU
1057*5113495bSYour Name 
1058*5113495bSYour Name 			<legal all>
1059*5113495bSYour Name */
1060*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_OFFSET 0x00000010
1061*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_LSB 26
1062*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_MASK 0x04000000
1063*5113495bSYour Name 
1064*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT
1065*5113495bSYour Name 
1066*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans
1067*5113495bSYour Name 			over multiple buffers, this field will be valid in the Last
1068*5113495bSYour Name 			buffer used by the MSDU
1069*5113495bSYour Name 
1070*5113495bSYour Name 
1071*5113495bSYour Name 
1072*5113495bSYour Name 			Indicates an unsuccessful MAC destination address search
1073*5113495bSYour Name 			due to the expiring of the search timer for this MSDU
1074*5113495bSYour Name 
1075*5113495bSYour Name 			<legal all>
1076*5113495bSYour Name */
1077*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_OFFSET 0x00000010
1078*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_LSB 27
1079*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_MASK 0x08000000
1080*5113495bSYour Name 
1081*5113495bSYour Name /* Description		REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_RESERVED_0A
1082*5113495bSYour Name 
1083*5113495bSYour Name 			<legal 0>
1084*5113495bSYour Name */
1085*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_RESERVED_0A_OFFSET 0x00000010
1086*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_RESERVED_0A_LSB 28
1087*5113495bSYour Name #define REO_DESTINATION_RING_4_RX_MSDU_DESC_INFO_DETAILS_RESERVED_0A_MASK 0xf0000000
1088*5113495bSYour Name 
1089*5113495bSYour Name /* Description		REO_DESTINATION_RING_5_RX_MSDU_DESC_INFO_DETAILS_RESERVED_1A
1090*5113495bSYour Name 
1091*5113495bSYour Name 			<legal 0>
1092*5113495bSYour Name */
1093*5113495bSYour Name #define REO_DESTINATION_RING_5_RX_MSDU_DESC_INFO_DETAILS_RESERVED_1A_OFFSET 0x00000014
1094*5113495bSYour Name #define REO_DESTINATION_RING_5_RX_MSDU_DESC_INFO_DETAILS_RESERVED_1A_LSB 0
1095*5113495bSYour Name #define REO_DESTINATION_RING_5_RX_MSDU_DESC_INFO_DETAILS_RESERVED_1A_MASK 0xffffffff
1096*5113495bSYour Name 
1097*5113495bSYour Name /* Description		REO_DESTINATION_RING_6_RX_REO_QUEUE_DESC_ADDR_31_0
1098*5113495bSYour Name 
1099*5113495bSYour Name 			Consumer: REO
1100*5113495bSYour Name 
1101*5113495bSYour Name 			Producer: RXDMA
1102*5113495bSYour Name 
1103*5113495bSYour Name 
1104*5113495bSYour Name 
1105*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor.
1106*5113495bSYour Name 
1107*5113495bSYour Name 			<legal all>
1108*5113495bSYour Name */
1109*5113495bSYour Name #define REO_DESTINATION_RING_6_RX_REO_QUEUE_DESC_ADDR_31_0_OFFSET    0x00000018
1110*5113495bSYour Name #define REO_DESTINATION_RING_6_RX_REO_QUEUE_DESC_ADDR_31_0_LSB       0
1111*5113495bSYour Name #define REO_DESTINATION_RING_6_RX_REO_QUEUE_DESC_ADDR_31_0_MASK      0xffffffff
1112*5113495bSYour Name 
1113*5113495bSYour Name /* Description		REO_DESTINATION_RING_7_RX_REO_QUEUE_DESC_ADDR_39_32
1114*5113495bSYour Name 
1115*5113495bSYour Name 			Consumer: REO
1116*5113495bSYour Name 
1117*5113495bSYour Name 			Producer: RXDMA
1118*5113495bSYour Name 
1119*5113495bSYour Name 
1120*5113495bSYour Name 
1121*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor.
1122*5113495bSYour Name 
1123*5113495bSYour Name 			<legal all>
1124*5113495bSYour Name */
1125*5113495bSYour Name #define REO_DESTINATION_RING_7_RX_REO_QUEUE_DESC_ADDR_39_32_OFFSET   0x0000001c
1126*5113495bSYour Name #define REO_DESTINATION_RING_7_RX_REO_QUEUE_DESC_ADDR_39_32_LSB      0
1127*5113495bSYour Name #define REO_DESTINATION_RING_7_RX_REO_QUEUE_DESC_ADDR_39_32_MASK     0x000000ff
1128*5113495bSYour Name 
1129*5113495bSYour Name /* Description		REO_DESTINATION_RING_7_REO_DEST_BUFFER_TYPE
1130*5113495bSYour Name 
1131*5113495bSYour Name 			Indicates the type of address provided in the
1132*5113495bSYour Name 			'Buf_or_link_desc_addr_info'
1133*5113495bSYour Name 
1134*5113495bSYour Name 
1135*5113495bSYour Name 
1136*5113495bSYour Name 			<enum 0 MSDU_buf_address> The address of an MSDU buffer
1137*5113495bSYour Name 
1138*5113495bSYour Name 			<enum 1 MSDU_link_desc_address> The address of the MSDU
1139*5113495bSYour Name 			link descriptor.
1140*5113495bSYour Name 
1141*5113495bSYour Name 
1142*5113495bSYour Name 
1143*5113495bSYour Name 			<legal all>
1144*5113495bSYour Name */
1145*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_DEST_BUFFER_TYPE_OFFSET           0x0000001c
1146*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_DEST_BUFFER_TYPE_LSB              8
1147*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_DEST_BUFFER_TYPE_MASK             0x00000100
1148*5113495bSYour Name 
1149*5113495bSYour Name /* Description		REO_DESTINATION_RING_7_REO_PUSH_REASON
1150*5113495bSYour Name 
1151*5113495bSYour Name 			Indicates why REO pushed the frame to this exit ring
1152*5113495bSYour Name 
1153*5113495bSYour Name 
1154*5113495bSYour Name 
1155*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an
1156*5113495bSYour Name 			pushed this frame to this queue
1157*5113495bSYour Name 
1158*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
1159*5113495bSYour Name 			this queue per received routing instructions. No error
1160*5113495bSYour Name 			within REO was detected
1161*5113495bSYour Name 
1162*5113495bSYour Name 
1163*5113495bSYour Name 
1164*5113495bSYour Name 
1165*5113495bSYour Name 
1166*5113495bSYour Name 			<legal 0 - 1>
1167*5113495bSYour Name */
1168*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_PUSH_REASON_OFFSET                0x0000001c
1169*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_PUSH_REASON_LSB                   9
1170*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_PUSH_REASON_MASK                  0x00000600
1171*5113495bSYour Name 
1172*5113495bSYour Name /* Description		REO_DESTINATION_RING_7_REO_ERROR_CODE
1173*5113495bSYour Name 
1174*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to
1175*5113495bSYour Name 			'reo_error_detected'.
1176*5113495bSYour Name 
1177*5113495bSYour Name 
1178*5113495bSYour Name 
1179*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor
1180*5113495bSYour Name 			provided in the REO_ENTRANCE ring is set to 0
1181*5113495bSYour Name 
1182*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor
1183*5113495bSYour Name 			valid bit is NOT set
1184*5113495bSYour Name 
1185*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
1186*5113495bSYour Name 			session having been setup.
1187*5113495bSYour Name 
1188*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to
1189*5113495bSYour Name 			SSN, Retry bit set: duplicate frame
1190*5113495bSYour Name 
1191*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
1192*5113495bSYour Name 
1193*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
1194*5113495bSYour Name 			frame) received with 2K jump in SN
1195*5113495bSYour Name 
1196*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump
1197*5113495bSYour Name 			in SSN
1198*5113495bSYour Name 
1199*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data
1200*5113495bSYour Name 			frame) received with SN falling within the OOR window
1201*5113495bSYour Name 
1202*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling
1203*5113495bSYour Name 			within the OOR window
1204*5113495bSYour Name 
1205*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
1206*5113495bSYour Name 			a BA session
1207*5113495bSYour Name 
1208*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with
1209*5113495bSYour Name 			SSN equal to SN
1210*5113495bSYour Name 
1211*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
1212*5113495bSYour Name 
1213*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
1214*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set in
1215*5113495bSYour Name 			the REO Queue descriptor
1216*5113495bSYour Name 
1217*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
1218*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in the
1219*5113495bSYour Name 			REO Queue descriptor
1220*5113495bSYour Name 
1221*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is
1222*5113495bSYour Name 			forwarded as a result of the queue descriptor(address) being
1223*5113495bSYour Name 			blocked as SW/FW seems to be currently in the process of
1224*5113495bSYour Name 			making updates to this descriptor...
1225*5113495bSYour Name 
1226*5113495bSYour Name 
1227*5113495bSYour Name 
1228*5113495bSYour Name 			<legal 0-14>
1229*5113495bSYour Name */
1230*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_ERROR_CODE_OFFSET                 0x0000001c
1231*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_ERROR_CODE_LSB                    11
1232*5113495bSYour Name #define REO_DESTINATION_RING_7_REO_ERROR_CODE_MASK                   0x0000f800
1233*5113495bSYour Name 
1234*5113495bSYour Name /* Description		REO_DESTINATION_RING_7_RECEIVE_QUEUE_NUMBER
1235*5113495bSYour Name 
1236*5113495bSYour Name 			This field indicates the REO MPDU reorder queue ID from
1237*5113495bSYour Name 			which this frame originated. This field is populated from a
1238*5113495bSYour Name 			field with the same name in the RX_REO_QUEUE descriptor.
1239*5113495bSYour Name 
1240*5113495bSYour Name 			<legal all>
1241*5113495bSYour Name */
1242*5113495bSYour Name #define REO_DESTINATION_RING_7_RECEIVE_QUEUE_NUMBER_OFFSET           0x0000001c
1243*5113495bSYour Name #define REO_DESTINATION_RING_7_RECEIVE_QUEUE_NUMBER_LSB              16
1244*5113495bSYour Name #define REO_DESTINATION_RING_7_RECEIVE_QUEUE_NUMBER_MASK             0xffff0000
1245*5113495bSYour Name 
1246*5113495bSYour Name /* Description		REO_DESTINATION_RING_8_SOFT_REORDER_INFO_VALID
1247*5113495bSYour Name 
1248*5113495bSYour Name 			When set, REO has been instructed to not perform the
1249*5113495bSYour Name 			actual re-ordering of frames for this queue, but just to
1250*5113495bSYour Name 			insert the reorder opcodes
1251*5113495bSYour Name 
1252*5113495bSYour Name 			<legal all>
1253*5113495bSYour Name */
1254*5113495bSYour Name #define REO_DESTINATION_RING_8_SOFT_REORDER_INFO_VALID_OFFSET        0x00000020
1255*5113495bSYour Name #define REO_DESTINATION_RING_8_SOFT_REORDER_INFO_VALID_LSB           0
1256*5113495bSYour Name #define REO_DESTINATION_RING_8_SOFT_REORDER_INFO_VALID_MASK          0x00000001
1257*5113495bSYour Name 
1258*5113495bSYour Name /* Description		REO_DESTINATION_RING_8_REORDER_OPCODE
1259*5113495bSYour Name 
1260*5113495bSYour Name 			Field is valid when 'Soft_reorder_info_valid' is set.
1261*5113495bSYour Name 			This field is always valid for debug purpose as well.
1262*5113495bSYour Name 
1263*5113495bSYour Name 			Details are in the MLD.
1264*5113495bSYour Name 
1265*5113495bSYour Name 
1266*5113495bSYour Name 
1267*5113495bSYour Name 			<enum 0 invalid>
1268*5113495bSYour Name 
1269*5113495bSYour Name 			<enum 1 fwdcur_fwdbuf>
1270*5113495bSYour Name 
1271*5113495bSYour Name 			<enum 2 fwdbuf_fwdcur>
1272*5113495bSYour Name 
1273*5113495bSYour Name 			<enum 3 qcur>
1274*5113495bSYour Name 
1275*5113495bSYour Name 			<enum 4 fwdbuf_qcur>
1276*5113495bSYour Name 
1277*5113495bSYour Name 			<enum 5 fwdbuf_drop>
1278*5113495bSYour Name 
1279*5113495bSYour Name 			<enum 6 fwdall_drop>
1280*5113495bSYour Name 
1281*5113495bSYour Name 			<enum 7 fwdall_qcur>
1282*5113495bSYour Name 
1283*5113495bSYour Name 			<enum 8 reserved_reo_opcode_1>
1284*5113495bSYour Name 
1285*5113495bSYour Name 			<enum 9 dropcur>  the error reason code is in
1286*5113495bSYour Name 			reo_error_code field.
1287*5113495bSYour Name 
1288*5113495bSYour Name 			<enum 10 reserved_reo_opcode_2>
1289*5113495bSYour Name 
1290*5113495bSYour Name 			<enum 11 reserved_reo_opcode_3>
1291*5113495bSYour Name 
1292*5113495bSYour Name 			<enum 12 reserved_reo_opcode_4>
1293*5113495bSYour Name 
1294*5113495bSYour Name 			<enum 13 reserved_reo_opcode_5>
1295*5113495bSYour Name 
1296*5113495bSYour Name 			<enum 14 reserved_reo_opcode_6>
1297*5113495bSYour Name 
1298*5113495bSYour Name 			<enum 15 reserved_reo_opcode_7>
1299*5113495bSYour Name 
1300*5113495bSYour Name 
1301*5113495bSYour Name 
1302*5113495bSYour Name 			<legal all>
1303*5113495bSYour Name */
1304*5113495bSYour Name #define REO_DESTINATION_RING_8_REORDER_OPCODE_OFFSET                 0x00000020
1305*5113495bSYour Name #define REO_DESTINATION_RING_8_REORDER_OPCODE_LSB                    1
1306*5113495bSYour Name #define REO_DESTINATION_RING_8_REORDER_OPCODE_MASK                   0x0000001e
1307*5113495bSYour Name 
1308*5113495bSYour Name /* Description		REO_DESTINATION_RING_8_REORDER_SLOT_INDEX
1309*5113495bSYour Name 
1310*5113495bSYour Name 			Field only valid when 'Soft_reorder_info_valid' is set.
1311*5113495bSYour Name 
1312*5113495bSYour Name 
1313*5113495bSYour Name 
1314*5113495bSYour Name 			TODO: add description
1315*5113495bSYour Name 
1316*5113495bSYour Name 
1317*5113495bSYour Name 
1318*5113495bSYour Name 			<legal all>
1319*5113495bSYour Name */
1320*5113495bSYour Name #define REO_DESTINATION_RING_8_REORDER_SLOT_INDEX_OFFSET             0x00000020
1321*5113495bSYour Name #define REO_DESTINATION_RING_8_REORDER_SLOT_INDEX_LSB                5
1322*5113495bSYour Name #define REO_DESTINATION_RING_8_REORDER_SLOT_INDEX_MASK               0x00001fe0
1323*5113495bSYour Name 
1324*5113495bSYour Name /* Description		REO_DESTINATION_RING_8_MPDU_FRAGMENT_NUMBER
1325*5113495bSYour Name 
1326*5113495bSYour Name 			Field only valid when Rx_mpdu_desc_info_details.
1327*5113495bSYour Name 
1328*5113495bSYour Name 			Fragment_flag  is set.
1329*5113495bSYour Name 
1330*5113495bSYour Name 
1331*5113495bSYour Name 
1332*5113495bSYour Name 			The fragment number from the 802.11 header.
1333*5113495bSYour Name 
1334*5113495bSYour Name 
1335*5113495bSYour Name 
1336*5113495bSYour Name 			Note that the sequence number is embedded in field:
1337*5113495bSYour Name 			Rx_mpdu_desc_info_details.
1338*5113495bSYour Name 
1339*5113495bSYour Name 			Mpdu_Sequence_number
1340*5113495bSYour Name 
1341*5113495bSYour Name 			<legal all>
1342*5113495bSYour Name */
1343*5113495bSYour Name #define REO_DESTINATION_RING_8_MPDU_FRAGMENT_NUMBER_OFFSET           0x00000020
1344*5113495bSYour Name #define REO_DESTINATION_RING_8_MPDU_FRAGMENT_NUMBER_LSB              13
1345*5113495bSYour Name #define REO_DESTINATION_RING_8_MPDU_FRAGMENT_NUMBER_MASK             0x0001e000
1346*5113495bSYour Name 
1347*5113495bSYour Name /* Description		REO_DESTINATION_RING_8_RESERVED_8A
1348*5113495bSYour Name 
1349*5113495bSYour Name 			<legal 0>
1350*5113495bSYour Name */
1351*5113495bSYour Name #define REO_DESTINATION_RING_8_RESERVED_8A_OFFSET                    0x00000020
1352*5113495bSYour Name #define REO_DESTINATION_RING_8_RESERVED_8A_LSB                       17
1353*5113495bSYour Name #define REO_DESTINATION_RING_8_RESERVED_8A_MASK                      0xfffe0000
1354*5113495bSYour Name 
1355*5113495bSYour Name /* Description		REO_DESTINATION_RING_9_RESERVED_9A
1356*5113495bSYour Name 
1357*5113495bSYour Name 			<legal 0>
1358*5113495bSYour Name */
1359*5113495bSYour Name #define REO_DESTINATION_RING_9_RESERVED_9A_OFFSET                    0x00000024
1360*5113495bSYour Name #define REO_DESTINATION_RING_9_RESERVED_9A_LSB                       0
1361*5113495bSYour Name #define REO_DESTINATION_RING_9_RESERVED_9A_MASK                      0xffffffff
1362*5113495bSYour Name 
1363*5113495bSYour Name /* Description		REO_DESTINATION_RING_10_RESERVED_10A
1364*5113495bSYour Name 
1365*5113495bSYour Name 			<legal 0>
1366*5113495bSYour Name */
1367*5113495bSYour Name #define REO_DESTINATION_RING_10_RESERVED_10A_OFFSET                  0x00000028
1368*5113495bSYour Name #define REO_DESTINATION_RING_10_RESERVED_10A_LSB                     0
1369*5113495bSYour Name #define REO_DESTINATION_RING_10_RESERVED_10A_MASK                    0xffffffff
1370*5113495bSYour Name 
1371*5113495bSYour Name /* Description		REO_DESTINATION_RING_11_RESERVED_11A
1372*5113495bSYour Name 
1373*5113495bSYour Name 			<legal 0>
1374*5113495bSYour Name */
1375*5113495bSYour Name #define REO_DESTINATION_RING_11_RESERVED_11A_OFFSET                  0x0000002c
1376*5113495bSYour Name #define REO_DESTINATION_RING_11_RESERVED_11A_LSB                     0
1377*5113495bSYour Name #define REO_DESTINATION_RING_11_RESERVED_11A_MASK                    0xffffffff
1378*5113495bSYour Name 
1379*5113495bSYour Name /* Description		REO_DESTINATION_RING_12_RESERVED_12A
1380*5113495bSYour Name 
1381*5113495bSYour Name 			<legal 0>
1382*5113495bSYour Name */
1383*5113495bSYour Name #define REO_DESTINATION_RING_12_RESERVED_12A_OFFSET                  0x00000030
1384*5113495bSYour Name #define REO_DESTINATION_RING_12_RESERVED_12A_LSB                     0
1385*5113495bSYour Name #define REO_DESTINATION_RING_12_RESERVED_12A_MASK                    0xffffffff
1386*5113495bSYour Name 
1387*5113495bSYour Name /* Description		REO_DESTINATION_RING_13_RESERVED_13A
1388*5113495bSYour Name 
1389*5113495bSYour Name 			<legal 0>
1390*5113495bSYour Name */
1391*5113495bSYour Name #define REO_DESTINATION_RING_13_RESERVED_13A_OFFSET                  0x00000034
1392*5113495bSYour Name #define REO_DESTINATION_RING_13_RESERVED_13A_LSB                     0
1393*5113495bSYour Name #define REO_DESTINATION_RING_13_RESERVED_13A_MASK                    0xffffffff
1394*5113495bSYour Name 
1395*5113495bSYour Name /* Description		REO_DESTINATION_RING_14_RESERVED_14A
1396*5113495bSYour Name 
1397*5113495bSYour Name 			<legal 0>
1398*5113495bSYour Name */
1399*5113495bSYour Name #define REO_DESTINATION_RING_14_RESERVED_14A_OFFSET                  0x00000038
1400*5113495bSYour Name #define REO_DESTINATION_RING_14_RESERVED_14A_LSB                     0
1401*5113495bSYour Name #define REO_DESTINATION_RING_14_RESERVED_14A_MASK                    0xffffffff
1402*5113495bSYour Name 
1403*5113495bSYour Name /* Description		REO_DESTINATION_RING_15_RESERVED_15
1404*5113495bSYour Name 
1405*5113495bSYour Name 			<legal 0>
1406*5113495bSYour Name */
1407*5113495bSYour Name #define REO_DESTINATION_RING_15_RESERVED_15_OFFSET                   0x0000003c
1408*5113495bSYour Name #define REO_DESTINATION_RING_15_RESERVED_15_LSB                      0
1409*5113495bSYour Name #define REO_DESTINATION_RING_15_RESERVED_15_MASK                     0x000fffff
1410*5113495bSYour Name 
1411*5113495bSYour Name /* Description		REO_DESTINATION_RING_15_RING_ID
1412*5113495bSYour Name 
1413*5113495bSYour Name 			The buffer pointer ring ID.
1414*5113495bSYour Name 
1415*5113495bSYour Name 			0 refers to the IDLE ring
1416*5113495bSYour Name 
1417*5113495bSYour Name 			1 - N refers to other rings
1418*5113495bSYour Name 
1419*5113495bSYour Name 
1420*5113495bSYour Name 
1421*5113495bSYour Name 			Helps with debugging when dumping ring contents.
1422*5113495bSYour Name 
1423*5113495bSYour Name 			<legal all>
1424*5113495bSYour Name */
1425*5113495bSYour Name #define REO_DESTINATION_RING_15_RING_ID_OFFSET                       0x0000003c
1426*5113495bSYour Name #define REO_DESTINATION_RING_15_RING_ID_LSB                          20
1427*5113495bSYour Name #define REO_DESTINATION_RING_15_RING_ID_MASK                         0x0ff00000
1428*5113495bSYour Name 
1429*5113495bSYour Name /* Description		REO_DESTINATION_RING_15_LOOPING_COUNT
1430*5113495bSYour Name 
1431*5113495bSYour Name 			A count value that indicates the number of times the
1432*5113495bSYour Name 			producer of entries into this Ring has looped around the
1433*5113495bSYour Name 			ring.
1434*5113495bSYour Name 
1435*5113495bSYour Name 			At initialization time, this value is set to 0. On the
1436*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
1437*5113495bSYour Name 			reached allowed by the number of bits for this field, the
1438*5113495bSYour Name 			count value continues with 0 again.
1439*5113495bSYour Name 
1440*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
1441*5113495bSYour Name 			use this field to figure out up to where the producer of
1442*5113495bSYour Name 			entries has created new entries. This eliminates the need to
1443*5113495bSYour Name 			check where the head pointer' of the ring is located once
1444*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
1445*5113495bSYour Name 			entries have been put into this ring...
1446*5113495bSYour Name 
1447*5113495bSYour Name 
1448*5113495bSYour Name 
1449*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1450*5113495bSYour Name 			LSB bit of this count value.
1451*5113495bSYour Name 
1452*5113495bSYour Name 			<legal all>
1453*5113495bSYour Name */
1454*5113495bSYour Name #define REO_DESTINATION_RING_15_LOOPING_COUNT_OFFSET                 0x0000003c
1455*5113495bSYour Name #define REO_DESTINATION_RING_15_LOOPING_COUNT_LSB                    28
1456*5113495bSYour Name #define REO_DESTINATION_RING_15_LOOPING_COUNT_MASK                   0xf0000000
1457*5113495bSYour Name 
1458*5113495bSYour Name 
1459*5113495bSYour Name #endif // _REO_DESTINATION_RING_H_
1460