xref: /wlan-driver/fw-api/hw/qca8074/v2/reo_entrance_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
2*5113495bSYour Name  *
3*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
4*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
5*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
6*5113495bSYour Name  *
7*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14*5113495bSYour Name  */
15*5113495bSYour Name 
16*5113495bSYour Name // $ATH_LICENSE_HW_HDR_C$
17*5113495bSYour Name //
18*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
19*5113495bSYour Name //               These definitions are tied to a particular hardware layout
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name #ifndef _REO_ENTRANCE_RING_H_
23*5113495bSYour Name #define _REO_ENTRANCE_RING_H_
24*5113495bSYour Name #if !defined(__ASSEMBLER__)
25*5113495bSYour Name #endif
26*5113495bSYour Name 
27*5113495bSYour Name #include "rx_mpdu_details.h"
28*5113495bSYour Name 
29*5113495bSYour Name // ################ START SUMMARY #################
30*5113495bSYour Name //
31*5113495bSYour Name //	Dword	Fields
32*5113495bSYour Name //	0-3	struct rx_mpdu_details reo_level_mpdu_frame_info;
33*5113495bSYour Name //	4	rx_reo_queue_desc_addr_31_0[31:0]
34*5113495bSYour Name //	5	rx_reo_queue_desc_addr_39_32[7:0], rounded_mpdu_byte_count[21:8], reo_destination_indication[26:22], frameless_bar[27], reserved_5a[31:28]
35*5113495bSYour Name //	6	rxdma_push_reason[1:0], rxdma_error_code[6:2], mpdu_fragment_number[10:7], reserved_6a[31:11]
36*5113495bSYour Name //	7	reserved_7a[19:0], ring_id[27:20], looping_count[31:28]
37*5113495bSYour Name //
38*5113495bSYour Name // ################ END SUMMARY #################
39*5113495bSYour Name 
40*5113495bSYour Name #define NUM_OF_DWORDS_REO_ENTRANCE_RING 8
41*5113495bSYour Name 
42*5113495bSYour Name struct reo_entrance_ring {
43*5113495bSYour Name     struct            rx_mpdu_details                       reo_level_mpdu_frame_info;
44*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_31_0     : 32; //[31:0]
45*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_39_32    :  8, //[7:0]
46*5113495bSYour Name                       rounded_mpdu_byte_count         : 14, //[21:8]
47*5113495bSYour Name                       reo_destination_indication      :  5, //[26:22]
48*5113495bSYour Name                       frameless_bar                   :  1, //[27]
49*5113495bSYour Name                       reserved_5a                     :  4; //[31:28]
50*5113495bSYour Name              uint32_t rxdma_push_reason               :  2, //[1:0]
51*5113495bSYour Name                       rxdma_error_code                :  5, //[6:2]
52*5113495bSYour Name                       mpdu_fragment_number            :  4, //[10:7]
53*5113495bSYour Name                       reserved_6a                     : 21; //[31:11]
54*5113495bSYour Name              uint32_t reserved_7a                     : 20, //[19:0]
55*5113495bSYour Name                       ring_id                         :  8, //[27:20]
56*5113495bSYour Name                       looping_count                   :  4; //[31:28]
57*5113495bSYour Name };
58*5113495bSYour Name 
59*5113495bSYour Name /*
60*5113495bSYour Name 
61*5113495bSYour Name struct rx_mpdu_details reo_level_mpdu_frame_info
62*5113495bSYour Name 
63*5113495bSYour Name 			Consumer: REO
64*5113495bSYour Name 
65*5113495bSYour Name 			Producer: RXDMA
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name 
69*5113495bSYour Name 			Details related to the MPDU being pushed into the REO
70*5113495bSYour Name 
71*5113495bSYour Name rx_reo_queue_desc_addr_31_0
72*5113495bSYour Name 
73*5113495bSYour Name 			Consumer: REO
74*5113495bSYour Name 
75*5113495bSYour Name 			Producer: RXDMA
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor.
80*5113495bSYour Name 
81*5113495bSYour Name 			<legal all>
82*5113495bSYour Name 
83*5113495bSYour Name rx_reo_queue_desc_addr_39_32
84*5113495bSYour Name 
85*5113495bSYour Name 			Consumer: REO
86*5113495bSYour Name 
87*5113495bSYour Name 			Producer: RXDMA
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor.
92*5113495bSYour Name 
93*5113495bSYour Name 			<legal all>
94*5113495bSYour Name 
95*5113495bSYour Name rounded_mpdu_byte_count
96*5113495bSYour Name 
97*5113495bSYour Name 			An approximation of the number of bytes received in this
98*5113495bSYour Name 			MPDU.
99*5113495bSYour Name 
100*5113495bSYour Name 			Used to keeps stats on the amount of data flowing
101*5113495bSYour Name 			through a queue.
102*5113495bSYour Name 
103*5113495bSYour Name 			<legal all>
104*5113495bSYour Name 
105*5113495bSYour Name reo_destination_indication
106*5113495bSYour Name 
107*5113495bSYour Name 			RXDMA copy the MPDU's first MSDU's destination
108*5113495bSYour Name 			indication field here. This is used for REO to be able to
109*5113495bSYour Name 			re-route the packet to a different SW destination ring if
110*5113495bSYour Name 			the packet is detected as error in REO.
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
115*5113495bSYour Name 			push after (MPDU level) reordering has finished.
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
120*5113495bSYour Name 			into the REO2TCL ring
121*5113495bSYour Name 
122*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
123*5113495bSYour Name 			into the REO2SW1 ring
124*5113495bSYour Name 
125*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
126*5113495bSYour Name 			into the REO2SW1 ring
127*5113495bSYour Name 
128*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
129*5113495bSYour Name 			into the REO2SW1 ring
130*5113495bSYour Name 
131*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
132*5113495bSYour Name 			into the REO2SW1 ring
133*5113495bSYour Name 
134*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
135*5113495bSYour Name 			into the REO_release ring
136*5113495bSYour Name 
137*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
138*5113495bSYour Name 			the REO2FW ring
139*5113495bSYour Name 
140*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
143*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
144*5113495bSYour Name 			reo_destination_10> REO remaps this
145*5113495bSYour Name 
146*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
149*5113495bSYour Name 			reo_destination_13> REO remaps this
150*5113495bSYour Name 
151*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
152*5113495bSYour Name 
153*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
154*5113495bSYour Name 
155*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
156*5113495bSYour Name 
157*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
158*5113495bSYour Name 
159*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
160*5113495bSYour Name 
161*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
162*5113495bSYour Name 
163*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
164*5113495bSYour Name 
165*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
166*5113495bSYour Name 
167*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
168*5113495bSYour Name 
169*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
170*5113495bSYour Name 
171*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
172*5113495bSYour Name 
173*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
174*5113495bSYour Name 
175*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
176*5113495bSYour Name 
177*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
178*5113495bSYour Name 
179*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
180*5113495bSYour Name 
181*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
182*5113495bSYour Name 
183*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
184*5113495bSYour Name 
185*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
186*5113495bSYour Name 
187*5113495bSYour Name 
188*5113495bSYour Name 
189*5113495bSYour Name 			<legal all>
190*5113495bSYour Name 
191*5113495bSYour Name frameless_bar
192*5113495bSYour Name 
193*5113495bSYour Name 			When set, this REO entrance ring struct contains BAR
194*5113495bSYour Name 			info from a multi TID BAR frame. The original multi TID BAR
195*5113495bSYour Name 			frame itself contained all the REO info for the first TID,
196*5113495bSYour Name 			but all the subsequent TID info and their linkage to the REO
197*5113495bSYour Name 			descriptors is passed down as 'frameless' BAR info.
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name 			The only fields valid in this descriptor when this bit
202*5113495bSYour Name 			is set are:
203*5113495bSYour Name 
204*5113495bSYour Name 			Rx_reo_queue_desc_addr_31_0
205*5113495bSYour Name 
206*5113495bSYour Name 			RX_reo_queue_desc_addr_39_32
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 
210*5113495bSYour Name 			And within the
211*5113495bSYour Name 
212*5113495bSYour Name 			Reo_level_mpdu_frame_info:
213*5113495bSYour Name 
214*5113495bSYour Name 			   Within Rx_mpdu_desc_info_details:
215*5113495bSYour Name 
216*5113495bSYour Name 			Mpdu_Sequence_number
217*5113495bSYour Name 
218*5113495bSYour Name 			BAR_frame
219*5113495bSYour Name 
220*5113495bSYour Name 			Peer_meta_data
221*5113495bSYour Name 
222*5113495bSYour Name 			All other fields shall be set to 0
223*5113495bSYour Name 
224*5113495bSYour Name 
225*5113495bSYour Name 
226*5113495bSYour Name 			<legal all>
227*5113495bSYour Name 
228*5113495bSYour Name reserved_5a
229*5113495bSYour Name 
230*5113495bSYour Name 			<legal 0>
231*5113495bSYour Name 
232*5113495bSYour Name rxdma_push_reason
233*5113495bSYour Name 
234*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
235*5113495bSYour Name 
236*5113495bSYour Name 
237*5113495bSYour Name 
238*5113495bSYour Name 			This field is ignored by REO.
239*5113495bSYour Name 
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
243*5113495bSYour Name 			pushed this frame to this queue
244*5113495bSYour Name 
245*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
246*5113495bSYour Name 			frame to this queue per received routing instructions. No
247*5113495bSYour Name 			error within RXDMA was detected
248*5113495bSYour Name 
249*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
250*5113495bSYour Name 			result the MSDU link descriptor might not have the
251*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
252*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
253*5113495bSYour Name 			considered a normal condition for this scenario.
254*5113495bSYour Name 
255*5113495bSYour Name 
256*5113495bSYour Name 
257*5113495bSYour Name 			<legal 0 - 2>
258*5113495bSYour Name 
259*5113495bSYour Name rxdma_error_code
260*5113495bSYour Name 
261*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
262*5113495bSYour Name 			'rxdma_error_detected'.
263*5113495bSYour Name 
264*5113495bSYour Name 
265*5113495bSYour Name 
266*5113495bSYour Name 			This field is ignored by REO.
267*5113495bSYour Name 
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
271*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
272*5113495bSYour Name 
273*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
274*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
278*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
279*5113495bSYour Name 			a valid corresponding key id in the peer entry.
280*5113495bSYour Name 
281*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
282*5113495bSYour Name 			error
283*5113495bSYour Name 
284*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
285*5113495bSYour Name 			unencrypted frame error when encrypted was expected
286*5113495bSYour Name 
287*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
288*5113495bSYour Name 			length error
289*5113495bSYour Name 
290*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
291*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
292*5113495bSYour Name 
293*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
294*5113495bSYour Name 			error
295*5113495bSYour Name 
296*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
297*5113495bSYour Name 			parsing error
298*5113495bSYour Name 
299*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
300*5113495bSYour Name 			during SA search
301*5113495bSYour Name 
302*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
303*5113495bSYour Name 			during DA search
304*5113495bSYour Name 
305*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
306*5113495bSYour Name 			timeout during flow search
307*5113495bSYour Name 
308*5113495bSYour Name 			<enum 13 Rxdma_flush_request>RXDMA received a flush
309*5113495bSYour Name 			request
310*5113495bSYour Name 
311*5113495bSYour Name mpdu_fragment_number
312*5113495bSYour Name 
313*5113495bSYour Name 			Field only valid when Reo_level_mpdu_frame_info.
314*5113495bSYour Name 
315*5113495bSYour Name 			Rx_mpdu_desc_info_details.
316*5113495bSYour Name 
317*5113495bSYour Name 			Fragment_flag  is set.
318*5113495bSYour Name 
319*5113495bSYour Name 
320*5113495bSYour Name 
321*5113495bSYour Name 			The fragment number from the 802.11 header.
322*5113495bSYour Name 
323*5113495bSYour Name 
324*5113495bSYour Name 
325*5113495bSYour Name 			Note that the sequence number is embedded in field:
326*5113495bSYour Name 			Reo_level_mpdu_frame_info.
327*5113495bSYour Name 
328*5113495bSYour Name 			Rx_mpdu_desc_info_details.
329*5113495bSYour Name 
330*5113495bSYour Name 			Mpdu_Sequence_number
331*5113495bSYour Name 
332*5113495bSYour Name 
333*5113495bSYour Name 
334*5113495bSYour Name 			<legal all>
335*5113495bSYour Name 
336*5113495bSYour Name reserved_6a
337*5113495bSYour Name 
338*5113495bSYour Name 			<legal 0>
339*5113495bSYour Name 
340*5113495bSYour Name reserved_7a
341*5113495bSYour Name 
342*5113495bSYour Name 			<legal 0>
343*5113495bSYour Name 
344*5113495bSYour Name ring_id
345*5113495bSYour Name 
346*5113495bSYour Name 			Consumer: SW/REO/DEBUG
347*5113495bSYour Name 
348*5113495bSYour Name 			Producer: SRNG (of RXDMA)
349*5113495bSYour Name 
350*5113495bSYour Name 
351*5113495bSYour Name 
352*5113495bSYour Name 			For debugging.
353*5113495bSYour Name 
354*5113495bSYour Name 			This field is filled in by the SRNG module.
355*5113495bSYour Name 
356*5113495bSYour Name 			It help to identify the ring that is being looked <legal
357*5113495bSYour Name 			all>
358*5113495bSYour Name 
359*5113495bSYour Name looping_count
360*5113495bSYour Name 
361*5113495bSYour Name 			Consumer: SW/REO/DEBUG
362*5113495bSYour Name 
363*5113495bSYour Name 			Producer: SRNG (of RXDMA)
364*5113495bSYour Name 
365*5113495bSYour Name 
366*5113495bSYour Name 
367*5113495bSYour Name 			For debugging.
368*5113495bSYour Name 
369*5113495bSYour Name 			This field is filled in by the SRNG module.
370*5113495bSYour Name 
371*5113495bSYour Name 
372*5113495bSYour Name 
373*5113495bSYour Name 			A count value that indicates the number of times the
374*5113495bSYour Name 			producer of entries into this Ring has looped around the
375*5113495bSYour Name 			ring.
376*5113495bSYour Name 
377*5113495bSYour Name 			At initialization time, this value is set to 0. On the
378*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
379*5113495bSYour Name 			reached allowed by the number of bits for this field, the
380*5113495bSYour Name 			count value continues with 0 again.
381*5113495bSYour Name 
382*5113495bSYour Name 
383*5113495bSYour Name 
384*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
385*5113495bSYour Name 			use this field to figure out up to where the producer of
386*5113495bSYour Name 			entries has created new entries. This eliminates the need to
387*5113495bSYour Name 			check where the head pointer' of the ring is located once
388*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
389*5113495bSYour Name 			entries have been put into this ring...
390*5113495bSYour Name 
391*5113495bSYour Name 
392*5113495bSYour Name 
393*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
394*5113495bSYour Name 			LSB bit of this count value.
395*5113495bSYour Name 
396*5113495bSYour Name 			<legal all>
397*5113495bSYour Name */
398*5113495bSYour Name 
399*5113495bSYour Name 
400*5113495bSYour Name  /* EXTERNAL REFERENCE : struct rx_mpdu_details reo_level_mpdu_frame_info */
401*5113495bSYour Name 
402*5113495bSYour Name 
403*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info msdu_link_desc_addr_info */
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name /* Description		REO_ENTRANCE_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0
407*5113495bSYour Name 
408*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
409*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
410*5113495bSYour Name 
411*5113495bSYour Name 
412*5113495bSYour Name 
413*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
414*5113495bSYour Name 
415*5113495bSYour Name 			<legal all>
416*5113495bSYour Name */
417*5113495bSYour Name #define REO_ENTRANCE_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
418*5113495bSYour Name #define REO_ENTRANCE_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
419*5113495bSYour Name #define REO_ENTRANCE_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
420*5113495bSYour Name 
421*5113495bSYour Name /* Description		REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32
422*5113495bSYour Name 
423*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
424*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
425*5113495bSYour Name 
426*5113495bSYour Name 
427*5113495bSYour Name 
428*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
429*5113495bSYour Name 
430*5113495bSYour Name 			<legal all>
431*5113495bSYour Name */
432*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
433*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
434*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
435*5113495bSYour Name 
436*5113495bSYour Name /* Description		REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER
437*5113495bSYour Name 
438*5113495bSYour Name 			Consumer: WBM
439*5113495bSYour Name 
440*5113495bSYour Name 			Producer: SW/FW
441*5113495bSYour Name 
442*5113495bSYour Name 
443*5113495bSYour Name 
444*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
445*5113495bSYour Name 
446*5113495bSYour Name 
447*5113495bSYour Name 
448*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
449*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
450*5113495bSYour Name 			pointed to shall be returned after the frame has been
451*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 
455*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
456*5113495bSYour Name 			to the WMB buffer idle list
457*5113495bSYour Name 
458*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
459*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
460*5113495bSYour Name 
461*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
462*5113495bSYour Name 
463*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
464*5113495bSYour Name 			ring 0
465*5113495bSYour Name 
466*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
467*5113495bSYour Name 			ring 1
468*5113495bSYour Name 
469*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
470*5113495bSYour Name 			ring 2
471*5113495bSYour Name 
472*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
473*5113495bSYour Name 			ring 3
474*5113495bSYour Name 
475*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
476*5113495bSYour Name 			ring 3
477*5113495bSYour Name 
478*5113495bSYour Name 
479*5113495bSYour Name 
480*5113495bSYour Name 			<legal all>
481*5113495bSYour Name */
482*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
483*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
484*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000700
485*5113495bSYour Name 
486*5113495bSYour Name /* Description		REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE
487*5113495bSYour Name 
488*5113495bSYour Name 			Cookie field exclusively used by SW.
489*5113495bSYour Name 
490*5113495bSYour Name 
491*5113495bSYour Name 
492*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
493*5113495bSYour Name 
494*5113495bSYour Name 
495*5113495bSYour Name 
496*5113495bSYour Name 			HW ignores the contents, accept that it passes the
497*5113495bSYour Name 			programmed value on to other descriptors together with the
498*5113495bSYour Name 			physical address
499*5113495bSYour Name 
500*5113495bSYour Name 
501*5113495bSYour Name 
502*5113495bSYour Name 			Field can be used by SW to for example associate the
503*5113495bSYour Name 			buffers physical address with the virtual address
504*5113495bSYour Name 
505*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
506*5113495bSYour Name 			specification
507*5113495bSYour Name 
508*5113495bSYour Name 
509*5113495bSYour Name 
510*5113495bSYour Name 			NOTE:
511*5113495bSYour Name 
512*5113495bSYour Name 			The three most significant bits can have a special
513*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
514*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
515*5113495bSYour Name 
516*5113495bSYour Name 
517*5113495bSYour Name 
518*5113495bSYour Name 			In case of NON punctured transmission:
519*5113495bSYour Name 
520*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
521*5113495bSYour Name 
522*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
523*5113495bSYour Name 
524*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
525*5113495bSYour Name 
526*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
527*5113495bSYour Name 
528*5113495bSYour Name 
529*5113495bSYour Name 
530*5113495bSYour Name 			In case of punctured transmission:
531*5113495bSYour Name 
532*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
533*5113495bSYour Name 
534*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
535*5113495bSYour Name 
536*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
537*5113495bSYour Name 
538*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
539*5113495bSYour Name 
540*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
541*5113495bSYour Name 
542*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
543*5113495bSYour Name 
544*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
545*5113495bSYour Name 
546*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
547*5113495bSYour Name 
548*5113495bSYour Name 
549*5113495bSYour Name 
550*5113495bSYour Name 			Note: a punctured transmission is indicated by the
551*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
552*5113495bSYour Name 			TLV
553*5113495bSYour Name 
554*5113495bSYour Name 
555*5113495bSYour Name 
556*5113495bSYour Name 			<legal all>
557*5113495bSYour Name */
558*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
559*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB 11
560*5113495bSYour Name #define REO_ENTRANCE_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff800
561*5113495bSYour Name 
562*5113495bSYour Name  /* EXTERNAL REFERENCE : struct rx_mpdu_desc_info rx_mpdu_desc_info_details */
563*5113495bSYour Name 
564*5113495bSYour Name 
565*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT
566*5113495bSYour Name 
567*5113495bSYour Name 			Consumer: REO/SW/FW
568*5113495bSYour Name 
569*5113495bSYour Name 			Producer: RXDMA
570*5113495bSYour Name 
571*5113495bSYour Name 
572*5113495bSYour Name 
573*5113495bSYour Name 			The number of MSDUs within the MPDU
574*5113495bSYour Name 
575*5113495bSYour Name 			<legal all>
576*5113495bSYour Name */
577*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_OFFSET 0x00000008
578*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_LSB 0
579*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MASK 0x000000ff
580*5113495bSYour Name 
581*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER
582*5113495bSYour Name 
583*5113495bSYour Name 			Consumer: REO/SW/FW
584*5113495bSYour Name 
585*5113495bSYour Name 			Producer: RXDMA
586*5113495bSYour Name 
587*5113495bSYour Name 
588*5113495bSYour Name 
589*5113495bSYour Name 			The field can have two different meanings based on the
590*5113495bSYour Name 			setting of field 'BAR_frame':
591*5113495bSYour Name 
592*5113495bSYour Name 
593*5113495bSYour Name 
594*5113495bSYour Name 			'BAR_frame' is NOT set:
595*5113495bSYour Name 
596*5113495bSYour Name 			The MPDU sequence number of the received frame.
597*5113495bSYour Name 
598*5113495bSYour Name 
599*5113495bSYour Name 
600*5113495bSYour Name 			'BAR_frame' is set.
601*5113495bSYour Name 
602*5113495bSYour Name 			The MPDU Start sequence number from the BAR frame
603*5113495bSYour Name 
604*5113495bSYour Name 			<legal all>
605*5113495bSYour Name */
606*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_OFFSET 0x00000008
607*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_LSB 8
608*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_MASK 0x000fff00
609*5113495bSYour Name 
610*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG
611*5113495bSYour Name 
612*5113495bSYour Name 			Consumer: REO/SW/FW
613*5113495bSYour Name 
614*5113495bSYour Name 			Producer: RXDMA
615*5113495bSYour Name 
616*5113495bSYour Name 
617*5113495bSYour Name 
618*5113495bSYour Name 			When set, this MPDU is a fragment and REO should forward
619*5113495bSYour Name 			this fragment MPDU to the REO destination ring without any
620*5113495bSYour Name 			reorder checks, pn checks or bitmap update. This implies
621*5113495bSYour Name 			that REO is forwarding the pointer to the MSDU link
622*5113495bSYour Name 			descriptor. The destination ring is coming from a
623*5113495bSYour Name 			programmable register setting in REO
624*5113495bSYour Name 
625*5113495bSYour Name 
626*5113495bSYour Name 
627*5113495bSYour Name 			<legal all>
628*5113495bSYour Name */
629*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_OFFSET 0x00000008
630*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_LSB 20
631*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MASK 0x00100000
632*5113495bSYour Name 
633*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT
634*5113495bSYour Name 
635*5113495bSYour Name 			Consumer: REO/SW/FW
636*5113495bSYour Name 
637*5113495bSYour Name 			Producer: RXDMA
638*5113495bSYour Name 
639*5113495bSYour Name 
640*5113495bSYour Name 
641*5113495bSYour Name 			The retry bit setting from the MPDU header of the
642*5113495bSYour Name 			received frame
643*5113495bSYour Name 
644*5113495bSYour Name 			<legal all>
645*5113495bSYour Name */
646*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_OFFSET 0x00000008
647*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_LSB 21
648*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MASK 0x00200000
649*5113495bSYour Name 
650*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG
651*5113495bSYour Name 
652*5113495bSYour Name 			Consumer: REO/SW/FW
653*5113495bSYour Name 
654*5113495bSYour Name 			Producer: RXDMA
655*5113495bSYour Name 
656*5113495bSYour Name 
657*5113495bSYour Name 
658*5113495bSYour Name 			When set, the MPDU was received as part of an A-MPDU.
659*5113495bSYour Name 
660*5113495bSYour Name 			<legal all>
661*5113495bSYour Name */
662*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_OFFSET 0x00000008
663*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_LSB 22
664*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MASK 0x00400000
665*5113495bSYour Name 
666*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME
667*5113495bSYour Name 
668*5113495bSYour Name 			Consumer: REO/SW/FW
669*5113495bSYour Name 
670*5113495bSYour Name 			Producer: RXDMA
671*5113495bSYour Name 
672*5113495bSYour Name 
673*5113495bSYour Name 
674*5113495bSYour Name 			When set, the received frame is a BAR frame. After
675*5113495bSYour Name 			processing, this frame shall be pushed to SW or deleted.
676*5113495bSYour Name 
677*5113495bSYour Name 			<legal all>
678*5113495bSYour Name */
679*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_OFFSET 0x00000008
680*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_LSB 23
681*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MASK 0x00800000
682*5113495bSYour Name 
683*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO
684*5113495bSYour Name 
685*5113495bSYour Name 			Consumer: REO/SW/FW
686*5113495bSYour Name 
687*5113495bSYour Name 			Producer: RXDMA
688*5113495bSYour Name 
689*5113495bSYour Name 
690*5113495bSYour Name 
691*5113495bSYour Name 			Copied here by RXDMA from RX_MPDU_END
692*5113495bSYour Name 
693*5113495bSYour Name 			When not set, REO will Not perform a PN sequence number
694*5113495bSYour Name 			check
695*5113495bSYour Name */
696*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET 0x00000008
697*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_LSB 24
698*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MASK 0x01000000
699*5113495bSYour Name 
700*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID
701*5113495bSYour Name 
702*5113495bSYour Name 			When set, OLE found a valid SA entry for all MSDUs in
703*5113495bSYour Name 			this MPDU
704*5113495bSYour Name 
705*5113495bSYour Name 			<legal all>
706*5113495bSYour Name */
707*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_OFFSET 0x00000008
708*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_LSB 25
709*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_MASK 0x02000000
710*5113495bSYour Name 
711*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT
712*5113495bSYour Name 
713*5113495bSYour Name 			When set, at least 1 MSDU within the MPDU has an
714*5113495bSYour Name 			unsuccessful MAC source address search due to the expiration
715*5113495bSYour Name 			of the search timer.
716*5113495bSYour Name 
717*5113495bSYour Name 			<legal all>
718*5113495bSYour Name */
719*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_OFFSET 0x00000008
720*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_LSB 26
721*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_MASK 0x04000000
722*5113495bSYour Name 
723*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID
724*5113495bSYour Name 
725*5113495bSYour Name 			When set, OLE found a valid DA entry for all MSDUs in
726*5113495bSYour Name 			this MPDU
727*5113495bSYour Name 
728*5113495bSYour Name 			<legal all>
729*5113495bSYour Name */
730*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_OFFSET 0x00000008
731*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_LSB 27
732*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_MASK 0x08000000
733*5113495bSYour Name 
734*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC
735*5113495bSYour Name 
736*5113495bSYour Name 			Field Only valid if da_is_valid is set
737*5113495bSYour Name 
738*5113495bSYour Name 
739*5113495bSYour Name 
740*5113495bSYour Name 			When set, at least one of the DA addresses is a
741*5113495bSYour Name 			Multicast or Broadcast address.
742*5113495bSYour Name 
743*5113495bSYour Name 			<legal all>
744*5113495bSYour Name */
745*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_OFFSET 0x00000008
746*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_LSB 28
747*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_MASK 0x10000000
748*5113495bSYour Name 
749*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT
750*5113495bSYour Name 
751*5113495bSYour Name 			When set, at least 1 MSDU within the MPDU has an
752*5113495bSYour Name 			unsuccessful MAC destination address search due to the
753*5113495bSYour Name 			expiration of the search timer.
754*5113495bSYour Name 
755*5113495bSYour Name 			<legal all>
756*5113495bSYour Name */
757*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_OFFSET 0x00000008
758*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_LSB 29
759*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_MASK 0x20000000
760*5113495bSYour Name 
761*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU
762*5113495bSYour Name 
763*5113495bSYour Name 			Field only valid when first_msdu_in_mpdu_flag is set.
764*5113495bSYour Name 
765*5113495bSYour Name 
766*5113495bSYour Name 
767*5113495bSYour Name 			When set, the contents in the MSDU buffer contains a
768*5113495bSYour Name 			'RAW' MPDU. This 'RAW' MPDU might be spread out over
769*5113495bSYour Name 			multiple MSDU buffers.
770*5113495bSYour Name 
771*5113495bSYour Name 			<legal all>
772*5113495bSYour Name */
773*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_OFFSET 0x00000008
774*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_LSB 30
775*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MASK 0x40000000
776*5113495bSYour Name 
777*5113495bSYour Name /* Description		REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG
778*5113495bSYour Name 
779*5113495bSYour Name 			The More Fragment bit setting from the MPDU header of
780*5113495bSYour Name 			the received frame
781*5113495bSYour Name 
782*5113495bSYour Name 
783*5113495bSYour Name 
784*5113495bSYour Name 			<legal all>
785*5113495bSYour Name */
786*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_OFFSET 0x00000008
787*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_LSB 31
788*5113495bSYour Name #define REO_ENTRANCE_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MASK 0x80000000
789*5113495bSYour Name 
790*5113495bSYour Name /* Description		REO_ENTRANCE_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA
791*5113495bSYour Name 
792*5113495bSYour Name 			Meta data that SW has programmed in the Peer table entry
793*5113495bSYour Name 			of the transmitting STA.
794*5113495bSYour Name 
795*5113495bSYour Name 			<legal all>
796*5113495bSYour Name */
797*5113495bSYour Name #define REO_ENTRANCE_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_OFFSET 0x0000000c
798*5113495bSYour Name #define REO_ENTRANCE_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_LSB 0
799*5113495bSYour Name #define REO_ENTRANCE_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MASK 0xffffffff
800*5113495bSYour Name 
801*5113495bSYour Name /* Description		REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0
802*5113495bSYour Name 
803*5113495bSYour Name 			Consumer: REO
804*5113495bSYour Name 
805*5113495bSYour Name 			Producer: RXDMA
806*5113495bSYour Name 
807*5113495bSYour Name 
808*5113495bSYour Name 
809*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor.
810*5113495bSYour Name 
811*5113495bSYour Name 			<legal all>
812*5113495bSYour Name */
813*5113495bSYour Name #define REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0_OFFSET       0x00000010
814*5113495bSYour Name #define REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0_LSB          0
815*5113495bSYour Name #define REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0_MASK         0xffffffff
816*5113495bSYour Name 
817*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32
818*5113495bSYour Name 
819*5113495bSYour Name 			Consumer: REO
820*5113495bSYour Name 
821*5113495bSYour Name 			Producer: RXDMA
822*5113495bSYour Name 
823*5113495bSYour Name 
824*5113495bSYour Name 
825*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor.
826*5113495bSYour Name 
827*5113495bSYour Name 			<legal all>
828*5113495bSYour Name */
829*5113495bSYour Name #define REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32_OFFSET      0x00000014
830*5113495bSYour Name #define REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32_LSB         0
831*5113495bSYour Name #define REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32_MASK        0x000000ff
832*5113495bSYour Name 
833*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT
834*5113495bSYour Name 
835*5113495bSYour Name 			An approximation of the number of bytes received in this
836*5113495bSYour Name 			MPDU.
837*5113495bSYour Name 
838*5113495bSYour Name 			Used to keeps stats on the amount of data flowing
839*5113495bSYour Name 			through a queue.
840*5113495bSYour Name 
841*5113495bSYour Name 			<legal all>
842*5113495bSYour Name */
843*5113495bSYour Name #define REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT_OFFSET           0x00000014
844*5113495bSYour Name #define REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT_LSB              8
845*5113495bSYour Name #define REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT_MASK             0x003fff00
846*5113495bSYour Name 
847*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION
848*5113495bSYour Name 
849*5113495bSYour Name 			RXDMA copy the MPDU's first MSDU's destination
850*5113495bSYour Name 			indication field here. This is used for REO to be able to
851*5113495bSYour Name 			re-route the packet to a different SW destination ring if
852*5113495bSYour Name 			the packet is detected as error in REO.
853*5113495bSYour Name 
854*5113495bSYour Name 
855*5113495bSYour Name 
856*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
857*5113495bSYour Name 			push after (MPDU level) reordering has finished.
858*5113495bSYour Name 
859*5113495bSYour Name 
860*5113495bSYour Name 
861*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
862*5113495bSYour Name 			into the REO2TCL ring
863*5113495bSYour Name 
864*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
865*5113495bSYour Name 			into the REO2SW1 ring
866*5113495bSYour Name 
867*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
868*5113495bSYour Name 			into the REO2SW1 ring
869*5113495bSYour Name 
870*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
871*5113495bSYour Name 			into the REO2SW1 ring
872*5113495bSYour Name 
873*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
874*5113495bSYour Name 			into the REO2SW1 ring
875*5113495bSYour Name 
876*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
877*5113495bSYour Name 			into the REO_release ring
878*5113495bSYour Name 
879*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
880*5113495bSYour Name 			the REO2FW ring
881*5113495bSYour Name 
882*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
883*5113495bSYour Name 
884*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
885*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
886*5113495bSYour Name 			reo_destination_10> REO remaps this
887*5113495bSYour Name 
888*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
889*5113495bSYour Name 
890*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
891*5113495bSYour Name 			reo_destination_13> REO remaps this
892*5113495bSYour Name 
893*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
894*5113495bSYour Name 
895*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
896*5113495bSYour Name 
897*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
898*5113495bSYour Name 
899*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
900*5113495bSYour Name 
901*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
902*5113495bSYour Name 
903*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
904*5113495bSYour Name 
905*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
906*5113495bSYour Name 
907*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
908*5113495bSYour Name 
909*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
910*5113495bSYour Name 
911*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
912*5113495bSYour Name 
913*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
914*5113495bSYour Name 
915*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
916*5113495bSYour Name 
917*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
918*5113495bSYour Name 
919*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
920*5113495bSYour Name 
921*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
922*5113495bSYour Name 
923*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
924*5113495bSYour Name 
925*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
926*5113495bSYour Name 
927*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
928*5113495bSYour Name 
929*5113495bSYour Name 
930*5113495bSYour Name 
931*5113495bSYour Name 			<legal all>
932*5113495bSYour Name */
933*5113495bSYour Name #define REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION_OFFSET        0x00000014
934*5113495bSYour Name #define REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION_LSB           22
935*5113495bSYour Name #define REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION_MASK          0x07c00000
936*5113495bSYour Name 
937*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_FRAMELESS_BAR
938*5113495bSYour Name 
939*5113495bSYour Name 			When set, this REO entrance ring struct contains BAR
940*5113495bSYour Name 			info from a multi TID BAR frame. The original multi TID BAR
941*5113495bSYour Name 			frame itself contained all the REO info for the first TID,
942*5113495bSYour Name 			but all the subsequent TID info and their linkage to the REO
943*5113495bSYour Name 			descriptors is passed down as 'frameless' BAR info.
944*5113495bSYour Name 
945*5113495bSYour Name 
946*5113495bSYour Name 
947*5113495bSYour Name 			The only fields valid in this descriptor when this bit
948*5113495bSYour Name 			is set are:
949*5113495bSYour Name 
950*5113495bSYour Name 			Rx_reo_queue_desc_addr_31_0
951*5113495bSYour Name 
952*5113495bSYour Name 			RX_reo_queue_desc_addr_39_32
953*5113495bSYour Name 
954*5113495bSYour Name 
955*5113495bSYour Name 
956*5113495bSYour Name 			And within the
957*5113495bSYour Name 
958*5113495bSYour Name 			Reo_level_mpdu_frame_info:
959*5113495bSYour Name 
960*5113495bSYour Name 			   Within Rx_mpdu_desc_info_details:
961*5113495bSYour Name 
962*5113495bSYour Name 			Mpdu_Sequence_number
963*5113495bSYour Name 
964*5113495bSYour Name 			BAR_frame
965*5113495bSYour Name 
966*5113495bSYour Name 			Peer_meta_data
967*5113495bSYour Name 
968*5113495bSYour Name 			All other fields shall be set to 0
969*5113495bSYour Name 
970*5113495bSYour Name 
971*5113495bSYour Name 
972*5113495bSYour Name 			<legal all>
973*5113495bSYour Name */
974*5113495bSYour Name #define REO_ENTRANCE_RING_5_FRAMELESS_BAR_OFFSET                     0x00000014
975*5113495bSYour Name #define REO_ENTRANCE_RING_5_FRAMELESS_BAR_LSB                        27
976*5113495bSYour Name #define REO_ENTRANCE_RING_5_FRAMELESS_BAR_MASK                       0x08000000
977*5113495bSYour Name 
978*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_RESERVED_5A
979*5113495bSYour Name 
980*5113495bSYour Name 			<legal 0>
981*5113495bSYour Name */
982*5113495bSYour Name #define REO_ENTRANCE_RING_5_RESERVED_5A_OFFSET                       0x00000014
983*5113495bSYour Name #define REO_ENTRANCE_RING_5_RESERVED_5A_LSB                          28
984*5113495bSYour Name #define REO_ENTRANCE_RING_5_RESERVED_5A_MASK                         0xf0000000
985*5113495bSYour Name 
986*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON
987*5113495bSYour Name 
988*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
989*5113495bSYour Name 
990*5113495bSYour Name 
991*5113495bSYour Name 
992*5113495bSYour Name 			This field is ignored by REO.
993*5113495bSYour Name 
994*5113495bSYour Name 
995*5113495bSYour Name 
996*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
997*5113495bSYour Name 			pushed this frame to this queue
998*5113495bSYour Name 
999*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
1000*5113495bSYour Name 			frame to this queue per received routing instructions. No
1001*5113495bSYour Name 			error within RXDMA was detected
1002*5113495bSYour Name 
1003*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
1004*5113495bSYour Name 			result the MSDU link descriptor might not have the
1005*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
1006*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
1007*5113495bSYour Name 			considered a normal condition for this scenario.
1008*5113495bSYour Name 
1009*5113495bSYour Name 
1010*5113495bSYour Name 
1011*5113495bSYour Name 			<legal 0 - 2>
1012*5113495bSYour Name */
1013*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON_OFFSET                 0x00000018
1014*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON_LSB                    0
1015*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON_MASK                   0x00000003
1016*5113495bSYour Name 
1017*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE
1018*5113495bSYour Name 
1019*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
1020*5113495bSYour Name 			'rxdma_error_detected'.
1021*5113495bSYour Name 
1022*5113495bSYour Name 
1023*5113495bSYour Name 
1024*5113495bSYour Name 			This field is ignored by REO.
1025*5113495bSYour Name 
1026*5113495bSYour Name 
1027*5113495bSYour Name 
1028*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
1029*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
1030*5113495bSYour Name 
1031*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
1032*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
1033*5113495bSYour Name 
1034*5113495bSYour Name 
1035*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
1036*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
1037*5113495bSYour Name 			a valid corresponding key id in the peer entry.
1038*5113495bSYour Name 
1039*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
1040*5113495bSYour Name 			error
1041*5113495bSYour Name 
1042*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
1043*5113495bSYour Name 			unencrypted frame error when encrypted was expected
1044*5113495bSYour Name 
1045*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
1046*5113495bSYour Name 			length error
1047*5113495bSYour Name 
1048*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
1049*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
1050*5113495bSYour Name 
1051*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
1052*5113495bSYour Name 			error
1053*5113495bSYour Name 
1054*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
1055*5113495bSYour Name 			parsing error
1056*5113495bSYour Name 
1057*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
1058*5113495bSYour Name 			during SA search
1059*5113495bSYour Name 
1060*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
1061*5113495bSYour Name 			during DA search
1062*5113495bSYour Name 
1063*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
1064*5113495bSYour Name 			timeout during flow search
1065*5113495bSYour Name 
1066*5113495bSYour Name 			<enum 13 Rxdma_flush_request>RXDMA received a flush
1067*5113495bSYour Name 			request
1068*5113495bSYour Name */
1069*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE_OFFSET                  0x00000018
1070*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE_LSB                     2
1071*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE_MASK                    0x0000007c
1072*5113495bSYour Name 
1073*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_MPDU_FRAGMENT_NUMBER
1074*5113495bSYour Name 
1075*5113495bSYour Name 			Field only valid when Reo_level_mpdu_frame_info.
1076*5113495bSYour Name 
1077*5113495bSYour Name 			Rx_mpdu_desc_info_details.
1078*5113495bSYour Name 
1079*5113495bSYour Name 			Fragment_flag  is set.
1080*5113495bSYour Name 
1081*5113495bSYour Name 
1082*5113495bSYour Name 
1083*5113495bSYour Name 			The fragment number from the 802.11 header.
1084*5113495bSYour Name 
1085*5113495bSYour Name 
1086*5113495bSYour Name 
1087*5113495bSYour Name 			Note that the sequence number is embedded in field:
1088*5113495bSYour Name 			Reo_level_mpdu_frame_info.
1089*5113495bSYour Name 
1090*5113495bSYour Name 			Rx_mpdu_desc_info_details.
1091*5113495bSYour Name 
1092*5113495bSYour Name 			Mpdu_Sequence_number
1093*5113495bSYour Name 
1094*5113495bSYour Name 
1095*5113495bSYour Name 
1096*5113495bSYour Name 			<legal all>
1097*5113495bSYour Name */
1098*5113495bSYour Name #define REO_ENTRANCE_RING_6_MPDU_FRAGMENT_NUMBER_OFFSET              0x00000018
1099*5113495bSYour Name #define REO_ENTRANCE_RING_6_MPDU_FRAGMENT_NUMBER_LSB                 7
1100*5113495bSYour Name #define REO_ENTRANCE_RING_6_MPDU_FRAGMENT_NUMBER_MASK                0x00000780
1101*5113495bSYour Name 
1102*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_RESERVED_6A
1103*5113495bSYour Name 
1104*5113495bSYour Name 			<legal 0>
1105*5113495bSYour Name */
1106*5113495bSYour Name #define REO_ENTRANCE_RING_6_RESERVED_6A_OFFSET                       0x00000018
1107*5113495bSYour Name #define REO_ENTRANCE_RING_6_RESERVED_6A_LSB                          11
1108*5113495bSYour Name #define REO_ENTRANCE_RING_6_RESERVED_6A_MASK                         0xfffff800
1109*5113495bSYour Name 
1110*5113495bSYour Name /* Description		REO_ENTRANCE_RING_7_RESERVED_7A
1111*5113495bSYour Name 
1112*5113495bSYour Name 			<legal 0>
1113*5113495bSYour Name */
1114*5113495bSYour Name #define REO_ENTRANCE_RING_7_RESERVED_7A_OFFSET                       0x0000001c
1115*5113495bSYour Name #define REO_ENTRANCE_RING_7_RESERVED_7A_LSB                          0
1116*5113495bSYour Name #define REO_ENTRANCE_RING_7_RESERVED_7A_MASK                         0x000fffff
1117*5113495bSYour Name 
1118*5113495bSYour Name /* Description		REO_ENTRANCE_RING_7_RING_ID
1119*5113495bSYour Name 
1120*5113495bSYour Name 			Consumer: SW/REO/DEBUG
1121*5113495bSYour Name 
1122*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1123*5113495bSYour Name 
1124*5113495bSYour Name 
1125*5113495bSYour Name 
1126*5113495bSYour Name 			For debugging.
1127*5113495bSYour Name 
1128*5113495bSYour Name 			This field is filled in by the SRNG module.
1129*5113495bSYour Name 
1130*5113495bSYour Name 			It help to identify the ring that is being looked <legal
1131*5113495bSYour Name 			all>
1132*5113495bSYour Name */
1133*5113495bSYour Name #define REO_ENTRANCE_RING_7_RING_ID_OFFSET                           0x0000001c
1134*5113495bSYour Name #define REO_ENTRANCE_RING_7_RING_ID_LSB                              20
1135*5113495bSYour Name #define REO_ENTRANCE_RING_7_RING_ID_MASK                             0x0ff00000
1136*5113495bSYour Name 
1137*5113495bSYour Name /* Description		REO_ENTRANCE_RING_7_LOOPING_COUNT
1138*5113495bSYour Name 
1139*5113495bSYour Name 			Consumer: SW/REO/DEBUG
1140*5113495bSYour Name 
1141*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1142*5113495bSYour Name 
1143*5113495bSYour Name 
1144*5113495bSYour Name 
1145*5113495bSYour Name 			For debugging.
1146*5113495bSYour Name 
1147*5113495bSYour Name 			This field is filled in by the SRNG module.
1148*5113495bSYour Name 
1149*5113495bSYour Name 
1150*5113495bSYour Name 
1151*5113495bSYour Name 			A count value that indicates the number of times the
1152*5113495bSYour Name 			producer of entries into this Ring has looped around the
1153*5113495bSYour Name 			ring.
1154*5113495bSYour Name 
1155*5113495bSYour Name 			At initialization time, this value is set to 0. On the
1156*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
1157*5113495bSYour Name 			reached allowed by the number of bits for this field, the
1158*5113495bSYour Name 			count value continues with 0 again.
1159*5113495bSYour Name 
1160*5113495bSYour Name 
1161*5113495bSYour Name 
1162*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
1163*5113495bSYour Name 			use this field to figure out up to where the producer of
1164*5113495bSYour Name 			entries has created new entries. This eliminates the need to
1165*5113495bSYour Name 			check where the head pointer' of the ring is located once
1166*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
1167*5113495bSYour Name 			entries have been put into this ring...
1168*5113495bSYour Name 
1169*5113495bSYour Name 
1170*5113495bSYour Name 
1171*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1172*5113495bSYour Name 			LSB bit of this count value.
1173*5113495bSYour Name 
1174*5113495bSYour Name 			<legal all>
1175*5113495bSYour Name */
1176*5113495bSYour Name #define REO_ENTRANCE_RING_7_LOOPING_COUNT_OFFSET                     0x0000001c
1177*5113495bSYour Name #define REO_ENTRANCE_RING_7_LOOPING_COUNT_LSB                        28
1178*5113495bSYour Name #define REO_ENTRANCE_RING_7_LOOPING_COUNT_MASK                       0xf0000000
1179*5113495bSYour Name 
1180*5113495bSYour Name 
1181*5113495bSYour Name #endif // _REO_ENTRANCE_RING_H_
1182