xref: /wlan-driver/fw-api/hw/qca6290/v2/buffer_addr_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _BUFFER_ADDR_INFO_H_
25*5113495bSYour Name #define _BUFFER_ADDR_INFO_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	buffer_addr_31_0[31:0]
34*5113495bSYour Name //	1	buffer_addr_39_32[7:0], return_buffer_manager[10:8], sw_buffer_cookie[31:11]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_BUFFER_ADDR_INFO 2
39*5113495bSYour Name 
40*5113495bSYour Name struct buffer_addr_info {
41*5113495bSYour Name              uint32_t buffer_addr_31_0                : 32; //[31:0]
42*5113495bSYour Name              uint32_t buffer_addr_39_32               :  8, //[7:0]
43*5113495bSYour Name                       return_buffer_manager           :  3, //[10:8]
44*5113495bSYour Name                       sw_buffer_cookie                : 21; //[31:11]
45*5113495bSYour Name };
46*5113495bSYour Name 
47*5113495bSYour Name /*
48*5113495bSYour Name 
49*5113495bSYour Name buffer_addr_31_0
50*5113495bSYour Name 
51*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
52*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name 
56*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
57*5113495bSYour Name 
58*5113495bSYour Name 			<legal all>
59*5113495bSYour Name 
60*5113495bSYour Name buffer_addr_39_32
61*5113495bSYour Name 
62*5113495bSYour Name 			Address (upper 8 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 return_buffer_manager
72*5113495bSYour Name 
73*5113495bSYour Name 			Consumer: WBM
74*5113495bSYour Name 
75*5113495bSYour Name 			Producer: SW/FW
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
80*5113495bSYour Name 
81*5113495bSYour Name 
82*5113495bSYour Name 
83*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
84*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
85*5113495bSYour Name 			pointed to shall be returned after the frame has been
86*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
91*5113495bSYour Name 			to the WMB buffer idle list
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
94*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
95*5113495bSYour Name 
96*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
97*5113495bSYour Name 
98*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
99*5113495bSYour Name 			ring 0
100*5113495bSYour Name 
101*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
102*5113495bSYour Name 			ring 1
103*5113495bSYour Name 
104*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
105*5113495bSYour Name 			ring 2
106*5113495bSYour Name 
107*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
108*5113495bSYour Name 			ring 3
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name 			<legal 0-6>
113*5113495bSYour Name 
114*5113495bSYour Name sw_buffer_cookie
115*5113495bSYour Name 
116*5113495bSYour Name 			Cookie field exclusively used by SW.
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name 			HW ignores the contents, accept that it passes the
125*5113495bSYour Name 			programmed value on to other descriptors together with the
126*5113495bSYour Name 			physical address
127*5113495bSYour Name 
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name 			Field can be used by SW to for example associate the
131*5113495bSYour Name 			buffers physical address with the virtual address
132*5113495bSYour Name 
133*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
134*5113495bSYour Name 			specification
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 			NOTE:
139*5113495bSYour Name 
140*5113495bSYour Name 			The two most significant bits can have a special meaning
141*5113495bSYour Name 			in case this struct is embedded in a TX_MPDU_DETAILS STRUCT,
142*5113495bSYour Name 			and field transmit_bw_restriction is set
143*5113495bSYour Name 
144*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
145*5113495bSYour Name 
146*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
147*5113495bSYour Name 
148*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
149*5113495bSYour Name 
150*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name 			<legal all>
155*5113495bSYour Name */
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0
159*5113495bSYour Name 
160*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
161*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
162*5113495bSYour Name 
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
166*5113495bSYour Name 
167*5113495bSYour Name 			<legal all>
168*5113495bSYour Name */
169*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_OFFSET                   0x00000000
170*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_LSB                      0
171*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_MASK                     0xffffffff
172*5113495bSYour Name 
173*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32
174*5113495bSYour Name 
175*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
176*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
181*5113495bSYour Name 
182*5113495bSYour Name 			<legal all>
183*5113495bSYour Name */
184*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_OFFSET                  0x00000004
185*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_LSB                     0
186*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_MASK                    0x000000ff
187*5113495bSYour Name 
188*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER
189*5113495bSYour Name 
190*5113495bSYour Name 			Consumer: WBM
191*5113495bSYour Name 
192*5113495bSYour Name 			Producer: SW/FW
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
197*5113495bSYour Name 
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
201*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
202*5113495bSYour Name 			pointed to shall be returned after the frame has been
203*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
208*5113495bSYour Name 			to the WMB buffer idle list
209*5113495bSYour Name 
210*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
211*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
212*5113495bSYour Name 
213*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
214*5113495bSYour Name 
215*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
216*5113495bSYour Name 			ring 0
217*5113495bSYour Name 
218*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
219*5113495bSYour Name 			ring 1
220*5113495bSYour Name 
221*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
222*5113495bSYour Name 			ring 2
223*5113495bSYour Name 
224*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
225*5113495bSYour Name 			ring 3
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 
229*5113495bSYour Name 			<legal 0-6>
230*5113495bSYour Name */
231*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_OFFSET              0x00000004
232*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_LSB                 8
233*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_MASK                0x00000700
234*5113495bSYour Name 
235*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE
236*5113495bSYour Name 
237*5113495bSYour Name 			Cookie field exclusively used by SW.
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 
241*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 			HW ignores the contents, accept that it passes the
246*5113495bSYour Name 			programmed value on to other descriptors together with the
247*5113495bSYour Name 			physical address
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 
251*5113495bSYour Name 			Field can be used by SW to for example associate the
252*5113495bSYour Name 			buffers physical address with the virtual address
253*5113495bSYour Name 
254*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
255*5113495bSYour Name 			specification
256*5113495bSYour Name 
257*5113495bSYour Name 
258*5113495bSYour Name 
259*5113495bSYour Name 			NOTE:
260*5113495bSYour Name 
261*5113495bSYour Name 			The two most significant bits can have a special meaning
262*5113495bSYour Name 			in case this struct is embedded in a TX_MPDU_DETAILS STRUCT,
263*5113495bSYour Name 			and field transmit_bw_restriction is set
264*5113495bSYour Name 
265*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
266*5113495bSYour Name 
267*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
268*5113495bSYour Name 
269*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
270*5113495bSYour Name 
271*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
272*5113495bSYour Name 
273*5113495bSYour Name 
274*5113495bSYour Name 
275*5113495bSYour Name 			<legal all>
276*5113495bSYour Name */
277*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_OFFSET                   0x00000004
278*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_LSB                      11
279*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_MASK                     0xfffff800
280*5113495bSYour Name 
281*5113495bSYour Name 
282*5113495bSYour Name #endif // _BUFFER_ADDR_INFO_H_
283