xref: /wlan-driver/fw-api/hw/qca6490/v1/wbm_release_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _WBM_RELEASE_RING_H_
25*5113495bSYour Name #define _WBM_RELEASE_RING_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name #include "buffer_addr_info.h"
30*5113495bSYour Name #include "tx_rate_stats_info.h"
31*5113495bSYour Name 
32*5113495bSYour Name // ################ START SUMMARY #################
33*5113495bSYour Name //
34*5113495bSYour Name //	Dword	Fields
35*5113495bSYour Name //	0-1	struct buffer_addr_info released_buff_or_desc_addr_info;
36*5113495bSYour Name //	2	release_source_module[2:0], bm_action[5:3], buffer_or_desc_type[8:6], first_msdu_index[12:9], tqm_release_reason[16:13], rxdma_push_reason[18:17], rxdma_error_code[23:19], reo_push_reason[25:24], reo_error_code[30:26], wbm_internal_error[31]
37*5113495bSYour Name //	3	tqm_status_number[23:0], transmit_count[30:24], msdu_continuation[31]
38*5113495bSYour Name //	4	ack_frame_rssi[7:0], sw_release_details_valid[8], first_msdu[9], last_msdu[10], msdu_part_of_amsdu[11], fw_tx_notify_frame[12], buffer_timestamp[31:13]
39*5113495bSYour Name //	5-6	struct tx_rate_stats_info tx_rate_stats;
40*5113495bSYour Name //	7	sw_peer_id[15:0], tid[19:16], ring_id[27:20], looping_count[31:28]
41*5113495bSYour Name //
42*5113495bSYour Name // ################ END SUMMARY #################
43*5113495bSYour Name 
44*5113495bSYour Name #define NUM_OF_DWORDS_WBM_RELEASE_RING 8
45*5113495bSYour Name 
46*5113495bSYour Name struct wbm_release_ring {
47*5113495bSYour Name     struct            buffer_addr_info                       released_buff_or_desc_addr_info;
48*5113495bSYour Name              uint32_t release_source_module           :  3, //[2:0]
49*5113495bSYour Name                       bm_action                       :  3, //[5:3]
50*5113495bSYour Name                       buffer_or_desc_type             :  3, //[8:6]
51*5113495bSYour Name                       first_msdu_index                :  4, //[12:9]
52*5113495bSYour Name                       tqm_release_reason              :  4, //[16:13]
53*5113495bSYour Name                       rxdma_push_reason               :  2, //[18:17]
54*5113495bSYour Name                       rxdma_error_code                :  5, //[23:19]
55*5113495bSYour Name                       reo_push_reason                 :  2, //[25:24]
56*5113495bSYour Name                       reo_error_code                  :  5, //[30:26]
57*5113495bSYour Name                       wbm_internal_error              :  1; //[31]
58*5113495bSYour Name              uint32_t tqm_status_number               : 24, //[23:0]
59*5113495bSYour Name                       transmit_count                  :  7, //[30:24]
60*5113495bSYour Name                       msdu_continuation               :  1; //[31]
61*5113495bSYour Name              uint32_t ack_frame_rssi                  :  8, //[7:0]
62*5113495bSYour Name                       sw_release_details_valid        :  1, //[8]
63*5113495bSYour Name                       first_msdu                      :  1, //[9]
64*5113495bSYour Name                       last_msdu                       :  1, //[10]
65*5113495bSYour Name                       msdu_part_of_amsdu              :  1, //[11]
66*5113495bSYour Name                       fw_tx_notify_frame              :  1, //[12]
67*5113495bSYour Name                       buffer_timestamp                : 19; //[31:13]
68*5113495bSYour Name     struct            tx_rate_stats_info                       tx_rate_stats;
69*5113495bSYour Name              uint32_t sw_peer_id                      : 16, //[15:0]
70*5113495bSYour Name                       tid                             :  4, //[19:16]
71*5113495bSYour Name                       ring_id                         :  8, //[27:20]
72*5113495bSYour Name                       looping_count                   :  4; //[31:28]
73*5113495bSYour Name };
74*5113495bSYour Name 
75*5113495bSYour Name /*
76*5113495bSYour Name 
77*5113495bSYour Name struct buffer_addr_info released_buff_or_desc_addr_info
78*5113495bSYour Name 
79*5113495bSYour Name 			Consumer: WBM/SW/FW
80*5113495bSYour Name 
81*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name 			Details of the physical address of the buffer or link
86*5113495bSYour Name 			descriptor that is being released. Note that within this
87*5113495bSYour Name 			descriptor, WBM will look at the 'owner' of the released
88*5113495bSYour Name 			buffer/descriptor and forward it to SW/FW is WBM is not the
89*5113495bSYour Name 			owner.
90*5113495bSYour Name 
91*5113495bSYour Name release_source_module
92*5113495bSYour Name 
93*5113495bSYour Name 			Indicates which module initiated the release of this
94*5113495bSYour Name 			buffer or descriptor
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name 			<enum 0 release_source_TQM> TQM released this buffer or
99*5113495bSYour Name 			descriptor
100*5113495bSYour Name 
101*5113495bSYour Name 			<enum 1 release_source_RXDMA> RXDMA released this buffer
102*5113495bSYour Name 			or descriptor
103*5113495bSYour Name 
104*5113495bSYour Name 			<enum 2 release_source_REO> REO released this buffer or
105*5113495bSYour Name 			descriptor
106*5113495bSYour Name 
107*5113495bSYour Name 			<enum 3 release_source_FW> FW released this buffer or
108*5113495bSYour Name 			descriptor
109*5113495bSYour Name 
110*5113495bSYour Name 			<enum 4 release_source_SW> SW released this buffer or
111*5113495bSYour Name 			descriptor
112*5113495bSYour Name 
113*5113495bSYour Name 			<legal 0-4>
114*5113495bSYour Name 
115*5113495bSYour Name bm_action
116*5113495bSYour Name 
117*5113495bSYour Name 			Consumer: WBM/SW/FW
118*5113495bSYour Name 
119*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 			Field only valid when the field return_buffer_manager in
124*5113495bSYour Name 			the Released_buff_or_desc_addr_info indicates:
125*5113495bSYour Name 
126*5113495bSYour Name 			WBM_IDLE_BUF_LIST or
127*5113495bSYour Name 
128*5113495bSYour Name 			WBM_IDLE_DESC_LIST
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 			An MSDU extension descriptor shall never be marked as
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name 			<enum 0 Put_in_idle_list> Put the buffer or descriptor
137*5113495bSYour Name 			back in the idle list. In case of MSDU or MDPU link
138*5113495bSYour Name 			descriptor, BM does not need to check to release any
139*5113495bSYour Name 			individual MSDU buffers
140*5113495bSYour Name 
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name 			<enum 1 release_msdu_list > This BM action can only be
144*5113495bSYour Name 			used in combination with buffer_or_desc_type being
145*5113495bSYour Name 			msdu_link_descriptor. Field first_msdu_index points out
146*5113495bSYour Name 			which MSDU pointer in the MSDU link descriptor is the first
147*5113495bSYour Name 			of an MPDU that is released.
148*5113495bSYour Name 
149*5113495bSYour Name 			BM shall release all the MSDU buffers linked to this
150*5113495bSYour Name 			first MSDU buffer pointer. All related MSDU buffer pointer
151*5113495bSYour Name 			entries shall be set to value 0, which represents the 'NULL
152*5113495bSYour Name 			pointer. When all MSDU buffer pointers in the MSDU link
153*5113495bSYour Name 			descriptor are 'NULL', the MSDU link descriptor itself shall
154*5113495bSYour Name 			also be released.
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name 			<enum 2 Put_in_idle_list_expanded> CURRENTLY NOT
159*5113495bSYour Name 			IMPLEMENTED....
160*5113495bSYour Name 
161*5113495bSYour Name 			Put the buffer or descriptor back in the idle list. Only
162*5113495bSYour Name 			valid in combination with buffer_or_desc_type indicating
163*5113495bSYour Name 			MDPU_link_descriptor.
164*5113495bSYour Name 
165*5113495bSYour Name 			BM shall release the MPDU link descriptor as well as all
166*5113495bSYour Name 			MSDUs that are linked to the MPDUs in this descriptor.
167*5113495bSYour Name 
168*5113495bSYour Name 
169*5113495bSYour Name 
170*5113495bSYour Name 			<legal 0-2>
171*5113495bSYour Name 
172*5113495bSYour Name buffer_or_desc_type
173*5113495bSYour Name 
174*5113495bSYour Name 			Consumer: WBM/SW/FW
175*5113495bSYour Name 
176*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 			Field only valid when WBM is marked as the
181*5113495bSYour Name 			return_buffer_manager in the Released_Buffer_address_info
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name 			Indicates that type of buffer or descriptor is being
186*5113495bSYour Name 			released
187*5113495bSYour Name 
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name 			<enum 0 MSDU_rel_buffer> The address points to an MSDU
191*5113495bSYour Name 			buffer
192*5113495bSYour Name 
193*5113495bSYour Name 			<enum 1 msdu_link_descriptor> The address points to an
194*5113495bSYour Name 			TX MSDU link descriptor
195*5113495bSYour Name 
196*5113495bSYour Name 			<enum 2 mpdu_link_descriptor> The address points to an
197*5113495bSYour Name 			MPDU link descriptor
198*5113495bSYour Name 
199*5113495bSYour Name 			<enum 3 msdu_ext_descriptor > The address points to an
200*5113495bSYour Name 			MSDU extension descriptor.
201*5113495bSYour Name 
202*5113495bSYour Name 			In case BM finds this one in a release ring, it passes
203*5113495bSYour Name 			it on to FW...
204*5113495bSYour Name 
205*5113495bSYour Name 			<enum 4 queue_ext_descriptor> The address points to an
206*5113495bSYour Name 			TQM queue extension descriptor. WBM should treat this is the
207*5113495bSYour Name 			same way as a link descriptor. That is, put the 128 byte
208*5113495bSYour Name 			buffer back in the link buffer idle list.
209*5113495bSYour Name 
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name 			<legal 0-4>
213*5113495bSYour Name 
214*5113495bSYour Name first_msdu_index
215*5113495bSYour Name 
216*5113495bSYour Name 			Consumer: WBM/SW/FW
217*5113495bSYour Name 
218*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name 			Field only valid for the bm_action release_msdu_list.
223*5113495bSYour Name 
224*5113495bSYour Name 
225*5113495bSYour Name 
226*5113495bSYour Name 			The index of the first MSDU in an MSDU link descriptor
227*5113495bSYour Name 			all belonging to the same MPDU.
228*5113495bSYour Name 
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name 			<legal 0-6>
232*5113495bSYour Name 
233*5113495bSYour Name tqm_release_reason
234*5113495bSYour Name 
235*5113495bSYour Name 			Consumer: WBM/SW/FW
236*5113495bSYour Name 
237*5113495bSYour Name 			Producer: TQM
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 
241*5113495bSYour Name 			Field only valid when Release_source_module is set to
242*5113495bSYour Name 			release_source_TQM
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 
246*5113495bSYour Name 			(rr = Release Reason)
247*5113495bSYour Name 
248*5113495bSYour Name 			<enum 0 tqm_rr_frame_acked> frame is removed because an
249*5113495bSYour Name 			ACK of BA for it was received
250*5113495bSYour Name 
251*5113495bSYour Name 			<enum 1 tqm_rr_rem_cmd_rem> frame is removed because a
252*5113495bSYour Name 			remove command of type Remove_mpdus initiated by SW
253*5113495bSYour Name 
254*5113495bSYour Name 			<enum 2 tqm_rr_rem_cmd_tx> frame is removed because a
255*5113495bSYour Name 			remove command of type Remove_transmitted_mpdus initiated by
256*5113495bSYour Name 			SW
257*5113495bSYour Name 
258*5113495bSYour Name 			<enum 3 tqm_rr_rem_cmd_notx> frame is removed because a
259*5113495bSYour Name 			remove command of type Remove_untransmitted_mpdus initiated
260*5113495bSYour Name 			by SW
261*5113495bSYour Name 
262*5113495bSYour Name 			<enum 4 tqm_rr_rem_cmd_aged> frame is removed because a
263*5113495bSYour Name 			remove command of type Remove_aged_mpdus or
264*5113495bSYour Name 			Remove_aged_msdus initiated by SW
265*5113495bSYour Name 
266*5113495bSYour Name 			<enum 5 tqm_fw_reason1> frame is removed because a
267*5113495bSYour Name 			remove command where fw indicated that remove reason is
268*5113495bSYour Name 			fw_reason1
269*5113495bSYour Name 
270*5113495bSYour Name 			<enum 6 tqm_fw_reason2> frame is removed because a
271*5113495bSYour Name 			remove command where fw indicated that remove reason is
272*5113495bSYour Name 			fw_reason1
273*5113495bSYour Name 
274*5113495bSYour Name 			<enum 7 tqm_fw_reason3> frame is removed because a
275*5113495bSYour Name 			remove command where fw indicated that remove reason is
276*5113495bSYour Name 			fw_reason1
277*5113495bSYour Name 
278*5113495bSYour Name 			<enum 8 tqm_rr_rem_cmd_disable_queue> frame is removed
279*5113495bSYour Name 			because a remove command of type
280*5113495bSYour Name 			remove_mpdus_and_disable_queue or
281*5113495bSYour Name 			remove_msdus_and_disable_flow initiated by SW
282*5113495bSYour Name 
283*5113495bSYour Name 
284*5113495bSYour Name 
285*5113495bSYour Name 			<legal 0-8>
286*5113495bSYour Name 
287*5113495bSYour Name rxdma_push_reason
288*5113495bSYour Name 
289*5113495bSYour Name 			Field only valid when Release_source_module is set to
290*5113495bSYour Name 			release_source_RXDMA
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 
294*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
295*5113495bSYour Name 
296*5113495bSYour Name 
297*5113495bSYour Name 
298*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
299*5113495bSYour Name 			pushed this frame to this queue
300*5113495bSYour Name 
301*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
302*5113495bSYour Name 			frame to this queue per received routing instructions. No
303*5113495bSYour Name 			error within RXDMA was detected
304*5113495bSYour Name 
305*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
306*5113495bSYour Name 			result the MSDU link descriptor might not have the
307*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
308*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
309*5113495bSYour Name 			considered a normal condition for this scenario.
310*5113495bSYour Name 
311*5113495bSYour Name 
312*5113495bSYour Name 
313*5113495bSYour Name 			<legal 0 - 2>
314*5113495bSYour Name 
315*5113495bSYour Name rxdma_error_code
316*5113495bSYour Name 
317*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
318*5113495bSYour Name 			'rxdma_error_detected'.
319*5113495bSYour Name 
320*5113495bSYour Name 
321*5113495bSYour Name 
322*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
323*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
324*5113495bSYour Name 
325*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
326*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
327*5113495bSYour Name 
328*5113495bSYour Name 
329*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
330*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
331*5113495bSYour Name 			a valid corresponding key id in the peer entry.
332*5113495bSYour Name 
333*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
334*5113495bSYour Name 			error
335*5113495bSYour Name 
336*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
337*5113495bSYour Name 			unencrypted frame error when encrypted was expected
338*5113495bSYour Name 
339*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
340*5113495bSYour Name 			length error
341*5113495bSYour Name 
342*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
343*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
344*5113495bSYour Name 
345*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
346*5113495bSYour Name 			error
347*5113495bSYour Name 
348*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
349*5113495bSYour Name 			parsing error
350*5113495bSYour Name 
351*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
352*5113495bSYour Name 			during SA search
353*5113495bSYour Name 
354*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
355*5113495bSYour Name 			during DA search
356*5113495bSYour Name 
357*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
358*5113495bSYour Name 			timeout during flow search
359*5113495bSYour Name 
360*5113495bSYour Name 			<enum 13 rxdma_flush_request>RXDMA received a flush
361*5113495bSYour Name 			request
362*5113495bSYour Name 
363*5113495bSYour Name 			<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
364*5113495bSYour Name 			present as well as a fragmented MPDU. A-MSDU defragmentation
365*5113495bSYour Name 			is not supported in Lithium SW so this is treated as an
366*5113495bSYour Name 			error.
367*5113495bSYour Name 
368*5113495bSYour Name reo_push_reason
369*5113495bSYour Name 
370*5113495bSYour Name 			Field only valid when Release_source_module is set to
371*5113495bSYour Name 			release_source_REO
372*5113495bSYour Name 
373*5113495bSYour Name 
374*5113495bSYour Name 
375*5113495bSYour Name 			Indicates why REO pushed the frame to this release ring
376*5113495bSYour Name 
377*5113495bSYour Name 
378*5113495bSYour Name 
379*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an
380*5113495bSYour Name 			pushed this frame to this queue
381*5113495bSYour Name 
382*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
383*5113495bSYour Name 			this queue per received routing instructions. No error
384*5113495bSYour Name 			within REO was detected
385*5113495bSYour Name 
386*5113495bSYour Name 
387*5113495bSYour Name 
388*5113495bSYour Name 			<legal 0 - 1>
389*5113495bSYour Name 
390*5113495bSYour Name reo_error_code
391*5113495bSYour Name 
392*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to
393*5113495bSYour Name 			'reo_error_detected'.
394*5113495bSYour Name 
395*5113495bSYour Name 
396*5113495bSYour Name 
397*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor
398*5113495bSYour Name 			provided in the REO_ENTRANCE ring is set to 0
399*5113495bSYour Name 
400*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor
401*5113495bSYour Name 			valid bit is NOT set
402*5113495bSYour Name 
403*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
404*5113495bSYour Name 			session having been setup.
405*5113495bSYour Name 
406*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to
407*5113495bSYour Name 			SSN, Retry bit set: duplicate frame
408*5113495bSYour Name 
409*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
410*5113495bSYour Name 
411*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
412*5113495bSYour Name 			frame) received with 2K jump in SN
413*5113495bSYour Name 
414*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump
415*5113495bSYour Name 			in SSN
416*5113495bSYour Name 
417*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data
418*5113495bSYour Name 			frame) received with SN falling within the OOR window
419*5113495bSYour Name 
420*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling
421*5113495bSYour Name 			within the OOR window
422*5113495bSYour Name 
423*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
424*5113495bSYour Name 			a BA session
425*5113495bSYour Name 
426*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with
427*5113495bSYour Name 			SSN equal to SN
428*5113495bSYour Name 
429*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
430*5113495bSYour Name 
431*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
432*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set in
433*5113495bSYour Name 			the REO Queue descriptor
434*5113495bSYour Name 
435*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
436*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in the
437*5113495bSYour Name 			REO Queue descriptor
438*5113495bSYour Name 
439*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is
440*5113495bSYour Name 			forwarded as a result of the queue descriptor(address) being
441*5113495bSYour Name 			blocked as SW/FW seems to be currently in the process of
442*5113495bSYour Name 			making updates to this descriptor...
443*5113495bSYour Name 
444*5113495bSYour Name 
445*5113495bSYour Name 
446*5113495bSYour Name 			<legal 0-14>
447*5113495bSYour Name 
448*5113495bSYour Name wbm_internal_error
449*5113495bSYour Name 
450*5113495bSYour Name 			Can only be set by WBM.
451*5113495bSYour Name 
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 			Is set when WBM got a buffer pointer but the action was
455*5113495bSYour Name 			to push it to the idle link descriptor ring or do link
456*5113495bSYour Name 			related activity
457*5113495bSYour Name 
458*5113495bSYour Name 			OR
459*5113495bSYour Name 
460*5113495bSYour Name 			Is set when WBM got a link buffer pointer but the action
461*5113495bSYour Name 			was to push it to the buffer  descriptor ring
462*5113495bSYour Name 
463*5113495bSYour Name 
464*5113495bSYour Name 
465*5113495bSYour Name 			<legal all>
466*5113495bSYour Name 
467*5113495bSYour Name tqm_status_number
468*5113495bSYour Name 
469*5113495bSYour Name 			Field only valid when Release_source_module is set to
470*5113495bSYour Name 			release_source_TQM
471*5113495bSYour Name 
472*5113495bSYour Name 
473*5113495bSYour Name 
474*5113495bSYour Name 			The value in this field is equal to value of the
475*5113495bSYour Name 			'TQM_CMD_Number' field the TQM command or the
476*5113495bSYour Name 			'TQM_add_cmd_Number' field from the TQM entrance ring
477*5113495bSYour Name 			descriptor
478*5113495bSYour Name 
479*5113495bSYour Name 
480*5113495bSYour Name 
481*5113495bSYour Name 			This field helps to correlate the statuses with the TQM
482*5113495bSYour Name 			commands.
483*5113495bSYour Name 
484*5113495bSYour Name 
485*5113495bSYour Name 
486*5113495bSYour Name 			NOTE that SW could program this number to be equal to
487*5113495bSYour Name 			the PPDU_ID number in case direct correlation with the PPDU
488*5113495bSYour Name 			ID is desired
489*5113495bSYour Name 
490*5113495bSYour Name 
491*5113495bSYour Name 
492*5113495bSYour Name 			<legal all>
493*5113495bSYour Name 
494*5113495bSYour Name transmit_count
495*5113495bSYour Name 
496*5113495bSYour Name 			Field only valid when Release_source_module is set to
497*5113495bSYour Name 			release_source_TQM
498*5113495bSYour Name 
499*5113495bSYour Name 
500*5113495bSYour Name 
501*5113495bSYour Name 			The number of times this frame has been transmitted
502*5113495bSYour Name 
503*5113495bSYour Name msdu_continuation
504*5113495bSYour Name 
505*5113495bSYour Name 			FR53947 requests MSDU_continuation reporting for Rx
506*5113495bSYour Name 			MSDUs in Pine and HastingsPrime for which
507*5113495bSYour Name 			SW_release_details_valid may not be set.
508*5113495bSYour Name 
509*5113495bSYour Name 			<legal all>
510*5113495bSYour Name 
511*5113495bSYour Name ack_frame_rssi
512*5113495bSYour Name 
513*5113495bSYour Name 			This field is only valid when the source is TQM.
514*5113495bSYour Name 
515*5113495bSYour Name 
516*5113495bSYour Name 
517*5113495bSYour Name 			If this frame is removed as the result of the reception
518*5113495bSYour Name 			of an ACK or BA, this field indicates the RSSI of the
519*5113495bSYour Name 			received ACK or BA frame.
520*5113495bSYour Name 
521*5113495bSYour Name 
522*5113495bSYour Name 
523*5113495bSYour Name 			When the frame is removed as result of a direct remove
524*5113495bSYour Name 			command from the SW,  this field is set to 0x0 (which is
525*5113495bSYour Name 			never a valid value when real RSSI is available)
526*5113495bSYour Name 
527*5113495bSYour Name 
528*5113495bSYour Name 
529*5113495bSYour Name 			<legal all>
530*5113495bSYour Name 
531*5113495bSYour Name sw_release_details_valid
532*5113495bSYour Name 
533*5113495bSYour Name 			Consumer: SW
534*5113495bSYour Name 
535*5113495bSYour Name 			Producer: WBM
536*5113495bSYour Name 
537*5113495bSYour Name 
538*5113495bSYour Name 
539*5113495bSYour Name 			When set, some WBM specific release info for SW is
540*5113495bSYour Name 			valid.
541*5113495bSYour Name 
542*5113495bSYour Name 			This is set when WMB got a 'release_msdu_list' command
543*5113495bSYour Name 			from TQM and the return buffer manager is not WMB. WBM will
544*5113495bSYour Name 			then de-aggregate all the MSDUs and pass them one at a time
545*5113495bSYour Name 			on to the 'buffer owner'
546*5113495bSYour Name 
547*5113495bSYour Name 
548*5113495bSYour Name 
549*5113495bSYour Name 			<legal all>
550*5113495bSYour Name 
551*5113495bSYour Name first_msdu
552*5113495bSYour Name 
553*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
554*5113495bSYour Name 
555*5113495bSYour Name 
556*5113495bSYour Name 
557*5113495bSYour Name 			Consumer: SW
558*5113495bSYour Name 
559*5113495bSYour Name 			Producer: WBM
560*5113495bSYour Name 
561*5113495bSYour Name 
562*5113495bSYour Name 
563*5113495bSYour Name 			When set, this MSDU is the first MSDU pointed to in the
564*5113495bSYour Name 			'release_msdu_list' command.
565*5113495bSYour Name 
566*5113495bSYour Name 
567*5113495bSYour Name 
568*5113495bSYour Name 			FR53947 extends this to Rx MSDUs in Pine and
569*5113495bSYour Name 			HastingsPrime for which SW_release_details_valid may not be
570*5113495bSYour Name 			set.
571*5113495bSYour Name 
572*5113495bSYour Name 			<legal all>
573*5113495bSYour Name 
574*5113495bSYour Name last_msdu
575*5113495bSYour Name 
576*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
577*5113495bSYour Name 
578*5113495bSYour Name 
579*5113495bSYour Name 
580*5113495bSYour Name 			Consumer: SW
581*5113495bSYour Name 
582*5113495bSYour Name 			Producer: WBM
583*5113495bSYour Name 
584*5113495bSYour Name 
585*5113495bSYour Name 
586*5113495bSYour Name 			When set, this MSDU is the last MSDU pointed to in the
587*5113495bSYour Name 			'release_msdu_list' command.
588*5113495bSYour Name 
589*5113495bSYour Name 
590*5113495bSYour Name 
591*5113495bSYour Name 			FR53947 extends this to Rx MSDUs in Pine and
592*5113495bSYour Name 			HastingsPrime for which SW_release_details_valid may not be
593*5113495bSYour Name 			set.
594*5113495bSYour Name 
595*5113495bSYour Name 			<legal all>
596*5113495bSYour Name 
597*5113495bSYour Name msdu_part_of_amsdu
598*5113495bSYour Name 
599*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
600*5113495bSYour Name 
601*5113495bSYour Name 
602*5113495bSYour Name 
603*5113495bSYour Name 			Consumer: SW
604*5113495bSYour Name 
605*5113495bSYour Name 			Producer: WBM
606*5113495bSYour Name 
607*5113495bSYour Name 
608*5113495bSYour Name 
609*5113495bSYour Name 			When set, this MSDU was part of an A-MSDU in MPDU
610*5113495bSYour Name 
611*5113495bSYour Name 			<legal all>
612*5113495bSYour Name 
613*5113495bSYour Name fw_tx_notify_frame
614*5113495bSYour Name 
615*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
616*5113495bSYour Name 
617*5113495bSYour Name 
618*5113495bSYour Name 
619*5113495bSYour Name 			Consumer: SW
620*5113495bSYour Name 
621*5113495bSYour Name 			Producer: WBM
622*5113495bSYour Name 
623*5113495bSYour Name 
624*5113495bSYour Name 
625*5113495bSYour Name 			This is the FW_tx_notify_frame field from the
626*5113495bSYour Name 
627*5113495bSYour Name 			<legal all>
628*5113495bSYour Name 
629*5113495bSYour Name buffer_timestamp
630*5113495bSYour Name 
631*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
632*5113495bSYour Name 
633*5113495bSYour Name 
634*5113495bSYour Name 
635*5113495bSYour Name 			Consumer: SW
636*5113495bSYour Name 
637*5113495bSYour Name 			Producer: WBM
638*5113495bSYour Name 
639*5113495bSYour Name 
640*5113495bSYour Name 
641*5113495bSYour Name 			This is the Buffer_timestamp field from the
642*5113495bSYour Name 			TX_MSDU_DETAILS for this frame from the MSDU link
643*5113495bSYour Name 			descriptor.
644*5113495bSYour Name 
645*5113495bSYour Name 
646*5113495bSYour Name 
647*5113495bSYour Name 			Timestamp in units of 1024 µs
648*5113495bSYour Name 
649*5113495bSYour Name 			<legal all>
650*5113495bSYour Name 
651*5113495bSYour Name struct tx_rate_stats_info tx_rate_stats
652*5113495bSYour Name 
653*5113495bSYour Name 			Consumer: TQM
654*5113495bSYour Name 
655*5113495bSYour Name 			Producer: SW/SCH(from TXPCU, PDG)
656*5113495bSYour Name 
657*5113495bSYour Name 
658*5113495bSYour Name 
659*5113495bSYour Name 			Details for command execution tracking purposes.
660*5113495bSYour Name 
661*5113495bSYour Name sw_peer_id
662*5113495bSYour Name 
663*5113495bSYour Name 			Field only valid when Release_source_module is set to
664*5113495bSYour Name 			release_source_TQM
665*5113495bSYour Name 
666*5113495bSYour Name 
667*5113495bSYour Name 
668*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
669*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
670*5113495bSYour Name 
671*5113495bSYour Name 			buffer_or_desc_type = e_num 0
672*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
673*5113495bSYour Name 			tqm_rr_rem_cmd_rem
674*5113495bSYour Name 
675*5113495bSYour Name 
676*5113495bSYour Name 
677*5113495bSYour Name 
678*5113495bSYour Name 
679*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
680*5113495bSYour Name 			hence sw_peer_id and tid = 0
681*5113495bSYour Name 
682*5113495bSYour Name 			buffer_or_desc_type = e_num 0
683*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
684*5113495bSYour Name 			tqm_rr_rem_cmd_rem
685*5113495bSYour Name 
686*5113495bSYour Name 
687*5113495bSYour Name 
688*5113495bSYour Name 
689*5113495bSYour Name 
690*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
691*5113495bSYour Name 			command.
692*5113495bSYour Name 
693*5113495bSYour Name 			buffer_or_desc_type = e_num1
694*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
695*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
696*5113495bSYour Name 
697*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
698*5113495bSYour Name 
699*5113495bSYour Name 
700*5113495bSYour Name 
701*5113495bSYour Name 			Sw_peer_id from the TX_MSDU_FLOW descriptor or
702*5113495bSYour Name 			TX_MPDU_QUEUE descriptor
703*5113495bSYour Name 
704*5113495bSYour Name 			<legal all>
705*5113495bSYour Name 
706*5113495bSYour Name tid
707*5113495bSYour Name 
708*5113495bSYour Name 			Field only valid when Release_source_module is set to
709*5113495bSYour Name 			release_source_TQM
710*5113495bSYour Name 
711*5113495bSYour Name 
712*5113495bSYour Name 
713*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
714*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
715*5113495bSYour Name 
716*5113495bSYour Name 			buffer_or_desc_type = e_num 0
717*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
718*5113495bSYour Name 			tqm_rr_rem_cmd_rem
719*5113495bSYour Name 
720*5113495bSYour Name 
721*5113495bSYour Name 
722*5113495bSYour Name 
723*5113495bSYour Name 
724*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
725*5113495bSYour Name 			hence sw_peer_id and tid = 0
726*5113495bSYour Name 
727*5113495bSYour Name 			buffer_or_desc_type = e_num 0
728*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
729*5113495bSYour Name 			tqm_rr_rem_cmd_rem
730*5113495bSYour Name 
731*5113495bSYour Name 
732*5113495bSYour Name 
733*5113495bSYour Name 
734*5113495bSYour Name 
735*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
736*5113495bSYour Name 			command.
737*5113495bSYour Name 
738*5113495bSYour Name 			buffer_or_desc_type = e_num1
739*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
740*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
741*5113495bSYour Name 
742*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
743*5113495bSYour Name 
744*5113495bSYour Name 
745*5113495bSYour Name 
746*5113495bSYour Name 
747*5113495bSYour Name 
748*5113495bSYour Name 			This field represents the TID from the TX_MSDU_FLOW
749*5113495bSYour Name 			descriptor or TX_MPDU_QUEUE descriptor
750*5113495bSYour Name 
751*5113495bSYour Name 
752*5113495bSYour Name 
753*5113495bSYour Name 			 <legal all>
754*5113495bSYour Name 
755*5113495bSYour Name ring_id
756*5113495bSYour Name 
757*5113495bSYour Name 			Consumer: TQM/REO/RXDMA/SW
758*5113495bSYour Name 
759*5113495bSYour Name 			Producer: SRNG (of RXDMA)
760*5113495bSYour Name 
761*5113495bSYour Name 
762*5113495bSYour Name 
763*5113495bSYour Name 			For debugging.
764*5113495bSYour Name 
765*5113495bSYour Name 			This field is filled in by the SRNG module.
766*5113495bSYour Name 
767*5113495bSYour Name 			It help to identify the ring that is being looked <legal
768*5113495bSYour Name 			all>
769*5113495bSYour Name 
770*5113495bSYour Name looping_count
771*5113495bSYour Name 
772*5113495bSYour Name 			Consumer: WBM/SW/FW
773*5113495bSYour Name 
774*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
775*5113495bSYour Name 
776*5113495bSYour Name 
777*5113495bSYour Name 
778*5113495bSYour Name 			A count value that indicates the number of times the
779*5113495bSYour Name 			producer of entries into the Buffer Manager Ring has looped
780*5113495bSYour Name 			around the ring.
781*5113495bSYour Name 
782*5113495bSYour Name 			At initialization time, this value is set to 0. On the
783*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
784*5113495bSYour Name 			reached allowed by the number of bits for this field, the
785*5113495bSYour Name 			count value continues with 0 again.
786*5113495bSYour Name 
787*5113495bSYour Name 
788*5113495bSYour Name 
789*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
790*5113495bSYour Name 			use this field to figure out up to where the producer of
791*5113495bSYour Name 			entries has created new entries. This eliminates the need to
792*5113495bSYour Name 			check where the head pointer' of the ring is located once
793*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
794*5113495bSYour Name 			entries have been put into this ring...
795*5113495bSYour Name 
796*5113495bSYour Name 
797*5113495bSYour Name 
798*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
799*5113495bSYour Name 			LSB bit of this count value.
800*5113495bSYour Name 
801*5113495bSYour Name 			<legal all>
802*5113495bSYour Name */
803*5113495bSYour Name 
804*5113495bSYour Name 
805*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info released_buff_or_desc_addr_info */
806*5113495bSYour Name 
807*5113495bSYour Name 
808*5113495bSYour Name /* Description		WBM_RELEASE_RING_0_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0
809*5113495bSYour Name 
810*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
811*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
812*5113495bSYour Name 
813*5113495bSYour Name 
814*5113495bSYour Name 
815*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
816*5113495bSYour Name 
817*5113495bSYour Name 			<legal all>
818*5113495bSYour Name */
819*5113495bSYour Name #define WBM_RELEASE_RING_0_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
820*5113495bSYour Name #define WBM_RELEASE_RING_0_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
821*5113495bSYour Name #define WBM_RELEASE_RING_0_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
822*5113495bSYour Name 
823*5113495bSYour Name /* Description		WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32
824*5113495bSYour Name 
825*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
826*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
827*5113495bSYour Name 
828*5113495bSYour Name 
829*5113495bSYour Name 
830*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
831*5113495bSYour Name 
832*5113495bSYour Name 			<legal all>
833*5113495bSYour Name */
834*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
835*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
836*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
837*5113495bSYour Name 
838*5113495bSYour Name /* Description		WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER
839*5113495bSYour Name 
840*5113495bSYour Name 			Consumer: WBM
841*5113495bSYour Name 
842*5113495bSYour Name 			Producer: SW/FW
843*5113495bSYour Name 
844*5113495bSYour Name 
845*5113495bSYour Name 
846*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
847*5113495bSYour Name 
848*5113495bSYour Name 
849*5113495bSYour Name 
850*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
851*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
852*5113495bSYour Name 			pointed to shall be returned after the frame has been
853*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
854*5113495bSYour Name 
855*5113495bSYour Name 
856*5113495bSYour Name 
857*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
858*5113495bSYour Name 			to the WMB buffer idle list
859*5113495bSYour Name 
860*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
861*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
862*5113495bSYour Name 
863*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
864*5113495bSYour Name 
865*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
866*5113495bSYour Name 			ring 0
867*5113495bSYour Name 
868*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
869*5113495bSYour Name 			ring 1
870*5113495bSYour Name 
871*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
872*5113495bSYour Name 			ring 2
873*5113495bSYour Name 
874*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
875*5113495bSYour Name 			ring 3
876*5113495bSYour Name 
877*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
878*5113495bSYour Name 			ring 4
879*5113495bSYour Name 
880*5113495bSYour Name 
881*5113495bSYour Name 
882*5113495bSYour Name 			<legal all>
883*5113495bSYour Name */
884*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
885*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
886*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000700
887*5113495bSYour Name 
888*5113495bSYour Name /* Description		WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE
889*5113495bSYour Name 
890*5113495bSYour Name 			Cookie field exclusively used by SW.
891*5113495bSYour Name 
892*5113495bSYour Name 
893*5113495bSYour Name 
894*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
895*5113495bSYour Name 
896*5113495bSYour Name 
897*5113495bSYour Name 
898*5113495bSYour Name 			HW ignores the contents, accept that it passes the
899*5113495bSYour Name 			programmed value on to other descriptors together with the
900*5113495bSYour Name 			physical address
901*5113495bSYour Name 
902*5113495bSYour Name 
903*5113495bSYour Name 
904*5113495bSYour Name 			Field can be used by SW to for example associate the
905*5113495bSYour Name 			buffers physical address with the virtual address
906*5113495bSYour Name 
907*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
908*5113495bSYour Name 			specification
909*5113495bSYour Name 
910*5113495bSYour Name 
911*5113495bSYour Name 
912*5113495bSYour Name 			NOTE:
913*5113495bSYour Name 
914*5113495bSYour Name 			The three most significant bits can have a special
915*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
916*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
917*5113495bSYour Name 
918*5113495bSYour Name 
919*5113495bSYour Name 
920*5113495bSYour Name 			In case of NON punctured transmission:
921*5113495bSYour Name 
922*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
923*5113495bSYour Name 
924*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
925*5113495bSYour Name 
926*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
927*5113495bSYour Name 
928*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
929*5113495bSYour Name 
930*5113495bSYour Name 
931*5113495bSYour Name 
932*5113495bSYour Name 			In case of punctured transmission:
933*5113495bSYour Name 
934*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
935*5113495bSYour Name 
936*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
937*5113495bSYour Name 
938*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
939*5113495bSYour Name 
940*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
941*5113495bSYour Name 
942*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
943*5113495bSYour Name 
944*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
945*5113495bSYour Name 
946*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
947*5113495bSYour Name 
948*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
949*5113495bSYour Name 
950*5113495bSYour Name 
951*5113495bSYour Name 
952*5113495bSYour Name 			Note: a punctured transmission is indicated by the
953*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
954*5113495bSYour Name 			TLV
955*5113495bSYour Name 
956*5113495bSYour Name 
957*5113495bSYour Name 
958*5113495bSYour Name 			<legal all>
959*5113495bSYour Name */
960*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
961*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB 11
962*5113495bSYour Name #define WBM_RELEASE_RING_1_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff800
963*5113495bSYour Name 
964*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE
965*5113495bSYour Name 
966*5113495bSYour Name 			Indicates which module initiated the release of this
967*5113495bSYour Name 			buffer or descriptor
968*5113495bSYour Name 
969*5113495bSYour Name 
970*5113495bSYour Name 
971*5113495bSYour Name 			<enum 0 release_source_TQM> TQM released this buffer or
972*5113495bSYour Name 			descriptor
973*5113495bSYour Name 
974*5113495bSYour Name 			<enum 1 release_source_RXDMA> RXDMA released this buffer
975*5113495bSYour Name 			or descriptor
976*5113495bSYour Name 
977*5113495bSYour Name 			<enum 2 release_source_REO> REO released this buffer or
978*5113495bSYour Name 			descriptor
979*5113495bSYour Name 
980*5113495bSYour Name 			<enum 3 release_source_FW> FW released this buffer or
981*5113495bSYour Name 			descriptor
982*5113495bSYour Name 
983*5113495bSYour Name 			<enum 4 release_source_SW> SW released this buffer or
984*5113495bSYour Name 			descriptor
985*5113495bSYour Name 
986*5113495bSYour Name 			<legal 0-4>
987*5113495bSYour Name */
988*5113495bSYour Name #define WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE_OFFSET              0x00000008
989*5113495bSYour Name #define WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE_LSB                 0
990*5113495bSYour Name #define WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE_MASK                0x00000007
991*5113495bSYour Name 
992*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_BM_ACTION
993*5113495bSYour Name 
994*5113495bSYour Name 			Consumer: WBM/SW/FW
995*5113495bSYour Name 
996*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
997*5113495bSYour Name 
998*5113495bSYour Name 
999*5113495bSYour Name 
1000*5113495bSYour Name 			Field only valid when the field return_buffer_manager in
1001*5113495bSYour Name 			the Released_buff_or_desc_addr_info indicates:
1002*5113495bSYour Name 
1003*5113495bSYour Name 			WBM_IDLE_BUF_LIST or
1004*5113495bSYour Name 
1005*5113495bSYour Name 			WBM_IDLE_DESC_LIST
1006*5113495bSYour Name 
1007*5113495bSYour Name 
1008*5113495bSYour Name 
1009*5113495bSYour Name 			An MSDU extension descriptor shall never be marked as
1010*5113495bSYour Name 
1011*5113495bSYour Name 
1012*5113495bSYour Name 
1013*5113495bSYour Name 			<enum 0 Put_in_idle_list> Put the buffer or descriptor
1014*5113495bSYour Name 			back in the idle list. In case of MSDU or MDPU link
1015*5113495bSYour Name 			descriptor, BM does not need to check to release any
1016*5113495bSYour Name 			individual MSDU buffers
1017*5113495bSYour Name 
1018*5113495bSYour Name 
1019*5113495bSYour Name 
1020*5113495bSYour Name 			<enum 1 release_msdu_list > This BM action can only be
1021*5113495bSYour Name 			used in combination with buffer_or_desc_type being
1022*5113495bSYour Name 			msdu_link_descriptor. Field first_msdu_index points out
1023*5113495bSYour Name 			which MSDU pointer in the MSDU link descriptor is the first
1024*5113495bSYour Name 			of an MPDU that is released.
1025*5113495bSYour Name 
1026*5113495bSYour Name 			BM shall release all the MSDU buffers linked to this
1027*5113495bSYour Name 			first MSDU buffer pointer. All related MSDU buffer pointer
1028*5113495bSYour Name 			entries shall be set to value 0, which represents the 'NULL
1029*5113495bSYour Name 			pointer. When all MSDU buffer pointers in the MSDU link
1030*5113495bSYour Name 			descriptor are 'NULL', the MSDU link descriptor itself shall
1031*5113495bSYour Name 			also be released.
1032*5113495bSYour Name 
1033*5113495bSYour Name 
1034*5113495bSYour Name 
1035*5113495bSYour Name 			<enum 2 Put_in_idle_list_expanded> CURRENTLY NOT
1036*5113495bSYour Name 			IMPLEMENTED....
1037*5113495bSYour Name 
1038*5113495bSYour Name 			Put the buffer or descriptor back in the idle list. Only
1039*5113495bSYour Name 			valid in combination with buffer_or_desc_type indicating
1040*5113495bSYour Name 			MDPU_link_descriptor.
1041*5113495bSYour Name 
1042*5113495bSYour Name 			BM shall release the MPDU link descriptor as well as all
1043*5113495bSYour Name 			MSDUs that are linked to the MPDUs in this descriptor.
1044*5113495bSYour Name 
1045*5113495bSYour Name 
1046*5113495bSYour Name 
1047*5113495bSYour Name 			<legal 0-2>
1048*5113495bSYour Name */
1049*5113495bSYour Name #define WBM_RELEASE_RING_2_BM_ACTION_OFFSET                          0x00000008
1050*5113495bSYour Name #define WBM_RELEASE_RING_2_BM_ACTION_LSB                             3
1051*5113495bSYour Name #define WBM_RELEASE_RING_2_BM_ACTION_MASK                            0x00000038
1052*5113495bSYour Name 
1053*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE
1054*5113495bSYour Name 
1055*5113495bSYour Name 			Consumer: WBM/SW/FW
1056*5113495bSYour Name 
1057*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
1058*5113495bSYour Name 
1059*5113495bSYour Name 
1060*5113495bSYour Name 
1061*5113495bSYour Name 			Field only valid when WBM is marked as the
1062*5113495bSYour Name 			return_buffer_manager in the Released_Buffer_address_info
1063*5113495bSYour Name 
1064*5113495bSYour Name 
1065*5113495bSYour Name 
1066*5113495bSYour Name 			Indicates that type of buffer or descriptor is being
1067*5113495bSYour Name 			released
1068*5113495bSYour Name 
1069*5113495bSYour Name 
1070*5113495bSYour Name 
1071*5113495bSYour Name 			<enum 0 MSDU_rel_buffer> The address points to an MSDU
1072*5113495bSYour Name 			buffer
1073*5113495bSYour Name 
1074*5113495bSYour Name 			<enum 1 msdu_link_descriptor> The address points to an
1075*5113495bSYour Name 			TX MSDU link descriptor
1076*5113495bSYour Name 
1077*5113495bSYour Name 			<enum 2 mpdu_link_descriptor> The address points to an
1078*5113495bSYour Name 			MPDU link descriptor
1079*5113495bSYour Name 
1080*5113495bSYour Name 			<enum 3 msdu_ext_descriptor > The address points to an
1081*5113495bSYour Name 			MSDU extension descriptor.
1082*5113495bSYour Name 
1083*5113495bSYour Name 			In case BM finds this one in a release ring, it passes
1084*5113495bSYour Name 			it on to FW...
1085*5113495bSYour Name 
1086*5113495bSYour Name 			<enum 4 queue_ext_descriptor> The address points to an
1087*5113495bSYour Name 			TQM queue extension descriptor. WBM should treat this is the
1088*5113495bSYour Name 			same way as a link descriptor. That is, put the 128 byte
1089*5113495bSYour Name 			buffer back in the link buffer idle list.
1090*5113495bSYour Name 
1091*5113495bSYour Name 
1092*5113495bSYour Name 
1093*5113495bSYour Name 			<legal 0-4>
1094*5113495bSYour Name */
1095*5113495bSYour Name #define WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE_OFFSET                0x00000008
1096*5113495bSYour Name #define WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE_LSB                   6
1097*5113495bSYour Name #define WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE_MASK                  0x000001c0
1098*5113495bSYour Name 
1099*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_FIRST_MSDU_INDEX
1100*5113495bSYour Name 
1101*5113495bSYour Name 			Consumer: WBM/SW/FW
1102*5113495bSYour Name 
1103*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
1104*5113495bSYour Name 
1105*5113495bSYour Name 
1106*5113495bSYour Name 
1107*5113495bSYour Name 			Field only valid for the bm_action release_msdu_list.
1108*5113495bSYour Name 
1109*5113495bSYour Name 
1110*5113495bSYour Name 
1111*5113495bSYour Name 			The index of the first MSDU in an MSDU link descriptor
1112*5113495bSYour Name 			all belonging to the same MPDU.
1113*5113495bSYour Name 
1114*5113495bSYour Name 
1115*5113495bSYour Name 
1116*5113495bSYour Name 			<legal 0-6>
1117*5113495bSYour Name */
1118*5113495bSYour Name #define WBM_RELEASE_RING_2_FIRST_MSDU_INDEX_OFFSET                   0x00000008
1119*5113495bSYour Name #define WBM_RELEASE_RING_2_FIRST_MSDU_INDEX_LSB                      9
1120*5113495bSYour Name #define WBM_RELEASE_RING_2_FIRST_MSDU_INDEX_MASK                     0x00001e00
1121*5113495bSYour Name 
1122*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_TQM_RELEASE_REASON
1123*5113495bSYour Name 
1124*5113495bSYour Name 			Consumer: WBM/SW/FW
1125*5113495bSYour Name 
1126*5113495bSYour Name 			Producer: TQM
1127*5113495bSYour Name 
1128*5113495bSYour Name 
1129*5113495bSYour Name 
1130*5113495bSYour Name 			Field only valid when Release_source_module is set to
1131*5113495bSYour Name 			release_source_TQM
1132*5113495bSYour Name 
1133*5113495bSYour Name 
1134*5113495bSYour Name 
1135*5113495bSYour Name 			(rr = Release Reason)
1136*5113495bSYour Name 
1137*5113495bSYour Name 			<enum 0 tqm_rr_frame_acked> frame is removed because an
1138*5113495bSYour Name 			ACK of BA for it was received
1139*5113495bSYour Name 
1140*5113495bSYour Name 			<enum 1 tqm_rr_rem_cmd_rem> frame is removed because a
1141*5113495bSYour Name 			remove command of type Remove_mpdus initiated by SW
1142*5113495bSYour Name 
1143*5113495bSYour Name 			<enum 2 tqm_rr_rem_cmd_tx> frame is removed because a
1144*5113495bSYour Name 			remove command of type Remove_transmitted_mpdus initiated by
1145*5113495bSYour Name 			SW
1146*5113495bSYour Name 
1147*5113495bSYour Name 			<enum 3 tqm_rr_rem_cmd_notx> frame is removed because a
1148*5113495bSYour Name 			remove command of type Remove_untransmitted_mpdus initiated
1149*5113495bSYour Name 			by SW
1150*5113495bSYour Name 
1151*5113495bSYour Name 			<enum 4 tqm_rr_rem_cmd_aged> frame is removed because a
1152*5113495bSYour Name 			remove command of type Remove_aged_mpdus or
1153*5113495bSYour Name 			Remove_aged_msdus initiated by SW
1154*5113495bSYour Name 
1155*5113495bSYour Name 			<enum 5 tqm_fw_reason1> frame is removed because a
1156*5113495bSYour Name 			remove command where fw indicated that remove reason is
1157*5113495bSYour Name 			fw_reason1
1158*5113495bSYour Name 
1159*5113495bSYour Name 			<enum 6 tqm_fw_reason2> frame is removed because a
1160*5113495bSYour Name 			remove command where fw indicated that remove reason is
1161*5113495bSYour Name 			fw_reason1
1162*5113495bSYour Name 
1163*5113495bSYour Name 			<enum 7 tqm_fw_reason3> frame is removed because a
1164*5113495bSYour Name 			remove command where fw indicated that remove reason is
1165*5113495bSYour Name 			fw_reason1
1166*5113495bSYour Name 
1167*5113495bSYour Name 			<enum 8 tqm_rr_rem_cmd_disable_queue> frame is removed
1168*5113495bSYour Name 			because a remove command of type
1169*5113495bSYour Name 			remove_mpdus_and_disable_queue or
1170*5113495bSYour Name 			remove_msdus_and_disable_flow initiated by SW
1171*5113495bSYour Name 
1172*5113495bSYour Name 
1173*5113495bSYour Name 
1174*5113495bSYour Name 			<legal 0-8>
1175*5113495bSYour Name */
1176*5113495bSYour Name #define WBM_RELEASE_RING_2_TQM_RELEASE_REASON_OFFSET                 0x00000008
1177*5113495bSYour Name #define WBM_RELEASE_RING_2_TQM_RELEASE_REASON_LSB                    13
1178*5113495bSYour Name #define WBM_RELEASE_RING_2_TQM_RELEASE_REASON_MASK                   0x0001e000
1179*5113495bSYour Name 
1180*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RXDMA_PUSH_REASON
1181*5113495bSYour Name 
1182*5113495bSYour Name 			Field only valid when Release_source_module is set to
1183*5113495bSYour Name 			release_source_RXDMA
1184*5113495bSYour Name 
1185*5113495bSYour Name 
1186*5113495bSYour Name 
1187*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
1188*5113495bSYour Name 
1189*5113495bSYour Name 
1190*5113495bSYour Name 
1191*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
1192*5113495bSYour Name 			pushed this frame to this queue
1193*5113495bSYour Name 
1194*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
1195*5113495bSYour Name 			frame to this queue per received routing instructions. No
1196*5113495bSYour Name 			error within RXDMA was detected
1197*5113495bSYour Name 
1198*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
1199*5113495bSYour Name 			result the MSDU link descriptor might not have the
1200*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
1201*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
1202*5113495bSYour Name 			considered a normal condition for this scenario.
1203*5113495bSYour Name 
1204*5113495bSYour Name 
1205*5113495bSYour Name 
1206*5113495bSYour Name 			<legal 0 - 2>
1207*5113495bSYour Name */
1208*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_PUSH_REASON_OFFSET                  0x00000008
1209*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_PUSH_REASON_LSB                     17
1210*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_PUSH_REASON_MASK                    0x00060000
1211*5113495bSYour Name 
1212*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RXDMA_ERROR_CODE
1213*5113495bSYour Name 
1214*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
1215*5113495bSYour Name 			'rxdma_error_detected'.
1216*5113495bSYour Name 
1217*5113495bSYour Name 
1218*5113495bSYour Name 
1219*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
1220*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
1221*5113495bSYour Name 
1222*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
1223*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
1224*5113495bSYour Name 
1225*5113495bSYour Name 
1226*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
1227*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
1228*5113495bSYour Name 			a valid corresponding key id in the peer entry.
1229*5113495bSYour Name 
1230*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
1231*5113495bSYour Name 			error
1232*5113495bSYour Name 
1233*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
1234*5113495bSYour Name 			unencrypted frame error when encrypted was expected
1235*5113495bSYour Name 
1236*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
1237*5113495bSYour Name 			length error
1238*5113495bSYour Name 
1239*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
1240*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
1241*5113495bSYour Name 
1242*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
1243*5113495bSYour Name 			error
1244*5113495bSYour Name 
1245*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
1246*5113495bSYour Name 			parsing error
1247*5113495bSYour Name 
1248*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
1249*5113495bSYour Name 			during SA search
1250*5113495bSYour Name 
1251*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
1252*5113495bSYour Name 			during DA search
1253*5113495bSYour Name 
1254*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
1255*5113495bSYour Name 			timeout during flow search
1256*5113495bSYour Name 
1257*5113495bSYour Name 			<enum 13 rxdma_flush_request>RXDMA received a flush
1258*5113495bSYour Name 			request
1259*5113495bSYour Name 
1260*5113495bSYour Name 			<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
1261*5113495bSYour Name 			present as well as a fragmented MPDU. A-MSDU defragmentation
1262*5113495bSYour Name 			is not supported in Lithium SW so this is treated as an
1263*5113495bSYour Name 			error.
1264*5113495bSYour Name */
1265*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_OFFSET                   0x00000008
1266*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_LSB                      19
1267*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_MASK                     0x00f80000
1268*5113495bSYour Name 
1269*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_REO_PUSH_REASON
1270*5113495bSYour Name 
1271*5113495bSYour Name 			Field only valid when Release_source_module is set to
1272*5113495bSYour Name 			release_source_REO
1273*5113495bSYour Name 
1274*5113495bSYour Name 
1275*5113495bSYour Name 
1276*5113495bSYour Name 			Indicates why REO pushed the frame to this release ring
1277*5113495bSYour Name 
1278*5113495bSYour Name 
1279*5113495bSYour Name 
1280*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an
1281*5113495bSYour Name 			pushed this frame to this queue
1282*5113495bSYour Name 
1283*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
1284*5113495bSYour Name 			this queue per received routing instructions. No error
1285*5113495bSYour Name 			within REO was detected
1286*5113495bSYour Name 
1287*5113495bSYour Name 
1288*5113495bSYour Name 
1289*5113495bSYour Name 			<legal 0 - 1>
1290*5113495bSYour Name */
1291*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_PUSH_REASON_OFFSET                    0x00000008
1292*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_PUSH_REASON_LSB                       24
1293*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_PUSH_REASON_MASK                      0x03000000
1294*5113495bSYour Name 
1295*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_REO_ERROR_CODE
1296*5113495bSYour Name 
1297*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to
1298*5113495bSYour Name 			'reo_error_detected'.
1299*5113495bSYour Name 
1300*5113495bSYour Name 
1301*5113495bSYour Name 
1302*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor
1303*5113495bSYour Name 			provided in the REO_ENTRANCE ring is set to 0
1304*5113495bSYour Name 
1305*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor
1306*5113495bSYour Name 			valid bit is NOT set
1307*5113495bSYour Name 
1308*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
1309*5113495bSYour Name 			session having been setup.
1310*5113495bSYour Name 
1311*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to
1312*5113495bSYour Name 			SSN, Retry bit set: duplicate frame
1313*5113495bSYour Name 
1314*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
1315*5113495bSYour Name 
1316*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
1317*5113495bSYour Name 			frame) received with 2K jump in SN
1318*5113495bSYour Name 
1319*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump
1320*5113495bSYour Name 			in SSN
1321*5113495bSYour Name 
1322*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data
1323*5113495bSYour Name 			frame) received with SN falling within the OOR window
1324*5113495bSYour Name 
1325*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling
1326*5113495bSYour Name 			within the OOR window
1327*5113495bSYour Name 
1328*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
1329*5113495bSYour Name 			a BA session
1330*5113495bSYour Name 
1331*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with
1332*5113495bSYour Name 			SSN equal to SN
1333*5113495bSYour Name 
1334*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
1335*5113495bSYour Name 
1336*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
1337*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set in
1338*5113495bSYour Name 			the REO Queue descriptor
1339*5113495bSYour Name 
1340*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
1341*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in the
1342*5113495bSYour Name 			REO Queue descriptor
1343*5113495bSYour Name 
1344*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is
1345*5113495bSYour Name 			forwarded as a result of the queue descriptor(address) being
1346*5113495bSYour Name 			blocked as SW/FW seems to be currently in the process of
1347*5113495bSYour Name 			making updates to this descriptor...
1348*5113495bSYour Name 
1349*5113495bSYour Name 
1350*5113495bSYour Name 
1351*5113495bSYour Name 			<legal 0-14>
1352*5113495bSYour Name */
1353*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_ERROR_CODE_OFFSET                     0x00000008
1354*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_ERROR_CODE_LSB                        26
1355*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_ERROR_CODE_MASK                       0x7c000000
1356*5113495bSYour Name 
1357*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR
1358*5113495bSYour Name 
1359*5113495bSYour Name 			Can only be set by WBM.
1360*5113495bSYour Name 
1361*5113495bSYour Name 
1362*5113495bSYour Name 
1363*5113495bSYour Name 			Is set when WBM got a buffer pointer but the action was
1364*5113495bSYour Name 			to push it to the idle link descriptor ring or do link
1365*5113495bSYour Name 			related activity
1366*5113495bSYour Name 
1367*5113495bSYour Name 			OR
1368*5113495bSYour Name 
1369*5113495bSYour Name 			Is set when WBM got a link buffer pointer but the action
1370*5113495bSYour Name 			was to push it to the buffer  descriptor ring
1371*5113495bSYour Name 
1372*5113495bSYour Name 
1373*5113495bSYour Name 
1374*5113495bSYour Name 			<legal all>
1375*5113495bSYour Name */
1376*5113495bSYour Name #define WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR_OFFSET                 0x00000008
1377*5113495bSYour Name #define WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR_LSB                    31
1378*5113495bSYour Name #define WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR_MASK                   0x80000000
1379*5113495bSYour Name 
1380*5113495bSYour Name /* Description		WBM_RELEASE_RING_3_TQM_STATUS_NUMBER
1381*5113495bSYour Name 
1382*5113495bSYour Name 			Field only valid when Release_source_module is set to
1383*5113495bSYour Name 			release_source_TQM
1384*5113495bSYour Name 
1385*5113495bSYour Name 
1386*5113495bSYour Name 
1387*5113495bSYour Name 			The value in this field is equal to value of the
1388*5113495bSYour Name 			'TQM_CMD_Number' field the TQM command or the
1389*5113495bSYour Name 			'TQM_add_cmd_Number' field from the TQM entrance ring
1390*5113495bSYour Name 			descriptor
1391*5113495bSYour Name 
1392*5113495bSYour Name 
1393*5113495bSYour Name 
1394*5113495bSYour Name 			This field helps to correlate the statuses with the TQM
1395*5113495bSYour Name 			commands.
1396*5113495bSYour Name 
1397*5113495bSYour Name 
1398*5113495bSYour Name 
1399*5113495bSYour Name 			NOTE that SW could program this number to be equal to
1400*5113495bSYour Name 			the PPDU_ID number in case direct correlation with the PPDU
1401*5113495bSYour Name 			ID is desired
1402*5113495bSYour Name 
1403*5113495bSYour Name 
1404*5113495bSYour Name 
1405*5113495bSYour Name 			<legal all>
1406*5113495bSYour Name */
1407*5113495bSYour Name #define WBM_RELEASE_RING_3_TQM_STATUS_NUMBER_OFFSET                  0x0000000c
1408*5113495bSYour Name #define WBM_RELEASE_RING_3_TQM_STATUS_NUMBER_LSB                     0
1409*5113495bSYour Name #define WBM_RELEASE_RING_3_TQM_STATUS_NUMBER_MASK                    0x00ffffff
1410*5113495bSYour Name 
1411*5113495bSYour Name /* Description		WBM_RELEASE_RING_3_TRANSMIT_COUNT
1412*5113495bSYour Name 
1413*5113495bSYour Name 			Field only valid when Release_source_module is set to
1414*5113495bSYour Name 			release_source_TQM
1415*5113495bSYour Name 
1416*5113495bSYour Name 
1417*5113495bSYour Name 
1418*5113495bSYour Name 			The number of times this frame has been transmitted
1419*5113495bSYour Name */
1420*5113495bSYour Name #define WBM_RELEASE_RING_3_TRANSMIT_COUNT_OFFSET                     0x0000000c
1421*5113495bSYour Name #define WBM_RELEASE_RING_3_TRANSMIT_COUNT_LSB                        24
1422*5113495bSYour Name #define WBM_RELEASE_RING_3_TRANSMIT_COUNT_MASK                       0x7f000000
1423*5113495bSYour Name 
1424*5113495bSYour Name /* Description		WBM_RELEASE_RING_3_MSDU_CONTINUATION
1425*5113495bSYour Name 
1426*5113495bSYour Name 			FR53947 requests MSDU_continuation reporting for Rx
1427*5113495bSYour Name 			MSDUs in Pine and HastingsPrime for which
1428*5113495bSYour Name 			SW_release_details_valid may not be set.
1429*5113495bSYour Name 
1430*5113495bSYour Name 			<legal all>
1431*5113495bSYour Name */
1432*5113495bSYour Name #define WBM_RELEASE_RING_3_MSDU_CONTINUATION_OFFSET                  0x0000000c
1433*5113495bSYour Name #define WBM_RELEASE_RING_3_MSDU_CONTINUATION_LSB                     31
1434*5113495bSYour Name #define WBM_RELEASE_RING_3_MSDU_CONTINUATION_MASK                    0x80000000
1435*5113495bSYour Name 
1436*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_ACK_FRAME_RSSI
1437*5113495bSYour Name 
1438*5113495bSYour Name 			This field is only valid when the source is TQM.
1439*5113495bSYour Name 
1440*5113495bSYour Name 
1441*5113495bSYour Name 
1442*5113495bSYour Name 			If this frame is removed as the result of the reception
1443*5113495bSYour Name 			of an ACK or BA, this field indicates the RSSI of the
1444*5113495bSYour Name 			received ACK or BA frame.
1445*5113495bSYour Name 
1446*5113495bSYour Name 
1447*5113495bSYour Name 
1448*5113495bSYour Name 			When the frame is removed as result of a direct remove
1449*5113495bSYour Name 			command from the SW,  this field is set to 0x0 (which is
1450*5113495bSYour Name 			never a valid value when real RSSI is available)
1451*5113495bSYour Name 
1452*5113495bSYour Name 
1453*5113495bSYour Name 
1454*5113495bSYour Name 			<legal all>
1455*5113495bSYour Name */
1456*5113495bSYour Name #define WBM_RELEASE_RING_4_ACK_FRAME_RSSI_OFFSET                     0x00000010
1457*5113495bSYour Name #define WBM_RELEASE_RING_4_ACK_FRAME_RSSI_LSB                        0
1458*5113495bSYour Name #define WBM_RELEASE_RING_4_ACK_FRAME_RSSI_MASK                       0x000000ff
1459*5113495bSYour Name 
1460*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID
1461*5113495bSYour Name 
1462*5113495bSYour Name 			Consumer: SW
1463*5113495bSYour Name 
1464*5113495bSYour Name 			Producer: WBM
1465*5113495bSYour Name 
1466*5113495bSYour Name 
1467*5113495bSYour Name 
1468*5113495bSYour Name 			When set, some WBM specific release info for SW is
1469*5113495bSYour Name 			valid.
1470*5113495bSYour Name 
1471*5113495bSYour Name 			This is set when WMB got a 'release_msdu_list' command
1472*5113495bSYour Name 			from TQM and the return buffer manager is not WMB. WBM will
1473*5113495bSYour Name 			then de-aggregate all the MSDUs and pass them one at a time
1474*5113495bSYour Name 			on to the 'buffer owner'
1475*5113495bSYour Name 
1476*5113495bSYour Name 
1477*5113495bSYour Name 
1478*5113495bSYour Name 			<legal all>
1479*5113495bSYour Name */
1480*5113495bSYour Name #define WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID_OFFSET           0x00000010
1481*5113495bSYour Name #define WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID_LSB              8
1482*5113495bSYour Name #define WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID_MASK             0x00000100
1483*5113495bSYour Name 
1484*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_FIRST_MSDU
1485*5113495bSYour Name 
1486*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1487*5113495bSYour Name 
1488*5113495bSYour Name 
1489*5113495bSYour Name 
1490*5113495bSYour Name 			Consumer: SW
1491*5113495bSYour Name 
1492*5113495bSYour Name 			Producer: WBM
1493*5113495bSYour Name 
1494*5113495bSYour Name 
1495*5113495bSYour Name 
1496*5113495bSYour Name 			When set, this MSDU is the first MSDU pointed to in the
1497*5113495bSYour Name 			'release_msdu_list' command.
1498*5113495bSYour Name 
1499*5113495bSYour Name 
1500*5113495bSYour Name 
1501*5113495bSYour Name 			FR53947 extends this to Rx MSDUs in Pine and
1502*5113495bSYour Name 			HastingsPrime for which SW_release_details_valid may not be
1503*5113495bSYour Name 			set.
1504*5113495bSYour Name 
1505*5113495bSYour Name 			<legal all>
1506*5113495bSYour Name */
1507*5113495bSYour Name #define WBM_RELEASE_RING_4_FIRST_MSDU_OFFSET                         0x00000010
1508*5113495bSYour Name #define WBM_RELEASE_RING_4_FIRST_MSDU_LSB                            9
1509*5113495bSYour Name #define WBM_RELEASE_RING_4_FIRST_MSDU_MASK                           0x00000200
1510*5113495bSYour Name 
1511*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_LAST_MSDU
1512*5113495bSYour Name 
1513*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1514*5113495bSYour Name 
1515*5113495bSYour Name 
1516*5113495bSYour Name 
1517*5113495bSYour Name 			Consumer: SW
1518*5113495bSYour Name 
1519*5113495bSYour Name 			Producer: WBM
1520*5113495bSYour Name 
1521*5113495bSYour Name 
1522*5113495bSYour Name 
1523*5113495bSYour Name 			When set, this MSDU is the last MSDU pointed to in the
1524*5113495bSYour Name 			'release_msdu_list' command.
1525*5113495bSYour Name 
1526*5113495bSYour Name 
1527*5113495bSYour Name 
1528*5113495bSYour Name 			FR53947 extends this to Rx MSDUs in Pine and
1529*5113495bSYour Name 			HastingsPrime for which SW_release_details_valid may not be
1530*5113495bSYour Name 			set.
1531*5113495bSYour Name 
1532*5113495bSYour Name 			<legal all>
1533*5113495bSYour Name */
1534*5113495bSYour Name #define WBM_RELEASE_RING_4_LAST_MSDU_OFFSET                          0x00000010
1535*5113495bSYour Name #define WBM_RELEASE_RING_4_LAST_MSDU_LSB                             10
1536*5113495bSYour Name #define WBM_RELEASE_RING_4_LAST_MSDU_MASK                            0x00000400
1537*5113495bSYour Name 
1538*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU
1539*5113495bSYour Name 
1540*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1541*5113495bSYour Name 
1542*5113495bSYour Name 
1543*5113495bSYour Name 
1544*5113495bSYour Name 			Consumer: SW
1545*5113495bSYour Name 
1546*5113495bSYour Name 			Producer: WBM
1547*5113495bSYour Name 
1548*5113495bSYour Name 
1549*5113495bSYour Name 
1550*5113495bSYour Name 			When set, this MSDU was part of an A-MSDU in MPDU
1551*5113495bSYour Name 
1552*5113495bSYour Name 			<legal all>
1553*5113495bSYour Name */
1554*5113495bSYour Name #define WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU_OFFSET                 0x00000010
1555*5113495bSYour Name #define WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU_LSB                    11
1556*5113495bSYour Name #define WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU_MASK                   0x00000800
1557*5113495bSYour Name 
1558*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME
1559*5113495bSYour Name 
1560*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1561*5113495bSYour Name 
1562*5113495bSYour Name 
1563*5113495bSYour Name 
1564*5113495bSYour Name 			Consumer: SW
1565*5113495bSYour Name 
1566*5113495bSYour Name 			Producer: WBM
1567*5113495bSYour Name 
1568*5113495bSYour Name 
1569*5113495bSYour Name 
1570*5113495bSYour Name 			This is the FW_tx_notify_frame field from the
1571*5113495bSYour Name 
1572*5113495bSYour Name 			<legal all>
1573*5113495bSYour Name */
1574*5113495bSYour Name #define WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME_OFFSET                 0x00000010
1575*5113495bSYour Name #define WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME_LSB                    12
1576*5113495bSYour Name #define WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME_MASK                   0x00001000
1577*5113495bSYour Name 
1578*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_BUFFER_TIMESTAMP
1579*5113495bSYour Name 
1580*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1581*5113495bSYour Name 
1582*5113495bSYour Name 
1583*5113495bSYour Name 
1584*5113495bSYour Name 			Consumer: SW
1585*5113495bSYour Name 
1586*5113495bSYour Name 			Producer: WBM
1587*5113495bSYour Name 
1588*5113495bSYour Name 
1589*5113495bSYour Name 
1590*5113495bSYour Name 			This is the Buffer_timestamp field from the
1591*5113495bSYour Name 			TX_MSDU_DETAILS for this frame from the MSDU link
1592*5113495bSYour Name 			descriptor.
1593*5113495bSYour Name 
1594*5113495bSYour Name 
1595*5113495bSYour Name 
1596*5113495bSYour Name 			Timestamp in units of 1024 µs
1597*5113495bSYour Name 
1598*5113495bSYour Name 			<legal all>
1599*5113495bSYour Name */
1600*5113495bSYour Name #define WBM_RELEASE_RING_4_BUFFER_TIMESTAMP_OFFSET                   0x00000010
1601*5113495bSYour Name #define WBM_RELEASE_RING_4_BUFFER_TIMESTAMP_LSB                      13
1602*5113495bSYour Name #define WBM_RELEASE_RING_4_BUFFER_TIMESTAMP_MASK                     0xffffe000
1603*5113495bSYour Name 
1604*5113495bSYour Name  /* EXTERNAL REFERENCE : struct tx_rate_stats_info tx_rate_stats */
1605*5113495bSYour Name 
1606*5113495bSYour Name 
1607*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TX_RATE_STATS_INFO_VALID
1608*5113495bSYour Name 
1609*5113495bSYour Name 			When set all other fields in this STRUCT contain valid
1610*5113495bSYour Name 			info.
1611*5113495bSYour Name 
1612*5113495bSYour Name 
1613*5113495bSYour Name 
1614*5113495bSYour Name 
1615*5113495bSYour Name 			<legal all>
1616*5113495bSYour Name */
1617*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TX_RATE_STATS_INFO_VALID_OFFSET 0x00000014
1618*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TX_RATE_STATS_INFO_VALID_LSB 0
1619*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TX_RATE_STATS_INFO_VALID_MASK 0x00000001
1620*5113495bSYour Name 
1621*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_BW
1622*5113495bSYour Name 
1623*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1624*5113495bSYour Name 
1625*5113495bSYour Name 
1626*5113495bSYour Name 
1627*5113495bSYour Name 			Indicates the BW of the upcoming transmission that shall
1628*5113495bSYour Name 			likely start in about 3 -4 us on the medium
1629*5113495bSYour Name 
1630*5113495bSYour Name 
1631*5113495bSYour Name 
1632*5113495bSYour Name 			<enum 0 transmit_bw_20_MHz>
1633*5113495bSYour Name 
1634*5113495bSYour Name 			<enum 1 transmit_bw_40_MHz>
1635*5113495bSYour Name 
1636*5113495bSYour Name 			<enum 2 transmit_bw_80_MHz>
1637*5113495bSYour Name 
1638*5113495bSYour Name 			<enum 3 transmit_bw_160_MHz>
1639*5113495bSYour Name 
1640*5113495bSYour Name 
1641*5113495bSYour Name 
1642*5113495bSYour Name 			<legal all>
1643*5113495bSYour Name */
1644*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_BW_OFFSET          0x00000014
1645*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_BW_LSB             1
1646*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_BW_MASK            0x00000006
1647*5113495bSYour Name 
1648*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_PKT_TYPE
1649*5113495bSYour Name 
1650*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1651*5113495bSYour Name 
1652*5113495bSYour Name 
1653*5113495bSYour Name 
1654*5113495bSYour Name 			Field filled in by PDG.
1655*5113495bSYour Name 
1656*5113495bSYour Name 			Not valid when in SW transmit mode
1657*5113495bSYour Name 
1658*5113495bSYour Name 
1659*5113495bSYour Name 
1660*5113495bSYour Name 			The packet type
1661*5113495bSYour Name 
1662*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
1663*5113495bSYour Name 
1664*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
1665*5113495bSYour Name 
1666*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
1667*5113495bSYour Name 
1668*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
1669*5113495bSYour Name 
1670*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
1671*5113495bSYour Name 
1672*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
1673*5113495bSYour Name */
1674*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_PKT_TYPE_OFFSET    0x00000014
1675*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_PKT_TYPE_LSB       3
1676*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_PKT_TYPE_MASK      0x00000078
1677*5113495bSYour Name 
1678*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_STBC
1679*5113495bSYour Name 
1680*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1681*5113495bSYour Name 
1682*5113495bSYour Name 
1683*5113495bSYour Name 
1684*5113495bSYour Name 			Field filled in by PDG.
1685*5113495bSYour Name 
1686*5113495bSYour Name 			Not valid when in SW transmit mode
1687*5113495bSYour Name 
1688*5113495bSYour Name 
1689*5113495bSYour Name 
1690*5113495bSYour Name 			When set, STBC transmission rate was used.
1691*5113495bSYour Name */
1692*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_STBC_OFFSET        0x00000014
1693*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_STBC_LSB           7
1694*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_STBC_MASK          0x00000080
1695*5113495bSYour Name 
1696*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_LDPC
1697*5113495bSYour Name 
1698*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1699*5113495bSYour Name 
1700*5113495bSYour Name 
1701*5113495bSYour Name 
1702*5113495bSYour Name 			Field filled in by PDG.
1703*5113495bSYour Name 
1704*5113495bSYour Name 			Not valid when in SW transmit mode
1705*5113495bSYour Name 
1706*5113495bSYour Name 
1707*5113495bSYour Name 
1708*5113495bSYour Name 			When set, use LDPC transmission rates
1709*5113495bSYour Name */
1710*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_LDPC_OFFSET        0x00000014
1711*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_LDPC_LSB           8
1712*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_LDPC_MASK          0x00000100
1713*5113495bSYour Name 
1714*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_SGI
1715*5113495bSYour Name 
1716*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1717*5113495bSYour Name 
1718*5113495bSYour Name 
1719*5113495bSYour Name 
1720*5113495bSYour Name 			Field filled in by PDG.
1721*5113495bSYour Name 
1722*5113495bSYour Name 			Not valid when in SW transmit mode
1723*5113495bSYour Name 
1724*5113495bSYour Name 
1725*5113495bSYour Name 
1726*5113495bSYour Name 			<enum 0     0_8_us_sgi > Legacy normal GI. Can also be
1727*5113495bSYour Name 			used for HE
1728*5113495bSYour Name 
1729*5113495bSYour Name 			<enum 1     0_4_us_sgi > Legacy short GI. Can also be
1730*5113495bSYour Name 			used for HE
1731*5113495bSYour Name 
1732*5113495bSYour Name 			<enum 2     1_6_us_sgi > HE related GI
1733*5113495bSYour Name 
1734*5113495bSYour Name 			<enum 3     3_2_us_sgi > HE related GI
1735*5113495bSYour Name 
1736*5113495bSYour Name 			<legal 0 - 3>
1737*5113495bSYour Name */
1738*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_SGI_OFFSET         0x00000014
1739*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_SGI_LSB            9
1740*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_SGI_MASK           0x00000600
1741*5113495bSYour Name 
1742*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_MCS
1743*5113495bSYour Name 
1744*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1745*5113495bSYour Name 
1746*5113495bSYour Name 
1747*5113495bSYour Name 
1748*5113495bSYour Name 			Field filled in by PDG.
1749*5113495bSYour Name 
1750*5113495bSYour Name 			Not valid when in SW transmit mode
1751*5113495bSYour Name 
1752*5113495bSYour Name 
1753*5113495bSYour Name 
1754*5113495bSYour Name 			For details, refer to  MCS_TYPE description
1755*5113495bSYour Name 
1756*5113495bSYour Name 			<legal all>
1757*5113495bSYour Name */
1758*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_MCS_OFFSET         0x00000014
1759*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_MCS_LSB            11
1760*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TRANSMIT_MCS_MASK           0x00007800
1761*5113495bSYour Name 
1762*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_OFDMA_TRANSMISSION
1763*5113495bSYour Name 
1764*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1765*5113495bSYour Name 
1766*5113495bSYour Name 
1767*5113495bSYour Name 
1768*5113495bSYour Name 			Field filled in by PDG.
1769*5113495bSYour Name 
1770*5113495bSYour Name 
1771*5113495bSYour Name 
1772*5113495bSYour Name 			Set when the transmission was an OFDMA transmission (DL
1773*5113495bSYour Name 			or UL).
1774*5113495bSYour Name 
1775*5113495bSYour Name 			<legal all>
1776*5113495bSYour Name */
1777*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_OFDMA_TRANSMISSION_OFFSET   0x00000014
1778*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_OFDMA_TRANSMISSION_LSB      15
1779*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_OFDMA_TRANSMISSION_MASK     0x00008000
1780*5113495bSYour Name 
1781*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_TONES_IN_RU
1782*5113495bSYour Name 
1783*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1784*5113495bSYour Name 
1785*5113495bSYour Name 
1786*5113495bSYour Name 
1787*5113495bSYour Name 			Field filled in by PDG.
1788*5113495bSYour Name 
1789*5113495bSYour Name 			Not valid when in SW transmit mode
1790*5113495bSYour Name 
1791*5113495bSYour Name 
1792*5113495bSYour Name 
1793*5113495bSYour Name 			The number of tones in the RU used.
1794*5113495bSYour Name 
1795*5113495bSYour Name 			<legal all>
1796*5113495bSYour Name */
1797*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TONES_IN_RU_OFFSET          0x00000014
1798*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TONES_IN_RU_LSB             16
1799*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_TONES_IN_RU_MASK            0x0fff0000
1800*5113495bSYour Name 
1801*5113495bSYour Name /* Description		WBM_RELEASE_RING_5_TX_RATE_STATS_RESERVED_0A
1802*5113495bSYour Name 
1803*5113495bSYour Name 			<legal 0>
1804*5113495bSYour Name */
1805*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_RESERVED_0A_OFFSET          0x00000014
1806*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_RESERVED_0A_LSB             28
1807*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_RESERVED_0A_MASK            0xf0000000
1808*5113495bSYour Name 
1809*5113495bSYour Name /* Description		WBM_RELEASE_RING_6_TX_RATE_STATS_PPDU_TRANSMISSION_TSF
1810*5113495bSYour Name 
1811*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
1812*5113495bSYour Name 
1813*5113495bSYour Name 
1814*5113495bSYour Name 
1815*5113495bSYour Name 			Based on a HWSCH configuration register setting, this
1816*5113495bSYour Name 			field either contains:
1817*5113495bSYour Name 
1818*5113495bSYour Name 
1819*5113495bSYour Name 
1820*5113495bSYour Name 			Lower 32 bits of the TSF, snapshot of this value when
1821*5113495bSYour Name 			transmission of the PPDU containing the frame finished.
1822*5113495bSYour Name 
1823*5113495bSYour Name 			OR
1824*5113495bSYour Name 
1825*5113495bSYour Name 			Lower 32 bits of the TSF, snapshot of this value when
1826*5113495bSYour Name 			transmission of the PPDU containing the frame started
1827*5113495bSYour Name 
1828*5113495bSYour Name 
1829*5113495bSYour Name 
1830*5113495bSYour Name 			<legal all>
1831*5113495bSYour Name */
1832*5113495bSYour Name #define WBM_RELEASE_RING_6_TX_RATE_STATS_PPDU_TRANSMISSION_TSF_OFFSET 0x00000018
1833*5113495bSYour Name #define WBM_RELEASE_RING_6_TX_RATE_STATS_PPDU_TRANSMISSION_TSF_LSB   0
1834*5113495bSYour Name #define WBM_RELEASE_RING_6_TX_RATE_STATS_PPDU_TRANSMISSION_TSF_MASK  0xffffffff
1835*5113495bSYour Name 
1836*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_SW_PEER_ID
1837*5113495bSYour Name 
1838*5113495bSYour Name 			Field only valid when Release_source_module is set to
1839*5113495bSYour Name 			release_source_TQM
1840*5113495bSYour Name 
1841*5113495bSYour Name 
1842*5113495bSYour Name 
1843*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
1844*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
1845*5113495bSYour Name 
1846*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1847*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1848*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1849*5113495bSYour Name 
1850*5113495bSYour Name 
1851*5113495bSYour Name 
1852*5113495bSYour Name 
1853*5113495bSYour Name 
1854*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
1855*5113495bSYour Name 			hence sw_peer_id and tid = 0
1856*5113495bSYour Name 
1857*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1858*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1859*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1860*5113495bSYour Name 
1861*5113495bSYour Name 
1862*5113495bSYour Name 
1863*5113495bSYour Name 
1864*5113495bSYour Name 
1865*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
1866*5113495bSYour Name 			command.
1867*5113495bSYour Name 
1868*5113495bSYour Name 			buffer_or_desc_type = e_num1
1869*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
1870*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
1871*5113495bSYour Name 
1872*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
1873*5113495bSYour Name 
1874*5113495bSYour Name 
1875*5113495bSYour Name 
1876*5113495bSYour Name 			Sw_peer_id from the TX_MSDU_FLOW descriptor or
1877*5113495bSYour Name 			TX_MPDU_QUEUE descriptor
1878*5113495bSYour Name 
1879*5113495bSYour Name 			<legal all>
1880*5113495bSYour Name */
1881*5113495bSYour Name #define WBM_RELEASE_RING_7_SW_PEER_ID_OFFSET                         0x0000001c
1882*5113495bSYour Name #define WBM_RELEASE_RING_7_SW_PEER_ID_LSB                            0
1883*5113495bSYour Name #define WBM_RELEASE_RING_7_SW_PEER_ID_MASK                           0x0000ffff
1884*5113495bSYour Name 
1885*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_TID
1886*5113495bSYour Name 
1887*5113495bSYour Name 			Field only valid when Release_source_module is set to
1888*5113495bSYour Name 			release_source_TQM
1889*5113495bSYour Name 
1890*5113495bSYour Name 
1891*5113495bSYour Name 
1892*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
1893*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
1894*5113495bSYour Name 
1895*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1896*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1897*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1898*5113495bSYour Name 
1899*5113495bSYour Name 
1900*5113495bSYour Name 
1901*5113495bSYour Name 
1902*5113495bSYour Name 
1903*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
1904*5113495bSYour Name 			hence sw_peer_id and tid = 0
1905*5113495bSYour Name 
1906*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1907*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1908*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1909*5113495bSYour Name 
1910*5113495bSYour Name 
1911*5113495bSYour Name 
1912*5113495bSYour Name 
1913*5113495bSYour Name 
1914*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
1915*5113495bSYour Name 			command.
1916*5113495bSYour Name 
1917*5113495bSYour Name 			buffer_or_desc_type = e_num1
1918*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
1919*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
1920*5113495bSYour Name 
1921*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
1922*5113495bSYour Name 
1923*5113495bSYour Name 
1924*5113495bSYour Name 
1925*5113495bSYour Name 
1926*5113495bSYour Name 
1927*5113495bSYour Name 			This field represents the TID from the TX_MSDU_FLOW
1928*5113495bSYour Name 			descriptor or TX_MPDU_QUEUE descriptor
1929*5113495bSYour Name 
1930*5113495bSYour Name 
1931*5113495bSYour Name 
1932*5113495bSYour Name 			 <legal all>
1933*5113495bSYour Name */
1934*5113495bSYour Name #define WBM_RELEASE_RING_7_TID_OFFSET                                0x0000001c
1935*5113495bSYour Name #define WBM_RELEASE_RING_7_TID_LSB                                   16
1936*5113495bSYour Name #define WBM_RELEASE_RING_7_TID_MASK                                  0x000f0000
1937*5113495bSYour Name 
1938*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_RING_ID
1939*5113495bSYour Name 
1940*5113495bSYour Name 			Consumer: TQM/REO/RXDMA/SW
1941*5113495bSYour Name 
1942*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1943*5113495bSYour Name 
1944*5113495bSYour Name 
1945*5113495bSYour Name 
1946*5113495bSYour Name 			For debugging.
1947*5113495bSYour Name 
1948*5113495bSYour Name 			This field is filled in by the SRNG module.
1949*5113495bSYour Name 
1950*5113495bSYour Name 			It help to identify the ring that is being looked <legal
1951*5113495bSYour Name 			all>
1952*5113495bSYour Name */
1953*5113495bSYour Name #define WBM_RELEASE_RING_7_RING_ID_OFFSET                            0x0000001c
1954*5113495bSYour Name #define WBM_RELEASE_RING_7_RING_ID_LSB                               20
1955*5113495bSYour Name #define WBM_RELEASE_RING_7_RING_ID_MASK                              0x0ff00000
1956*5113495bSYour Name 
1957*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_LOOPING_COUNT
1958*5113495bSYour Name 
1959*5113495bSYour Name 			Consumer: WBM/SW/FW
1960*5113495bSYour Name 
1961*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
1962*5113495bSYour Name 
1963*5113495bSYour Name 
1964*5113495bSYour Name 
1965*5113495bSYour Name 			A count value that indicates the number of times the
1966*5113495bSYour Name 			producer of entries into the Buffer Manager Ring has looped
1967*5113495bSYour Name 			around the ring.
1968*5113495bSYour Name 
1969*5113495bSYour Name 			At initialization time, this value is set to 0. On the
1970*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
1971*5113495bSYour Name 			reached allowed by the number of bits for this field, the
1972*5113495bSYour Name 			count value continues with 0 again.
1973*5113495bSYour Name 
1974*5113495bSYour Name 
1975*5113495bSYour Name 
1976*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
1977*5113495bSYour Name 			use this field to figure out up to where the producer of
1978*5113495bSYour Name 			entries has created new entries. This eliminates the need to
1979*5113495bSYour Name 			check where the head pointer' of the ring is located once
1980*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
1981*5113495bSYour Name 			entries have been put into this ring...
1982*5113495bSYour Name 
1983*5113495bSYour Name 
1984*5113495bSYour Name 
1985*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1986*5113495bSYour Name 			LSB bit of this count value.
1987*5113495bSYour Name 
1988*5113495bSYour Name 			<legal all>
1989*5113495bSYour Name */
1990*5113495bSYour Name #define WBM_RELEASE_RING_7_LOOPING_COUNT_OFFSET                      0x0000001c
1991*5113495bSYour Name #define WBM_RELEASE_RING_7_LOOPING_COUNT_LSB                         28
1992*5113495bSYour Name #define WBM_RELEASE_RING_7_LOOPING_COUNT_MASK                        0xf0000000
1993*5113495bSYour Name 
1994*5113495bSYour Name 
1995*5113495bSYour Name #endif // _WBM_RELEASE_RING_H_
1996