1 /******************************************************************************
3 * Module Name: tbxface - ACPI table-oriented external interfaces
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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 #include <linux/export.h>
45 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME("tbxface")
52 /*******************************************************************************
54 * FUNCTION: acpi_allocate_root_table
56 * PARAMETERS: initial_table_count - Size of initial_table_array, in number of
57 * struct acpi_table_desc structures
61 * DESCRIPTION: Allocate a root table array. Used by iASL compiler and
62 * acpi_initialize_tables.
64 ******************************************************************************/
65 acpi_status acpi_allocate_root_table(u32 initial_table_count)
68 acpi_gbl_root_table_list.max_table_count = initial_table_count;
69 acpi_gbl_root_table_list.flags = ACPI_ROOT_ALLOW_RESIZE;
71 return (acpi_tb_resize_root_table_list());
74 /*******************************************************************************
76 * FUNCTION: acpi_initialize_tables
78 * PARAMETERS: initial_table_array - Pointer to an array of pre-allocated
79 * struct acpi_table_desc structures. If NULL, the
80 * array is dynamically allocated.
81 * initial_table_count - Size of initial_table_array, in number of
82 * struct acpi_table_desc structures
83 * allow_resize - Flag to tell Table Manager if resize of
84 * pre-allocated array is allowed. Ignored
85 * if initial_table_array is NULL.
89 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
91 * NOTE: Allows static allocation of the initial table array in order
92 * to avoid the use of dynamic memory in confined environments
93 * such as the kernel boot sequence where it may not be available.
95 * If the host OS memory managers are initialized, use NULL for
96 * initial_table_array, and the table will be dynamically allocated.
98 ******************************************************************************/
101 acpi_initialize_tables(struct acpi_table_desc * initial_table_array,
102 u32 initial_table_count, u8 allow_resize)
104 acpi_physical_address rsdp_address;
107 ACPI_FUNCTION_TRACE(acpi_initialize_tables);
110 * Setup the Root Table Array and allocate the table array
113 if (!initial_table_array) {
114 status = acpi_allocate_root_table(initial_table_count);
115 if (ACPI_FAILURE(status)) {
116 return_ACPI_STATUS(status);
119 /* Root Table Array has been statically allocated by the host */
121 ACPI_MEMSET(initial_table_array, 0,
122 (acpi_size) initial_table_count *
123 sizeof(struct acpi_table_desc));
125 acpi_gbl_root_table_list.tables = initial_table_array;
126 acpi_gbl_root_table_list.max_table_count = initial_table_count;
127 acpi_gbl_root_table_list.flags = ACPI_ROOT_ORIGIN_UNKNOWN;
129 acpi_gbl_root_table_list.flags |=
130 ACPI_ROOT_ALLOW_RESIZE;
134 /* Get the address of the RSDP */
136 rsdp_address = acpi_os_get_root_pointer();
138 return_ACPI_STATUS(AE_NOT_FOUND);
142 * Get the root table (RSDT or XSDT) and extract all entries to the local
143 * Root Table Array. This array contains the information of the RSDT/XSDT
144 * in a common, more useable format.
146 status = acpi_tb_parse_root_table(rsdp_address);
147 return_ACPI_STATUS(status);
150 /*******************************************************************************
152 * FUNCTION: acpi_reallocate_root_table
158 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
159 * root list from the previously provided scratch area. Should
160 * be called once dynamic memory allocation is available in the
163 ******************************************************************************/
164 acpi_status acpi_reallocate_root_table(void)
168 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table);
171 * Only reallocate the root table if the host provided a static buffer
172 * for the table array in the call to acpi_initialize_tables.
174 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
175 return_ACPI_STATUS(AE_SUPPORT);
178 acpi_gbl_root_table_list.flags |= ACPI_ROOT_ALLOW_RESIZE;
180 status = acpi_tb_resize_root_table_list();
181 return_ACPI_STATUS(status);
184 /*******************************************************************************
186 * FUNCTION: acpi_get_table_header
188 * PARAMETERS: signature - ACPI signature of needed table
189 * instance - Which instance (for SSDTs)
190 * out_table_header - The pointer to the table header to fill
192 * RETURN: Status and pointer to mapped table header
194 * DESCRIPTION: Finds an ACPI table header.
196 * NOTE: Caller is responsible in unmapping the header with
197 * acpi_os_unmap_memory
199 ******************************************************************************/
201 acpi_get_table_header(char *signature,
202 u32 instance, struct acpi_table_header *out_table_header)
206 struct acpi_table_header *header;
208 /* Parameter validation */
210 if (!signature || !out_table_header) {
211 return (AE_BAD_PARAMETER);
214 /* Walk the root table list */
216 for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
218 if (!ACPI_COMPARE_NAME
219 (&(acpi_gbl_root_table_list.tables[i].signature),
224 if (++j < instance) {
228 if (!acpi_gbl_root_table_list.tables[i].pointer) {
229 if ((acpi_gbl_root_table_list.tables[i].flags &
230 ACPI_TABLE_ORIGIN_MASK) ==
231 ACPI_TABLE_ORIGIN_MAPPED) {
233 acpi_os_map_memory(acpi_gbl_root_table_list.
238 return (AE_NO_MEMORY);
240 ACPI_MEMCPY(out_table_header, header,
241 sizeof(struct acpi_table_header));
242 acpi_os_unmap_memory(header,
246 return (AE_NOT_FOUND);
249 ACPI_MEMCPY(out_table_header,
250 acpi_gbl_root_table_list.tables[i].pointer,
251 sizeof(struct acpi_table_header));
256 return (AE_NOT_FOUND);
259 ACPI_EXPORT_SYMBOL(acpi_get_table_header)
261 /*******************************************************************************
263 * FUNCTION: acpi_unload_table_id
265 * PARAMETERS: id - Owner ID of the table to be removed.
269 * DESCRIPTION: This routine is used to force the unload of a table (by id)
271 ******************************************************************************/
272 acpi_status acpi_unload_table_id(acpi_owner_id id)
275 acpi_status status = AE_NOT_EXIST;
277 ACPI_FUNCTION_TRACE(acpi_unload_table_id);
279 /* Find table in the global table list */
280 for (i = 0; i < acpi_gbl_root_table_list.current_table_count; ++i) {
281 if (id != acpi_gbl_root_table_list.tables[i].owner_id) {
285 * Delete all namespace objects owned by this table. Note that these
286 * objects can appear anywhere in the namespace by virtue of the AML
287 * "Scope" operator. Thus, we need to track ownership by an ID, not
288 * simply a position within the hierarchy
290 acpi_tb_delete_namespace_by_owner(i);
291 status = acpi_tb_release_owner_id(i);
292 acpi_tb_set_table_loaded_flag(i, FALSE);
295 return_ACPI_STATUS(status);
298 ACPI_EXPORT_SYMBOL(acpi_unload_table_id)
300 /*******************************************************************************
302 * FUNCTION: acpi_get_table_with_size
304 * PARAMETERS: signature - ACPI signature of needed table
305 * instance - Which instance (for SSDTs)
306 * out_table - Where the pointer to the table is returned
308 * RETURN: Status and pointer to the requested table
310 * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the
313 ******************************************************************************/
315 acpi_get_table_with_size(char *signature,
316 u32 instance, struct acpi_table_header **out_table,
323 /* Parameter validation */
325 if (!signature || !out_table) {
326 return (AE_BAD_PARAMETER);
329 /* Walk the root table list */
331 for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
333 if (!ACPI_COMPARE_NAME
334 (&(acpi_gbl_root_table_list.tables[i].signature),
339 if (++j < instance) {
344 acpi_tb_verify_table(&acpi_gbl_root_table_list.tables[i]);
345 if (ACPI_SUCCESS(status)) {
346 *out_table = acpi_gbl_root_table_list.tables[i].pointer;
347 *tbl_size = acpi_gbl_root_table_list.tables[i].length;
350 if (!acpi_gbl_permanent_mmap) {
351 acpi_gbl_root_table_list.tables[i].pointer = NULL;
357 return (AE_NOT_FOUND);
359 ACPI_EXPORT_SYMBOL(acpi_get_table_with_size)
362 acpi_get_table(char *signature,
363 u32 instance, struct acpi_table_header **out_table)
367 return acpi_get_table_with_size(signature,
368 instance, out_table, &tbl_size);
370 ACPI_EXPORT_SYMBOL(acpi_get_table)
372 /*******************************************************************************
374 * FUNCTION: acpi_get_table_by_index
376 * PARAMETERS: table_index - Table index
377 * table - Where the pointer to the table is returned
379 * RETURN: Status and pointer to the requested table
381 * DESCRIPTION: Obtain a table by an index into the global table list. Used
384 ******************************************************************************/
386 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **table)
390 ACPI_FUNCTION_TRACE(acpi_get_table_by_index);
392 /* Parameter validation */
395 return_ACPI_STATUS(AE_BAD_PARAMETER);
398 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
402 if (table_index >= acpi_gbl_root_table_list.current_table_count) {
403 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
404 return_ACPI_STATUS(AE_BAD_PARAMETER);
407 if (!acpi_gbl_root_table_list.tables[table_index].pointer) {
409 /* Table is not mapped, map it */
412 acpi_tb_verify_table(&acpi_gbl_root_table_list.
413 tables[table_index]);
414 if (ACPI_FAILURE(status)) {
415 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
416 return_ACPI_STATUS(status);
420 *table = acpi_gbl_root_table_list.tables[table_index].pointer;
421 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
422 return_ACPI_STATUS(AE_OK);
425 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index)
428 /*******************************************************************************
430 * FUNCTION: acpi_install_table_handler
432 * PARAMETERS: handler - Table event handler
433 * context - Value passed to the handler on each event
437 * DESCRIPTION: Install a global table event handler.
439 ******************************************************************************/
441 acpi_install_table_handler(acpi_table_handler handler, void *context)
445 ACPI_FUNCTION_TRACE(acpi_install_table_handler);
448 return_ACPI_STATUS(AE_BAD_PARAMETER);
451 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
452 if (ACPI_FAILURE(status)) {
453 return_ACPI_STATUS(status);
456 /* Don't allow more than one handler */
458 if (acpi_gbl_table_handler) {
459 status = AE_ALREADY_EXISTS;
463 /* Install the handler */
465 acpi_gbl_table_handler = handler;
466 acpi_gbl_table_handler_context = context;
469 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
470 return_ACPI_STATUS(status);
473 ACPI_EXPORT_SYMBOL(acpi_install_table_handler)
475 /*******************************************************************************
477 * FUNCTION: acpi_remove_table_handler
479 * PARAMETERS: handler - Table event handler that was installed
484 * DESCRIPTION: Remove a table event handler
486 ******************************************************************************/
487 acpi_status acpi_remove_table_handler(acpi_table_handler handler)
491 ACPI_FUNCTION_TRACE(acpi_remove_table_handler);
493 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
494 if (ACPI_FAILURE(status)) {
495 return_ACPI_STATUS(status);
498 /* Make sure that the installed handler is the same */
500 if (!handler || handler != acpi_gbl_table_handler) {
501 status = AE_BAD_PARAMETER;
505 /* Remove the handler */
507 acpi_gbl_table_handler = NULL;
510 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
511 return_ACPI_STATUS(status);
514 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler)