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