xref: /wlan-driver/fw-api/hw/qca5018/wbm_link_descriptor_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name #ifndef _WBM_LINK_DESCRIPTOR_RING_H_
18*5113495bSYour Name #define _WBM_LINK_DESCRIPTOR_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 
24*5113495bSYour Name // ################ START SUMMARY #################
25*5113495bSYour Name //
26*5113495bSYour Name //	Dword	Fields
27*5113495bSYour Name //	0-1	struct buffer_addr_info desc_addr_info;
28*5113495bSYour Name //
29*5113495bSYour Name // ################ END SUMMARY #################
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_WBM_LINK_DESCRIPTOR_RING 2
32*5113495bSYour Name 
33*5113495bSYour Name struct wbm_link_descriptor_ring {
34*5113495bSYour Name     struct            buffer_addr_info                       desc_addr_info;
35*5113495bSYour Name };
36*5113495bSYour Name 
37*5113495bSYour Name /*
38*5113495bSYour Name 
39*5113495bSYour Name struct buffer_addr_info desc_addr_info
40*5113495bSYour Name 
41*5113495bSYour Name 			Consumer: WBM
42*5113495bSYour Name 
43*5113495bSYour Name 			Producer: WBM
44*5113495bSYour Name 
45*5113495bSYour Name 
46*5113495bSYour Name 
47*5113495bSYour Name 			Details of the physical address of the buffer + source
48*5113495bSYour Name 			buffer owner +  some SW meta data
49*5113495bSYour Name 
50*5113495bSYour Name 			All modules getting this link descriptor address info,
51*5113495bSYour Name 			shall keep all the 64 bits in this descriptor together and
52*5113495bSYour Name 			eventually all 64 bits shall be given back to WBM when the
53*5113495bSYour Name 			link descriptor is released.
54*5113495bSYour Name */
55*5113495bSYour Name 
56*5113495bSYour Name 
57*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info desc_addr_info */
58*5113495bSYour Name 
59*5113495bSYour Name 
60*5113495bSYour Name /* Description		WBM_LINK_DESCRIPTOR_RING_0_DESC_ADDR_INFO_BUFFER_ADDR_31_0
61*5113495bSYour Name 
62*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
63*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name 
67*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
68*5113495bSYour Name 
69*5113495bSYour Name 			<legal all>
70*5113495bSYour Name */
71*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_0_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
72*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_0_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
73*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_0_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
74*5113495bSYour Name 
75*5113495bSYour Name /* Description		WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_BUFFER_ADDR_39_32
76*5113495bSYour Name 
77*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
78*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name 
82*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
83*5113495bSYour Name 
84*5113495bSYour Name 			<legal all>
85*5113495bSYour Name */
86*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
87*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
88*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
89*5113495bSYour Name 
90*5113495bSYour Name /* Description		WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER
91*5113495bSYour Name 
92*5113495bSYour Name 			Consumer: WBM
93*5113495bSYour Name 
94*5113495bSYour Name 			Producer: SW/FW
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
103*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
104*5113495bSYour Name 			pointed to shall be returned after the frame has been
105*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
110*5113495bSYour Name 			to the WMB buffer idle list
111*5113495bSYour Name 
112*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
113*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
114*5113495bSYour Name 
115*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
116*5113495bSYour Name 
117*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
118*5113495bSYour Name 			ring 0
119*5113495bSYour Name 
120*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
121*5113495bSYour Name 			ring 1
122*5113495bSYour Name 
123*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
124*5113495bSYour Name 			ring 2
125*5113495bSYour Name 
126*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
127*5113495bSYour Name 			ring 3
128*5113495bSYour Name 
129*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
130*5113495bSYour Name 			ring 4
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal all>
135*5113495bSYour Name */
136*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
137*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
138*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000700
139*5113495bSYour Name 
140*5113495bSYour Name /* Description		WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_SW_BUFFER_COOKIE
141*5113495bSYour Name 
142*5113495bSYour Name 			Cookie field exclusively used by SW.
143*5113495bSYour Name 
144*5113495bSYour Name 
145*5113495bSYour Name 
146*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name 
150*5113495bSYour Name 			HW ignores the contents, accept that it passes the
151*5113495bSYour Name 			programmed value on to other descriptors together with the
152*5113495bSYour Name 			physical address
153*5113495bSYour Name 
154*5113495bSYour Name 
155*5113495bSYour Name 
156*5113495bSYour Name 			Field can be used by SW to for example associate the
157*5113495bSYour Name 			buffers physical address with the virtual address
158*5113495bSYour Name 
159*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
160*5113495bSYour Name 			specification
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name 
164*5113495bSYour Name 			NOTE1:
165*5113495bSYour Name 
166*5113495bSYour Name 			The three most significant bits can have a special
167*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
168*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
169*5113495bSYour Name 
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name 			In case of NON punctured transmission:
173*5113495bSYour Name 
174*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
175*5113495bSYour Name 
176*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
177*5113495bSYour Name 
178*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
179*5113495bSYour Name 
180*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 			In case of punctured transmission:
185*5113495bSYour Name 
186*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
187*5113495bSYour Name 
188*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
189*5113495bSYour Name 
190*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
191*5113495bSYour Name 
192*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
193*5113495bSYour Name 
194*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
195*5113495bSYour Name 
196*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
197*5113495bSYour Name 
198*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
199*5113495bSYour Name 
200*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
201*5113495bSYour Name 
202*5113495bSYour Name 
203*5113495bSYour Name 
204*5113495bSYour Name 			Note: a punctured transmission is indicated by the
205*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
206*5113495bSYour Name 			TLV
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 
210*5113495bSYour Name 			NOTE 2:The five most significant bits can have a special
211*5113495bSYour Name 			meaning in case this struct is embedded in an
212*5113495bSYour Name 			RX_MSDU_DETAILS STRUCT, and Maple/Spruce Rx DMA is
213*5113495bSYour Name 			configured for passing on the additional info
214*5113495bSYour Name 			from 'RX_MPDU_INFO' structure in 'RX_MPDU_START' TLV
215*5113495bSYour Name 			(FR56821). This is not supported in HastingsPrime, Pine or
216*5113495bSYour Name 			Moselle.
217*5113495bSYour Name 
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name 			Sw_buffer_cookie[20:17]: Tid: The TID field in the QoS
221*5113495bSYour Name 			control field
222*5113495bSYour Name 
223*5113495bSYour Name 
224*5113495bSYour Name 
225*5113495bSYour Name 			Sw_buffer_cookie[16]: Mpdu_qos_control_valid: This field
226*5113495bSYour Name 			indicates MPDUs with a QoS control field.
227*5113495bSYour Name 
228*5113495bSYour Name 
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name 
232*5113495bSYour Name 			<legal all>
233*5113495bSYour Name */
234*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
235*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB 11
236*5113495bSYour Name #define WBM_LINK_DESCRIPTOR_RING_1_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff800
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name #endif // _WBM_LINK_DESCRIPTOR_RING_H_
240