xref: /wlan-driver/fw-api/hw/qca6390/v1/wbm_release_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _WBM_RELEASE_RING_H_
20*5113495bSYour Name #define _WBM_RELEASE_RING_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "buffer_addr_info.h"
25*5113495bSYour Name #include "tx_rate_stats_info.h"
26*5113495bSYour Name 
27*5113495bSYour Name // ################ START SUMMARY #################
28*5113495bSYour Name //
29*5113495bSYour Name //	Dword	Fields
30*5113495bSYour Name //	0-1	struct buffer_addr_info released_buff_or_desc_addr_info;
31*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[15:13], rxdma_push_reason[17:16], rxdma_error_code[22:18], reo_push_reason[24:23], reo_error_code[29:25], wbm_internal_error[30], reserved_2[31]
32*5113495bSYour Name //	3	tqm_status_number[23:0], transmit_count[30:24], reserved_3a[31]
33*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]
34*5113495bSYour Name //	5-6	struct tx_rate_stats_info tx_rate_stats;
35*5113495bSYour Name //	7	sw_peer_id[15:0], tid[19:16], ring_id[27:20], looping_count[31:28]
36*5113495bSYour Name //
37*5113495bSYour Name // ################ END SUMMARY #################
38*5113495bSYour Name 
39*5113495bSYour Name #define NUM_OF_DWORDS_WBM_RELEASE_RING 8
40*5113495bSYour Name 
41*5113495bSYour Name struct wbm_release_ring {
42*5113495bSYour Name     struct            buffer_addr_info                       released_buff_or_desc_addr_info;
43*5113495bSYour Name              uint32_t release_source_module           :  3, //[2:0]
44*5113495bSYour Name                       bm_action                       :  3, //[5:3]
45*5113495bSYour Name                       buffer_or_desc_type             :  3, //[8:6]
46*5113495bSYour Name                       first_msdu_index                :  4, //[12:9]
47*5113495bSYour Name                       tqm_release_reason              :  3, //[15:13]
48*5113495bSYour Name                       rxdma_push_reason               :  2, //[17:16]
49*5113495bSYour Name                       rxdma_error_code                :  5, //[22:18]
50*5113495bSYour Name                       reo_push_reason                 :  2, //[24:23]
51*5113495bSYour Name                       reo_error_code                  :  5, //[29:25]
52*5113495bSYour Name                       wbm_internal_error              :  1, //[30]
53*5113495bSYour Name                       reserved_2                      :  1; //[31]
54*5113495bSYour Name              uint32_t tqm_status_number               : 24, //[23:0]
55*5113495bSYour Name                       transmit_count                  :  7, //[30:24]
56*5113495bSYour Name                       reserved_3a                     :  1; //[31]
57*5113495bSYour Name              uint32_t ack_frame_rssi                  :  8, //[7:0]
58*5113495bSYour Name                       sw_release_details_valid        :  1, //[8]
59*5113495bSYour Name                       first_msdu                      :  1, //[9]
60*5113495bSYour Name                       last_msdu                       :  1, //[10]
61*5113495bSYour Name                       msdu_part_of_amsdu              :  1, //[11]
62*5113495bSYour Name                       fw_tx_notify_frame              :  1, //[12]
63*5113495bSYour Name                       buffer_timestamp                : 19; //[31:13]
64*5113495bSYour Name     struct            tx_rate_stats_info                       tx_rate_stats;
65*5113495bSYour Name              uint32_t sw_peer_id                      : 16, //[15:0]
66*5113495bSYour Name                       tid                             :  4, //[19:16]
67*5113495bSYour Name                       ring_id                         :  8, //[27:20]
68*5113495bSYour Name                       looping_count                   :  4; //[31:28]
69*5113495bSYour Name };
70*5113495bSYour Name 
71*5113495bSYour Name /*
72*5113495bSYour Name 
73*5113495bSYour Name struct buffer_addr_info released_buff_or_desc_addr_info
74*5113495bSYour Name 
75*5113495bSYour Name 			Consumer: WBM/SW/FW
76*5113495bSYour Name 
77*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
78*5113495bSYour Name 
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name 			Details of the physical address of the buffer or link
82*5113495bSYour Name 			descriptor that is being released. Note that within this
83*5113495bSYour Name 			descriptor, WBM will look at the 'owner' of the released
84*5113495bSYour Name 			buffer/descriptor and forward it to SW/FW is WBM is not the
85*5113495bSYour Name 			owner.
86*5113495bSYour Name 
87*5113495bSYour Name release_source_module
88*5113495bSYour Name 
89*5113495bSYour Name 			Indicates which module initiated the release of this
90*5113495bSYour Name 			buffer or descriptor
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name 			<enum 0 release_source_TQM> TQM released this buffer or
95*5113495bSYour Name 			descriptor
96*5113495bSYour Name 
97*5113495bSYour Name 			<enum 1 release_source_RXDMA> RXDMA released this buffer
98*5113495bSYour Name 			or descriptor
99*5113495bSYour Name 
100*5113495bSYour Name 			<enum 2 release_source_REO> REO released this buffer or
101*5113495bSYour Name 			descriptor
102*5113495bSYour Name 
103*5113495bSYour Name 			<enum 3 release_source_FW> FW released this buffer or
104*5113495bSYour Name 			descriptor
105*5113495bSYour Name 
106*5113495bSYour Name 			<enum 4 release_source_SW> SW released this buffer or
107*5113495bSYour Name 			descriptor
108*5113495bSYour Name 
109*5113495bSYour Name 			<legal 0-4>
110*5113495bSYour Name 
111*5113495bSYour Name bm_action
112*5113495bSYour Name 
113*5113495bSYour Name 			Consumer: WBM/SW/FW
114*5113495bSYour Name 
115*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 			Field only valid when the field return_buffer_manager in
120*5113495bSYour Name 			the Released_buff_or_desc_addr_info indicates:
121*5113495bSYour Name 
122*5113495bSYour Name 			WBM_IDLE_BUF_LIST or
123*5113495bSYour Name 
124*5113495bSYour Name 			WBM_IDLE_DESC_LIST
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 
128*5113495bSYour Name 			An MSDU extension descriptor shall never be marked as
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 0 Put_in_idle_list> Put the buffer or descriptor
133*5113495bSYour Name 			back in the idle list. In case of MSDU or MDPU link
134*5113495bSYour Name 			descriptor, BM does not need to check to release any
135*5113495bSYour Name 			individual MSDU buffers
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 			<enum 1 release_msdu_list > This BM action can only be
140*5113495bSYour Name 			used in combination with buffer_or_desc_type being
141*5113495bSYour Name 			msdu_link_descriptor. Field first_msdu_index points out
142*5113495bSYour Name 			which MSDU pointer in the MSDU link descriptor is the first
143*5113495bSYour Name 			of an MPDU that is released.
144*5113495bSYour Name 
145*5113495bSYour Name 			BM shall release all the MSDU buffers linked to this
146*5113495bSYour Name 			first MSDU buffer pointer. All related MSDU buffer pointer
147*5113495bSYour Name 			entries shall be set to value 0, which represents the 'NULL
148*5113495bSYour Name 			pointer. When all MSDU buffer pointers in the MSDU link
149*5113495bSYour Name 			descriptor are 'NULL', the MSDU link descriptor itself shall
150*5113495bSYour Name 			also be released.
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name 			<enum 2 Put_in_idle_list_expanded> CURRENTLY NOT
155*5113495bSYour Name 			IMPLEMENTED....
156*5113495bSYour Name 
157*5113495bSYour Name 			Put the buffer or descriptor back in the idle list. Only
158*5113495bSYour Name 			valid in combination with buffer_or_desc_type indicating
159*5113495bSYour Name 			MDPU_link_descriptor.
160*5113495bSYour Name 
161*5113495bSYour Name 			BM shall release the MPDU link descriptor as well as all
162*5113495bSYour Name 			MSDUs that are linked to the MPDUs in this descriptor.
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name 			<legal 0-2>
167*5113495bSYour Name 
168*5113495bSYour Name buffer_or_desc_type
169*5113495bSYour Name 
170*5113495bSYour Name 			Consumer: WBM/SW/FW
171*5113495bSYour Name 
172*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
173*5113495bSYour Name 
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name 			Field only valid when WBM is marked as the
177*5113495bSYour Name 			return_buffer_manager in the Released_Buffer_address_info
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 			Indicates that type of buffer or descriptor is being
182*5113495bSYour Name 			released
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name 
186*5113495bSYour Name 			<enum 0 MSDU_rel_buffer> The address points to an MSDU
187*5113495bSYour Name 			buffer
188*5113495bSYour Name 
189*5113495bSYour Name 			<enum 1 msdu_link_descriptor> The address points to an
190*5113495bSYour Name 			TX MSDU link descriptor
191*5113495bSYour Name 
192*5113495bSYour Name 			<enum 2 mpdu_link_descriptor> The address points to an
193*5113495bSYour Name 			MPDU link descriptor
194*5113495bSYour Name 
195*5113495bSYour Name 			<enum 3 msdu_ext_descriptor > The address points to an
196*5113495bSYour Name 			MSDU extension descriptor.
197*5113495bSYour Name 
198*5113495bSYour Name 			In case BM finds this one in a release ring, it passes
199*5113495bSYour Name 			it on to FW...
200*5113495bSYour Name 
201*5113495bSYour Name 			<enum 4 queue_ext_descriptor> The address points to an
202*5113495bSYour Name 			TQM queue extension descriptor. WBM should treat this is the
203*5113495bSYour Name 			same way as a link descriptor. That is, put the 128 byte
204*5113495bSYour Name 			buffer back in the link buffer idle list.
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name 			<legal 0-4>
209*5113495bSYour Name 
210*5113495bSYour Name first_msdu_index
211*5113495bSYour Name 
212*5113495bSYour Name 			Consumer: WBM/SW/FW
213*5113495bSYour Name 
214*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
215*5113495bSYour Name 
216*5113495bSYour Name 
217*5113495bSYour Name 
218*5113495bSYour Name 			Field only valid for the bm_action release_msdu_list.
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name 			The index of the first MSDU in an MSDU link descriptor
223*5113495bSYour Name 			all belonging to the same MPDU.
224*5113495bSYour Name 
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 			<legal 0-6>
228*5113495bSYour Name 
229*5113495bSYour Name tqm_release_reason
230*5113495bSYour Name 
231*5113495bSYour Name 			Consumer: WBM/SW/FW
232*5113495bSYour Name 
233*5113495bSYour Name 			Producer: TQM
234*5113495bSYour Name 
235*5113495bSYour Name 
236*5113495bSYour Name 
237*5113495bSYour Name 			Field only valid when Release_source_module is set to
238*5113495bSYour Name 			release_source_TQM
239*5113495bSYour Name 
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name 			(rr = Release Reason)
243*5113495bSYour Name 
244*5113495bSYour Name 			<enum 0 tqm_rr_frame_acked> frame is removed because an
245*5113495bSYour Name 			ACK of BA for it was received
246*5113495bSYour Name 
247*5113495bSYour Name 			<enum 1 tqm_rr_rem_cmd_rem> frame is removed because a
248*5113495bSYour Name 			remove command of type Remove_mpdus initiated by SW
249*5113495bSYour Name 
250*5113495bSYour Name 			<enum 2 tqm_rr_rem_cmd_tx> frame is removed because a
251*5113495bSYour Name 			remove command of type Remove_transmitted_mpdus initiated by
252*5113495bSYour Name 			SW
253*5113495bSYour Name 
254*5113495bSYour Name 			<enum 3 tqm_rr_rem_cmd_notx> frame is removed because a
255*5113495bSYour Name 			remove command of type Remove_untransmitted_mpdus initiated
256*5113495bSYour Name 			by SW
257*5113495bSYour Name 
258*5113495bSYour Name 			<enum 4 tqm_rr_rem_cmd_aged> frame is removed because a
259*5113495bSYour Name 			remove command of type Remove_aged_mpdus or
260*5113495bSYour Name 			Remove_aged_msdus initiated by SW
261*5113495bSYour Name 
262*5113495bSYour Name 			<enum 5 tqm_fw_reason1> frame is removed because a
263*5113495bSYour Name 			remove command where fw indicated that remove reason is
264*5113495bSYour Name 			fw_reason1
265*5113495bSYour Name 
266*5113495bSYour Name 			<enum 6 tqm_fw_reason2> frame is removed because a
267*5113495bSYour Name 			remove command where fw indicated that remove reason is
268*5113495bSYour Name 			fw_reason1
269*5113495bSYour Name 
270*5113495bSYour Name 			<enum 7 tqm_fw_reason3> frame is removed because a
271*5113495bSYour Name 			remove command where fw indicated that remove reason is
272*5113495bSYour Name 			fw_reason1
273*5113495bSYour Name 
274*5113495bSYour Name 
275*5113495bSYour Name 
276*5113495bSYour Name 			<legal 0-7>
277*5113495bSYour Name 
278*5113495bSYour Name rxdma_push_reason
279*5113495bSYour Name 
280*5113495bSYour Name 			Field only valid when Release_source_module is set to
281*5113495bSYour Name 			release_source_RXDMA
282*5113495bSYour Name 
283*5113495bSYour Name 
284*5113495bSYour Name 
285*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
286*5113495bSYour Name 
287*5113495bSYour Name 
288*5113495bSYour Name 
289*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
290*5113495bSYour Name 			pushed this frame to this queue
291*5113495bSYour Name 
292*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
293*5113495bSYour Name 			frame to this queue per received routing instructions. No
294*5113495bSYour Name 			error within RXDMA was detected
295*5113495bSYour Name 
296*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
297*5113495bSYour Name 			result the MSDU link descriptor might not have the
298*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
299*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
300*5113495bSYour Name 			considered a normal condition for this scenario.
301*5113495bSYour Name 
302*5113495bSYour Name 
303*5113495bSYour Name 
304*5113495bSYour Name 			<legal 0 - 2>
305*5113495bSYour Name 
306*5113495bSYour Name rxdma_error_code
307*5113495bSYour Name 
308*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
309*5113495bSYour Name 			'rxdma_error_detected'.
310*5113495bSYour Name 
311*5113495bSYour Name 
312*5113495bSYour Name 
313*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
314*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
315*5113495bSYour Name 
316*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
317*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
318*5113495bSYour Name 
319*5113495bSYour Name 
320*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
321*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
322*5113495bSYour Name 			a valid corresponding key id in the peer entry.
323*5113495bSYour Name 
324*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
325*5113495bSYour Name 			error
326*5113495bSYour Name 
327*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
328*5113495bSYour Name 			unencrypted frame error when encrypted was expected
329*5113495bSYour Name 
330*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
331*5113495bSYour Name 			length error
332*5113495bSYour Name 
333*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
334*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
335*5113495bSYour Name 
336*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
337*5113495bSYour Name 			error
338*5113495bSYour Name 
339*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
340*5113495bSYour Name 			parsing error
341*5113495bSYour Name 
342*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
343*5113495bSYour Name 			during SA search
344*5113495bSYour Name 
345*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
346*5113495bSYour Name 			during DA search
347*5113495bSYour Name 
348*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
349*5113495bSYour Name 			timeout during flow search
350*5113495bSYour Name 
351*5113495bSYour Name 			<enum 13 rxdma_flush_request>RXDMA received a flush
352*5113495bSYour Name 			request
353*5113495bSYour Name 
354*5113495bSYour Name 			<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
355*5113495bSYour Name 			present as well as a fragmented MPDU. A-MSDU defragmentation
356*5113495bSYour Name 			is not supported in Lithium SW so this is treated as an
357*5113495bSYour Name 			error.
358*5113495bSYour Name 
359*5113495bSYour Name reo_push_reason
360*5113495bSYour Name 
361*5113495bSYour Name 			Field only valid when Release_source_module is set to
362*5113495bSYour Name 			release_source_REO
363*5113495bSYour Name 
364*5113495bSYour Name 
365*5113495bSYour Name 
366*5113495bSYour Name 			Indicates why REO pushed the frame to this release ring
367*5113495bSYour Name 
368*5113495bSYour Name 
369*5113495bSYour Name 
370*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an
371*5113495bSYour Name 			pushed this frame to this queue
372*5113495bSYour Name 
373*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
374*5113495bSYour Name 			this queue per received routing instructions. No error
375*5113495bSYour Name 			within REO was detected
376*5113495bSYour Name 
377*5113495bSYour Name 
378*5113495bSYour Name 
379*5113495bSYour Name 			<legal 0 - 1>
380*5113495bSYour Name 
381*5113495bSYour Name reo_error_code
382*5113495bSYour Name 
383*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to
384*5113495bSYour Name 			'reo_error_detected'.
385*5113495bSYour Name 
386*5113495bSYour Name 
387*5113495bSYour Name 
388*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor
389*5113495bSYour Name 			provided in the REO_ENTRANCE ring is set to 0
390*5113495bSYour Name 
391*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor
392*5113495bSYour Name 			valid bit is NOT set
393*5113495bSYour Name 
394*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
395*5113495bSYour Name 			session having been setup.
396*5113495bSYour Name 
397*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to
398*5113495bSYour Name 			SSN, Retry bit set: duplicate frame
399*5113495bSYour Name 
400*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
401*5113495bSYour Name 
402*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
403*5113495bSYour Name 			frame) received with 2K jump in SN
404*5113495bSYour Name 
405*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump
406*5113495bSYour Name 			in SSN
407*5113495bSYour Name 
408*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data
409*5113495bSYour Name 			frame) received with SN falling within the OOR window
410*5113495bSYour Name 
411*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling
412*5113495bSYour Name 			within the OOR window
413*5113495bSYour Name 
414*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
415*5113495bSYour Name 			a BA session
416*5113495bSYour Name 
417*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with
418*5113495bSYour Name 			SSN equal to SN
419*5113495bSYour Name 
420*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
421*5113495bSYour Name 
422*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
423*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set in
424*5113495bSYour Name 			the REO Queue descriptor
425*5113495bSYour Name 
426*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
427*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in the
428*5113495bSYour Name 			REO Queue descriptor
429*5113495bSYour Name 
430*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is
431*5113495bSYour Name 			forwarded as a result of the queue descriptor(address) being
432*5113495bSYour Name 			blocked as SW/FW seems to be currently in the process of
433*5113495bSYour Name 			making updates to this descriptor...
434*5113495bSYour Name 
435*5113495bSYour Name 
436*5113495bSYour Name 
437*5113495bSYour Name 			<legal 0-14>
438*5113495bSYour Name 
439*5113495bSYour Name wbm_internal_error
440*5113495bSYour Name 
441*5113495bSYour Name 			Can only be set by WBM.
442*5113495bSYour Name 
443*5113495bSYour Name 
444*5113495bSYour Name 
445*5113495bSYour Name 			Is set when WBM got a buffer pointer but the action was
446*5113495bSYour Name 			to push it to the idle link descriptor ring or do link
447*5113495bSYour Name 			related activity
448*5113495bSYour Name 
449*5113495bSYour Name 			OR
450*5113495bSYour Name 
451*5113495bSYour Name 			Is set when WBM got a link buffer pointer but the action
452*5113495bSYour Name 			was to push it to the buffer  descriptor ring
453*5113495bSYour Name 
454*5113495bSYour Name 
455*5113495bSYour Name 
456*5113495bSYour Name 			<legal all>
457*5113495bSYour Name 
458*5113495bSYour Name reserved_2
459*5113495bSYour Name 
460*5113495bSYour Name 			<legal 0>
461*5113495bSYour Name 
462*5113495bSYour Name tqm_status_number
463*5113495bSYour Name 
464*5113495bSYour Name 			Field only valid when Release_source_module is set to
465*5113495bSYour Name 			release_source_TQM
466*5113495bSYour Name 
467*5113495bSYour Name 
468*5113495bSYour Name 
469*5113495bSYour Name 			The value in this field is equal to value of the
470*5113495bSYour Name 			'TQM_CMD_Number' field the TQM command or the
471*5113495bSYour Name 			'TQM_add_cmd_Number' field from the TQM entrance ring
472*5113495bSYour Name 			descriptor
473*5113495bSYour Name 
474*5113495bSYour Name 
475*5113495bSYour Name 
476*5113495bSYour Name 			This field helps to correlate the statuses with the TQM
477*5113495bSYour Name 			commands.
478*5113495bSYour Name 
479*5113495bSYour Name 
480*5113495bSYour Name 
481*5113495bSYour Name 			NOTE that SW could program this number to be equal to
482*5113495bSYour Name 			the PPDU_ID number in case direct correlation with the PPDU
483*5113495bSYour Name 			ID is desired
484*5113495bSYour Name 
485*5113495bSYour Name 
486*5113495bSYour Name 
487*5113495bSYour Name 			<legal all>
488*5113495bSYour Name 
489*5113495bSYour Name transmit_count
490*5113495bSYour Name 
491*5113495bSYour Name 			Field only valid when Release_source_module is set to
492*5113495bSYour Name 			release_source_TQM
493*5113495bSYour Name 
494*5113495bSYour Name 
495*5113495bSYour Name 
496*5113495bSYour Name 			The number of times this frame has been transmitted
497*5113495bSYour Name 
498*5113495bSYour Name reserved_3a
499*5113495bSYour Name 
500*5113495bSYour Name 			<legal 0>
501*5113495bSYour Name 
502*5113495bSYour Name ack_frame_rssi
503*5113495bSYour Name 
504*5113495bSYour Name 			This field is only valid when the source is TQM.
505*5113495bSYour Name 
506*5113495bSYour Name 
507*5113495bSYour Name 
508*5113495bSYour Name 			If this frame is removed as the result of the reception
509*5113495bSYour Name 			of an ACK or BA, this field indicates the RSSI of the
510*5113495bSYour Name 			received ACK or BA frame.
511*5113495bSYour Name 
512*5113495bSYour Name 
513*5113495bSYour Name 
514*5113495bSYour Name 			When the frame is removed as result of a direct remove
515*5113495bSYour Name 			command from the SW,  this field is set to 0x0 (which is
516*5113495bSYour Name 			never a valid value when real RSSI is available)
517*5113495bSYour Name 
518*5113495bSYour Name 
519*5113495bSYour Name 
520*5113495bSYour Name 			<legal all>
521*5113495bSYour Name 
522*5113495bSYour Name sw_release_details_valid
523*5113495bSYour Name 
524*5113495bSYour Name 			Consumer: SW
525*5113495bSYour Name 
526*5113495bSYour Name 			Producer: WBM
527*5113495bSYour Name 
528*5113495bSYour Name 
529*5113495bSYour Name 
530*5113495bSYour Name 			When set, some WBM specific release info for SW is
531*5113495bSYour Name 			valid.
532*5113495bSYour Name 
533*5113495bSYour Name 			This is set when WMB got a 'release_msdu_list' command
534*5113495bSYour Name 			from TQM and the return buffer manager is not WMB. WBM will
535*5113495bSYour Name 			then de-aggregate all the MSDUs and pass them one at a time
536*5113495bSYour Name 			on to the 'buffer owner'
537*5113495bSYour Name 
538*5113495bSYour Name 
539*5113495bSYour Name 
540*5113495bSYour Name 			<legal all>
541*5113495bSYour Name 
542*5113495bSYour Name first_msdu
543*5113495bSYour Name 
544*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
545*5113495bSYour Name 
546*5113495bSYour Name 
547*5113495bSYour Name 
548*5113495bSYour Name 			Consumer: SW
549*5113495bSYour Name 
550*5113495bSYour Name 			Producer: WBM
551*5113495bSYour Name 
552*5113495bSYour Name 
553*5113495bSYour Name 
554*5113495bSYour Name 			When set, this MSDU is the first MSDU pointed to in the
555*5113495bSYour Name 			'release_msdu_list' command.
556*5113495bSYour Name 
557*5113495bSYour Name 
558*5113495bSYour Name 
559*5113495bSYour Name 			<legal all>
560*5113495bSYour Name 
561*5113495bSYour Name last_msdu
562*5113495bSYour Name 
563*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
564*5113495bSYour Name 
565*5113495bSYour Name 
566*5113495bSYour Name 
567*5113495bSYour Name 			Consumer: SW
568*5113495bSYour Name 
569*5113495bSYour Name 			Producer: WBM
570*5113495bSYour Name 
571*5113495bSYour Name 
572*5113495bSYour Name 
573*5113495bSYour Name 			When set, this MSDU is the last MSDU pointed to in the
574*5113495bSYour Name 			'release_msdu_list' command.
575*5113495bSYour Name 
576*5113495bSYour Name 
577*5113495bSYour Name 
578*5113495bSYour Name 			<legal all>
579*5113495bSYour Name 
580*5113495bSYour Name msdu_part_of_amsdu
581*5113495bSYour Name 
582*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
583*5113495bSYour Name 
584*5113495bSYour Name 
585*5113495bSYour Name 
586*5113495bSYour Name 			Consumer: SW
587*5113495bSYour Name 
588*5113495bSYour Name 			Producer: WBM
589*5113495bSYour Name 
590*5113495bSYour Name 
591*5113495bSYour Name 
592*5113495bSYour Name 			When set, this MSDU was part of an A-MSDU in MPDU
593*5113495bSYour Name 
594*5113495bSYour Name 			<legal all>
595*5113495bSYour Name 
596*5113495bSYour Name fw_tx_notify_frame
597*5113495bSYour Name 
598*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
599*5113495bSYour Name 
600*5113495bSYour Name 
601*5113495bSYour Name 
602*5113495bSYour Name 			Consumer: SW
603*5113495bSYour Name 
604*5113495bSYour Name 			Producer: WBM
605*5113495bSYour Name 
606*5113495bSYour Name 
607*5113495bSYour Name 
608*5113495bSYour Name 			This is the FW_tx_notify_frame field from the
609*5113495bSYour Name 
610*5113495bSYour Name 			<legal all>
611*5113495bSYour Name 
612*5113495bSYour Name buffer_timestamp
613*5113495bSYour Name 
614*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
615*5113495bSYour Name 
616*5113495bSYour Name 
617*5113495bSYour Name 
618*5113495bSYour Name 			Consumer: SW
619*5113495bSYour Name 
620*5113495bSYour Name 			Producer: WBM
621*5113495bSYour Name 
622*5113495bSYour Name 
623*5113495bSYour Name 
624*5113495bSYour Name 			This is the Buffer_timestamp field from the
625*5113495bSYour Name 
626*5113495bSYour Name 			<legal all>
627*5113495bSYour Name 
628*5113495bSYour Name struct tx_rate_stats_info tx_rate_stats
629*5113495bSYour Name 
630*5113495bSYour Name 			Consumer: TQM
631*5113495bSYour Name 
632*5113495bSYour Name 			Producer: SW/SCH(from TXPCU, PDG)
633*5113495bSYour Name 
634*5113495bSYour Name 
635*5113495bSYour Name 
636*5113495bSYour Name 			Details for command execution tracking purposes.
637*5113495bSYour Name 
638*5113495bSYour Name sw_peer_id
639*5113495bSYour Name 
640*5113495bSYour Name 			Field only valid when Release_source_module is set to
641*5113495bSYour Name 			release_source_TQM
642*5113495bSYour Name 
643*5113495bSYour Name 
644*5113495bSYour Name 
645*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
646*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
647*5113495bSYour Name 
648*5113495bSYour Name 			buffer_or_desc_type = e_num 0
649*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
650*5113495bSYour Name 			tqm_rr_rem_cmd_rem
651*5113495bSYour Name 
652*5113495bSYour Name 
653*5113495bSYour Name 
654*5113495bSYour Name 
655*5113495bSYour Name 
656*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
657*5113495bSYour Name 			hence sw_peer_id and tid = 0
658*5113495bSYour Name 
659*5113495bSYour Name 			buffer_or_desc_type = e_num 0
660*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
661*5113495bSYour Name 			tqm_rr_rem_cmd_rem
662*5113495bSYour Name 
663*5113495bSYour Name 
664*5113495bSYour Name 
665*5113495bSYour Name 
666*5113495bSYour Name 
667*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
668*5113495bSYour Name 			command.
669*5113495bSYour Name 
670*5113495bSYour Name 			buffer_or_desc_type = e_num1
671*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
672*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
673*5113495bSYour Name 
674*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
675*5113495bSYour Name 
676*5113495bSYour Name 
677*5113495bSYour Name 
678*5113495bSYour Name 			Sw_peer_id from the TX_MSDU_FLOW descriptor or
679*5113495bSYour Name 			TX_MPDU_QUEUE descriptor
680*5113495bSYour Name 
681*5113495bSYour Name 			<legal all>
682*5113495bSYour Name 
683*5113495bSYour Name tid
684*5113495bSYour Name 
685*5113495bSYour Name 			Field only valid when Release_source_module is set to
686*5113495bSYour Name 			release_source_TQM
687*5113495bSYour Name 
688*5113495bSYour Name 
689*5113495bSYour Name 
690*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
691*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
692*5113495bSYour Name 
693*5113495bSYour Name 			buffer_or_desc_type = e_num 0
694*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
695*5113495bSYour Name 			tqm_rr_rem_cmd_rem
696*5113495bSYour Name 
697*5113495bSYour Name 
698*5113495bSYour Name 
699*5113495bSYour Name 
700*5113495bSYour Name 
701*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
702*5113495bSYour Name 			hence sw_peer_id and tid = 0
703*5113495bSYour Name 
704*5113495bSYour Name 			buffer_or_desc_type = e_num 0
705*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
706*5113495bSYour Name 			tqm_rr_rem_cmd_rem
707*5113495bSYour Name 
708*5113495bSYour Name 
709*5113495bSYour Name 
710*5113495bSYour Name 
711*5113495bSYour Name 
712*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
713*5113495bSYour Name 			command.
714*5113495bSYour Name 
715*5113495bSYour Name 			buffer_or_desc_type = e_num1
716*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
717*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
718*5113495bSYour Name 
719*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
720*5113495bSYour Name 
721*5113495bSYour Name 
722*5113495bSYour Name 
723*5113495bSYour Name 
724*5113495bSYour Name 
725*5113495bSYour Name 			This field represents the TID from the TX_MSDU_FLOW
726*5113495bSYour Name 			descriptor or TX_MPDU_QUEUE descriptor
727*5113495bSYour Name 
728*5113495bSYour Name 
729*5113495bSYour Name 
730*5113495bSYour Name 			 <legal all>
731*5113495bSYour Name 
732*5113495bSYour Name ring_id
733*5113495bSYour Name 
734*5113495bSYour Name 			Consumer: TQM/REO/RXDMA/SW
735*5113495bSYour Name 
736*5113495bSYour Name 			Producer: SRNG (of RXDMA)
737*5113495bSYour Name 
738*5113495bSYour Name 
739*5113495bSYour Name 
740*5113495bSYour Name 			For debugging.
741*5113495bSYour Name 
742*5113495bSYour Name 			This field is filled in by the SRNG module.
743*5113495bSYour Name 
744*5113495bSYour Name 			It help to identify the ring that is being looked <legal
745*5113495bSYour Name 			all>
746*5113495bSYour Name 
747*5113495bSYour Name looping_count
748*5113495bSYour Name 
749*5113495bSYour Name 			Consumer: WBM/SW/FW
750*5113495bSYour Name 
751*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
752*5113495bSYour Name 
753*5113495bSYour Name 
754*5113495bSYour Name 
755*5113495bSYour Name 			A count value that indicates the number of times the
756*5113495bSYour Name 			producer of entries into the Buffer Manager Ring has looped
757*5113495bSYour Name 			around the ring.
758*5113495bSYour Name 
759*5113495bSYour Name 			At initialization time, this value is set to 0. On the
760*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
761*5113495bSYour Name 			reached allowed by the number of bits for this field, the
762*5113495bSYour Name 			count value continues with 0 again.
763*5113495bSYour Name 
764*5113495bSYour Name 
765*5113495bSYour Name 
766*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
767*5113495bSYour Name 			use this field to figure out up to where the producer of
768*5113495bSYour Name 			entries has created new entries. This eliminates the need to
769*5113495bSYour Name 			check where the head pointer' of the ring is located once
770*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
771*5113495bSYour Name 			entries have been put into this ring...
772*5113495bSYour Name 
773*5113495bSYour Name 
774*5113495bSYour Name 
775*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
776*5113495bSYour Name 			LSB bit of this count value.
777*5113495bSYour Name 
778*5113495bSYour Name 			<legal all>
779*5113495bSYour Name */
780*5113495bSYour Name 
781*5113495bSYour Name #define WBM_RELEASE_RING_0_BUFFER_ADDR_INFO_RELEASED_BUFF_OR_DESC_ADDR_INFO_OFFSET 0x00000000
782*5113495bSYour Name #define WBM_RELEASE_RING_0_BUFFER_ADDR_INFO_RELEASED_BUFF_OR_DESC_ADDR_INFO_LSB 28
783*5113495bSYour Name #define WBM_RELEASE_RING_0_BUFFER_ADDR_INFO_RELEASED_BUFF_OR_DESC_ADDR_INFO_MASK 0xffffffff
784*5113495bSYour Name #define WBM_RELEASE_RING_1_BUFFER_ADDR_INFO_RELEASED_BUFF_OR_DESC_ADDR_INFO_OFFSET 0x00000004
785*5113495bSYour Name #define WBM_RELEASE_RING_1_BUFFER_ADDR_INFO_RELEASED_BUFF_OR_DESC_ADDR_INFO_LSB 28
786*5113495bSYour Name #define WBM_RELEASE_RING_1_BUFFER_ADDR_INFO_RELEASED_BUFF_OR_DESC_ADDR_INFO_MASK 0xffffffff
787*5113495bSYour Name 
788*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE
789*5113495bSYour Name 
790*5113495bSYour Name 			Indicates which module initiated the release of this
791*5113495bSYour Name 			buffer or descriptor
792*5113495bSYour Name 
793*5113495bSYour Name 
794*5113495bSYour Name 
795*5113495bSYour Name 			<enum 0 release_source_TQM> TQM released this buffer or
796*5113495bSYour Name 			descriptor
797*5113495bSYour Name 
798*5113495bSYour Name 			<enum 1 release_source_RXDMA> RXDMA released this buffer
799*5113495bSYour Name 			or descriptor
800*5113495bSYour Name 
801*5113495bSYour Name 			<enum 2 release_source_REO> REO released this buffer or
802*5113495bSYour Name 			descriptor
803*5113495bSYour Name 
804*5113495bSYour Name 			<enum 3 release_source_FW> FW released this buffer or
805*5113495bSYour Name 			descriptor
806*5113495bSYour Name 
807*5113495bSYour Name 			<enum 4 release_source_SW> SW released this buffer or
808*5113495bSYour Name 			descriptor
809*5113495bSYour Name 
810*5113495bSYour Name 			<legal 0-4>
811*5113495bSYour Name */
812*5113495bSYour Name #define WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE_OFFSET              0x00000008
813*5113495bSYour Name #define WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE_LSB                 0
814*5113495bSYour Name #define WBM_RELEASE_RING_2_RELEASE_SOURCE_MODULE_MASK                0x00000007
815*5113495bSYour Name 
816*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_BM_ACTION
817*5113495bSYour Name 
818*5113495bSYour Name 			Consumer: WBM/SW/FW
819*5113495bSYour Name 
820*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
821*5113495bSYour Name 
822*5113495bSYour Name 
823*5113495bSYour Name 
824*5113495bSYour Name 			Field only valid when the field return_buffer_manager in
825*5113495bSYour Name 			the Released_buff_or_desc_addr_info indicates:
826*5113495bSYour Name 
827*5113495bSYour Name 			WBM_IDLE_BUF_LIST or
828*5113495bSYour Name 
829*5113495bSYour Name 			WBM_IDLE_DESC_LIST
830*5113495bSYour Name 
831*5113495bSYour Name 
832*5113495bSYour Name 
833*5113495bSYour Name 			An MSDU extension descriptor shall never be marked as
834*5113495bSYour Name 
835*5113495bSYour Name 
836*5113495bSYour Name 
837*5113495bSYour Name 			<enum 0 Put_in_idle_list> Put the buffer or descriptor
838*5113495bSYour Name 			back in the idle list. In case of MSDU or MDPU link
839*5113495bSYour Name 			descriptor, BM does not need to check to release any
840*5113495bSYour Name 			individual MSDU buffers
841*5113495bSYour Name 
842*5113495bSYour Name 
843*5113495bSYour Name 
844*5113495bSYour Name 			<enum 1 release_msdu_list > This BM action can only be
845*5113495bSYour Name 			used in combination with buffer_or_desc_type being
846*5113495bSYour Name 			msdu_link_descriptor. Field first_msdu_index points out
847*5113495bSYour Name 			which MSDU pointer in the MSDU link descriptor is the first
848*5113495bSYour Name 			of an MPDU that is released.
849*5113495bSYour Name 
850*5113495bSYour Name 			BM shall release all the MSDU buffers linked to this
851*5113495bSYour Name 			first MSDU buffer pointer. All related MSDU buffer pointer
852*5113495bSYour Name 			entries shall be set to value 0, which represents the 'NULL
853*5113495bSYour Name 			pointer. When all MSDU buffer pointers in the MSDU link
854*5113495bSYour Name 			descriptor are 'NULL', the MSDU link descriptor itself shall
855*5113495bSYour Name 			also be released.
856*5113495bSYour Name 
857*5113495bSYour Name 
858*5113495bSYour Name 
859*5113495bSYour Name 			<enum 2 Put_in_idle_list_expanded> CURRENTLY NOT
860*5113495bSYour Name 			IMPLEMENTED....
861*5113495bSYour Name 
862*5113495bSYour Name 			Put the buffer or descriptor back in the idle list. Only
863*5113495bSYour Name 			valid in combination with buffer_or_desc_type indicating
864*5113495bSYour Name 			MDPU_link_descriptor.
865*5113495bSYour Name 
866*5113495bSYour Name 			BM shall release the MPDU link descriptor as well as all
867*5113495bSYour Name 			MSDUs that are linked to the MPDUs in this descriptor.
868*5113495bSYour Name 
869*5113495bSYour Name 
870*5113495bSYour Name 
871*5113495bSYour Name 			<legal 0-2>
872*5113495bSYour Name */
873*5113495bSYour Name #define WBM_RELEASE_RING_2_BM_ACTION_OFFSET                          0x00000008
874*5113495bSYour Name #define WBM_RELEASE_RING_2_BM_ACTION_LSB                             3
875*5113495bSYour Name #define WBM_RELEASE_RING_2_BM_ACTION_MASK                            0x00000038
876*5113495bSYour Name 
877*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE
878*5113495bSYour Name 
879*5113495bSYour Name 			Consumer: WBM/SW/FW
880*5113495bSYour Name 
881*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
882*5113495bSYour Name 
883*5113495bSYour Name 
884*5113495bSYour Name 
885*5113495bSYour Name 			Field only valid when WBM is marked as the
886*5113495bSYour Name 			return_buffer_manager in the Released_Buffer_address_info
887*5113495bSYour Name 
888*5113495bSYour Name 
889*5113495bSYour Name 
890*5113495bSYour Name 			Indicates that type of buffer or descriptor is being
891*5113495bSYour Name 			released
892*5113495bSYour Name 
893*5113495bSYour Name 
894*5113495bSYour Name 
895*5113495bSYour Name 			<enum 0 MSDU_rel_buffer> The address points to an MSDU
896*5113495bSYour Name 			buffer
897*5113495bSYour Name 
898*5113495bSYour Name 			<enum 1 msdu_link_descriptor> The address points to an
899*5113495bSYour Name 			TX MSDU link descriptor
900*5113495bSYour Name 
901*5113495bSYour Name 			<enum 2 mpdu_link_descriptor> The address points to an
902*5113495bSYour Name 			MPDU link descriptor
903*5113495bSYour Name 
904*5113495bSYour Name 			<enum 3 msdu_ext_descriptor > The address points to an
905*5113495bSYour Name 			MSDU extension descriptor.
906*5113495bSYour Name 
907*5113495bSYour Name 			In case BM finds this one in a release ring, it passes
908*5113495bSYour Name 			it on to FW...
909*5113495bSYour Name 
910*5113495bSYour Name 			<enum 4 queue_ext_descriptor> The address points to an
911*5113495bSYour Name 			TQM queue extension descriptor. WBM should treat this is the
912*5113495bSYour Name 			same way as a link descriptor. That is, put the 128 byte
913*5113495bSYour Name 			buffer back in the link buffer idle list.
914*5113495bSYour Name 
915*5113495bSYour Name 
916*5113495bSYour Name 
917*5113495bSYour Name 			<legal 0-4>
918*5113495bSYour Name */
919*5113495bSYour Name #define WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE_OFFSET                0x00000008
920*5113495bSYour Name #define WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE_LSB                   6
921*5113495bSYour Name #define WBM_RELEASE_RING_2_BUFFER_OR_DESC_TYPE_MASK                  0x000001c0
922*5113495bSYour Name 
923*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_FIRST_MSDU_INDEX
924*5113495bSYour Name 
925*5113495bSYour Name 			Consumer: WBM/SW/FW
926*5113495bSYour Name 
927*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
928*5113495bSYour Name 
929*5113495bSYour Name 
930*5113495bSYour Name 
931*5113495bSYour Name 			Field only valid for the bm_action release_msdu_list.
932*5113495bSYour Name 
933*5113495bSYour Name 
934*5113495bSYour Name 
935*5113495bSYour Name 			The index of the first MSDU in an MSDU link descriptor
936*5113495bSYour Name 			all belonging to the same MPDU.
937*5113495bSYour Name 
938*5113495bSYour Name 
939*5113495bSYour Name 
940*5113495bSYour Name 			<legal 0-6>
941*5113495bSYour Name */
942*5113495bSYour Name #define WBM_RELEASE_RING_2_FIRST_MSDU_INDEX_OFFSET                   0x00000008
943*5113495bSYour Name #define WBM_RELEASE_RING_2_FIRST_MSDU_INDEX_LSB                      9
944*5113495bSYour Name #define WBM_RELEASE_RING_2_FIRST_MSDU_INDEX_MASK                     0x00001e00
945*5113495bSYour Name 
946*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_TQM_RELEASE_REASON
947*5113495bSYour Name 
948*5113495bSYour Name 			Consumer: WBM/SW/FW
949*5113495bSYour Name 
950*5113495bSYour Name 			Producer: TQM
951*5113495bSYour Name 
952*5113495bSYour Name 
953*5113495bSYour Name 
954*5113495bSYour Name 			Field only valid when Release_source_module is set to
955*5113495bSYour Name 			release_source_TQM
956*5113495bSYour Name 
957*5113495bSYour Name 
958*5113495bSYour Name 
959*5113495bSYour Name 			(rr = Release Reason)
960*5113495bSYour Name 
961*5113495bSYour Name 			<enum 0 tqm_rr_frame_acked> frame is removed because an
962*5113495bSYour Name 			ACK of BA for it was received
963*5113495bSYour Name 
964*5113495bSYour Name 			<enum 1 tqm_rr_rem_cmd_rem> frame is removed because a
965*5113495bSYour Name 			remove command of type Remove_mpdus initiated by SW
966*5113495bSYour Name 
967*5113495bSYour Name 			<enum 2 tqm_rr_rem_cmd_tx> frame is removed because a
968*5113495bSYour Name 			remove command of type Remove_transmitted_mpdus initiated by
969*5113495bSYour Name 			SW
970*5113495bSYour Name 
971*5113495bSYour Name 			<enum 3 tqm_rr_rem_cmd_notx> frame is removed because a
972*5113495bSYour Name 			remove command of type Remove_untransmitted_mpdus initiated
973*5113495bSYour Name 			by SW
974*5113495bSYour Name 
975*5113495bSYour Name 			<enum 4 tqm_rr_rem_cmd_aged> frame is removed because a
976*5113495bSYour Name 			remove command of type Remove_aged_mpdus or
977*5113495bSYour Name 			Remove_aged_msdus initiated by SW
978*5113495bSYour Name 
979*5113495bSYour Name 			<enum 5 tqm_fw_reason1> frame is removed because a
980*5113495bSYour Name 			remove command where fw indicated that remove reason is
981*5113495bSYour Name 			fw_reason1
982*5113495bSYour Name 
983*5113495bSYour Name 			<enum 6 tqm_fw_reason2> frame is removed because a
984*5113495bSYour Name 			remove command where fw indicated that remove reason is
985*5113495bSYour Name 			fw_reason1
986*5113495bSYour Name 
987*5113495bSYour Name 			<enum 7 tqm_fw_reason3> frame is removed because a
988*5113495bSYour Name 			remove command where fw indicated that remove reason is
989*5113495bSYour Name 			fw_reason1
990*5113495bSYour Name 
991*5113495bSYour Name 
992*5113495bSYour Name 
993*5113495bSYour Name 			<legal 0-7>
994*5113495bSYour Name */
995*5113495bSYour Name #define WBM_RELEASE_RING_2_TQM_RELEASE_REASON_OFFSET                 0x00000008
996*5113495bSYour Name #define WBM_RELEASE_RING_2_TQM_RELEASE_REASON_LSB                    13
997*5113495bSYour Name #define WBM_RELEASE_RING_2_TQM_RELEASE_REASON_MASK                   0x0000e000
998*5113495bSYour Name 
999*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RXDMA_PUSH_REASON
1000*5113495bSYour Name 
1001*5113495bSYour Name 			Field only valid when Release_source_module is set to
1002*5113495bSYour Name 			release_source_RXDMA
1003*5113495bSYour Name 
1004*5113495bSYour Name 
1005*5113495bSYour Name 
1006*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
1007*5113495bSYour Name 
1008*5113495bSYour Name 
1009*5113495bSYour Name 
1010*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
1011*5113495bSYour Name 			pushed this frame to this queue
1012*5113495bSYour Name 
1013*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the
1014*5113495bSYour Name 			frame to this queue per received routing instructions. No
1015*5113495bSYour Name 			error within RXDMA was detected
1016*5113495bSYour Name 
1017*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
1018*5113495bSYour Name 			result the MSDU link descriptor might not have the
1019*5113495bSYour Name 			last_msdu_in_mpdu_flag set, but instead WBM might just see a
1020*5113495bSYour Name 			NULL pointer in the MSDU link descriptor. This is to be
1021*5113495bSYour Name 			considered a normal condition for this scenario.
1022*5113495bSYour Name 
1023*5113495bSYour Name 
1024*5113495bSYour Name 
1025*5113495bSYour Name 			<legal 0 - 2>
1026*5113495bSYour Name */
1027*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_PUSH_REASON_OFFSET                  0x00000008
1028*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_PUSH_REASON_LSB                     16
1029*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_PUSH_REASON_MASK                    0x00030000
1030*5113495bSYour Name 
1031*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RXDMA_ERROR_CODE
1032*5113495bSYour Name 
1033*5113495bSYour Name 			Field only valid when 'rxdma_push_reason' set to
1034*5113495bSYour Name 			'rxdma_error_detected'.
1035*5113495bSYour Name 
1036*5113495bSYour Name 
1037*5113495bSYour Name 
1038*5113495bSYour Name 			<enum 0 rxdma_overflow_err>MPDU frame is not complete
1039*5113495bSYour Name 			due to a FIFO overflow error in RXPCU.
1040*5113495bSYour Name 
1041*5113495bSYour Name 			<enum 1 rxdma_mpdu_length_err>MPDU frame is not complete
1042*5113495bSYour Name 			due to receiving incomplete MPDU from the PHY
1043*5113495bSYour Name 
1044*5113495bSYour Name 
1045*5113495bSYour Name 			<enum 3 rxdma_decrypt_err>CRYPTO reported a decryption
1046*5113495bSYour Name 			error or CRYPTO received an encrypted frame, but did not get
1047*5113495bSYour Name 			a valid corresponding key id in the peer entry.
1048*5113495bSYour Name 
1049*5113495bSYour Name 			<enum 4 rxdma_tkip_mic_err>CRYPTO reported a TKIP MIC
1050*5113495bSYour Name 			error
1051*5113495bSYour Name 
1052*5113495bSYour Name 			<enum 5 rxdma_unecrypted_err>CRYPTO reported an
1053*5113495bSYour Name 			unencrypted frame error when encrypted was expected
1054*5113495bSYour Name 
1055*5113495bSYour Name 			<enum 6 rxdma_msdu_len_err>RX OLE reported an MSDU
1056*5113495bSYour Name 			length error
1057*5113495bSYour Name 
1058*5113495bSYour Name 			<enum 7 rxdma_msdu_limit_err>RX OLE reported that max
1059*5113495bSYour Name 			number of MSDUs allowed in an MPDU got exceeded
1060*5113495bSYour Name 
1061*5113495bSYour Name 			<enum 8 rxdma_wifi_parse_err>RX OLE reported a parsing
1062*5113495bSYour Name 			error
1063*5113495bSYour Name 
1064*5113495bSYour Name 			<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
1065*5113495bSYour Name 			parsing error
1066*5113495bSYour Name 
1067*5113495bSYour Name 			<enum 10 rxdma_sa_timeout_err>RX OLE reported a timeout
1068*5113495bSYour Name 			during SA search
1069*5113495bSYour Name 
1070*5113495bSYour Name 			<enum 11 rxdma_da_timeout_err>RX OLE reported a timeout
1071*5113495bSYour Name 			during DA search
1072*5113495bSYour Name 
1073*5113495bSYour Name 			<enum 12 rxdma_flow_timeout_err>RX OLE reported a
1074*5113495bSYour Name 			timeout during flow search
1075*5113495bSYour Name 
1076*5113495bSYour Name 			<enum 13 rxdma_flush_request>RXDMA received a flush
1077*5113495bSYour Name 			request
1078*5113495bSYour Name 
1079*5113495bSYour Name 			<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
1080*5113495bSYour Name 			present as well as a fragmented MPDU. A-MSDU defragmentation
1081*5113495bSYour Name 			is not supported in Lithium SW so this is treated as an
1082*5113495bSYour Name 			error.
1083*5113495bSYour Name */
1084*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_OFFSET                   0x00000008
1085*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_LSB                      18
1086*5113495bSYour Name #define WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_MASK                     0x007c0000
1087*5113495bSYour Name 
1088*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_REO_PUSH_REASON
1089*5113495bSYour Name 
1090*5113495bSYour Name 			Field only valid when Release_source_module is set to
1091*5113495bSYour Name 			release_source_REO
1092*5113495bSYour Name 
1093*5113495bSYour Name 
1094*5113495bSYour Name 
1095*5113495bSYour Name 			Indicates why REO pushed the frame to this release ring
1096*5113495bSYour Name 
1097*5113495bSYour Name 
1098*5113495bSYour Name 
1099*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an
1100*5113495bSYour Name 			pushed this frame to this queue
1101*5113495bSYour Name 
1102*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
1103*5113495bSYour Name 			this queue per received routing instructions. No error
1104*5113495bSYour Name 			within REO was detected
1105*5113495bSYour Name 
1106*5113495bSYour Name 
1107*5113495bSYour Name 
1108*5113495bSYour Name 			<legal 0 - 1>
1109*5113495bSYour Name */
1110*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_PUSH_REASON_OFFSET                    0x00000008
1111*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_PUSH_REASON_LSB                       23
1112*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_PUSH_REASON_MASK                      0x01800000
1113*5113495bSYour Name 
1114*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_REO_ERROR_CODE
1115*5113495bSYour Name 
1116*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to
1117*5113495bSYour Name 			'reo_error_detected'.
1118*5113495bSYour Name 
1119*5113495bSYour Name 
1120*5113495bSYour Name 
1121*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor
1122*5113495bSYour Name 			provided in the REO_ENTRANCE ring is set to 0
1123*5113495bSYour Name 
1124*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor
1125*5113495bSYour Name 			valid bit is NOT set
1126*5113495bSYour Name 
1127*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
1128*5113495bSYour Name 			session having been setup.
1129*5113495bSYour Name 
1130*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to
1131*5113495bSYour Name 			SSN, Retry bit set: duplicate frame
1132*5113495bSYour Name 
1133*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
1134*5113495bSYour Name 
1135*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
1136*5113495bSYour Name 			frame) received with 2K jump in SN
1137*5113495bSYour Name 
1138*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump
1139*5113495bSYour Name 			in SSN
1140*5113495bSYour Name 
1141*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data
1142*5113495bSYour Name 			frame) received with SN falling within the OOR window
1143*5113495bSYour Name 
1144*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling
1145*5113495bSYour Name 			within the OOR window
1146*5113495bSYour Name 
1147*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
1148*5113495bSYour Name 			a BA session
1149*5113495bSYour Name 
1150*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with
1151*5113495bSYour Name 			SSN equal to SN
1152*5113495bSYour Name 
1153*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
1154*5113495bSYour Name 
1155*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
1156*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set in
1157*5113495bSYour Name 			the REO Queue descriptor
1158*5113495bSYour Name 
1159*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
1160*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in the
1161*5113495bSYour Name 			REO Queue descriptor
1162*5113495bSYour Name 
1163*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is
1164*5113495bSYour Name 			forwarded as a result of the queue descriptor(address) being
1165*5113495bSYour Name 			blocked as SW/FW seems to be currently in the process of
1166*5113495bSYour Name 			making updates to this descriptor...
1167*5113495bSYour Name 
1168*5113495bSYour Name 
1169*5113495bSYour Name 
1170*5113495bSYour Name 			<legal 0-14>
1171*5113495bSYour Name */
1172*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_ERROR_CODE_OFFSET                     0x00000008
1173*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_ERROR_CODE_LSB                        25
1174*5113495bSYour Name #define WBM_RELEASE_RING_2_REO_ERROR_CODE_MASK                       0x3e000000
1175*5113495bSYour Name 
1176*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR
1177*5113495bSYour Name 
1178*5113495bSYour Name 			Can only be set by WBM.
1179*5113495bSYour Name 
1180*5113495bSYour Name 
1181*5113495bSYour Name 
1182*5113495bSYour Name 			Is set when WBM got a buffer pointer but the action was
1183*5113495bSYour Name 			to push it to the idle link descriptor ring or do link
1184*5113495bSYour Name 			related activity
1185*5113495bSYour Name 
1186*5113495bSYour Name 			OR
1187*5113495bSYour Name 
1188*5113495bSYour Name 			Is set when WBM got a link buffer pointer but the action
1189*5113495bSYour Name 			was to push it to the buffer  descriptor ring
1190*5113495bSYour Name 
1191*5113495bSYour Name 
1192*5113495bSYour Name 
1193*5113495bSYour Name 			<legal all>
1194*5113495bSYour Name */
1195*5113495bSYour Name #define WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR_OFFSET                 0x00000008
1196*5113495bSYour Name #define WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR_LSB                    30
1197*5113495bSYour Name #define WBM_RELEASE_RING_2_WBM_INTERNAL_ERROR_MASK                   0x40000000
1198*5113495bSYour Name 
1199*5113495bSYour Name /* Description		WBM_RELEASE_RING_2_RESERVED_2
1200*5113495bSYour Name 
1201*5113495bSYour Name 			<legal 0>
1202*5113495bSYour Name */
1203*5113495bSYour Name #define WBM_RELEASE_RING_2_RESERVED_2_OFFSET                         0x00000008
1204*5113495bSYour Name #define WBM_RELEASE_RING_2_RESERVED_2_LSB                            31
1205*5113495bSYour Name #define WBM_RELEASE_RING_2_RESERVED_2_MASK                           0x80000000
1206*5113495bSYour Name 
1207*5113495bSYour Name /* Description		WBM_RELEASE_RING_3_TQM_STATUS_NUMBER
1208*5113495bSYour Name 
1209*5113495bSYour Name 			Field only valid when Release_source_module is set to
1210*5113495bSYour Name 			release_source_TQM
1211*5113495bSYour Name 
1212*5113495bSYour Name 
1213*5113495bSYour Name 
1214*5113495bSYour Name 			The value in this field is equal to value of the
1215*5113495bSYour Name 			'TQM_CMD_Number' field the TQM command or the
1216*5113495bSYour Name 			'TQM_add_cmd_Number' field from the TQM entrance ring
1217*5113495bSYour Name 			descriptor
1218*5113495bSYour Name 
1219*5113495bSYour Name 
1220*5113495bSYour Name 
1221*5113495bSYour Name 			This field helps to correlate the statuses with the TQM
1222*5113495bSYour Name 			commands.
1223*5113495bSYour Name 
1224*5113495bSYour Name 
1225*5113495bSYour Name 
1226*5113495bSYour Name 			NOTE that SW could program this number to be equal to
1227*5113495bSYour Name 			the PPDU_ID number in case direct correlation with the PPDU
1228*5113495bSYour Name 			ID is desired
1229*5113495bSYour Name 
1230*5113495bSYour Name 
1231*5113495bSYour Name 
1232*5113495bSYour Name 			<legal all>
1233*5113495bSYour Name */
1234*5113495bSYour Name #define WBM_RELEASE_RING_3_TQM_STATUS_NUMBER_OFFSET                  0x0000000c
1235*5113495bSYour Name #define WBM_RELEASE_RING_3_TQM_STATUS_NUMBER_LSB                     0
1236*5113495bSYour Name #define WBM_RELEASE_RING_3_TQM_STATUS_NUMBER_MASK                    0x00ffffff
1237*5113495bSYour Name 
1238*5113495bSYour Name /* Description		WBM_RELEASE_RING_3_TRANSMIT_COUNT
1239*5113495bSYour Name 
1240*5113495bSYour Name 			Field only valid when Release_source_module is set to
1241*5113495bSYour Name 			release_source_TQM
1242*5113495bSYour Name 
1243*5113495bSYour Name 
1244*5113495bSYour Name 
1245*5113495bSYour Name 			The number of times this frame has been transmitted
1246*5113495bSYour Name */
1247*5113495bSYour Name #define WBM_RELEASE_RING_3_TRANSMIT_COUNT_OFFSET                     0x0000000c
1248*5113495bSYour Name #define WBM_RELEASE_RING_3_TRANSMIT_COUNT_LSB                        24
1249*5113495bSYour Name #define WBM_RELEASE_RING_3_TRANSMIT_COUNT_MASK                       0x7f000000
1250*5113495bSYour Name 
1251*5113495bSYour Name /* Description		WBM_RELEASE_RING_3_RESERVED_3A
1252*5113495bSYour Name 
1253*5113495bSYour Name 			<legal 0>
1254*5113495bSYour Name */
1255*5113495bSYour Name #define WBM_RELEASE_RING_3_RESERVED_3A_OFFSET                        0x0000000c
1256*5113495bSYour Name #define WBM_RELEASE_RING_3_RESERVED_3A_LSB                           31
1257*5113495bSYour Name #define WBM_RELEASE_RING_3_RESERVED_3A_MASK                          0x80000000
1258*5113495bSYour Name 
1259*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_ACK_FRAME_RSSI
1260*5113495bSYour Name 
1261*5113495bSYour Name 			This field is only valid when the source is TQM.
1262*5113495bSYour Name 
1263*5113495bSYour Name 
1264*5113495bSYour Name 
1265*5113495bSYour Name 			If this frame is removed as the result of the reception
1266*5113495bSYour Name 			of an ACK or BA, this field indicates the RSSI of the
1267*5113495bSYour Name 			received ACK or BA frame.
1268*5113495bSYour Name 
1269*5113495bSYour Name 
1270*5113495bSYour Name 
1271*5113495bSYour Name 			When the frame is removed as result of a direct remove
1272*5113495bSYour Name 			command from the SW,  this field is set to 0x0 (which is
1273*5113495bSYour Name 			never a valid value when real RSSI is available)
1274*5113495bSYour Name 
1275*5113495bSYour Name 
1276*5113495bSYour Name 
1277*5113495bSYour Name 			<legal all>
1278*5113495bSYour Name */
1279*5113495bSYour Name #define WBM_RELEASE_RING_4_ACK_FRAME_RSSI_OFFSET                     0x00000010
1280*5113495bSYour Name #define WBM_RELEASE_RING_4_ACK_FRAME_RSSI_LSB                        0
1281*5113495bSYour Name #define WBM_RELEASE_RING_4_ACK_FRAME_RSSI_MASK                       0x000000ff
1282*5113495bSYour Name 
1283*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID
1284*5113495bSYour Name 
1285*5113495bSYour Name 			Consumer: SW
1286*5113495bSYour Name 
1287*5113495bSYour Name 			Producer: WBM
1288*5113495bSYour Name 
1289*5113495bSYour Name 
1290*5113495bSYour Name 
1291*5113495bSYour Name 			When set, some WBM specific release info for SW is
1292*5113495bSYour Name 			valid.
1293*5113495bSYour Name 
1294*5113495bSYour Name 			This is set when WMB got a 'release_msdu_list' command
1295*5113495bSYour Name 			from TQM and the return buffer manager is not WMB. WBM will
1296*5113495bSYour Name 			then de-aggregate all the MSDUs and pass them one at a time
1297*5113495bSYour Name 			on to the 'buffer owner'
1298*5113495bSYour Name 
1299*5113495bSYour Name 
1300*5113495bSYour Name 
1301*5113495bSYour Name 			<legal all>
1302*5113495bSYour Name */
1303*5113495bSYour Name #define WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID_OFFSET           0x00000010
1304*5113495bSYour Name #define WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID_LSB              8
1305*5113495bSYour Name #define WBM_RELEASE_RING_4_SW_RELEASE_DETAILS_VALID_MASK             0x00000100
1306*5113495bSYour Name 
1307*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_FIRST_MSDU
1308*5113495bSYour Name 
1309*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1310*5113495bSYour Name 
1311*5113495bSYour Name 
1312*5113495bSYour Name 
1313*5113495bSYour Name 			Consumer: SW
1314*5113495bSYour Name 
1315*5113495bSYour Name 			Producer: WBM
1316*5113495bSYour Name 
1317*5113495bSYour Name 
1318*5113495bSYour Name 
1319*5113495bSYour Name 			When set, this MSDU is the first MSDU pointed to in the
1320*5113495bSYour Name 			'release_msdu_list' command.
1321*5113495bSYour Name 
1322*5113495bSYour Name 
1323*5113495bSYour Name 
1324*5113495bSYour Name 			<legal all>
1325*5113495bSYour Name */
1326*5113495bSYour Name #define WBM_RELEASE_RING_4_FIRST_MSDU_OFFSET                         0x00000010
1327*5113495bSYour Name #define WBM_RELEASE_RING_4_FIRST_MSDU_LSB                            9
1328*5113495bSYour Name #define WBM_RELEASE_RING_4_FIRST_MSDU_MASK                           0x00000200
1329*5113495bSYour Name 
1330*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_LAST_MSDU
1331*5113495bSYour Name 
1332*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1333*5113495bSYour Name 
1334*5113495bSYour Name 
1335*5113495bSYour Name 
1336*5113495bSYour Name 			Consumer: SW
1337*5113495bSYour Name 
1338*5113495bSYour Name 			Producer: WBM
1339*5113495bSYour Name 
1340*5113495bSYour Name 
1341*5113495bSYour Name 
1342*5113495bSYour Name 			When set, this MSDU is the last MSDU pointed to in the
1343*5113495bSYour Name 			'release_msdu_list' command.
1344*5113495bSYour Name 
1345*5113495bSYour Name 
1346*5113495bSYour Name 
1347*5113495bSYour Name 			<legal all>
1348*5113495bSYour Name */
1349*5113495bSYour Name #define WBM_RELEASE_RING_4_LAST_MSDU_OFFSET                          0x00000010
1350*5113495bSYour Name #define WBM_RELEASE_RING_4_LAST_MSDU_LSB                             10
1351*5113495bSYour Name #define WBM_RELEASE_RING_4_LAST_MSDU_MASK                            0x00000400
1352*5113495bSYour Name 
1353*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU
1354*5113495bSYour Name 
1355*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1356*5113495bSYour Name 
1357*5113495bSYour Name 
1358*5113495bSYour Name 
1359*5113495bSYour Name 			Consumer: SW
1360*5113495bSYour Name 
1361*5113495bSYour Name 			Producer: WBM
1362*5113495bSYour Name 
1363*5113495bSYour Name 
1364*5113495bSYour Name 
1365*5113495bSYour Name 			When set, this MSDU was part of an A-MSDU in MPDU
1366*5113495bSYour Name 
1367*5113495bSYour Name 			<legal all>
1368*5113495bSYour Name */
1369*5113495bSYour Name #define WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU_OFFSET                 0x00000010
1370*5113495bSYour Name #define WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU_LSB                    11
1371*5113495bSYour Name #define WBM_RELEASE_RING_4_MSDU_PART_OF_AMSDU_MASK                   0x00000800
1372*5113495bSYour Name 
1373*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME
1374*5113495bSYour Name 
1375*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1376*5113495bSYour Name 
1377*5113495bSYour Name 
1378*5113495bSYour Name 
1379*5113495bSYour Name 			Consumer: SW
1380*5113495bSYour Name 
1381*5113495bSYour Name 			Producer: WBM
1382*5113495bSYour Name 
1383*5113495bSYour Name 
1384*5113495bSYour Name 
1385*5113495bSYour Name 			This is the FW_tx_notify_frame field from the
1386*5113495bSYour Name 
1387*5113495bSYour Name 			<legal all>
1388*5113495bSYour Name */
1389*5113495bSYour Name #define WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME_OFFSET                 0x00000010
1390*5113495bSYour Name #define WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME_LSB                    12
1391*5113495bSYour Name #define WBM_RELEASE_RING_4_FW_TX_NOTIFY_FRAME_MASK                   0x00001000
1392*5113495bSYour Name 
1393*5113495bSYour Name /* Description		WBM_RELEASE_RING_4_BUFFER_TIMESTAMP
1394*5113495bSYour Name 
1395*5113495bSYour Name 			Field only valid when SW_release_details_valid is set.
1396*5113495bSYour Name 
1397*5113495bSYour Name 
1398*5113495bSYour Name 
1399*5113495bSYour Name 			Consumer: SW
1400*5113495bSYour Name 
1401*5113495bSYour Name 			Producer: WBM
1402*5113495bSYour Name 
1403*5113495bSYour Name 
1404*5113495bSYour Name 
1405*5113495bSYour Name 			This is the Buffer_timestamp field from the
1406*5113495bSYour Name 
1407*5113495bSYour Name 			<legal all>
1408*5113495bSYour Name */
1409*5113495bSYour Name #define WBM_RELEASE_RING_4_BUFFER_TIMESTAMP_OFFSET                   0x00000010
1410*5113495bSYour Name #define WBM_RELEASE_RING_4_BUFFER_TIMESTAMP_LSB                      13
1411*5113495bSYour Name #define WBM_RELEASE_RING_4_BUFFER_TIMESTAMP_MASK                     0xffffe000
1412*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_INFO_TX_RATE_STATS_OFFSET   0x00000014
1413*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_INFO_TX_RATE_STATS_LSB      13
1414*5113495bSYour Name #define WBM_RELEASE_RING_5_TX_RATE_STATS_INFO_TX_RATE_STATS_MASK     0xffffffff
1415*5113495bSYour Name #define WBM_RELEASE_RING_6_TX_RATE_STATS_INFO_TX_RATE_STATS_OFFSET   0x00000018
1416*5113495bSYour Name #define WBM_RELEASE_RING_6_TX_RATE_STATS_INFO_TX_RATE_STATS_LSB      13
1417*5113495bSYour Name #define WBM_RELEASE_RING_6_TX_RATE_STATS_INFO_TX_RATE_STATS_MASK     0xffffffff
1418*5113495bSYour Name 
1419*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_SW_PEER_ID
1420*5113495bSYour Name 
1421*5113495bSYour Name 			Field only valid when Release_source_module is set to
1422*5113495bSYour Name 			release_source_TQM
1423*5113495bSYour Name 
1424*5113495bSYour Name 
1425*5113495bSYour Name 
1426*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
1427*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
1428*5113495bSYour Name 
1429*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1430*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1431*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1432*5113495bSYour Name 
1433*5113495bSYour Name 
1434*5113495bSYour Name 
1435*5113495bSYour Name 
1436*5113495bSYour Name 
1437*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
1438*5113495bSYour Name 			hence sw_peer_id and tid = 0
1439*5113495bSYour Name 
1440*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1441*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1442*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1443*5113495bSYour Name 
1444*5113495bSYour Name 
1445*5113495bSYour Name 
1446*5113495bSYour Name 
1447*5113495bSYour Name 
1448*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
1449*5113495bSYour Name 			command.
1450*5113495bSYour Name 
1451*5113495bSYour Name 			buffer_or_desc_type = e_num1
1452*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
1453*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
1454*5113495bSYour Name 
1455*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
1456*5113495bSYour Name 
1457*5113495bSYour Name 
1458*5113495bSYour Name 
1459*5113495bSYour Name 			Sw_peer_id from the TX_MSDU_FLOW descriptor or
1460*5113495bSYour Name 			TX_MPDU_QUEUE descriptor
1461*5113495bSYour Name 
1462*5113495bSYour Name 			<legal all>
1463*5113495bSYour Name */
1464*5113495bSYour Name #define WBM_RELEASE_RING_7_SW_PEER_ID_OFFSET                         0x0000001c
1465*5113495bSYour Name #define WBM_RELEASE_RING_7_SW_PEER_ID_LSB                            0
1466*5113495bSYour Name #define WBM_RELEASE_RING_7_SW_PEER_ID_MASK                           0x0000ffff
1467*5113495bSYour Name 
1468*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_TID
1469*5113495bSYour Name 
1470*5113495bSYour Name 			Field only valid when Release_source_module is set to
1471*5113495bSYour Name 			release_source_TQM
1472*5113495bSYour Name 
1473*5113495bSYour Name 
1474*5113495bSYour Name 
1475*5113495bSYour Name 			1) Release of msdu buffer due to drop_frame = 1. Flow is
1476*5113495bSYour Name 			not fetched and hence sw_peer_id and tid = 0
1477*5113495bSYour Name 
1478*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1479*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1480*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1481*5113495bSYour Name 
1482*5113495bSYour Name 
1483*5113495bSYour Name 
1484*5113495bSYour Name 
1485*5113495bSYour Name 
1486*5113495bSYour Name 			2) Release of msdu buffer due to Flow is not fetched and
1487*5113495bSYour Name 			hence sw_peer_id and tid = 0
1488*5113495bSYour Name 
1489*5113495bSYour Name 			buffer_or_desc_type = e_num 0
1490*5113495bSYour Name 			MSDU_rel_buffertqm_release_reason = e_num 1
1491*5113495bSYour Name 			tqm_rr_rem_cmd_rem
1492*5113495bSYour Name 
1493*5113495bSYour Name 
1494*5113495bSYour Name 
1495*5113495bSYour Name 
1496*5113495bSYour Name 
1497*5113495bSYour Name 			3) Release of msdu link due to remove_mpdu or acked_mpdu
1498*5113495bSYour Name 			command.
1499*5113495bSYour Name 
1500*5113495bSYour Name 			buffer_or_desc_type = e_num1
1501*5113495bSYour Name 			msdu_link_descriptortqm_release_reason can be:e_num 1
1502*5113495bSYour Name 			tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
1503*5113495bSYour Name 
1504*5113495bSYour Name 			e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
1505*5113495bSYour Name 
1506*5113495bSYour Name 
1507*5113495bSYour Name 
1508*5113495bSYour Name 
1509*5113495bSYour Name 
1510*5113495bSYour Name 			This field represents the TID from the TX_MSDU_FLOW
1511*5113495bSYour Name 			descriptor or TX_MPDU_QUEUE descriptor
1512*5113495bSYour Name 
1513*5113495bSYour Name 
1514*5113495bSYour Name 
1515*5113495bSYour Name 			 <legal all>
1516*5113495bSYour Name */
1517*5113495bSYour Name #define WBM_RELEASE_RING_7_TID_OFFSET                                0x0000001c
1518*5113495bSYour Name #define WBM_RELEASE_RING_7_TID_LSB                                   16
1519*5113495bSYour Name #define WBM_RELEASE_RING_7_TID_MASK                                  0x000f0000
1520*5113495bSYour Name 
1521*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_RING_ID
1522*5113495bSYour Name 
1523*5113495bSYour Name 			Consumer: TQM/REO/RXDMA/SW
1524*5113495bSYour Name 
1525*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1526*5113495bSYour Name 
1527*5113495bSYour Name 
1528*5113495bSYour Name 
1529*5113495bSYour Name 			For debugging.
1530*5113495bSYour Name 
1531*5113495bSYour Name 			This field is filled in by the SRNG module.
1532*5113495bSYour Name 
1533*5113495bSYour Name 			It help to identify the ring that is being looked <legal
1534*5113495bSYour Name 			all>
1535*5113495bSYour Name */
1536*5113495bSYour Name #define WBM_RELEASE_RING_7_RING_ID_OFFSET                            0x0000001c
1537*5113495bSYour Name #define WBM_RELEASE_RING_7_RING_ID_LSB                               20
1538*5113495bSYour Name #define WBM_RELEASE_RING_7_RING_ID_MASK                              0x0ff00000
1539*5113495bSYour Name 
1540*5113495bSYour Name /* Description		WBM_RELEASE_RING_7_LOOPING_COUNT
1541*5113495bSYour Name 
1542*5113495bSYour Name 			Consumer: WBM/SW/FW
1543*5113495bSYour Name 
1544*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
1545*5113495bSYour Name 
1546*5113495bSYour Name 
1547*5113495bSYour Name 
1548*5113495bSYour Name 			A count value that indicates the number of times the
1549*5113495bSYour Name 			producer of entries into the Buffer Manager Ring has looped
1550*5113495bSYour Name 			around the ring.
1551*5113495bSYour Name 
1552*5113495bSYour Name 			At initialization time, this value is set to 0. On the
1553*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
1554*5113495bSYour Name 			reached allowed by the number of bits for this field, the
1555*5113495bSYour Name 			count value continues with 0 again.
1556*5113495bSYour Name 
1557*5113495bSYour Name 
1558*5113495bSYour Name 
1559*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
1560*5113495bSYour Name 			use this field to figure out up to where the producer of
1561*5113495bSYour Name 			entries has created new entries. This eliminates the need to
1562*5113495bSYour Name 			check where the head pointer' of the ring is located once
1563*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
1564*5113495bSYour Name 			entries have been put into this ring...
1565*5113495bSYour Name 
1566*5113495bSYour Name 
1567*5113495bSYour Name 
1568*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1569*5113495bSYour Name 			LSB bit of this count value.
1570*5113495bSYour Name 
1571*5113495bSYour Name 			<legal all>
1572*5113495bSYour Name */
1573*5113495bSYour Name #define WBM_RELEASE_RING_7_LOOPING_COUNT_OFFSET                      0x0000001c
1574*5113495bSYour Name #define WBM_RELEASE_RING_7_LOOPING_COUNT_LSB                         28
1575*5113495bSYour Name #define WBM_RELEASE_RING_7_LOOPING_COUNT_MASK                        0xf0000000
1576*5113495bSYour Name 
1577*5113495bSYour Name 
1578*5113495bSYour Name #endif // _WBM_RELEASE_RING_H_
1579