1 /******************************************************************************
3 * Module Name: tbxface - ACPI table oriented external interfaces
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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>
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_realloc - 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 ******************************************************************************/
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 * Set up the Root Table Array
112 * Allocate the table array if requested
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 ACPI_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 /*******************************************************************************
153 * FUNCTION: acpi_reallocate_root_table
159 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
160 * root list from the previously provided scratch area. Should
161 * be called once dynamic memory allocation is available in the
164 ******************************************************************************/
165 acpi_status
acpi_reallocate_root_table(void)
169 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table
);
172 * Only reallocate the root table if the host provided a static buffer
173 * for the table array in the call to acpi_initialize_tables.
175 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
176 return_ACPI_STATUS(AE_SUPPORT
);
179 acpi_gbl_root_table_list
.flags
|= ACPI_ROOT_ALLOW_RESIZE
;
181 status
= acpi_tb_resize_root_table_list();
182 return_ACPI_STATUS(status
);
185 /*******************************************************************************
187 * FUNCTION: acpi_get_table_header
189 * PARAMETERS: signature - ACPI signature of needed table
190 * instance - Which instance (for SSDTs)
191 * out_table_header - The pointer to the table header to fill
193 * RETURN: Status and pointer to mapped table header
195 * DESCRIPTION: Finds an ACPI table header.
197 * NOTE: Caller is responsible in unmapping the header with
198 * acpi_os_unmap_memory
200 ******************************************************************************/
202 acpi_get_table_header(char *signature
,
203 u32 instance
, struct acpi_table_header
*out_table_header
)
207 struct acpi_table_header
*header
;
209 /* Parameter validation */
211 if (!signature
|| !out_table_header
) {
212 return (AE_BAD_PARAMETER
);
215 /* Walk the root table list */
217 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.current_table_count
;
219 if (!ACPI_COMPARE_NAME
220 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
225 if (++j
< instance
) {
229 if (!acpi_gbl_root_table_list
.tables
[i
].pointer
) {
230 if ((acpi_gbl_root_table_list
.tables
[i
].flags
&
231 ACPI_TABLE_ORIGIN_MASK
) ==
232 ACPI_TABLE_ORIGIN_MAPPED
) {
234 acpi_os_map_memory(acpi_gbl_root_table_list
.
239 return (AE_NO_MEMORY
);
241 ACPI_MEMCPY(out_table_header
, header
,
242 sizeof(struct acpi_table_header
));
243 acpi_os_unmap_memory(header
,
247 return (AE_NOT_FOUND
);
250 ACPI_MEMCPY(out_table_header
,
251 acpi_gbl_root_table_list
.tables
[i
].pointer
,
252 sizeof(struct acpi_table_header
));
257 return (AE_NOT_FOUND
);
260 ACPI_EXPORT_SYMBOL(acpi_get_table_header
)
262 /*******************************************************************************
264 * FUNCTION: acpi_unload_table_id
266 * PARAMETERS: id - Owner ID of the table to be removed.
270 * DESCRIPTION: This routine is used to force the unload of a table (by id)
272 ******************************************************************************/
273 acpi_status
acpi_unload_table_id(acpi_owner_id id
)
276 acpi_status status
= AE_NOT_EXIST
;
278 ACPI_FUNCTION_TRACE(acpi_unload_table_id
);
280 /* Find table in the global table list */
281 for (i
= 0; i
< acpi_gbl_root_table_list
.current_table_count
; ++i
) {
282 if (id
!= acpi_gbl_root_table_list
.tables
[i
].owner_id
) {
286 * Delete all namespace objects owned by this table. Note that these
287 * objects can appear anywhere in the namespace by virtue of the AML
288 * "Scope" operator. Thus, we need to track ownership by an ID, not
289 * simply a position within the hierarchy
291 acpi_tb_delete_namespace_by_owner(i
);
292 status
= acpi_tb_release_owner_id(i
);
293 acpi_tb_set_table_loaded_flag(i
, FALSE
);
296 return_ACPI_STATUS(status
);
299 ACPI_EXPORT_SYMBOL(acpi_unload_table_id
)
301 /*******************************************************************************
303 * FUNCTION: acpi_get_table_with_size
305 * PARAMETERS: signature - ACPI signature of needed table
306 * instance - Which instance (for SSDTs)
307 * out_table - Where the pointer to the table is returned
309 * RETURN: Status and pointer to table
311 * DESCRIPTION: Finds and verifies an ACPI table.
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 table
381 * DESCRIPTION: Obtain a table by an index into the global table list.
383 ******************************************************************************/
385 acpi_get_table_by_index(u32 table_index
, struct acpi_table_header
**table
)
389 ACPI_FUNCTION_TRACE(acpi_get_table_by_index
);
391 /* Parameter validation */
394 return_ACPI_STATUS(AE_BAD_PARAMETER
);
397 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
401 if (table_index
>= acpi_gbl_root_table_list
.current_table_count
) {
402 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
403 return_ACPI_STATUS(AE_BAD_PARAMETER
);
406 if (!acpi_gbl_root_table_list
.tables
[table_index
].pointer
) {
408 /* Table is not mapped, map it */
411 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
412 tables
[table_index
]);
413 if (ACPI_FAILURE(status
)) {
414 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
415 return_ACPI_STATUS(status
);
419 *table
= acpi_gbl_root_table_list
.tables
[table_index
].pointer
;
420 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
421 return_ACPI_STATUS(AE_OK
);
424 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index
)
427 /*******************************************************************************
429 * FUNCTION: acpi_install_table_handler
431 * PARAMETERS: handler - Table event handler
432 * context - Value passed to the handler on each event
436 * DESCRIPTION: Install table event handler
438 ******************************************************************************/
440 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
)
444 ACPI_FUNCTION_TRACE(acpi_install_table_handler
);
447 return_ACPI_STATUS(AE_BAD_PARAMETER
);
450 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
451 if (ACPI_FAILURE(status
)) {
452 return_ACPI_STATUS(status
);
455 /* Don't allow more than one handler */
457 if (acpi_gbl_table_handler
) {
458 status
= AE_ALREADY_EXISTS
;
462 /* Install the handler */
464 acpi_gbl_table_handler
= handler
;
465 acpi_gbl_table_handler_context
= context
;
468 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
469 return_ACPI_STATUS(status
);
472 ACPI_EXPORT_SYMBOL(acpi_install_table_handler
)
474 /*******************************************************************************
476 * FUNCTION: acpi_remove_table_handler
478 * PARAMETERS: handler - Table event handler that was installed
483 * DESCRIPTION: Remove table event handler
485 ******************************************************************************/
486 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
)
490 ACPI_FUNCTION_TRACE(acpi_remove_table_handler
);
492 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
493 if (ACPI_FAILURE(status
)) {
494 return_ACPI_STATUS(status
);
497 /* Make sure that the installed handler is the same */
499 if (!handler
|| handler
!= acpi_gbl_table_handler
) {
500 status
= AE_BAD_PARAMETER
;
504 /* Remove the handler */
506 acpi_gbl_table_handler
= NULL
;
509 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
510 return_ACPI_STATUS(status
);
513 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler
)