Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
b7ed9a8e | 3 | * Module Name: tbxface - ACPI table-oriented external interfaces |
1da177e4 LT |
4 | * |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, Intel Corp. |
1da177e4 LT |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
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. | |
25 | * | |
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. | |
29 | * | |
30 | * NO WARRANTY | |
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. | |
42 | */ | |
43 | ||
839e928f LZ |
44 | #define EXPORT_ACPI_INTERFACES |
45 | ||
1da177e4 | 46 | #include <acpi/acpi.h> |
e2f7a777 | 47 | #include "accommon.h" |
e2f7a777 | 48 | #include "actables.h" |
1da177e4 | 49 | |
1da177e4 | 50 | #define _COMPONENT ACPI_TABLES |
4be44fcd | 51 | ACPI_MODULE_NAME("tbxface") |
1da177e4 | 52 | |
77389e12 BM |
53 | /******************************************************************************* |
54 | * | |
55 | * FUNCTION: acpi_allocate_root_table | |
56 | * | |
57 | * PARAMETERS: initial_table_count - Size of initial_table_array, in number of | |
58 | * struct acpi_table_desc structures | |
59 | * | |
60 | * RETURN: Status | |
61 | * | |
ba494bee | 62 | * DESCRIPTION: Allocate a root table array. Used by iASL compiler and |
77389e12 BM |
63 | * acpi_initialize_tables. |
64 | * | |
65 | ******************************************************************************/ | |
77389e12 BM |
66 | acpi_status acpi_allocate_root_table(u32 initial_table_count) |
67 | { | |
68 | ||
b9ee2043 | 69 | acpi_gbl_root_table_list.max_table_count = initial_table_count; |
77389e12 BM |
70 | acpi_gbl_root_table_list.flags = ACPI_ROOT_ALLOW_RESIZE; |
71 | ||
72 | return (acpi_tb_resize_root_table_list()); | |
73 | } | |
74 | ||
1da177e4 LT |
75 | /******************************************************************************* |
76 | * | |
f3d2e786 | 77 | * FUNCTION: acpi_initialize_tables |
1da177e4 | 78 | * |
f3d2e786 BM |
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 | |
b7ed9a8e | 84 | * allow_resize - Flag to tell Table Manager if resize of |
f3d2e786 BM |
85 | * pre-allocated array is allowed. Ignored |
86 | * if initial_table_array is NULL. | |
1da177e4 LT |
87 | * |
88 | * RETURN: Status | |
89 | * | |
f3d2e786 BM |
90 | * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT. |
91 | * | |
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. | |
95 | * | |
96 | * If the host OS memory managers are initialized, use NULL for | |
97 | * initial_table_array, and the table will be dynamically allocated. | |
1da177e4 LT |
98 | * |
99 | ******************************************************************************/ | |
f3d2e786 | 100 | |
ad71860a | 101 | acpi_status __init |
f5c1e1c5 | 102 | acpi_initialize_tables(struct acpi_table_desc *initial_table_array, |
f3d2e786 | 103 | u32 initial_table_count, u8 allow_resize) |
1da177e4 | 104 | { |
c5fc42ac | 105 | acpi_physical_address rsdp_address; |
4be44fcd | 106 | acpi_status status; |
1da177e4 | 107 | |
f3d2e786 | 108 | ACPI_FUNCTION_TRACE(acpi_initialize_tables); |
1da177e4 | 109 | |
f3d2e786 | 110 | /* |
b7ed9a8e TC |
111 | * Setup the Root Table Array and allocate the table array |
112 | * if requested | |
f3d2e786 BM |
113 | */ |
114 | if (!initial_table_array) { | |
77389e12 | 115 | status = acpi_allocate_root_table(initial_table_count); |
f3d2e786 BM |
116 | if (ACPI_FAILURE(status)) { |
117 | return_ACPI_STATUS(status); | |
118 | } | |
119 | } else { | |
120 | /* Root Table Array has been statically allocated by the host */ | |
121 | ||
4fa4616e | 122 | memset(initial_table_array, 0, |
f5c1e1c5 | 123 | (acpi_size)initial_table_count * |
4fa4616e | 124 | sizeof(struct acpi_table_desc)); |
c5fc42ac | 125 | |
f3d2e786 | 126 | acpi_gbl_root_table_list.tables = initial_table_array; |
b9ee2043 | 127 | acpi_gbl_root_table_list.max_table_count = initial_table_count; |
c5fc42ac | 128 | acpi_gbl_root_table_list.flags = ACPI_ROOT_ORIGIN_UNKNOWN; |
f3d2e786 | 129 | if (allow_resize) { |
c5fc42ac BM |
130 | acpi_gbl_root_table_list.flags |= |
131 | ACPI_ROOT_ALLOW_RESIZE; | |
f3d2e786 | 132 | } |
1da177e4 LT |
133 | } |
134 | ||
c5fc42ac | 135 | /* Get the address of the RSDP */ |
1da177e4 | 136 | |
c5fc42ac BM |
137 | rsdp_address = acpi_os_get_root_pointer(); |
138 | if (!rsdp_address) { | |
f3d2e786 BM |
139 | return_ACPI_STATUS(AE_NOT_FOUND); |
140 | } | |
1da177e4 | 141 | |
f3d2e786 BM |
142 | /* |
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. | |
146 | */ | |
97cbb7d1 | 147 | status = acpi_tb_parse_root_table(rsdp_address); |
f3d2e786 BM |
148 | return_ACPI_STATUS(status); |
149 | } | |
1da177e4 | 150 | |
d21f600b LZ |
151 | ACPI_EXPORT_SYMBOL_INIT(acpi_initialize_tables) |
152 | ||
f3d2e786 BM |
153 | /******************************************************************************* |
154 | * | |
155 | * FUNCTION: acpi_reallocate_root_table | |
156 | * | |
157 | * PARAMETERS: None | |
158 | * | |
159 | * RETURN: Status | |
160 | * | |
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 | |
2bc198c1 | 164 | * kernel. |
f3d2e786 BM |
165 | * |
166 | ******************************************************************************/ | |
45c9f78b | 167 | acpi_status __init acpi_reallocate_root_table(void) |
f3d2e786 | 168 | { |
2bc198c1 | 169 | acpi_status status; |
f3d2e786 BM |
170 | |
171 | ACPI_FUNCTION_TRACE(acpi_reallocate_root_table); | |
172 | ||
173 | /* | |
174 | * Only reallocate the root table if the host provided a static buffer | |
175 | * for the table array in the call to acpi_initialize_tables. | |
176 | */ | |
c5fc42ac | 177 | if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) { |
f3d2e786 | 178 | return_ACPI_STATUS(AE_SUPPORT); |
1da177e4 LT |
179 | } |
180 | ||
2bc198c1 | 181 | acpi_gbl_root_table_list.flags |= ACPI_ROOT_ALLOW_RESIZE; |
1da177e4 | 182 | |
2bc198c1 LZ |
183 | status = acpi_tb_resize_root_table_list(); |
184 | return_ACPI_STATUS(status); | |
f3d2e786 | 185 | } |
fd350943 | 186 | |
d21f600b LZ |
187 | ACPI_EXPORT_SYMBOL_INIT(acpi_reallocate_root_table) |
188 | ||
ec41f193 | 189 | /******************************************************************************* |
f3d2e786 BM |
190 | * |
191 | * FUNCTION: acpi_get_table_header | |
192 | * | |
ba494bee BM |
193 | * PARAMETERS: signature - ACPI signature of needed table |
194 | * instance - Which instance (for SSDTs) | |
428f2112 | 195 | * out_table_header - The pointer to the table header to fill |
f3d2e786 BM |
196 | * |
197 | * RETURN: Status and pointer to mapped table header | |
198 | * | |
199 | * DESCRIPTION: Finds an ACPI table header. | |
200 | * | |
201 | * NOTE: Caller is responsible in unmapping the header with | |
202 | * acpi_os_unmap_memory | |
203 | * | |
ec41f193 | 204 | ******************************************************************************/ |
f3d2e786 BM |
205 | acpi_status |
206 | acpi_get_table_header(char *signature, | |
67a119f9 | 207 | u32 instance, struct acpi_table_header *out_table_header) |
f3d2e786 | 208 | { |
5582982d LZ |
209 | u32 i; |
210 | u32 j; | |
428f2112 | 211 | struct acpi_table_header *header; |
0c9938cc | 212 | |
c5fc42ac BM |
213 | /* Parameter validation */ |
214 | ||
215 | if (!signature || !out_table_header) { | |
216 | return (AE_BAD_PARAMETER); | |
217 | } | |
218 | ||
ec41f193 BM |
219 | /* Walk the root table list */ |
220 | ||
b9ee2043 BM |
221 | for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count; |
222 | i++) { | |
f3d2e786 BM |
223 | if (!ACPI_COMPARE_NAME |
224 | (&(acpi_gbl_root_table_list.tables[i].signature), | |
225 | signature)) { | |
226 | continue; | |
0c9938cc RM |
227 | } |
228 | ||
f3d2e786 BM |
229 | if (++j < instance) { |
230 | continue; | |
231 | } | |
1da177e4 | 232 | |
428f2112 | 233 | if (!acpi_gbl_root_table_list.tables[i].pointer) { |
ec41f193 BM |
234 | if ((acpi_gbl_root_table_list.tables[i].flags & |
235 | ACPI_TABLE_ORIGIN_MASK) == | |
ed6f1d44 | 236 | ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL) { |
428f2112 AS |
237 | header = |
238 | acpi_os_map_memory(acpi_gbl_root_table_list. | |
239 | tables[i].address, | |
240 | sizeof(struct | |
241 | acpi_table_header)); | |
242 | if (!header) { | |
68aafc35 | 243 | return (AE_NO_MEMORY); |
428f2112 | 244 | } |
52c1d803 | 245 | |
4fa4616e BM |
246 | memcpy(out_table_header, header, |
247 | sizeof(struct acpi_table_header)); | |
428f2112 AS |
248 | acpi_os_unmap_memory(header, |
249 | sizeof(struct | |
250 | acpi_table_header)); | |
251 | } else { | |
68aafc35 | 252 | return (AE_NOT_FOUND); |
428f2112 AS |
253 | } |
254 | } else { | |
4fa4616e BM |
255 | memcpy(out_table_header, |
256 | acpi_gbl_root_table_list.tables[i].pointer, | |
257 | sizeof(struct acpi_table_header)); | |
f3d2e786 | 258 | } |
f3d2e786 | 259 | return (AE_OK); |
1da177e4 LT |
260 | } |
261 | ||
f3d2e786 | 262 | return (AE_NOT_FOUND); |
1da177e4 LT |
263 | } |
264 | ||
f3d2e786 | 265 | ACPI_EXPORT_SYMBOL(acpi_get_table_header) |
8313524a | 266 | |
1da177e4 LT |
267 | /******************************************************************************* |
268 | * | |
7d97277b | 269 | * FUNCTION: acpi_get_table_with_size |
1da177e4 | 270 | * |
ba494bee BM |
271 | * PARAMETERS: signature - ACPI signature of needed table |
272 | * instance - Which instance (for SSDTs) | |
f3d2e786 | 273 | * out_table - Where the pointer to the table is returned |
1da177e4 | 274 | * |
b7ed9a8e | 275 | * RETURN: Status and pointer to the requested table |
1da177e4 | 276 | * |
b7ed9a8e TC |
277 | * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the |
278 | * RSDT/XSDT. | |
1da177e4 | 279 | * |
ec41f193 | 280 | ******************************************************************************/ |
f3d2e786 | 281 | acpi_status |
7d97277b YL |
282 | acpi_get_table_with_size(char *signature, |
283 | u32 instance, struct acpi_table_header **out_table, | |
284 | acpi_size *tbl_size) | |
1da177e4 | 285 | { |
5582982d LZ |
286 | u32 i; |
287 | u32 j; | |
f3d2e786 | 288 | acpi_status status; |
1da177e4 | 289 | |
c5fc42ac BM |
290 | /* Parameter validation */ |
291 | ||
292 | if (!signature || !out_table) { | |
293 | return (AE_BAD_PARAMETER); | |
294 | } | |
295 | ||
ec41f193 BM |
296 | /* Walk the root table list */ |
297 | ||
b9ee2043 BM |
298 | for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count; |
299 | i++) { | |
f3d2e786 BM |
300 | if (!ACPI_COMPARE_NAME |
301 | (&(acpi_gbl_root_table_list.tables[i].signature), | |
302 | signature)) { | |
303 | continue; | |
304 | } | |
1da177e4 | 305 | |
f3d2e786 BM |
306 | if (++j < instance) { |
307 | continue; | |
308 | } | |
1da177e4 | 309 | |
f3d2e786 | 310 | status = |
7f9fc99c | 311 | acpi_tb_validate_table(&acpi_gbl_root_table_list.tables[i]); |
f3d2e786 BM |
312 | if (ACPI_SUCCESS(status)) { |
313 | *out_table = acpi_gbl_root_table_list.tables[i].pointer; | |
7d97277b | 314 | *tbl_size = acpi_gbl_root_table_list.tables[i].length; |
f3d2e786 | 315 | } |
f6dd9221 | 316 | |
ad71860a | 317 | if (!acpi_gbl_permanent_mmap) { |
70c0846e | 318 | acpi_gbl_root_table_list.tables[i].pointer = NULL; |
ad71860a AS |
319 | } |
320 | ||
f3d2e786 | 321 | return (status); |
1da177e4 LT |
322 | } |
323 | ||
f3d2e786 | 324 | return (AE_NOT_FOUND); |
1da177e4 | 325 | } |
d21f600b | 326 | |
4f81f986 | 327 | ACPI_EXPORT_SYMBOL(acpi_get_table_with_size) |
1da177e4 | 328 | |
7d97277b YL |
329 | acpi_status |
330 | acpi_get_table(char *signature, | |
331 | u32 instance, struct acpi_table_header **out_table) | |
332 | { | |
333 | acpi_size tbl_size; | |
334 | ||
335 | return acpi_get_table_with_size(signature, | |
336 | instance, out_table, &tbl_size); | |
337 | } | |
d21f600b | 338 | |
f3d2e786 | 339 | ACPI_EXPORT_SYMBOL(acpi_get_table) |
8313524a | 340 | |
1da177e4 LT |
341 | /******************************************************************************* |
342 | * | |
f3d2e786 | 343 | * FUNCTION: acpi_get_table_by_index |
1da177e4 | 344 | * |
f3d2e786 | 345 | * PARAMETERS: table_index - Table index |
ba494bee | 346 | * table - Where the pointer to the table is returned |
1da177e4 | 347 | * |
b7ed9a8e | 348 | * RETURN: Status and pointer to the requested table |
1da177e4 | 349 | * |
b7ed9a8e TC |
350 | * DESCRIPTION: Obtain a table by an index into the global table list. Used |
351 | * internally also. | |
1da177e4 LT |
352 | * |
353 | ******************************************************************************/ | |
1da177e4 | 354 | acpi_status |
f5c1e1c5 | 355 | acpi_get_table_by_index(u32 table_index, struct acpi_table_header **table) |
1da177e4 | 356 | { |
4be44fcd | 357 | acpi_status status; |
1da177e4 | 358 | |
f3d2e786 | 359 | ACPI_FUNCTION_TRACE(acpi_get_table_by_index); |
1da177e4 | 360 | |
c5fc42ac BM |
361 | /* Parameter validation */ |
362 | ||
363 | if (!table) { | |
364 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
365 | } | |
366 | ||
f3d2e786 | 367 | (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES); |
1da177e4 | 368 | |
f3d2e786 | 369 | /* Validate index */ |
1da177e4 | 370 | |
b9ee2043 | 371 | if (table_index >= acpi_gbl_root_table_list.current_table_count) { |
f3d2e786 | 372 | (void)acpi_ut_release_mutex(ACPI_MTX_TABLES); |
4be44fcd | 373 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
374 | } |
375 | ||
f3d2e786 | 376 | if (!acpi_gbl_root_table_list.tables[table_index].pointer) { |
1da177e4 | 377 | |
f3d2e786 | 378 | /* Table is not mapped, map it */ |
1da177e4 | 379 | |
f3d2e786 | 380 | status = |
7f9fc99c LZ |
381 | acpi_tb_validate_table(&acpi_gbl_root_table_list. |
382 | tables[table_index]); | |
f3d2e786 BM |
383 | if (ACPI_FAILURE(status)) { |
384 | (void)acpi_ut_release_mutex(ACPI_MTX_TABLES); | |
385 | return_ACPI_STATUS(status); | |
386 | } | |
1da177e4 LT |
387 | } |
388 | ||
f3d2e786 BM |
389 | *table = acpi_gbl_root_table_list.tables[table_index].pointer; |
390 | (void)acpi_ut_release_mutex(ACPI_MTX_TABLES); | |
391 | return_ACPI_STATUS(AE_OK); | |
1da177e4 LT |
392 | } |
393 | ||
f3d2e786 | 394 | ACPI_EXPORT_SYMBOL(acpi_get_table_by_index) |
1da177e4 | 395 | |
3e08e2d2 LM |
396 | /******************************************************************************* |
397 | * | |
398 | * FUNCTION: acpi_install_table_handler | |
399 | * | |
ba494bee BM |
400 | * PARAMETERS: handler - Table event handler |
401 | * context - Value passed to the handler on each event | |
3e08e2d2 LM |
402 | * |
403 | * RETURN: Status | |
404 | * | |
b7ed9a8e | 405 | * DESCRIPTION: Install a global table event handler. |
3e08e2d2 LM |
406 | * |
407 | ******************************************************************************/ | |
408 | acpi_status | |
b43e1065 | 409 | acpi_install_table_handler(acpi_table_handler handler, void *context) |
3e08e2d2 LM |
410 | { |
411 | acpi_status status; | |
412 | ||
413 | ACPI_FUNCTION_TRACE(acpi_install_table_handler); | |
414 | ||
415 | if (!handler) { | |
416 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
417 | } | |
418 | ||
419 | status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS); | |
420 | if (ACPI_FAILURE(status)) { | |
421 | return_ACPI_STATUS(status); | |
422 | } | |
423 | ||
424 | /* Don't allow more than one handler */ | |
425 | ||
426 | if (acpi_gbl_table_handler) { | |
427 | status = AE_ALREADY_EXISTS; | |
428 | goto cleanup; | |
429 | } | |
430 | ||
431 | /* Install the handler */ | |
432 | ||
433 | acpi_gbl_table_handler = handler; | |
434 | acpi_gbl_table_handler_context = context; | |
435 | ||
10622bf8 | 436 | cleanup: |
3e08e2d2 LM |
437 | (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS); |
438 | return_ACPI_STATUS(status); | |
439 | } | |
440 | ||
441 | ACPI_EXPORT_SYMBOL(acpi_install_table_handler) | |
442 | ||
443 | /******************************************************************************* | |
444 | * | |
445 | * FUNCTION: acpi_remove_table_handler | |
446 | * | |
ba494bee | 447 | * PARAMETERS: handler - Table event handler that was installed |
3e08e2d2 LM |
448 | * previously. |
449 | * | |
450 | * RETURN: Status | |
451 | * | |
b7ed9a8e | 452 | * DESCRIPTION: Remove a table event handler |
3e08e2d2 LM |
453 | * |
454 | ******************************************************************************/ | |
b43e1065 | 455 | acpi_status acpi_remove_table_handler(acpi_table_handler handler) |
3e08e2d2 LM |
456 | { |
457 | acpi_status status; | |
458 | ||
459 | ACPI_FUNCTION_TRACE(acpi_remove_table_handler); | |
460 | ||
461 | status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS); | |
462 | if (ACPI_FAILURE(status)) { | |
463 | return_ACPI_STATUS(status); | |
464 | } | |
465 | ||
466 | /* Make sure that the installed handler is the same */ | |
467 | ||
468 | if (!handler || handler != acpi_gbl_table_handler) { | |
469 | status = AE_BAD_PARAMETER; | |
470 | goto cleanup; | |
471 | } | |
472 | ||
473 | /* Remove the handler */ | |
474 | ||
475 | acpi_gbl_table_handler = NULL; | |
476 | ||
10622bf8 | 477 | cleanup: |
3e08e2d2 LM |
478 | (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS); |
479 | return_ACPI_STATUS(status); | |
480 | } | |
481 | ||
482 | ACPI_EXPORT_SYMBOL(acpi_remove_table_handler) |