xref: /wlan-driver/fw-api/hw/qca6290/11ax/v1/reo_entrance_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _REO_ENTRANCE_RING_H_
20*5113495bSYour Name #define _REO_ENTRANCE_RING_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "rx_mpdu_details.h"
25*5113495bSYour Name 
26*5113495bSYour Name // ################ START SUMMARY #################
27*5113495bSYour Name //
28*5113495bSYour Name //	Dword	Fields
29*5113495bSYour Name //	0-3	struct rx_mpdu_details reo_level_mpdu_frame_info;
30*5113495bSYour Name //	4	rx_reo_queue_desc_addr_31_0[31:0]
31*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]
32*5113495bSYour Name //	6	rxdma_push_reason[1:0], rxdma_error_code[6:2], reserved_6a[31:7]
33*5113495bSYour Name //	7	reserved_7a[19:0], ring_id[27:20], looping_count[31:28]
34*5113495bSYour Name //
35*5113495bSYour Name // ################ END SUMMARY #################
36*5113495bSYour Name 
37*5113495bSYour Name #define NUM_OF_DWORDS_REO_ENTRANCE_RING 8
38*5113495bSYour Name 
39*5113495bSYour Name struct reo_entrance_ring {
40*5113495bSYour Name     struct            rx_mpdu_details                       reo_level_mpdu_frame_info;
41*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_31_0     : 32; //[31:0]
42*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_39_32    :  8, //[7:0]
43*5113495bSYour Name                       rounded_mpdu_byte_count         : 14, //[21:8]
44*5113495bSYour Name                       reo_destination_indication      :  5, //[26:22]
45*5113495bSYour Name                       frameless_bar                   :  1, //[27]
46*5113495bSYour Name                       reserved_5a                     :  4; //[31:28]
47*5113495bSYour Name              uint32_t rxdma_push_reason               :  2, //[1:0]
48*5113495bSYour Name                       rxdma_error_code                :  5, //[6:2]
49*5113495bSYour Name                       reserved_6a                     : 25; //[31:7]
50*5113495bSYour Name              uint32_t reserved_7a                     : 20, //[19:0]
51*5113495bSYour Name                       ring_id                         :  8, //[27:20]
52*5113495bSYour Name                       looping_count                   :  4; //[31:28]
53*5113495bSYour Name };
54*5113495bSYour Name 
55*5113495bSYour Name /*
56*5113495bSYour Name 
57*5113495bSYour Name struct rx_mpdu_details reo_level_mpdu_frame_info
58*5113495bSYour Name 
59*5113495bSYour Name 			Consumer: REO
60*5113495bSYour Name 
61*5113495bSYour Name 			Producer: RXDMA
62*5113495bSYour Name 
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name 			Details related to the MPDU being pushed into the REO
66*5113495bSYour Name 
67*5113495bSYour Name rx_reo_queue_desc_addr_31_0
68*5113495bSYour Name 
69*5113495bSYour Name 			Consumer: REO
70*5113495bSYour Name 
71*5113495bSYour Name 			Producer: RXDMA
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 
75*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor.
76*5113495bSYour Name 
77*5113495bSYour Name 			<legal all>
78*5113495bSYour Name 
79*5113495bSYour Name rx_reo_queue_desc_addr_39_32
80*5113495bSYour Name 
81*5113495bSYour Name 			Consumer: REO
82*5113495bSYour Name 
83*5113495bSYour Name 			Producer: RXDMA
84*5113495bSYour Name 
85*5113495bSYour Name 
86*5113495bSYour Name 
87*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor.
88*5113495bSYour Name 
89*5113495bSYour Name 			<legal all>
90*5113495bSYour Name 
91*5113495bSYour Name rounded_mpdu_byte_count
92*5113495bSYour Name 
93*5113495bSYour Name 			An approximation of the number of bytes received in this
94*5113495bSYour Name 			MPDU.
95*5113495bSYour Name 
96*5113495bSYour Name 			Used to keeps stats on the amount of data flowing
97*5113495bSYour Name 			through a queue.
98*5113495bSYour Name 
99*5113495bSYour Name 			<legal all>
100*5113495bSYour Name 
101*5113495bSYour Name reo_destination_indication
102*5113495bSYour Name 
103*5113495bSYour Name 			RXDMA copy the MPDU's first MSDU's destination
104*5113495bSYour Name 			indication field here. This is used for REO to be able to
105*5113495bSYour Name 			re-route the packet to a different SW destination ring if
106*5113495bSYour Name 			the packet is detected as error in REO.
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
111*5113495bSYour Name 			push after (MPDU level) reordering has finished.
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
116*5113495bSYour Name 			into the REO2TCL ring
117*5113495bSYour Name 
118*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
119*5113495bSYour Name 			into the REO2SW1 ring
120*5113495bSYour Name 
121*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
122*5113495bSYour Name 			into the REO2SW1 ring
123*5113495bSYour Name 
124*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
125*5113495bSYour Name 			into the REO2SW1 ring
126*5113495bSYour Name 
127*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
128*5113495bSYour Name 			into the REO2SW1 ring
129*5113495bSYour Name 
130*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
131*5113495bSYour Name 			into the REO_release ring
132*5113495bSYour Name 
133*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
134*5113495bSYour Name 			the REO2FW ring
135*5113495bSYour Name 
136*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
137*5113495bSYour Name 
138*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
139*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
140*5113495bSYour Name 			reo_destination_10> REO remaps this
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
143*5113495bSYour Name 
144*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
145*5113495bSYour Name 			reo_destination_13> REO remaps this
146*5113495bSYour Name 
147*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
148*5113495bSYour Name 
149*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
150*5113495bSYour Name 
151*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
152*5113495bSYour Name 
153*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
154*5113495bSYour Name 
155*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
156*5113495bSYour Name 
157*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
158*5113495bSYour Name 
159*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
160*5113495bSYour Name 
161*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
162*5113495bSYour Name 
163*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
164*5113495bSYour Name 
165*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
166*5113495bSYour Name 
167*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
168*5113495bSYour Name 
169*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
170*5113495bSYour Name 
171*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
172*5113495bSYour Name 
173*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
174*5113495bSYour Name 
175*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
176*5113495bSYour Name 
177*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
178*5113495bSYour Name 
179*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
180*5113495bSYour Name 
181*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name 			<legal all>
186*5113495bSYour Name 
187*5113495bSYour Name frameless_bar
188*5113495bSYour Name 
189*5113495bSYour Name 			When set, this REO entrance ring struct contains BAR
190*5113495bSYour Name 			info from a multi TID BAR frame. The original multi TID BAR
191*5113495bSYour Name 			frame itself contained all the REO info for the first TID,
192*5113495bSYour Name 			but all the subsequent TID info and their linkage to the REO
193*5113495bSYour Name 			descriptors is passed down as 'frameless' BAR info.
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 			The only fields valid in this descriptor when this bit
198*5113495bSYour Name 			is set are:
199*5113495bSYour Name 
200*5113495bSYour Name 			Rx_reo_queue_desc_addr_31_0
201*5113495bSYour Name 
202*5113495bSYour Name 			RX_reo_queue_desc_addr_39_32
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name 			And within the
207*5113495bSYour Name 
208*5113495bSYour Name 			Reo_level_mpdu_frame_info:
209*5113495bSYour Name 
210*5113495bSYour Name 			   Within Rx_mpdu_desc_info_details:
211*5113495bSYour Name 
212*5113495bSYour Name 			Mpdu_Sequence_number
213*5113495bSYour Name 
214*5113495bSYour Name 			BAR_frame
215*5113495bSYour Name 
216*5113495bSYour Name 			Peer_meta_data
217*5113495bSYour Name 
218*5113495bSYour Name 			All other fields shall be set to 0
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name 			<legal all>
223*5113495bSYour Name 
224*5113495bSYour Name reserved_5a
225*5113495bSYour Name 
226*5113495bSYour Name 			<legal 0>
227*5113495bSYour Name 
228*5113495bSYour Name rxdma_push_reason
229*5113495bSYour Name 
230*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
231*5113495bSYour Name 
232*5113495bSYour Name 
233*5113495bSYour Name 
234*5113495bSYour Name 			This field is ignored by REO.
235*5113495bSYour Name 
236*5113495bSYour Name 
237*5113495bSYour Name 
238*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
239*5113495bSYour Name 			pushed this frame to this queue
240*5113495bSYour Name 
241*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
242*5113495bSYour Name 			frame to this queue per received routing instructions. No
243*5113495bSYour Name 			error within RXDMA was detected
244*5113495bSYour Name 
245*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
246*5113495bSYour Name 			result the MSDU link descriptor might not have the
247*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
248*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
249*5113495bSYour Name 			considered a normal condition for this scenario.
250*5113495bSYour Name 
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name 			<legal 0 - 2>
254*5113495bSYour Name 
255*5113495bSYour Name rxdma_error_code
256*5113495bSYour Name 
257*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
258*5113495bSYour Name 			'rxdma_error_detected'.
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name 
262*5113495bSYour Name 			This field is ignored by REO.
263*5113495bSYour Name 
264*5113495bSYour Name 
265*5113495bSYour Name 
266*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
267*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
268*5113495bSYour Name 
269*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
270*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
271*5113495bSYour Name 
272*5113495bSYour Name 
273*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
274*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
275*5113495bSYour Name 			a valid corresponding key id in the peer entry.
276*5113495bSYour Name 
277*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
278*5113495bSYour Name 			error
279*5113495bSYour Name 
280*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
281*5113495bSYour Name 			unencrypted frame error when encrypted was expected
282*5113495bSYour Name 
283*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
284*5113495bSYour Name 			length error
285*5113495bSYour Name 
286*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
287*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
288*5113495bSYour Name 
289*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
290*5113495bSYour Name 			error
291*5113495bSYour Name 
292*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
293*5113495bSYour Name 			parsing error
294*5113495bSYour Name 
295*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
296*5113495bSYour Name 			during SA search
297*5113495bSYour Name 
298*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
299*5113495bSYour Name 			during DA search
300*5113495bSYour Name 
301*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
302*5113495bSYour Name 			timeout during flow search
303*5113495bSYour Name 
304*5113495bSYour Name 			<enum 13 Rxdma_flush_request>RXDMA received a flush
305*5113495bSYour Name 			request
306*5113495bSYour Name 
307*5113495bSYour Name reserved_6a
308*5113495bSYour Name 
309*5113495bSYour Name 			<legal 0>
310*5113495bSYour Name 
311*5113495bSYour Name reserved_7a
312*5113495bSYour Name 
313*5113495bSYour Name 			<legal 0>
314*5113495bSYour Name 
315*5113495bSYour Name ring_id
316*5113495bSYour Name 
317*5113495bSYour Name 			Consumer: SW/REO/DEBUG
318*5113495bSYour Name 
319*5113495bSYour Name 			Producer: SRNG (of RXDMA)
320*5113495bSYour Name 
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 			For debugging.
324*5113495bSYour Name 
325*5113495bSYour Name 			This field is filled in by the SRNG module.
326*5113495bSYour Name 
327*5113495bSYour Name 			It help to identify the ring that is being looked <legal
328*5113495bSYour Name 			all>
329*5113495bSYour Name 
330*5113495bSYour Name looping_count
331*5113495bSYour Name 
332*5113495bSYour Name 			Consumer: SW/REO/DEBUG
333*5113495bSYour Name 
334*5113495bSYour Name 			Producer: SRNG (of RXDMA)
335*5113495bSYour Name 
336*5113495bSYour Name 
337*5113495bSYour Name 
338*5113495bSYour Name 			For debugging.
339*5113495bSYour Name 
340*5113495bSYour Name 			This field is filled in by the SRNG module.
341*5113495bSYour Name 
342*5113495bSYour Name 
343*5113495bSYour Name 
344*5113495bSYour Name 			A count value that indicates the number of times the
345*5113495bSYour Name 			producer of entries into this Ring has looped around the
346*5113495bSYour Name 			ring.
347*5113495bSYour Name 
348*5113495bSYour Name 			At initialization time, this value is set to 0. On the
349*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
350*5113495bSYour Name 			reached allowed by the number of bits for this field, the
351*5113495bSYour Name 			count value continues with 0 again.
352*5113495bSYour Name 
353*5113495bSYour Name 
354*5113495bSYour Name 
355*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
356*5113495bSYour Name 			use this field to figure out up to where the producer of
357*5113495bSYour Name 			entries has created new entries. This eliminates the need to
358*5113495bSYour Name 			check where the head pointer' of the ring is located once
359*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
360*5113495bSYour Name 			entries have been put into this ring...
361*5113495bSYour Name 
362*5113495bSYour Name 
363*5113495bSYour Name 
364*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
365*5113495bSYour Name 			LSB bit of this count value.
366*5113495bSYour Name 
367*5113495bSYour Name 			<legal all>
368*5113495bSYour Name */
369*5113495bSYour Name 
370*5113495bSYour Name #define REO_ENTRANCE_RING_0_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_OFFSET 0x00000000
371*5113495bSYour Name #define REO_ENTRANCE_RING_0_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_LSB 28
372*5113495bSYour Name #define REO_ENTRANCE_RING_0_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_MASK 0xffffffff
373*5113495bSYour Name #define REO_ENTRANCE_RING_1_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_OFFSET 0x00000004
374*5113495bSYour Name #define REO_ENTRANCE_RING_1_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_LSB 28
375*5113495bSYour Name #define REO_ENTRANCE_RING_1_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_MASK 0xffffffff
376*5113495bSYour Name #define REO_ENTRANCE_RING_2_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_OFFSET 0x00000008
377*5113495bSYour Name #define REO_ENTRANCE_RING_2_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_LSB 28
378*5113495bSYour Name #define REO_ENTRANCE_RING_2_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_MASK 0xffffffff
379*5113495bSYour Name #define REO_ENTRANCE_RING_3_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_OFFSET 0x0000000c
380*5113495bSYour Name #define REO_ENTRANCE_RING_3_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_LSB 28
381*5113495bSYour Name #define REO_ENTRANCE_RING_3_RX_MPDU_DETAILS_REO_LEVEL_MPDU_FRAME_INFO_MASK 0xffffffff
382*5113495bSYour Name 
383*5113495bSYour Name /* Description		REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0
384*5113495bSYour Name 
385*5113495bSYour Name 			Consumer: REO
386*5113495bSYour Name 
387*5113495bSYour Name 			Producer: RXDMA
388*5113495bSYour Name 
389*5113495bSYour Name 
390*5113495bSYour Name 
391*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor.
392*5113495bSYour Name 
393*5113495bSYour Name 			<legal all>
394*5113495bSYour Name */
395*5113495bSYour Name #define REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0_OFFSET       0x00000010
396*5113495bSYour Name #define REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0_LSB          0
397*5113495bSYour Name #define REO_ENTRANCE_RING_4_RX_REO_QUEUE_DESC_ADDR_31_0_MASK         0xffffffff
398*5113495bSYour Name 
399*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32
400*5113495bSYour Name 
401*5113495bSYour Name 			Consumer: REO
402*5113495bSYour Name 
403*5113495bSYour Name 			Producer: RXDMA
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name 
407*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor.
408*5113495bSYour Name 
409*5113495bSYour Name 			<legal all>
410*5113495bSYour Name */
411*5113495bSYour Name #define REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32_OFFSET      0x00000014
412*5113495bSYour Name #define REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32_LSB         0
413*5113495bSYour Name #define REO_ENTRANCE_RING_5_RX_REO_QUEUE_DESC_ADDR_39_32_MASK        0x000000ff
414*5113495bSYour Name 
415*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT
416*5113495bSYour Name 
417*5113495bSYour Name 			An approximation of the number of bytes received in this
418*5113495bSYour Name 			MPDU.
419*5113495bSYour Name 
420*5113495bSYour Name 			Used to keeps stats on the amount of data flowing
421*5113495bSYour Name 			through a queue.
422*5113495bSYour Name 
423*5113495bSYour Name 			<legal all>
424*5113495bSYour Name */
425*5113495bSYour Name #define REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT_OFFSET           0x00000014
426*5113495bSYour Name #define REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT_LSB              8
427*5113495bSYour Name #define REO_ENTRANCE_RING_5_ROUNDED_MPDU_BYTE_COUNT_MASK             0x003fff00
428*5113495bSYour Name 
429*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION
430*5113495bSYour Name 
431*5113495bSYour Name 			RXDMA copy the MPDU's first MSDU's destination
432*5113495bSYour Name 			indication field here. This is used for REO to be able to
433*5113495bSYour Name 			re-route the packet to a different SW destination ring if
434*5113495bSYour Name 			the packet is detected as error in REO.
435*5113495bSYour Name 
436*5113495bSYour Name 
437*5113495bSYour Name 
438*5113495bSYour Name 			The ID of the REO exit ring where the MSDU frame shall
439*5113495bSYour Name 			push after (MPDU level) reordering has finished.
440*5113495bSYour Name 
441*5113495bSYour Name 
442*5113495bSYour Name 
443*5113495bSYour Name 			<enum 0 reo_destination_tcl> Reo will push the frame
444*5113495bSYour Name 			into the REO2TCL ring
445*5113495bSYour Name 
446*5113495bSYour Name 			<enum 1 reo_destination_sw1> Reo will push the frame
447*5113495bSYour Name 			into the REO2SW1 ring
448*5113495bSYour Name 
449*5113495bSYour Name 			<enum 2 reo_destination_sw2> Reo will push the frame
450*5113495bSYour Name 			into the REO2SW1 ring
451*5113495bSYour Name 
452*5113495bSYour Name 			<enum 3 reo_destination_sw3> Reo will push the frame
453*5113495bSYour Name 			into the REO2SW1 ring
454*5113495bSYour Name 
455*5113495bSYour Name 			<enum 4 reo_destination_sw4> Reo will push the frame
456*5113495bSYour Name 			into the REO2SW1 ring
457*5113495bSYour Name 
458*5113495bSYour Name 			<enum 5 reo_destination_release> Reo will push the frame
459*5113495bSYour Name 			into the REO_release ring
460*5113495bSYour Name 
461*5113495bSYour Name 			<enum 6 reo_destination_fw> Reo will push the frame into
462*5113495bSYour Name 			the REO2FW ring
463*5113495bSYour Name 
464*5113495bSYour Name 			<enum 7 reo_destination_7> REO remaps this
465*5113495bSYour Name 
466*5113495bSYour Name 			<enum 8 reo_destination_8> REO remaps this <enum 9
467*5113495bSYour Name 			reo_destination_9> REO remaps this <enum 10
468*5113495bSYour Name 			reo_destination_10> REO remaps this
469*5113495bSYour Name 
470*5113495bSYour Name 			<enum 11 reo_destination_11> REO remaps this
471*5113495bSYour Name 
472*5113495bSYour Name 			<enum 12 reo_destination_12> REO remaps this <enum 13
473*5113495bSYour Name 			reo_destination_13> REO remaps this
474*5113495bSYour Name 
475*5113495bSYour Name 			<enum 14 reo_destination_14> REO remaps this
476*5113495bSYour Name 
477*5113495bSYour Name 			<enum 15 reo_destination_15> REO remaps this
478*5113495bSYour Name 
479*5113495bSYour Name 			<enum 16 reo_destination_16> REO remaps this
480*5113495bSYour Name 
481*5113495bSYour Name 			<enum 17 reo_destination_17> REO remaps this
482*5113495bSYour Name 
483*5113495bSYour Name 			<enum 18 reo_destination_18> REO remaps this
484*5113495bSYour Name 
485*5113495bSYour Name 			<enum 19 reo_destination_19> REO remaps this
486*5113495bSYour Name 
487*5113495bSYour Name 			<enum 20 reo_destination_20> REO remaps this
488*5113495bSYour Name 
489*5113495bSYour Name 			<enum 21 reo_destination_21> REO remaps this
490*5113495bSYour Name 
491*5113495bSYour Name 			<enum 22 reo_destination_22> REO remaps this
492*5113495bSYour Name 
493*5113495bSYour Name 			<enum 23 reo_destination_23> REO remaps this
494*5113495bSYour Name 
495*5113495bSYour Name 			<enum 24 reo_destination_24> REO remaps this
496*5113495bSYour Name 
497*5113495bSYour Name 			<enum 25 reo_destination_25> REO remaps this
498*5113495bSYour Name 
499*5113495bSYour Name 			<enum 26 reo_destination_26> REO remaps this
500*5113495bSYour Name 
501*5113495bSYour Name 			<enum 27 reo_destination_27> REO remaps this
502*5113495bSYour Name 
503*5113495bSYour Name 			<enum 28 reo_destination_28> REO remaps this
504*5113495bSYour Name 
505*5113495bSYour Name 			<enum 29 reo_destination_29> REO remaps this
506*5113495bSYour Name 
507*5113495bSYour Name 			<enum 30 reo_destination_30> REO remaps this
508*5113495bSYour Name 
509*5113495bSYour Name 			<enum 31 reo_destination_31> REO remaps this
510*5113495bSYour Name 
511*5113495bSYour Name 
512*5113495bSYour Name 
513*5113495bSYour Name 			<legal all>
514*5113495bSYour Name */
515*5113495bSYour Name #define REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION_OFFSET        0x00000014
516*5113495bSYour Name #define REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION_LSB           22
517*5113495bSYour Name #define REO_ENTRANCE_RING_5_REO_DESTINATION_INDICATION_MASK          0x07c00000
518*5113495bSYour Name 
519*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_FRAMELESS_BAR
520*5113495bSYour Name 
521*5113495bSYour Name 			When set, this REO entrance ring struct contains BAR
522*5113495bSYour Name 			info from a multi TID BAR frame. The original multi TID BAR
523*5113495bSYour Name 			frame itself contained all the REO info for the first TID,
524*5113495bSYour Name 			but all the subsequent TID info and their linkage to the REO
525*5113495bSYour Name 			descriptors is passed down as 'frameless' BAR info.
526*5113495bSYour Name 
527*5113495bSYour Name 
528*5113495bSYour Name 
529*5113495bSYour Name 			The only fields valid in this descriptor when this bit
530*5113495bSYour Name 			is set are:
531*5113495bSYour Name 
532*5113495bSYour Name 			Rx_reo_queue_desc_addr_31_0
533*5113495bSYour Name 
534*5113495bSYour Name 			RX_reo_queue_desc_addr_39_32
535*5113495bSYour Name 
536*5113495bSYour Name 
537*5113495bSYour Name 
538*5113495bSYour Name 			And within the
539*5113495bSYour Name 
540*5113495bSYour Name 			Reo_level_mpdu_frame_info:
541*5113495bSYour Name 
542*5113495bSYour Name 			   Within Rx_mpdu_desc_info_details:
543*5113495bSYour Name 
544*5113495bSYour Name 			Mpdu_Sequence_number
545*5113495bSYour Name 
546*5113495bSYour Name 			BAR_frame
547*5113495bSYour Name 
548*5113495bSYour Name 			Peer_meta_data
549*5113495bSYour Name 
550*5113495bSYour Name 			All other fields shall be set to 0
551*5113495bSYour Name 
552*5113495bSYour Name 
553*5113495bSYour Name 
554*5113495bSYour Name 			<legal all>
555*5113495bSYour Name */
556*5113495bSYour Name #define REO_ENTRANCE_RING_5_FRAMELESS_BAR_OFFSET                     0x00000014
557*5113495bSYour Name #define REO_ENTRANCE_RING_5_FRAMELESS_BAR_LSB                        27
558*5113495bSYour Name #define REO_ENTRANCE_RING_5_FRAMELESS_BAR_MASK                       0x08000000
559*5113495bSYour Name 
560*5113495bSYour Name /* Description		REO_ENTRANCE_RING_5_RESERVED_5A
561*5113495bSYour Name 
562*5113495bSYour Name 			<legal 0>
563*5113495bSYour Name */
564*5113495bSYour Name #define REO_ENTRANCE_RING_5_RESERVED_5A_OFFSET                       0x00000014
565*5113495bSYour Name #define REO_ENTRANCE_RING_5_RESERVED_5A_LSB                          28
566*5113495bSYour Name #define REO_ENTRANCE_RING_5_RESERVED_5A_MASK                         0xf0000000
567*5113495bSYour Name 
568*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON
569*5113495bSYour Name 
570*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
571*5113495bSYour Name 
572*5113495bSYour Name 
573*5113495bSYour Name 
574*5113495bSYour Name 			This field is ignored by REO.
575*5113495bSYour Name 
576*5113495bSYour Name 
577*5113495bSYour Name 
578*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
579*5113495bSYour Name 			pushed this frame to this queue
580*5113495bSYour Name 
581*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
582*5113495bSYour Name 			frame to this queue per received routing instructions. No
583*5113495bSYour Name 			error within RXDMA was detected
584*5113495bSYour Name 
585*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
586*5113495bSYour Name 			result the MSDU link descriptor might not have the
587*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
588*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
589*5113495bSYour Name 			considered a normal condition for this scenario.
590*5113495bSYour Name 
591*5113495bSYour Name 
592*5113495bSYour Name 
593*5113495bSYour Name 			<legal 0 - 2>
594*5113495bSYour Name */
595*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON_OFFSET                 0x00000018
596*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON_LSB                    0
597*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_PUSH_REASON_MASK                   0x00000003
598*5113495bSYour Name 
599*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE
600*5113495bSYour Name 
601*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
602*5113495bSYour Name 			'rxdma_error_detected'.
603*5113495bSYour Name 
604*5113495bSYour Name 
605*5113495bSYour Name 
606*5113495bSYour Name 			This field is ignored by REO.
607*5113495bSYour Name 
608*5113495bSYour Name 
609*5113495bSYour Name 
610*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
611*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
612*5113495bSYour Name 
613*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
614*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
615*5113495bSYour Name 
616*5113495bSYour Name 
617*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
618*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
619*5113495bSYour Name 			a valid corresponding key id in the peer entry.
620*5113495bSYour Name 
621*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
622*5113495bSYour Name 			error
623*5113495bSYour Name 
624*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
625*5113495bSYour Name 			unencrypted frame error when encrypted was expected
626*5113495bSYour Name 
627*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
628*5113495bSYour Name 			length error
629*5113495bSYour Name 
630*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
631*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
632*5113495bSYour Name 
633*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
634*5113495bSYour Name 			error
635*5113495bSYour Name 
636*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
637*5113495bSYour Name 			parsing error
638*5113495bSYour Name 
639*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
640*5113495bSYour Name 			during SA search
641*5113495bSYour Name 
642*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
643*5113495bSYour Name 			during DA search
644*5113495bSYour Name 
645*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
646*5113495bSYour Name 			timeout during flow search
647*5113495bSYour Name 
648*5113495bSYour Name 			<enum 13 Rxdma_flush_request>RXDMA received a flush
649*5113495bSYour Name 			request
650*5113495bSYour Name */
651*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE_OFFSET                  0x00000018
652*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE_LSB                     2
653*5113495bSYour Name #define REO_ENTRANCE_RING_6_RXDMA_ERROR_CODE_MASK                    0x0000007c
654*5113495bSYour Name 
655*5113495bSYour Name /* Description		REO_ENTRANCE_RING_6_RESERVED_6A
656*5113495bSYour Name 
657*5113495bSYour Name 			<legal 0>
658*5113495bSYour Name */
659*5113495bSYour Name #define REO_ENTRANCE_RING_6_RESERVED_6A_OFFSET                       0x00000018
660*5113495bSYour Name #define REO_ENTRANCE_RING_6_RESERVED_6A_LSB                          7
661*5113495bSYour Name #define REO_ENTRANCE_RING_6_RESERVED_6A_MASK                         0xffffff80
662*5113495bSYour Name 
663*5113495bSYour Name /* Description		REO_ENTRANCE_RING_7_RESERVED_7A
664*5113495bSYour Name 
665*5113495bSYour Name 			<legal 0>
666*5113495bSYour Name */
667*5113495bSYour Name #define REO_ENTRANCE_RING_7_RESERVED_7A_OFFSET                       0x0000001c
668*5113495bSYour Name #define REO_ENTRANCE_RING_7_RESERVED_7A_LSB                          0
669*5113495bSYour Name #define REO_ENTRANCE_RING_7_RESERVED_7A_MASK                         0x000fffff
670*5113495bSYour Name 
671*5113495bSYour Name /* Description		REO_ENTRANCE_RING_7_RING_ID
672*5113495bSYour Name 
673*5113495bSYour Name 			Consumer: SW/REO/DEBUG
674*5113495bSYour Name 
675*5113495bSYour Name 			Producer: SRNG (of RXDMA)
676*5113495bSYour Name 
677*5113495bSYour Name 
678*5113495bSYour Name 
679*5113495bSYour Name 			For debugging.
680*5113495bSYour Name 
681*5113495bSYour Name 			This field is filled in by the SRNG module.
682*5113495bSYour Name 
683*5113495bSYour Name 			It help to identify the ring that is being looked <legal
684*5113495bSYour Name 			all>
685*5113495bSYour Name */
686*5113495bSYour Name #define REO_ENTRANCE_RING_7_RING_ID_OFFSET                           0x0000001c
687*5113495bSYour Name #define REO_ENTRANCE_RING_7_RING_ID_LSB                              20
688*5113495bSYour Name #define REO_ENTRANCE_RING_7_RING_ID_MASK                             0x0ff00000
689*5113495bSYour Name 
690*5113495bSYour Name /* Description		REO_ENTRANCE_RING_7_LOOPING_COUNT
691*5113495bSYour Name 
692*5113495bSYour Name 			Consumer: SW/REO/DEBUG
693*5113495bSYour Name 
694*5113495bSYour Name 			Producer: SRNG (of RXDMA)
695*5113495bSYour Name 
696*5113495bSYour Name 
697*5113495bSYour Name 
698*5113495bSYour Name 			For debugging.
699*5113495bSYour Name 
700*5113495bSYour Name 			This field is filled in by the SRNG module.
701*5113495bSYour Name 
702*5113495bSYour Name 
703*5113495bSYour Name 
704*5113495bSYour Name 			A count value that indicates the number of times the
705*5113495bSYour Name 			producer of entries into this Ring has looped around the
706*5113495bSYour Name 			ring.
707*5113495bSYour Name 
708*5113495bSYour Name 			At initialization time, this value is set to 0. On the
709*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
710*5113495bSYour Name 			reached allowed by the number of bits for this field, the
711*5113495bSYour Name 			count value continues with 0 again.
712*5113495bSYour Name 
713*5113495bSYour Name 
714*5113495bSYour Name 
715*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
716*5113495bSYour Name 			use this field to figure out up to where the producer of
717*5113495bSYour Name 			entries has created new entries. This eliminates the need to
718*5113495bSYour Name 			check where the head pointer' of the ring is located once
719*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
720*5113495bSYour Name 			entries have been put into this ring...
721*5113495bSYour Name 
722*5113495bSYour Name 
723*5113495bSYour Name 
724*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
725*5113495bSYour Name 			LSB bit of this count value.
726*5113495bSYour Name 
727*5113495bSYour Name 			<legal all>
728*5113495bSYour Name */
729*5113495bSYour Name #define REO_ENTRANCE_RING_7_LOOPING_COUNT_OFFSET                     0x0000001c
730*5113495bSYour Name #define REO_ENTRANCE_RING_7_LOOPING_COUNT_LSB                        28
731*5113495bSYour Name #define REO_ENTRANCE_RING_7_LOOPING_COUNT_MASK                       0xf0000000
732*5113495bSYour Name 
733*5113495bSYour Name 
734*5113495bSYour Name #endif // _REO_ENTRANCE_RING_H_
735