xref: /wlan-driver/fw-api/hw/qca8074/v2/uniform_descriptor_header.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2020 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 // $ATH_LICENSE_HW_HDR_C$
18 //
19 // DO NOT EDIT!  This file is automatically generated
20 //               These definitions are tied to a particular hardware layout
21 
22 
23 #ifndef _UNIFORM_DESCRIPTOR_HEADER_H_
24 #define _UNIFORM_DESCRIPTOR_HEADER_H_
25 #if !defined(__ASSEMBLER__)
26 #endif
27 
28 
29 // ################ START SUMMARY #################
30 //
31 //	Dword	Fields
32 //	0	owner[3:0], buffer_type[7:4], reserved_0a[31:8]
33 //
34 // ################ END SUMMARY #################
35 
36 #define NUM_OF_DWORDS_UNIFORM_DESCRIPTOR_HEADER 1
37 
38 struct uniform_descriptor_header {
39              uint32_t owner                           :  4, //[3:0]
40                       buffer_type                     :  4, //[7:4]
41                       reserved_0a                     : 24; //[31:8]
42 };
43 
44 /*
45 
46 owner
47 
48 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
49 
50 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
51 
52 
53 
54 			The owner of this data structure:
55 
56 			<enum 0 WBM_owned> Buffer Manager currently owns this
57 			data structure.
58 
59 			<enum 1 SW_OR_FW_owned> Software of FW currently owns
60 			this data structure.
61 
62 			<enum 2 TQM_owned> Transmit Queue Manager currently owns
63 			this data structure.
64 
65 			<enum 3 RXDMA_owned> Receive DMA currently owns this
66 			data structure.
67 
68 			<enum 4 REO_owned> Reorder currently owns this data
69 			structure.
70 
71 			<enum 5 SWITCH_owned> SWITCH currently owns this data
72 			structure.
73 
74 
75 
76 			<legal 0-5>
77 
78 buffer_type
79 
80 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
81 
82 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
83 
84 
85 
86 			Field describing what contents format is of this
87 			descriptor
88 
89 
90 
91 			<enum 0 Transmit_MSDU_Link_descriptor >
92 
93 			<enum 1 Transmit_MPDU_Link_descriptor >
94 
95 			<enum 2 Transmit_MPDU_Queue_head_descriptor>
96 
97 			<enum 3 Transmit_MPDU_Queue_ext_descriptor>
98 
99 			<enum 4 Transmit_flow_descriptor>
100 
101 			<enum 5 Transmit_buffer > NOT TO BE USED:
102 
103 
104 
105 			<enum 6 Receive_MSDU_Link_descriptor >
106 
107 			<enum 7 Receive_MPDU_Link_descriptor >
108 
109 			<enum 8 Receive_REO_queue_descriptor >
110 
111 			<enum 9 Receive_REO_queue_ext_descriptor >
112 
113 
114 
115 			<enum 10 Receive_buffer >
116 
117 
118 
119 			<enum 11 Idle_link_list_entry>
120 
121 
122 
123 			<legal 0-11>
124 
125 reserved_0a
126 
127 			<legal 0>
128 */
129 
130 
131 /* Description		UNIFORM_DESCRIPTOR_HEADER_0_OWNER
132 
133 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
134 
135 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
136 
137 
138 
139 			The owner of this data structure:
140 
141 			<enum 0 WBM_owned> Buffer Manager currently owns this
142 			data structure.
143 
144 			<enum 1 SW_OR_FW_owned> Software of FW currently owns
145 			this data structure.
146 
147 			<enum 2 TQM_owned> Transmit Queue Manager currently owns
148 			this data structure.
149 
150 			<enum 3 RXDMA_owned> Receive DMA currently owns this
151 			data structure.
152 
153 			<enum 4 REO_owned> Reorder currently owns this data
154 			structure.
155 
156 			<enum 5 SWITCH_owned> SWITCH currently owns this data
157 			structure.
158 
159 
160 
161 			<legal 0-5>
162 */
163 #define UNIFORM_DESCRIPTOR_HEADER_0_OWNER_OFFSET                     0x00000000
164 #define UNIFORM_DESCRIPTOR_HEADER_0_OWNER_LSB                        0
165 #define UNIFORM_DESCRIPTOR_HEADER_0_OWNER_MASK                       0x0000000f
166 
167 /* Description		UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE
168 
169 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
170 
171 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
172 
173 
174 
175 			Field describing what contents format is of this
176 			descriptor
177 
178 
179 
180 			<enum 0 Transmit_MSDU_Link_descriptor >
181 
182 			<enum 1 Transmit_MPDU_Link_descriptor >
183 
184 			<enum 2 Transmit_MPDU_Queue_head_descriptor>
185 
186 			<enum 3 Transmit_MPDU_Queue_ext_descriptor>
187 
188 			<enum 4 Transmit_flow_descriptor>
189 
190 			<enum 5 Transmit_buffer > NOT TO BE USED:
191 
192 
193 
194 			<enum 6 Receive_MSDU_Link_descriptor >
195 
196 			<enum 7 Receive_MPDU_Link_descriptor >
197 
198 			<enum 8 Receive_REO_queue_descriptor >
199 
200 			<enum 9 Receive_REO_queue_ext_descriptor >
201 
202 
203 
204 			<enum 10 Receive_buffer >
205 
206 
207 
208 			<enum 11 Idle_link_list_entry>
209 
210 
211 
212 			<legal 0-11>
213 */
214 #define UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE_OFFSET               0x00000000
215 #define UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE_LSB                  4
216 #define UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE_MASK                 0x000000f0
217 
218 /* Description		UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A
219 
220 			<legal 0>
221 */
222 #define UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A_OFFSET               0x00000000
223 #define UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A_LSB                  8
224 #define UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A_MASK                 0xffffff00
225 
226 
227 #endif // _UNIFORM_DESCRIPTOR_HEADER_H_
228