1 /******************************************************************************
3 * Name: acresrc.h - Resource Manager function prototypes
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
47 /* Need the AML resource descriptor structs */
52 * If possible, pack the following structures to byte alignment, since we
53 * don't care about performance for debug output. Two cases where we cannot
54 * pack the structures:
56 * 1) Hardware does not support misaligned memory transfers
57 * 2) Compiler does not support pointers within packed structures
59 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
64 * Individual entry for the resource conversion tables
66 typedef const struct acpi_rsconvert_info {
72 } acpi_rsconvert_info;
74 /* Resource conversion opcodes */
88 ACPI_RSC_COUNT_GPIO_PIN,
89 ACPI_RSC_COUNT_GPIO_RES,
90 ACPI_RSC_COUNT_GPIO_VEN,
91 ACPI_RSC_COUNT_SERIAL_RES,
92 ACPI_RSC_COUNT_SERIAL_VEN,
98 ACPI_RSC_MOVE_GPIO_PIN,
99 ACPI_RSC_MOVE_GPIO_RES,
100 ACPI_RSC_MOVE_SERIAL_RES,
101 ACPI_RSC_MOVE_SERIAL_VEN,
109 } ACPI_RSCONVERT_OPCODES;
111 /* Resource Conversion sub-opcodes */
113 #define ACPI_RSC_COMPARE_AML_LENGTH 0
114 #define ACPI_RSC_COMPARE_VALUE 1
116 #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (struct acpi_rsconvert_info))
118 #define ACPI_RS_OFFSET(f) (u8) ACPI_OFFSET (struct acpi_resource,f)
119 #define AML_OFFSET(f) (u8) ACPI_OFFSET (union aml_resource,f)
122 * Individual entry for the resource dump tables
124 typedef const struct acpi_rsdump_info {
128 const char **pointer;
132 /* Values for the Opcode field above */
152 } ACPI_RSDUMP_OPCODES;
154 /* restore default alignment */
158 /* Resource tables indexed by internal resource type */
160 extern const u8 acpi_gbl_aml_resource_sizes[];
161 extern const u8 acpi_gbl_aml_resource_serial_bus_sizes[];
162 extern struct acpi_rsconvert_info *acpi_gbl_set_resource_dispatch[];
164 /* Resource tables indexed by raw AML resource descriptor type */
166 extern const u8 acpi_gbl_resource_struct_sizes[];
167 extern const u8 acpi_gbl_resource_struct_serial_bus_sizes[];
168 extern struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[];
170 extern struct acpi_rsconvert_info
171 *acpi_gbl_convert_resource_serial_bus_dispatch[];
173 struct acpi_vendor_walk_info {
174 struct acpi_vendor_uuid *uuid;
175 struct acpi_buffer *buffer;
183 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
184 struct acpi_buffer *output_buffer);
187 acpi_rs_create_aml_resources(struct acpi_buffer *resource_list,
188 struct acpi_buffer *output_buffer);
191 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
192 struct acpi_buffer *output_buffer);
199 acpi_rs_get_prt_method_data(struct acpi_namespace_node *node,
200 struct acpi_buffer *ret_buffer);
203 acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
204 struct acpi_buffer *ret_buffer);
207 acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
208 struct acpi_buffer *ret_buffer);
211 acpi_rs_get_method_data(acpi_handle handle,
212 const char *path, struct acpi_buffer *ret_buffer);
215 acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
216 struct acpi_buffer *ret_buffer);
219 acpi_rs_get_aei_method_data(struct acpi_namespace_node *node,
220 struct acpi_buffer *ret_buffer);
226 acpi_rs_get_list_length(u8 *aml_buffer,
227 u32 aml_buffer_length, acpi_size *size_needed);
230 acpi_rs_get_aml_length(struct acpi_resource *resource_list,
231 acpi_size resource_list_size, acpi_size *size_needed);
234 acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
235 acpi_size *buffer_size_needed);
238 acpi_rs_convert_aml_to_resources(u8 * aml,
240 u32 offset, u8 resource_index, void **context);
243 acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
244 acpi_size aml_size_needed, u8 * output_buffer);
250 acpi_rs_set_address_common(union aml_resource *aml,
251 struct acpi_resource *resource);
254 acpi_rs_get_address_common(struct acpi_resource *resource,
255 union aml_resource *aml);
261 acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
262 union aml_resource *aml,
263 struct acpi_rsconvert_info *info);
266 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
267 union aml_resource *aml,
268 struct acpi_rsconvert_info *info);
274 acpi_rs_move_data(void *destination,
275 void *source, u16 item_count, u8 move_type);
277 u8 acpi_rs_decode_bitmask(u16 mask, u8 * list);
279 u16 acpi_rs_encode_bitmask(u8 * list, u8 count);
282 acpi_rs_get_resource_source(acpi_rs_length resource_length,
283 acpi_rs_length minimum_length,
284 struct acpi_resource_source *resource_source,
285 union aml_resource *aml, char *string_ptr);
288 acpi_rs_set_resource_source(union aml_resource *aml,
289 acpi_rs_length minimum_length,
290 struct acpi_resource_source *resource_source);
293 acpi_rs_set_resource_header(u8 descriptor_type,
294 acpi_rsdesc_size total_length,
295 union aml_resource *aml);
298 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
299 union aml_resource *aml);
302 * rsdump - Debugger support
305 void acpi_rs_dump_resource_list(struct acpi_resource *resource);
307 void acpi_rs_dump_irq_list(u8 *route_table);
311 * Resource conversion tables
313 extern struct acpi_rsconvert_info acpi_rs_convert_dma[];
314 extern struct acpi_rsconvert_info acpi_rs_convert_end_dpf[];
315 extern struct acpi_rsconvert_info acpi_rs_convert_io[];
316 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_io[];
317 extern struct acpi_rsconvert_info acpi_rs_convert_end_tag[];
318 extern struct acpi_rsconvert_info acpi_rs_convert_memory24[];
319 extern struct acpi_rsconvert_info acpi_rs_convert_generic_reg[];
320 extern struct acpi_rsconvert_info acpi_rs_convert_memory32[];
321 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_memory32[];
322 extern struct acpi_rsconvert_info acpi_rs_convert_address32[];
323 extern struct acpi_rsconvert_info acpi_rs_convert_address16[];
324 extern struct acpi_rsconvert_info acpi_rs_convert_ext_irq[];
325 extern struct acpi_rsconvert_info acpi_rs_convert_address64[];
326 extern struct acpi_rsconvert_info acpi_rs_convert_ext_address64[];
327 extern struct acpi_rsconvert_info acpi_rs_convert_gpio[];
328 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_dma[];
329 extern struct acpi_rsconvert_info acpi_rs_convert_i2c_serial_bus[];
330 extern struct acpi_rsconvert_info acpi_rs_convert_spi_serial_bus[];
331 extern struct acpi_rsconvert_info acpi_rs_convert_uart_serial_bus[];
333 /* These resources require separate get/set tables */
335 extern struct acpi_rsconvert_info acpi_rs_get_irq[];
336 extern struct acpi_rsconvert_info acpi_rs_get_start_dpf[];
337 extern struct acpi_rsconvert_info acpi_rs_get_vendor_small[];
338 extern struct acpi_rsconvert_info acpi_rs_get_vendor_large[];
340 extern struct acpi_rsconvert_info acpi_rs_set_irq[];
341 extern struct acpi_rsconvert_info acpi_rs_set_start_dpf[];
342 extern struct acpi_rsconvert_info acpi_rs_set_vendor[];
344 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
348 extern struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[];
349 extern struct acpi_rsdump_info *acpi_gbl_dump_serial_bus_dispatch[];
354 extern struct acpi_rsdump_info acpi_rs_dump_irq[];
355 extern struct acpi_rsdump_info acpi_rs_dump_prt[];
356 extern struct acpi_rsdump_info acpi_rs_dump_dma[];
357 extern struct acpi_rsdump_info acpi_rs_dump_start_dpf[];
358 extern struct acpi_rsdump_info acpi_rs_dump_end_dpf[];
359 extern struct acpi_rsdump_info acpi_rs_dump_io[];
360 extern struct acpi_rsdump_info acpi_rs_dump_io_flags[];
361 extern struct acpi_rsdump_info acpi_rs_dump_fixed_io[];
362 extern struct acpi_rsdump_info acpi_rs_dump_vendor[];
363 extern struct acpi_rsdump_info acpi_rs_dump_end_tag[];
364 extern struct acpi_rsdump_info acpi_rs_dump_memory24[];
365 extern struct acpi_rsdump_info acpi_rs_dump_memory32[];
366 extern struct acpi_rsdump_info acpi_rs_dump_memory_flags[];
367 extern struct acpi_rsdump_info acpi_rs_dump_fixed_memory32[];
368 extern struct acpi_rsdump_info acpi_rs_dump_address16[];
369 extern struct acpi_rsdump_info acpi_rs_dump_address32[];
370 extern struct acpi_rsdump_info acpi_rs_dump_address64[];
371 extern struct acpi_rsdump_info acpi_rs_dump_ext_address64[];
372 extern struct acpi_rsdump_info acpi_rs_dump_ext_irq[];
373 extern struct acpi_rsdump_info acpi_rs_dump_generic_reg[];
374 extern struct acpi_rsdump_info acpi_rs_dump_gpio[];
375 extern struct acpi_rsdump_info acpi_rs_dump_fixed_dma[];
376 extern struct acpi_rsdump_info acpi_rs_dump_common_serial_bus[];
377 extern struct acpi_rsdump_info acpi_rs_dump_i2c_serial_bus[];
378 extern struct acpi_rsdump_info acpi_rs_dump_spi_serial_bus[];
379 extern struct acpi_rsdump_info acpi_rs_dump_uart_serial_bus[];
380 extern struct acpi_rsdump_info acpi_rs_dump_general_flags[];
383 #endif /* __ACRESRC_H__ */