xref: /wlan-driver/fw-api/hw/qcn6122/sw_monitor_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name #ifndef _SW_MONITOR_RING_H_
18*5113495bSYour Name #define _SW_MONITOR_RING_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "rx_mpdu_details.h"
23*5113495bSYour Name #include "buffer_addr_info.h"
24*5113495bSYour Name 
25*5113495bSYour Name // ################ START SUMMARY #################
26*5113495bSYour Name //
27*5113495bSYour Name //	Dword	Fields
28*5113495bSYour Name //	0-3	struct rx_mpdu_details reo_level_mpdu_frame_info;
29*5113495bSYour Name //	4-5	struct buffer_addr_info status_buff_addr_info;
30*5113495bSYour Name //	6	rxdma_push_reason[1:0], rxdma_error_code[6:2], mpdu_fragment_number[10:7], frameless_bar[11], status_buf_count[15:12], end_of_ppdu[16], reserved_6a[31:17]
31*5113495bSYour Name //	7	phy_ppdu_id[15:0], reserved_7a[19:16], ring_id[27:20], looping_count[31:28]
32*5113495bSYour Name //
33*5113495bSYour Name // ################ END SUMMARY #################
34*5113495bSYour Name 
35*5113495bSYour Name #define NUM_OF_DWORDS_SW_MONITOR_RING 8
36*5113495bSYour Name 
37*5113495bSYour Name struct sw_monitor_ring {
38*5113495bSYour Name     struct            rx_mpdu_details                       reo_level_mpdu_frame_info;
39*5113495bSYour Name     struct            buffer_addr_info                       status_buff_addr_info;
40*5113495bSYour Name              uint32_t rxdma_push_reason               :  2, //[1:0]
41*5113495bSYour Name                       rxdma_error_code                :  5, //[6:2]
42*5113495bSYour Name                       mpdu_fragment_number            :  4, //[10:7]
43*5113495bSYour Name                       frameless_bar                   :  1, //[11]
44*5113495bSYour Name                       status_buf_count                :  4, //[15:12]
45*5113495bSYour Name                       end_of_ppdu                     :  1, //[16]
46*5113495bSYour Name                       reserved_6a                     : 15; //[31:17]
47*5113495bSYour Name              uint32_t phy_ppdu_id                     : 16, //[15:0]
48*5113495bSYour Name                       reserved_7a                     :  4, //[19:16]
49*5113495bSYour Name                       ring_id                         :  8, //[27:20]
50*5113495bSYour Name                       looping_count                   :  4; //[31:28]
51*5113495bSYour Name };
52*5113495bSYour Name 
53*5113495bSYour Name /*
54*5113495bSYour Name 
55*5113495bSYour Name struct rx_mpdu_details reo_level_mpdu_frame_info
56*5113495bSYour Name 
57*5113495bSYour Name 			Consumer: SW
58*5113495bSYour Name 
59*5113495bSYour Name 			Producer: RXDMA
60*5113495bSYour Name 
61*5113495bSYour Name 
62*5113495bSYour Name 
63*5113495bSYour Name 			Details related to the MPDU being pushed to SW, valid
64*5113495bSYour Name 			only if end_of_ppdu is set to 0
65*5113495bSYour Name 
66*5113495bSYour Name struct buffer_addr_info status_buff_addr_info
67*5113495bSYour Name 
68*5113495bSYour Name 			Consumer: SW
69*5113495bSYour Name 
70*5113495bSYour Name 			Producer: RXDMA
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 			Details of the physical address of the first status
75*5113495bSYour Name 			buffer used for the PPDU (either the PPDU that included the
76*5113495bSYour Name 			MPDU being pushed to SW if end_of_ppdu = 0, or the PPDU
77*5113495bSYour Name 			whose end is indicated through end_of_ppdu = 1)
78*5113495bSYour Name 
79*5113495bSYour Name rxdma_push_reason
80*5113495bSYour Name 
81*5113495bSYour Name 			Indicates why RXDMA pushed the frame to this ring
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
86*5113495bSYour Name 			pushed this frame to this queue
87*5113495bSYour Name 
88*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
89*5113495bSYour Name 			frame to this queue per received routing instructions. No
90*5113495bSYour Name 			error within RXDMA was detected
91*5113495bSYour Name 
92*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
93*5113495bSYour Name 			result the MSDU link descriptor might not have the
94*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
95*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
96*5113495bSYour Name 			considered a normal condition for this scenario.
97*5113495bSYour Name 
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name 			<legal 0 - 2>
101*5113495bSYour Name 
102*5113495bSYour Name rxdma_error_code
103*5113495bSYour Name 
104*5113495bSYour Name 			Field only valid when rxdma_push_reason is set to
105*5113495bSYour Name 			'rxdma_error_detected.'
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
110*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
111*5113495bSYour Name 
112*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
113*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
117*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
118*5113495bSYour Name 			a valid corresponding key id in the peer entry.
119*5113495bSYour Name 
120*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
121*5113495bSYour Name 			error
122*5113495bSYour Name 
123*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
124*5113495bSYour Name 			unencrypted frame error when encrypted was expected
125*5113495bSYour Name 
126*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
127*5113495bSYour Name 			length error
128*5113495bSYour Name 
129*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
130*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
133*5113495bSYour Name 			error
134*5113495bSYour Name 
135*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
136*5113495bSYour Name 			parsing error
137*5113495bSYour Name 
138*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
139*5113495bSYour Name 			during SA search
140*5113495bSYour Name 
141*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
142*5113495bSYour Name 			during DA search
143*5113495bSYour Name 
144*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
145*5113495bSYour Name 			timeout during flow search
146*5113495bSYour Name 
147*5113495bSYour Name 			<enum 13 rxdma_flush_request>RXDMA received a flush
148*5113495bSYour Name 			request
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
151*5113495bSYour Name 			present as well as a fragmented MPDU. A-MSDU defragmentation
152*5113495bSYour Name 			is not supported in Lithium SW so this is treated as an
153*5113495bSYour Name 			error.
154*5113495bSYour Name 
155*5113495bSYour Name mpdu_fragment_number
156*5113495bSYour Name 
157*5113495bSYour Name 			Field only valid when Reo_level_mpdu_frame_info.
158*5113495bSYour Name 			Rx_mpdu_desc_info_details.Fragment_flag is set and
159*5113495bSYour Name 			end_of_ppdu is set to 0.
160*5113495bSYour Name 
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name 			The fragment number from the 802.11 header.
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name 
167*5113495bSYour Name 			Note that the sequence number is embedded in the field:
168*5113495bSYour Name 			Reo_level_mpdu_frame_info. Rx_mpdu_desc_info_details.
169*5113495bSYour Name 			Mpdu_sequence_number
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name 			<legal all>
174*5113495bSYour Name 
175*5113495bSYour Name frameless_bar
176*5113495bSYour Name 
177*5113495bSYour Name 			When set, this SW monitor ring struct contains BAR info
178*5113495bSYour Name 			from a multi TID BAR frame. The original multi TID BAR frame
179*5113495bSYour Name 			itself contained all the REO info for the first TID, but all
180*5113495bSYour Name 			the subsequent TID info and their linkage to the REO
181*5113495bSYour Name 			descriptors is passed down as 'frameless' BAR info.
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name 			The only fields valid in this descriptor when this bit
186*5113495bSYour Name 			is within the
187*5113495bSYour Name 
188*5113495bSYour Name 			Reo_level_mpdu_frame_info:
189*5113495bSYour Name 
190*5113495bSYour Name 			   Within Rx_mpdu_desc_info_details:
191*5113495bSYour Name 
192*5113495bSYour Name 			Mpdu_Sequence_number
193*5113495bSYour Name 
194*5113495bSYour Name 			BAR_frame
195*5113495bSYour Name 
196*5113495bSYour Name 			Peer_meta_data
197*5113495bSYour Name 
198*5113495bSYour Name 			All other fields shall be set to 0.
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name 
202*5113495bSYour Name 			<legal all>
203*5113495bSYour Name 
204*5113495bSYour Name status_buf_count
205*5113495bSYour Name 
206*5113495bSYour Name 			A count of status buffers used so far for the PPDU
207*5113495bSYour Name 			(either the PPDU that included the MPDU being pushed to SW
208*5113495bSYour Name 			if end_of_ppdu = 0, or the PPDU whose end is indicated
209*5113495bSYour Name 			through end_of_ppdu = 1)
210*5113495bSYour Name 
211*5113495bSYour Name end_of_ppdu
212*5113495bSYour Name 
213*5113495bSYour Name 			Pine RXDMA can be configured to generate a separate
214*5113495bSYour Name 			'SW_MONITOR_RING' descriptor at the end of a PPDU (either
215*5113495bSYour Name 			through an 'RX_PPDU_END' TLV or through an 'RX_FLUSH') to
216*5113495bSYour Name 			demarcate PPDUs.
217*5113495bSYour Name 
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name 			For such a descriptor, this bit is set to 1 and fields
221*5113495bSYour Name 			Reo_level_mpdu_frame_info, mpdu_fragment_number and
222*5113495bSYour Name 			Frameless_bar are all set to 0.
223*5113495bSYour Name 
224*5113495bSYour Name 
225*5113495bSYour Name 
226*5113495bSYour Name 			Otherwise this bit is set to 0.
227*5113495bSYour Name 
228*5113495bSYour Name reserved_6a
229*5113495bSYour Name 
230*5113495bSYour Name 			<legal 0>
231*5113495bSYour Name 
232*5113495bSYour Name phy_ppdu_id
233*5113495bSYour Name 
234*5113495bSYour Name 			A PPDU counter value that PHY increments for every PPDU
235*5113495bSYour Name 			received
236*5113495bSYour Name 
237*5113495bSYour Name 			The counter value wraps around. Pine RXDMA can be
238*5113495bSYour Name 			configured to copy this from the RX_PPDU_START TLV for every
239*5113495bSYour Name 			output descriptor.
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name 
243*5113495bSYour Name 			<legal all>
244*5113495bSYour Name 
245*5113495bSYour Name reserved_7a
246*5113495bSYour Name 
247*5113495bSYour Name 			<legal 0>
248*5113495bSYour Name 
249*5113495bSYour Name ring_id
250*5113495bSYour Name 
251*5113495bSYour Name 			Consumer: SW/REO/DEBUG
252*5113495bSYour Name 
253*5113495bSYour Name 			Producer: SRNG (of RXDMA)
254*5113495bSYour Name 
255*5113495bSYour Name 
256*5113495bSYour Name 
257*5113495bSYour Name 			For debugging.
258*5113495bSYour Name 
259*5113495bSYour Name 			This field is filled in by the SRNG module.
260*5113495bSYour Name 
261*5113495bSYour Name 			It help to identify the ring that is being looked <legal
262*5113495bSYour Name 			all>
263*5113495bSYour Name 
264*5113495bSYour Name looping_count
265*5113495bSYour Name 
266*5113495bSYour Name 			Consumer: SW/REO/DEBUG
267*5113495bSYour Name 
268*5113495bSYour Name 			Producer: SRNG (of RXDMA)
269*5113495bSYour Name 
270*5113495bSYour Name 
271*5113495bSYour Name 
272*5113495bSYour Name 			For debugging.
273*5113495bSYour Name 
274*5113495bSYour Name 			This field is filled in by the SRNG module.
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 
278*5113495bSYour Name 			A count value that indicates the number of times the
279*5113495bSYour Name 			producer of entries into this Ring has looped around the
280*5113495bSYour Name 			ring.
281*5113495bSYour Name 
282*5113495bSYour Name 			At initialization time, this value is set to 0. On the
283*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
284*5113495bSYour Name 			reached allowed by the number of bits for this field, the
285*5113495bSYour Name 			count value continues with 0 again.
286*5113495bSYour Name 
287*5113495bSYour Name 
288*5113495bSYour Name 
289*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
290*5113495bSYour Name 			use this field to figure out up to where the producer of
291*5113495bSYour Name 			entries has created new entries. This eliminates the need to
292*5113495bSYour Name 			check where the head pointer' of the ring is located once
293*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
294*5113495bSYour Name 			entries have been put into this ring...
295*5113495bSYour Name 
296*5113495bSYour Name 
297*5113495bSYour Name 
298*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
299*5113495bSYour Name 			LSB bit of this count value.
300*5113495bSYour Name 
301*5113495bSYour Name 			<legal all>
302*5113495bSYour Name */
303*5113495bSYour Name 
304*5113495bSYour Name 
305*5113495bSYour Name  /* EXTERNAL REFERENCE : struct rx_mpdu_details reo_level_mpdu_frame_info */
306*5113495bSYour Name 
307*5113495bSYour Name 
308*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info msdu_link_desc_addr_info */
309*5113495bSYour Name 
310*5113495bSYour Name 
311*5113495bSYour Name /* Description		SW_MONITOR_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0
312*5113495bSYour Name 
313*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
314*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
315*5113495bSYour Name 
316*5113495bSYour Name 
317*5113495bSYour Name 
318*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
319*5113495bSYour Name 
320*5113495bSYour Name 			<legal all>
321*5113495bSYour Name */
322*5113495bSYour Name #define SW_MONITOR_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
323*5113495bSYour Name #define SW_MONITOR_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
324*5113495bSYour Name #define SW_MONITOR_RING_0_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
325*5113495bSYour Name 
326*5113495bSYour Name /* Description		SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32
327*5113495bSYour Name 
328*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
329*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
330*5113495bSYour Name 
331*5113495bSYour Name 
332*5113495bSYour Name 
333*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
334*5113495bSYour Name 
335*5113495bSYour Name 			<legal all>
336*5113495bSYour Name */
337*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
338*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
339*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
340*5113495bSYour Name 
341*5113495bSYour Name /* Description		SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER
342*5113495bSYour Name 
343*5113495bSYour Name 			Consumer: WBM
344*5113495bSYour Name 
345*5113495bSYour Name 			Producer: SW/FW
346*5113495bSYour Name 
347*5113495bSYour Name 
348*5113495bSYour Name 
349*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
350*5113495bSYour Name 
351*5113495bSYour Name 
352*5113495bSYour Name 
353*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
354*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
355*5113495bSYour Name 			pointed to shall be returned after the frame has been
356*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
357*5113495bSYour Name 
358*5113495bSYour Name 
359*5113495bSYour Name 
360*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
361*5113495bSYour Name 			to the WMB buffer idle list
362*5113495bSYour Name 
363*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
364*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
365*5113495bSYour Name 
366*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
367*5113495bSYour Name 
368*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
369*5113495bSYour Name 			ring 0
370*5113495bSYour Name 
371*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
372*5113495bSYour Name 			ring 1
373*5113495bSYour Name 
374*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
375*5113495bSYour Name 			ring 2
376*5113495bSYour Name 
377*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
378*5113495bSYour Name 			ring 3
379*5113495bSYour Name 
380*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
381*5113495bSYour Name 			ring 4
382*5113495bSYour Name 
383*5113495bSYour Name 
384*5113495bSYour Name 
385*5113495bSYour Name 			<legal all>
386*5113495bSYour Name */
387*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
388*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
389*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000700
390*5113495bSYour Name 
391*5113495bSYour Name /* Description		SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE
392*5113495bSYour Name 
393*5113495bSYour Name 			Cookie field exclusively used by SW.
394*5113495bSYour Name 
395*5113495bSYour Name 
396*5113495bSYour Name 
397*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
398*5113495bSYour Name 
399*5113495bSYour Name 
400*5113495bSYour Name 
401*5113495bSYour Name 			HW ignores the contents, accept that it passes the
402*5113495bSYour Name 			programmed value on to other descriptors together with the
403*5113495bSYour Name 			physical address
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name 
407*5113495bSYour Name 			Field can be used by SW to for example associate the
408*5113495bSYour Name 			buffers physical address with the virtual address
409*5113495bSYour Name 
410*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
411*5113495bSYour Name 			specification
412*5113495bSYour Name 
413*5113495bSYour Name 
414*5113495bSYour Name 
415*5113495bSYour Name 			NOTE1:
416*5113495bSYour Name 
417*5113495bSYour Name 			The three most significant bits can have a special
418*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
419*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
420*5113495bSYour Name 
421*5113495bSYour Name 
422*5113495bSYour Name 
423*5113495bSYour Name 			In case of NON punctured transmission:
424*5113495bSYour Name 
425*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
426*5113495bSYour Name 
427*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
428*5113495bSYour Name 
429*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
430*5113495bSYour Name 
431*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
432*5113495bSYour Name 
433*5113495bSYour Name 
434*5113495bSYour Name 
435*5113495bSYour Name 			In case of punctured transmission:
436*5113495bSYour Name 
437*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
438*5113495bSYour Name 
439*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
440*5113495bSYour Name 
441*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
442*5113495bSYour Name 
443*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
444*5113495bSYour Name 
445*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
446*5113495bSYour Name 
447*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
448*5113495bSYour Name 
449*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
450*5113495bSYour Name 
451*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 
455*5113495bSYour Name 			Note: a punctured transmission is indicated by the
456*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
457*5113495bSYour Name 			TLV
458*5113495bSYour Name 
459*5113495bSYour Name 
460*5113495bSYour Name 
461*5113495bSYour Name 			NOTE 2:The five most significant bits can have a special
462*5113495bSYour Name 			meaning in case this struct is embedded in an
463*5113495bSYour Name 			RX_MSDU_DETAILS STRUCT, and Maple/Spruce Rx DMA is
464*5113495bSYour Name 			configured for passing on the additional info
465*5113495bSYour Name 			from 'RX_MPDU_INFO' structure in 'RX_MPDU_START' TLV
466*5113495bSYour Name 			(FR56821). This is not supported in HastingsPrime, Pine or
467*5113495bSYour Name 			Moselle.
468*5113495bSYour Name 
469*5113495bSYour Name 
470*5113495bSYour Name 
471*5113495bSYour Name 			Sw_buffer_cookie[20:17]: Tid: The TID field in the QoS
472*5113495bSYour Name 			control field
473*5113495bSYour Name 
474*5113495bSYour Name 
475*5113495bSYour Name 
476*5113495bSYour Name 			Sw_buffer_cookie[16]: Mpdu_qos_control_valid: This field
477*5113495bSYour Name 			indicates MPDUs with a QoS control field.
478*5113495bSYour Name 
479*5113495bSYour Name 
480*5113495bSYour Name 
481*5113495bSYour Name 
482*5113495bSYour Name 
483*5113495bSYour Name 			<legal all>
484*5113495bSYour Name */
485*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
486*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB 11
487*5113495bSYour Name #define SW_MONITOR_RING_1_REO_LEVEL_MPDU_FRAME_INFO_MSDU_LINK_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff800
488*5113495bSYour Name 
489*5113495bSYour Name  /* EXTERNAL REFERENCE : struct rx_mpdu_desc_info rx_mpdu_desc_info_details */
490*5113495bSYour Name 
491*5113495bSYour Name 
492*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT
493*5113495bSYour Name 
494*5113495bSYour Name 			Consumer: REO/SW/FW
495*5113495bSYour Name 
496*5113495bSYour Name 			Producer: RXDMA
497*5113495bSYour Name 
498*5113495bSYour Name 
499*5113495bSYour Name 
500*5113495bSYour Name 			The number of MSDUs within the MPDU
501*5113495bSYour Name 
502*5113495bSYour Name 			<legal all>
503*5113495bSYour Name */
504*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_OFFSET 0x00000008
505*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_LSB 0
506*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MASK 0x000000ff
507*5113495bSYour Name 
508*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER
509*5113495bSYour Name 
510*5113495bSYour Name 			Consumer: REO/SW/FW
511*5113495bSYour Name 
512*5113495bSYour Name 			Producer: RXDMA
513*5113495bSYour Name 
514*5113495bSYour Name 
515*5113495bSYour Name 
516*5113495bSYour Name 			The field can have two different meanings based on the
517*5113495bSYour Name 			setting of field 'BAR_frame':
518*5113495bSYour Name 
519*5113495bSYour Name 
520*5113495bSYour Name 
521*5113495bSYour Name 			'BAR_frame' is NOT set:
522*5113495bSYour Name 
523*5113495bSYour Name 			The MPDU sequence number of the received frame.
524*5113495bSYour Name 
525*5113495bSYour Name 
526*5113495bSYour Name 
527*5113495bSYour Name 			'BAR_frame' is set.
528*5113495bSYour Name 
529*5113495bSYour Name 			The MPDU Start sequence number from the BAR frame
530*5113495bSYour Name 
531*5113495bSYour Name 			<legal all>
532*5113495bSYour Name */
533*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_OFFSET 0x00000008
534*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_LSB 8
535*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_SEQUENCE_NUMBER_MASK 0x000fff00
536*5113495bSYour Name 
537*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG
538*5113495bSYour Name 
539*5113495bSYour Name 			Consumer: REO/SW/FW
540*5113495bSYour Name 
541*5113495bSYour Name 			Producer: RXDMA
542*5113495bSYour Name 
543*5113495bSYour Name 
544*5113495bSYour Name 
545*5113495bSYour Name 			When set, this MPDU is a fragment and REO should forward
546*5113495bSYour Name 			this fragment MPDU to the REO destination ring without any
547*5113495bSYour Name 			reorder checks, pn checks or bitmap update. This implies
548*5113495bSYour Name 			that REO is forwarding the pointer to the MSDU link
549*5113495bSYour Name 			descriptor. The destination ring is coming from a
550*5113495bSYour Name 			programmable register setting in REO
551*5113495bSYour Name 
552*5113495bSYour Name 
553*5113495bSYour Name 
554*5113495bSYour Name 			<legal all>
555*5113495bSYour Name */
556*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_OFFSET 0x00000008
557*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_LSB 20
558*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MASK 0x00100000
559*5113495bSYour Name 
560*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT
561*5113495bSYour Name 
562*5113495bSYour Name 			Consumer: REO/SW/FW
563*5113495bSYour Name 
564*5113495bSYour Name 			Producer: RXDMA
565*5113495bSYour Name 
566*5113495bSYour Name 
567*5113495bSYour Name 
568*5113495bSYour Name 			The retry bit setting from the MPDU header of the
569*5113495bSYour Name 			received frame
570*5113495bSYour Name 
571*5113495bSYour Name 			<legal all>
572*5113495bSYour Name */
573*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_OFFSET 0x00000008
574*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_LSB 21
575*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MASK 0x00200000
576*5113495bSYour Name 
577*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG
578*5113495bSYour Name 
579*5113495bSYour Name 			Consumer: REO/SW/FW
580*5113495bSYour Name 
581*5113495bSYour Name 			Producer: RXDMA
582*5113495bSYour Name 
583*5113495bSYour Name 
584*5113495bSYour Name 
585*5113495bSYour Name 			When set, the MPDU was received as part of an A-MPDU.
586*5113495bSYour Name 
587*5113495bSYour Name 			<legal all>
588*5113495bSYour Name */
589*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_OFFSET 0x00000008
590*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_LSB 22
591*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MASK 0x00400000
592*5113495bSYour Name 
593*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME
594*5113495bSYour Name 
595*5113495bSYour Name 			Consumer: REO/SW/FW
596*5113495bSYour Name 
597*5113495bSYour Name 			Producer: RXDMA
598*5113495bSYour Name 
599*5113495bSYour Name 
600*5113495bSYour Name 
601*5113495bSYour Name 			When set, the received frame is a BAR frame. After
602*5113495bSYour Name 			processing, this frame shall be pushed to SW or deleted.
603*5113495bSYour Name 
604*5113495bSYour Name 			<legal all>
605*5113495bSYour Name */
606*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_OFFSET 0x00000008
607*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_LSB 23
608*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MASK 0x00800000
609*5113495bSYour Name 
610*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO
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 			Copied here by RXDMA from RX_MPDU_END
619*5113495bSYour Name 
620*5113495bSYour Name 			When not set, REO will Not perform a PN sequence number
621*5113495bSYour Name 			check
622*5113495bSYour Name */
623*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET 0x00000008
624*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_LSB 24
625*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MASK 0x01000000
626*5113495bSYour Name 
627*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID
628*5113495bSYour Name 
629*5113495bSYour Name 			When set, OLE found a valid SA entry for all MSDUs in
630*5113495bSYour Name 			this MPDU
631*5113495bSYour Name 
632*5113495bSYour Name 			<legal all>
633*5113495bSYour Name */
634*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_OFFSET 0x00000008
635*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_LSB 25
636*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IS_VALID_MASK 0x02000000
637*5113495bSYour Name 
638*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT
639*5113495bSYour Name 
640*5113495bSYour Name 			When set, at least 1 MSDU within the MPDU has an
641*5113495bSYour Name 			unsuccessful MAC source address search due to the expiration
642*5113495bSYour Name 			of the search timer.
643*5113495bSYour Name 
644*5113495bSYour Name 			<legal all>
645*5113495bSYour Name */
646*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_OFFSET 0x00000008
647*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_LSB 26
648*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_SA_IDX_TIMEOUT_MASK 0x04000000
649*5113495bSYour Name 
650*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID
651*5113495bSYour Name 
652*5113495bSYour Name 			When set, OLE found a valid DA entry for all MSDUs in
653*5113495bSYour Name 			this MPDU
654*5113495bSYour Name 
655*5113495bSYour Name 			<legal all>
656*5113495bSYour Name */
657*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_OFFSET 0x00000008
658*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_LSB 27
659*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_VALID_MASK 0x08000000
660*5113495bSYour Name 
661*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC
662*5113495bSYour Name 
663*5113495bSYour Name 			Field Only valid if da_is_valid is set
664*5113495bSYour Name 
665*5113495bSYour Name 
666*5113495bSYour Name 
667*5113495bSYour Name 			When set, at least one of the DA addresses is a
668*5113495bSYour Name 			Multicast or Broadcast address.
669*5113495bSYour Name 
670*5113495bSYour Name 			<legal all>
671*5113495bSYour Name */
672*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_OFFSET 0x00000008
673*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_LSB 28
674*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IS_MCBC_MASK 0x10000000
675*5113495bSYour Name 
676*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT
677*5113495bSYour Name 
678*5113495bSYour Name 			When set, at least 1 MSDU within the MPDU has an
679*5113495bSYour Name 			unsuccessful MAC destination address search due to the
680*5113495bSYour Name 			expiration of the search timer.
681*5113495bSYour Name 
682*5113495bSYour Name 			<legal all>
683*5113495bSYour Name */
684*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_OFFSET 0x00000008
685*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_LSB 29
686*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_DA_IDX_TIMEOUT_MASK 0x20000000
687*5113495bSYour Name 
688*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU
689*5113495bSYour Name 
690*5113495bSYour Name 			Field only valid when first_msdu_in_mpdu_flag is set.
691*5113495bSYour Name 
692*5113495bSYour Name 
693*5113495bSYour Name 
694*5113495bSYour Name 			When set, the contents in the MSDU buffer contains a
695*5113495bSYour Name 			'RAW' MPDU. This 'RAW' MPDU might be spread out over
696*5113495bSYour Name 			multiple MSDU buffers.
697*5113495bSYour Name 
698*5113495bSYour Name 			<legal all>
699*5113495bSYour Name */
700*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_OFFSET 0x00000008
701*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_LSB 30
702*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MASK 0x40000000
703*5113495bSYour Name 
704*5113495bSYour Name /* Description		SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG
705*5113495bSYour Name 
706*5113495bSYour Name 			The More Fragment bit setting from the MPDU header of
707*5113495bSYour Name 			the received frame
708*5113495bSYour Name 
709*5113495bSYour Name 
710*5113495bSYour Name 
711*5113495bSYour Name 			<legal all>
712*5113495bSYour Name */
713*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_OFFSET 0x00000008
714*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_LSB 31
715*5113495bSYour Name #define SW_MONITOR_RING_2_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MASK 0x80000000
716*5113495bSYour Name 
717*5113495bSYour Name /* Description		SW_MONITOR_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA
718*5113495bSYour Name 
719*5113495bSYour Name 			Meta data that SW has programmed in the Peer table entry
720*5113495bSYour Name 			of the transmitting STA.
721*5113495bSYour Name 
722*5113495bSYour Name 			<legal all>
723*5113495bSYour Name */
724*5113495bSYour Name #define SW_MONITOR_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_OFFSET 0x0000000c
725*5113495bSYour Name #define SW_MONITOR_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_LSB 0
726*5113495bSYour Name #define SW_MONITOR_RING_3_REO_LEVEL_MPDU_FRAME_INFO_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MASK 0xffffffff
727*5113495bSYour Name 
728*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info status_buff_addr_info */
729*5113495bSYour Name 
730*5113495bSYour Name 
731*5113495bSYour Name /* Description		SW_MONITOR_RING_4_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_31_0
732*5113495bSYour Name 
733*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
734*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
735*5113495bSYour Name 
736*5113495bSYour Name 
737*5113495bSYour Name 
738*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
739*5113495bSYour Name 
740*5113495bSYour Name 			<legal all>
741*5113495bSYour Name */
742*5113495bSYour Name #define SW_MONITOR_RING_4_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000010
743*5113495bSYour Name #define SW_MONITOR_RING_4_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
744*5113495bSYour Name #define SW_MONITOR_RING_4_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
745*5113495bSYour Name 
746*5113495bSYour Name /* Description		SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_39_32
747*5113495bSYour Name 
748*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
749*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
750*5113495bSYour Name 
751*5113495bSYour Name 
752*5113495bSYour Name 
753*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
754*5113495bSYour Name 
755*5113495bSYour Name 			<legal all>
756*5113495bSYour Name */
757*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000014
758*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
759*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
760*5113495bSYour Name 
761*5113495bSYour Name /* Description		SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_RETURN_BUFFER_MANAGER
762*5113495bSYour Name 
763*5113495bSYour Name 			Consumer: WBM
764*5113495bSYour Name 
765*5113495bSYour Name 			Producer: SW/FW
766*5113495bSYour Name 
767*5113495bSYour Name 
768*5113495bSYour Name 
769*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
770*5113495bSYour Name 
771*5113495bSYour Name 
772*5113495bSYour Name 
773*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
774*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
775*5113495bSYour Name 			pointed to shall be returned after the frame has been
776*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
777*5113495bSYour Name 
778*5113495bSYour Name 
779*5113495bSYour Name 
780*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
781*5113495bSYour Name 			to the WMB buffer idle list
782*5113495bSYour Name 
783*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
784*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
785*5113495bSYour Name 
786*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
787*5113495bSYour Name 
788*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
789*5113495bSYour Name 			ring 0
790*5113495bSYour Name 
791*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
792*5113495bSYour Name 			ring 1
793*5113495bSYour Name 
794*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
795*5113495bSYour Name 			ring 2
796*5113495bSYour Name 
797*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
798*5113495bSYour Name 			ring 3
799*5113495bSYour Name 
800*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
801*5113495bSYour Name 			ring 4
802*5113495bSYour Name 
803*5113495bSYour Name 
804*5113495bSYour Name 
805*5113495bSYour Name 			<legal all>
806*5113495bSYour Name */
807*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000014
808*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
809*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000700
810*5113495bSYour Name 
811*5113495bSYour Name /* Description		SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_SW_BUFFER_COOKIE
812*5113495bSYour Name 
813*5113495bSYour Name 			Cookie field exclusively used by SW.
814*5113495bSYour Name 
815*5113495bSYour Name 
816*5113495bSYour Name 
817*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
818*5113495bSYour Name 
819*5113495bSYour Name 
820*5113495bSYour Name 
821*5113495bSYour Name 			HW ignores the contents, accept that it passes the
822*5113495bSYour Name 			programmed value on to other descriptors together with the
823*5113495bSYour Name 			physical address
824*5113495bSYour Name 
825*5113495bSYour Name 
826*5113495bSYour Name 
827*5113495bSYour Name 			Field can be used by SW to for example associate the
828*5113495bSYour Name 			buffers physical address with the virtual address
829*5113495bSYour Name 
830*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
831*5113495bSYour Name 			specification
832*5113495bSYour Name 
833*5113495bSYour Name 
834*5113495bSYour Name 
835*5113495bSYour Name 			NOTE1:
836*5113495bSYour Name 
837*5113495bSYour Name 			The three most significant bits can have a special
838*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
839*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
840*5113495bSYour Name 
841*5113495bSYour Name 
842*5113495bSYour Name 
843*5113495bSYour Name 			In case of NON punctured transmission:
844*5113495bSYour Name 
845*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
846*5113495bSYour Name 
847*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
848*5113495bSYour Name 
849*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
850*5113495bSYour Name 
851*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
852*5113495bSYour Name 
853*5113495bSYour Name 
854*5113495bSYour Name 
855*5113495bSYour Name 			In case of punctured transmission:
856*5113495bSYour Name 
857*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
858*5113495bSYour Name 
859*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
860*5113495bSYour Name 
861*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
862*5113495bSYour Name 
863*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
864*5113495bSYour Name 
865*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
866*5113495bSYour Name 
867*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
868*5113495bSYour Name 
869*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
870*5113495bSYour Name 
871*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
872*5113495bSYour Name 
873*5113495bSYour Name 
874*5113495bSYour Name 
875*5113495bSYour Name 			Note: a punctured transmission is indicated by the
876*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
877*5113495bSYour Name 			TLV
878*5113495bSYour Name 
879*5113495bSYour Name 
880*5113495bSYour Name 
881*5113495bSYour Name 			NOTE 2:The five most significant bits can have a special
882*5113495bSYour Name 			meaning in case this struct is embedded in an
883*5113495bSYour Name 			RX_MSDU_DETAILS STRUCT, and Maple/Spruce Rx DMA is
884*5113495bSYour Name 			configured for passing on the additional info
885*5113495bSYour Name 			from 'RX_MPDU_INFO' structure in 'RX_MPDU_START' TLV
886*5113495bSYour Name 			(FR56821). This is not supported in HastingsPrime, Pine or
887*5113495bSYour Name 			Moselle.
888*5113495bSYour Name 
889*5113495bSYour Name 
890*5113495bSYour Name 
891*5113495bSYour Name 			Sw_buffer_cookie[20:17]: Tid: The TID field in the QoS
892*5113495bSYour Name 			control field
893*5113495bSYour Name 
894*5113495bSYour Name 
895*5113495bSYour Name 
896*5113495bSYour Name 			Sw_buffer_cookie[16]: Mpdu_qos_control_valid: This field
897*5113495bSYour Name 			indicates MPDUs with a QoS control field.
898*5113495bSYour Name 
899*5113495bSYour Name 
900*5113495bSYour Name 
901*5113495bSYour Name 
902*5113495bSYour Name 
903*5113495bSYour Name 			<legal all>
904*5113495bSYour Name */
905*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000014
906*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_SW_BUFFER_COOKIE_LSB 11
907*5113495bSYour Name #define SW_MONITOR_RING_5_STATUS_BUFF_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff800
908*5113495bSYour Name 
909*5113495bSYour Name /* Description		SW_MONITOR_RING_6_RXDMA_PUSH_REASON
910*5113495bSYour Name 
911*5113495bSYour Name 			Indicates why RXDMA pushed the frame to this ring
912*5113495bSYour Name 
913*5113495bSYour Name 
914*5113495bSYour Name 
915*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
916*5113495bSYour Name 			pushed this frame to this queue
917*5113495bSYour Name 
918*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
919*5113495bSYour Name 			frame to this queue per received routing instructions. No
920*5113495bSYour Name 			error within RXDMA was detected
921*5113495bSYour Name 
922*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
923*5113495bSYour Name 			result the MSDU link descriptor might not have the
924*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
925*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
926*5113495bSYour Name 			considered a normal condition for this scenario.
927*5113495bSYour Name 
928*5113495bSYour Name 
929*5113495bSYour Name 
930*5113495bSYour Name 			<legal 0 - 2>
931*5113495bSYour Name */
932*5113495bSYour Name #define SW_MONITOR_RING_6_RXDMA_PUSH_REASON_OFFSET                   0x00000018
933*5113495bSYour Name #define SW_MONITOR_RING_6_RXDMA_PUSH_REASON_LSB                      0
934*5113495bSYour Name #define SW_MONITOR_RING_6_RXDMA_PUSH_REASON_MASK                     0x00000003
935*5113495bSYour Name 
936*5113495bSYour Name /* Description		SW_MONITOR_RING_6_RXDMA_ERROR_CODE
937*5113495bSYour Name 
938*5113495bSYour Name 			Field only valid when rxdma_push_reason is set to
939*5113495bSYour Name 			'rxdma_error_detected.'
940*5113495bSYour Name 
941*5113495bSYour Name 
942*5113495bSYour Name 
943*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
944*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
945*5113495bSYour Name 
946*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
947*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
948*5113495bSYour Name 
949*5113495bSYour Name 
950*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
951*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
952*5113495bSYour Name 			a valid corresponding key id in the peer entry.
953*5113495bSYour Name 
954*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
955*5113495bSYour Name 			error
956*5113495bSYour Name 
957*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
958*5113495bSYour Name 			unencrypted frame error when encrypted was expected
959*5113495bSYour Name 
960*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
961*5113495bSYour Name 			length error
962*5113495bSYour Name 
963*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
964*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
965*5113495bSYour Name 
966*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
967*5113495bSYour Name 			error
968*5113495bSYour Name 
969*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
970*5113495bSYour Name 			parsing error
971*5113495bSYour Name 
972*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
973*5113495bSYour Name 			during SA search
974*5113495bSYour Name 
975*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
976*5113495bSYour Name 			during DA search
977*5113495bSYour Name 
978*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
979*5113495bSYour Name 			timeout during flow search
980*5113495bSYour Name 
981*5113495bSYour Name 			<enum 13 rxdma_flush_request>RXDMA received a flush
982*5113495bSYour Name 			request
983*5113495bSYour Name 
984*5113495bSYour Name 			<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
985*5113495bSYour Name 			present as well as a fragmented MPDU. A-MSDU defragmentation
986*5113495bSYour Name 			is not supported in Lithium SW so this is treated as an
987*5113495bSYour Name 			error.
988*5113495bSYour Name */
989*5113495bSYour Name #define SW_MONITOR_RING_6_RXDMA_ERROR_CODE_OFFSET                    0x00000018
990*5113495bSYour Name #define SW_MONITOR_RING_6_RXDMA_ERROR_CODE_LSB                       2
991*5113495bSYour Name #define SW_MONITOR_RING_6_RXDMA_ERROR_CODE_MASK                      0x0000007c
992*5113495bSYour Name 
993*5113495bSYour Name /* Description		SW_MONITOR_RING_6_MPDU_FRAGMENT_NUMBER
994*5113495bSYour Name 
995*5113495bSYour Name 			Field only valid when Reo_level_mpdu_frame_info.
996*5113495bSYour Name 			Rx_mpdu_desc_info_details.Fragment_flag is set and
997*5113495bSYour Name 			end_of_ppdu is set to 0.
998*5113495bSYour Name 
999*5113495bSYour Name 
1000*5113495bSYour Name 
1001*5113495bSYour Name 			The fragment number from the 802.11 header.
1002*5113495bSYour Name 
1003*5113495bSYour Name 
1004*5113495bSYour Name 
1005*5113495bSYour Name 			Note that the sequence number is embedded in the field:
1006*5113495bSYour Name 			Reo_level_mpdu_frame_info. Rx_mpdu_desc_info_details.
1007*5113495bSYour Name 			Mpdu_sequence_number
1008*5113495bSYour Name 
1009*5113495bSYour Name 
1010*5113495bSYour Name 
1011*5113495bSYour Name 			<legal all>
1012*5113495bSYour Name */
1013*5113495bSYour Name #define SW_MONITOR_RING_6_MPDU_FRAGMENT_NUMBER_OFFSET                0x00000018
1014*5113495bSYour Name #define SW_MONITOR_RING_6_MPDU_FRAGMENT_NUMBER_LSB                   7
1015*5113495bSYour Name #define SW_MONITOR_RING_6_MPDU_FRAGMENT_NUMBER_MASK                  0x00000780
1016*5113495bSYour Name 
1017*5113495bSYour Name /* Description		SW_MONITOR_RING_6_FRAMELESS_BAR
1018*5113495bSYour Name 
1019*5113495bSYour Name 			When set, this SW monitor ring struct contains BAR info
1020*5113495bSYour Name 			from a multi TID BAR frame. The original multi TID BAR frame
1021*5113495bSYour Name 			itself contained all the REO info for the first TID, but all
1022*5113495bSYour Name 			the subsequent TID info and their linkage to the REO
1023*5113495bSYour Name 			descriptors is passed down as 'frameless' BAR info.
1024*5113495bSYour Name 
1025*5113495bSYour Name 
1026*5113495bSYour Name 
1027*5113495bSYour Name 			The only fields valid in this descriptor when this bit
1028*5113495bSYour Name 			is within the
1029*5113495bSYour Name 
1030*5113495bSYour Name 			Reo_level_mpdu_frame_info:
1031*5113495bSYour Name 
1032*5113495bSYour Name 			   Within Rx_mpdu_desc_info_details:
1033*5113495bSYour Name 
1034*5113495bSYour Name 			Mpdu_Sequence_number
1035*5113495bSYour Name 
1036*5113495bSYour Name 			BAR_frame
1037*5113495bSYour Name 
1038*5113495bSYour Name 			Peer_meta_data
1039*5113495bSYour Name 
1040*5113495bSYour Name 			All other fields shall be set to 0.
1041*5113495bSYour Name 
1042*5113495bSYour Name 
1043*5113495bSYour Name 
1044*5113495bSYour Name 			<legal all>
1045*5113495bSYour Name */
1046*5113495bSYour Name #define SW_MONITOR_RING_6_FRAMELESS_BAR_OFFSET                       0x00000018
1047*5113495bSYour Name #define SW_MONITOR_RING_6_FRAMELESS_BAR_LSB                          11
1048*5113495bSYour Name #define SW_MONITOR_RING_6_FRAMELESS_BAR_MASK                         0x00000800
1049*5113495bSYour Name 
1050*5113495bSYour Name /* Description		SW_MONITOR_RING_6_STATUS_BUF_COUNT
1051*5113495bSYour Name 
1052*5113495bSYour Name 			A count of status buffers used so far for the PPDU
1053*5113495bSYour Name 			(either the PPDU that included the MPDU being pushed to SW
1054*5113495bSYour Name 			if end_of_ppdu = 0, or the PPDU whose end is indicated
1055*5113495bSYour Name 			through end_of_ppdu = 1)
1056*5113495bSYour Name */
1057*5113495bSYour Name #define SW_MONITOR_RING_6_STATUS_BUF_COUNT_OFFSET                    0x00000018
1058*5113495bSYour Name #define SW_MONITOR_RING_6_STATUS_BUF_COUNT_LSB                       12
1059*5113495bSYour Name #define SW_MONITOR_RING_6_STATUS_BUF_COUNT_MASK                      0x0000f000
1060*5113495bSYour Name 
1061*5113495bSYour Name /* Description		SW_MONITOR_RING_6_END_OF_PPDU
1062*5113495bSYour Name 
1063*5113495bSYour Name 			Pine RXDMA can be configured to generate a separate
1064*5113495bSYour Name 			'SW_MONITOR_RING' descriptor at the end of a PPDU (either
1065*5113495bSYour Name 			through an 'RX_PPDU_END' TLV or through an 'RX_FLUSH') to
1066*5113495bSYour Name 			demarcate PPDUs.
1067*5113495bSYour Name 
1068*5113495bSYour Name 
1069*5113495bSYour Name 
1070*5113495bSYour Name 			For such a descriptor, this bit is set to 1 and fields
1071*5113495bSYour Name 			Reo_level_mpdu_frame_info, mpdu_fragment_number and
1072*5113495bSYour Name 			Frameless_bar are all set to 0.
1073*5113495bSYour Name 
1074*5113495bSYour Name 
1075*5113495bSYour Name 
1076*5113495bSYour Name 			Otherwise this bit is set to 0.
1077*5113495bSYour Name */
1078*5113495bSYour Name #define SW_MONITOR_RING_6_END_OF_PPDU_OFFSET                         0x00000018
1079*5113495bSYour Name #define SW_MONITOR_RING_6_END_OF_PPDU_LSB                            16
1080*5113495bSYour Name #define SW_MONITOR_RING_6_END_OF_PPDU_MASK                           0x00010000
1081*5113495bSYour Name 
1082*5113495bSYour Name /* Description		SW_MONITOR_RING_6_RESERVED_6A
1083*5113495bSYour Name 
1084*5113495bSYour Name 			<legal 0>
1085*5113495bSYour Name */
1086*5113495bSYour Name #define SW_MONITOR_RING_6_RESERVED_6A_OFFSET                         0x00000018
1087*5113495bSYour Name #define SW_MONITOR_RING_6_RESERVED_6A_LSB                            17
1088*5113495bSYour Name #define SW_MONITOR_RING_6_RESERVED_6A_MASK                           0xfffe0000
1089*5113495bSYour Name 
1090*5113495bSYour Name /* Description		SW_MONITOR_RING_7_PHY_PPDU_ID
1091*5113495bSYour Name 
1092*5113495bSYour Name 			A PPDU counter value that PHY increments for every PPDU
1093*5113495bSYour Name 			received
1094*5113495bSYour Name 
1095*5113495bSYour Name 			The counter value wraps around. Pine RXDMA can be
1096*5113495bSYour Name 			configured to copy this from the RX_PPDU_START TLV for every
1097*5113495bSYour Name 			output descriptor.
1098*5113495bSYour Name 
1099*5113495bSYour Name 
1100*5113495bSYour Name 
1101*5113495bSYour Name 			<legal all>
1102*5113495bSYour Name */
1103*5113495bSYour Name #define SW_MONITOR_RING_7_PHY_PPDU_ID_OFFSET                         0x0000001c
1104*5113495bSYour Name #define SW_MONITOR_RING_7_PHY_PPDU_ID_LSB                            0
1105*5113495bSYour Name #define SW_MONITOR_RING_7_PHY_PPDU_ID_MASK                           0x0000ffff
1106*5113495bSYour Name 
1107*5113495bSYour Name /* Description		SW_MONITOR_RING_7_RESERVED_7A
1108*5113495bSYour Name 
1109*5113495bSYour Name 			<legal 0>
1110*5113495bSYour Name */
1111*5113495bSYour Name #define SW_MONITOR_RING_7_RESERVED_7A_OFFSET                         0x0000001c
1112*5113495bSYour Name #define SW_MONITOR_RING_7_RESERVED_7A_LSB                            16
1113*5113495bSYour Name #define SW_MONITOR_RING_7_RESERVED_7A_MASK                           0x000f0000
1114*5113495bSYour Name 
1115*5113495bSYour Name /* Description		SW_MONITOR_RING_7_RING_ID
1116*5113495bSYour Name 
1117*5113495bSYour Name 			Consumer: SW/REO/DEBUG
1118*5113495bSYour Name 
1119*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1120*5113495bSYour Name 
1121*5113495bSYour Name 
1122*5113495bSYour Name 
1123*5113495bSYour Name 			For debugging.
1124*5113495bSYour Name 
1125*5113495bSYour Name 			This field is filled in by the SRNG module.
1126*5113495bSYour Name 
1127*5113495bSYour Name 			It help to identify the ring that is being looked <legal
1128*5113495bSYour Name 			all>
1129*5113495bSYour Name */
1130*5113495bSYour Name #define SW_MONITOR_RING_7_RING_ID_OFFSET                             0x0000001c
1131*5113495bSYour Name #define SW_MONITOR_RING_7_RING_ID_LSB                                20
1132*5113495bSYour Name #define SW_MONITOR_RING_7_RING_ID_MASK                               0x0ff00000
1133*5113495bSYour Name 
1134*5113495bSYour Name /* Description		SW_MONITOR_RING_7_LOOPING_COUNT
1135*5113495bSYour Name 
1136*5113495bSYour Name 			Consumer: SW/REO/DEBUG
1137*5113495bSYour Name 
1138*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1139*5113495bSYour Name 
1140*5113495bSYour Name 
1141*5113495bSYour Name 
1142*5113495bSYour Name 			For debugging.
1143*5113495bSYour Name 
1144*5113495bSYour Name 			This field is filled in by the SRNG module.
1145*5113495bSYour Name 
1146*5113495bSYour Name 
1147*5113495bSYour Name 
1148*5113495bSYour Name 			A count value that indicates the number of times the
1149*5113495bSYour Name 			producer of entries into this Ring has looped around the
1150*5113495bSYour Name 			ring.
1151*5113495bSYour Name 
1152*5113495bSYour Name 			At initialization time, this value is set to 0. On the
1153*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
1154*5113495bSYour Name 			reached allowed by the number of bits for this field, the
1155*5113495bSYour Name 			count value continues with 0 again.
1156*5113495bSYour Name 
1157*5113495bSYour Name 
1158*5113495bSYour Name 
1159*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
1160*5113495bSYour Name 			use this field to figure out up to where the producer of
1161*5113495bSYour Name 			entries has created new entries. This eliminates the need to
1162*5113495bSYour Name 			check where the head pointer' of the ring is located once
1163*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
1164*5113495bSYour Name 			entries have been put into this ring...
1165*5113495bSYour Name 
1166*5113495bSYour Name 
1167*5113495bSYour Name 
1168*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1169*5113495bSYour Name 			LSB bit of this count value.
1170*5113495bSYour Name 
1171*5113495bSYour Name 			<legal all>
1172*5113495bSYour Name */
1173*5113495bSYour Name #define SW_MONITOR_RING_7_LOOPING_COUNT_OFFSET                       0x0000001c
1174*5113495bSYour Name #define SW_MONITOR_RING_7_LOOPING_COUNT_LSB                          28
1175*5113495bSYour Name #define SW_MONITOR_RING_7_LOOPING_COUNT_MASK                         0xf0000000
1176*5113495bSYour Name 
1177*5113495bSYour Name 
1178*5113495bSYour Name #endif // _SW_MONITOR_RING_H_
1179