1 /******************************************************************************
3 * Module Name: tbxface - ACPI table-oriented external interfaces
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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.
44 #define EXPORT_ACPI_INTERFACES
46 #include <acpi/acpi.h>
50 #define _COMPONENT ACPI_TABLES
51 ACPI_MODULE_NAME("tbxface")
53 /*******************************************************************************
55 * FUNCTION: acpi_allocate_root_table
57 * PARAMETERS: initial_table_count - Size of initial_table_array, in number of
58 * struct acpi_table_desc structures
62 * DESCRIPTION: Allocate a root table array. Used by iASL compiler and
63 * acpi_initialize_tables.
65 ******************************************************************************/
66 acpi_status acpi_allocate_root_table(u32 initial_table_count)
69 acpi_gbl_root_table_list.max_table_count = initial_table_count;
70 acpi_gbl_root_table_list.flags = ACPI_ROOT_ALLOW_RESIZE;
72 return (acpi_tb_resize_root_table_list());
75 /*******************************************************************************
77 * FUNCTION: acpi_initialize_tables
79 * PARAMETERS: initial_table_array - Pointer to an array of pre-allocated
80 * struct acpi_table_desc structures. If NULL, the
81 * array is dynamically allocated.
82 * initial_table_count - Size of initial_table_array, in number of
83 * struct acpi_table_desc structures
84 * allow_resize - Flag to tell Table Manager if resize of
85 * pre-allocated array is allowed. Ignored
86 * if initial_table_array is NULL.
90 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
92 * NOTE: Allows static allocation of the initial table array in order
93 * to avoid the use of dynamic memory in confined environments
94 * such as the kernel boot sequence where it may not be available.
96 * If the host OS memory managers are initialized, use NULL for
97 * initial_table_array, and the table will be dynamically allocated.
99 ******************************************************************************/
101 acpi_status ACPI_INIT_FUNCTION
102 acpi_initialize_tables(struct acpi_table_desc *initial_table_array,
103 u32 initial_table_count, u8 allow_resize)
105 acpi_physical_address rsdp_address;
108 ACPI_FUNCTION_TRACE(acpi_initialize_tables);
111 * Setup the Root Table Array and allocate the table array
114 if (!initial_table_array) {
115 status = acpi_allocate_root_table(initial_table_count);
116 if (ACPI_FAILURE(status)) {
117 return_ACPI_STATUS(status);
120 /* Root Table Array has been statically allocated by the host */
122 memset(initial_table_array, 0,
123 (acpi_size)initial_table_count *
124 sizeof(struct acpi_table_desc));
126 acpi_gbl_root_table_list.tables = initial_table_array;
127 acpi_gbl_root_table_list.max_table_count = initial_table_count;
128 acpi_gbl_root_table_list.flags = ACPI_ROOT_ORIGIN_UNKNOWN;
130 acpi_gbl_root_table_list.flags |=
131 ACPI_ROOT_ALLOW_RESIZE;
135 /* Get the address of the RSDP */
137 rsdp_address = acpi_os_get_root_pointer();
139 return_ACPI_STATUS(AE_NOT_FOUND);
143 * Get the root table (RSDT or XSDT) and extract all entries to the local
144 * Root Table Array. This array contains the information of the RSDT/XSDT
145 * in a common, more useable format.
147 status = acpi_tb_parse_root_table(rsdp_address);
148 return_ACPI_STATUS(status);
151 ACPI_EXPORT_SYMBOL_INIT(acpi_initialize_tables)
153 /*******************************************************************************
155 * FUNCTION: acpi_reallocate_root_table
161 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
162 * root list from the previously provided scratch area. Should
163 * be called once dynamic memory allocation is available in the
166 ******************************************************************************/
167 acpi_status ACPI_INIT_FUNCTION acpi_reallocate_root_table(void)
172 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table);
175 * Only reallocate the root table if the host provided a static buffer
176 * for the table array in the call to acpi_initialize_tables.
178 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
179 return_ACPI_STATUS(AE_SUPPORT);
183 * Ensure OS early boot logic, which is required by some hosts. If the
184 * table state is reported to be wrong, developers should fix the
185 * issue by invoking acpi_put_table() for the reported table during the
188 for (i = 0; i < acpi_gbl_root_table_list.current_table_count; ++i) {
189 if (acpi_gbl_root_table_list.tables[i].pointer) {
191 "Table [%4.4s] is not invalidated during early boot stage",
192 acpi_gbl_root_table_list.tables[i].
197 acpi_gbl_root_table_list.flags |= ACPI_ROOT_ALLOW_RESIZE;
199 status = acpi_tb_resize_root_table_list();
200 return_ACPI_STATUS(status);
203 ACPI_EXPORT_SYMBOL_INIT(acpi_reallocate_root_table)
205 /*******************************************************************************
207 * FUNCTION: acpi_get_table_header
209 * PARAMETERS: signature - ACPI signature of needed table
210 * instance - Which instance (for SSDTs)
211 * out_table_header - The pointer to the table header to fill
213 * RETURN: Status and pointer to mapped table header
215 * DESCRIPTION: Finds an ACPI table header.
217 * NOTE: Caller is responsible in unmapping the header with
218 * acpi_os_unmap_memory
220 ******************************************************************************/
222 acpi_get_table_header(char *signature,
223 u32 instance, struct acpi_table_header *out_table_header)
227 struct acpi_table_header *header;
229 /* Parameter validation */
231 if (!signature || !out_table_header) {
232 return (AE_BAD_PARAMETER);
235 /* Walk the root table list */
237 for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
239 if (!ACPI_COMPARE_NAME
240 (&(acpi_gbl_root_table_list.tables[i].signature),
245 if (++j < instance) {
249 if (!acpi_gbl_root_table_list.tables[i].pointer) {
250 if ((acpi_gbl_root_table_list.tables[i].flags &
251 ACPI_TABLE_ORIGIN_MASK) ==
252 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL) {
254 acpi_os_map_memory(acpi_gbl_root_table_list.
259 return (AE_NO_MEMORY);
262 memcpy(out_table_header, header,
263 sizeof(struct acpi_table_header));
264 acpi_os_unmap_memory(header,
268 return (AE_NOT_FOUND);
271 memcpy(out_table_header,
272 acpi_gbl_root_table_list.tables[i].pointer,
273 sizeof(struct acpi_table_header));
278 return (AE_NOT_FOUND);
281 ACPI_EXPORT_SYMBOL(acpi_get_table_header)
283 /*******************************************************************************
285 * FUNCTION: acpi_get_table_with_size
287 * PARAMETERS: signature - ACPI signature of needed table
288 * instance - Which instance (for SSDTs)
289 * out_table - Where the pointer to the table is returned
291 * RETURN: Status and pointer to the requested table
293 * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the
296 ******************************************************************************/
298 acpi_get_table_with_size(char *signature,
299 u32 instance, struct acpi_table_header **out_table,
306 /* Parameter validation */
308 if (!signature || !out_table) {
309 return (AE_BAD_PARAMETER);
312 /* Walk the root table list */
314 for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
316 if (!ACPI_COMPARE_NAME
317 (&(acpi_gbl_root_table_list.tables[i].signature),
322 if (++j < instance) {
327 acpi_tb_validate_table(&acpi_gbl_root_table_list.tables[i]);
328 if (ACPI_SUCCESS(status)) {
329 *out_table = acpi_gbl_root_table_list.tables[i].pointer;
330 *tbl_size = acpi_gbl_root_table_list.tables[i].length;
333 if (!acpi_gbl_permanent_mmap) {
334 acpi_gbl_root_table_list.tables[i].pointer = NULL;
340 return (AE_NOT_FOUND);
343 ACPI_EXPORT_SYMBOL(acpi_get_table_with_size)
346 acpi_get_table(char *signature,
347 u32 instance, struct acpi_table_header **out_table)
351 return acpi_get_table_with_size(signature,
352 instance, out_table, &tbl_size);
355 ACPI_EXPORT_SYMBOL(acpi_get_table)
357 /*******************************************************************************
359 * FUNCTION: acpi_get_table_by_index
361 * PARAMETERS: table_index - Table index
362 * table - Where the pointer to the table is returned
364 * RETURN: Status and pointer to the requested table
366 * DESCRIPTION: Obtain a table by an index into the global table list. Used
369 ******************************************************************************/
371 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **table)
375 ACPI_FUNCTION_TRACE(acpi_get_table_by_index);
377 /* Parameter validation */
380 return_ACPI_STATUS(AE_BAD_PARAMETER);
383 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
387 if (table_index >= acpi_gbl_root_table_list.current_table_count) {
388 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
389 return_ACPI_STATUS(AE_BAD_PARAMETER);
392 if (!acpi_gbl_root_table_list.tables[table_index].pointer) {
394 /* Table is not mapped, map it */
397 acpi_tb_validate_table(&acpi_gbl_root_table_list.
398 tables[table_index]);
399 if (ACPI_FAILURE(status)) {
400 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
401 return_ACPI_STATUS(status);
405 *table = acpi_gbl_root_table_list.tables[table_index].pointer;
406 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
407 return_ACPI_STATUS(AE_OK);
410 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index)
412 /*******************************************************************************
414 * FUNCTION: acpi_install_table_handler
416 * PARAMETERS: handler - Table event handler
417 * context - Value passed to the handler on each event
421 * DESCRIPTION: Install a global table event handler.
423 ******************************************************************************/
425 acpi_install_table_handler(acpi_table_handler handler, void *context)
429 ACPI_FUNCTION_TRACE(acpi_install_table_handler);
432 return_ACPI_STATUS(AE_BAD_PARAMETER);
435 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
436 if (ACPI_FAILURE(status)) {
437 return_ACPI_STATUS(status);
440 /* Don't allow more than one handler */
442 if (acpi_gbl_table_handler) {
443 status = AE_ALREADY_EXISTS;
447 /* Install the handler */
449 acpi_gbl_table_handler = handler;
450 acpi_gbl_table_handler_context = context;
453 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
454 return_ACPI_STATUS(status);
457 ACPI_EXPORT_SYMBOL(acpi_install_table_handler)
459 /*******************************************************************************
461 * FUNCTION: acpi_remove_table_handler
463 * PARAMETERS: handler - Table event handler that was installed
468 * DESCRIPTION: Remove a table event handler
470 ******************************************************************************/
471 acpi_status acpi_remove_table_handler(acpi_table_handler handler)
475 ACPI_FUNCTION_TRACE(acpi_remove_table_handler);
477 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
478 if (ACPI_FAILURE(status)) {
479 return_ACPI_STATUS(status);
482 /* Make sure that the installed handler is the same */
484 if (!handler || handler != acpi_gbl_table_handler) {
485 status = AE_BAD_PARAMETER;
489 /* Remove the handler */
491 acpi_gbl_table_handler = NULL;
494 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
495 return_ACPI_STATUS(status);
498 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler)