1/******************************************************************************
2 *
3 * Module Name: tbinstal - ACPI table installation and removal
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, Intel Corp.
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
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "actables.h"
47
48#define _COMPONENT          ACPI_TABLES
49ACPI_MODULE_NAME("tbinstal")
50
51/* Local prototypes */
52static u8
53acpi_tb_compare_tables(struct acpi_table_desc *table_desc, u32 table_index);
54
55/*******************************************************************************
56 *
57 * FUNCTION:    acpi_tb_compare_tables
58 *
59 * PARAMETERS:  table_desc          - Table 1 descriptor to be compared
60 *              table_index         - Index of table 2 to be compared
61 *
62 * RETURN:      TRUE if both tables are identical.
63 *
64 * DESCRIPTION: This function compares a table with another table that has
65 *              already been installed in the root table list.
66 *
67 ******************************************************************************/
68
69static u8
70acpi_tb_compare_tables(struct acpi_table_desc *table_desc, u32 table_index)
71{
72	acpi_status status = AE_OK;
73	u8 is_identical;
74	struct acpi_table_header *table;
75	u32 table_length;
76	u8 table_flags;
77
78	status =
79	    acpi_tb_acquire_table(&acpi_gbl_root_table_list.tables[table_index],
80				  &table, &table_length, &table_flags);
81	if (ACPI_FAILURE(status)) {
82		return (FALSE);
83	}
84
85	/*
86	 * Check for a table match on the entire table length,
87	 * not just the header.
88	 */
89	is_identical = (u8)((table_desc->length != table_length ||
90			     ACPI_MEMCMP(table_desc->pointer, table,
91					 table_length)) ? FALSE : TRUE);
92
93	/* Release the acquired table */
94
95	acpi_tb_release_table(table, table_length, table_flags);
96	return (is_identical);
97}
98
99/*******************************************************************************
100 *
101 * FUNCTION:    acpi_tb_install_table_with_override
102 *
103 * PARAMETERS:  table_index             - Index into root table array
104 *              new_table_desc          - New table descriptor to install
105 *              override                - Whether override should be performed
106 *
107 * RETURN:      None
108 *
109 * DESCRIPTION: Install an ACPI table into the global data structure. The
110 *              table override mechanism is called to allow the host
111 *              OS to replace any table before it is installed in the root
112 *              table array.
113 *
114 ******************************************************************************/
115
116void
117acpi_tb_install_table_with_override(u32 table_index,
118				    struct acpi_table_desc *new_table_desc,
119				    u8 override)
120{
121
122	if (table_index >= acpi_gbl_root_table_list.current_table_count) {
123		return;
124	}
125
126	/*
127	 * ACPI Table Override:
128	 *
129	 * Before we install the table, let the host OS override it with a new
130	 * one if desired. Any table within the RSDT/XSDT can be replaced,
131	 * including the DSDT which is pointed to by the FADT.
132	 */
133	if (override) {
134		acpi_tb_override_table(new_table_desc);
135	}
136
137	acpi_tb_init_table_descriptor(&acpi_gbl_root_table_list.
138				      tables[table_index],
139				      new_table_desc->address,
140				      new_table_desc->flags,
141				      new_table_desc->pointer);
142
143	acpi_tb_print_table_header(new_table_desc->address,
144				   new_table_desc->pointer);
145
146	/* Set the global integer width (based upon revision of the DSDT) */
147
148	if (table_index == ACPI_TABLE_INDEX_DSDT) {
149		acpi_ut_set_integer_width(new_table_desc->pointer->revision);
150	}
151}
152
153/*******************************************************************************
154 *
155 * FUNCTION:    acpi_tb_install_fixed_table
156 *
157 * PARAMETERS:  address                 - Physical address of DSDT or FACS
158 *              signature               - Table signature, NULL if no need to
159 *                                        match
160 *              table_index             - Index into root table array
161 *
162 * RETURN:      Status
163 *
164 * DESCRIPTION: Install a fixed ACPI table (DSDT/FACS) into the global data
165 *              structure.
166 *
167 ******************************************************************************/
168
169acpi_status
170acpi_tb_install_fixed_table(acpi_physical_address address,
171			    char *signature, u32 table_index)
172{
173	struct acpi_table_desc new_table_desc;
174	acpi_status status;
175
176	ACPI_FUNCTION_TRACE(tb_install_fixed_table);
177
178	if (!address) {
179		ACPI_ERROR((AE_INFO,
180			    "Null physical address for ACPI table [%s]",
181			    signature));
182		return (AE_NO_MEMORY);
183	}
184
185	/* Fill a table descriptor for validation */
186
187	status = acpi_tb_acquire_temp_table(&new_table_desc, address,
188					    ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL);
189	if (ACPI_FAILURE(status)) {
190		ACPI_ERROR((AE_INFO,
191			    "Could not acquire table length at %8.8X%8.8X",
192			    ACPI_FORMAT_UINT64(address)));
193		return_ACPI_STATUS(status);
194	}
195
196	/* Validate and verify a table before installation */
197
198	status = acpi_tb_verify_temp_table(&new_table_desc, signature);
199	if (ACPI_FAILURE(status)) {
200		goto release_and_exit;
201	}
202
203	acpi_tb_install_table_with_override(table_index, &new_table_desc, TRUE);
204
205release_and_exit:
206
207	/* Release the temporary table descriptor */
208
209	acpi_tb_release_temp_table(&new_table_desc);
210	return_ACPI_STATUS(status);
211}
212
213/*******************************************************************************
214 *
215 * FUNCTION:    acpi_tb_install_standard_table
216 *
217 * PARAMETERS:  address             - Address of the table (might be a virtual
218 *                                    address depending on the table_flags)
219 *              flags               - Flags for the table
220 *              reload              - Whether reload should be performed
221 *              override            - Whether override should be performed
222 *              table_index         - Where the table index is returned
223 *
224 * RETURN:      Status
225 *
226 * DESCRIPTION: This function is called to install an ACPI table that is
227 *              neither DSDT nor FACS (a "standard" table.)
228 *              When this function is called by "Load" or "LoadTable" opcodes,
229 *              or by acpi_load_table() API, the "Reload" parameter is set.
230 *              After sucessfully returning from this function, table is
231 *              "INSTALLED" but not "VALIDATED".
232 *
233 ******************************************************************************/
234
235acpi_status
236acpi_tb_install_standard_table(acpi_physical_address address,
237			       u8 flags,
238			       u8 reload, u8 override, u32 *table_index)
239{
240	u32 i;
241	acpi_status status = AE_OK;
242	struct acpi_table_desc new_table_desc;
243
244	ACPI_FUNCTION_TRACE(tb_install_standard_table);
245
246	/* Acquire a temporary table descriptor for validation */
247
248	status = acpi_tb_acquire_temp_table(&new_table_desc, address, flags);
249	if (ACPI_FAILURE(status)) {
250		ACPI_ERROR((AE_INFO,
251			    "Could not acquire table length at %8.8X%8.8X",
252			    ACPI_FORMAT_UINT64(address)));
253		return_ACPI_STATUS(status);
254	}
255
256	/*
257	 * Optionally do not load any SSDTs from the RSDT/XSDT. This can
258	 * be useful for debugging ACPI problems on some machines.
259	 */
260	if (!reload &&
261	    acpi_gbl_disable_ssdt_table_install &&
262	    ACPI_COMPARE_NAME(&new_table_desc.signature, ACPI_SIG_SSDT)) {
263		ACPI_INFO((AE_INFO,
264			   "Ignoring installation of %4.4s at %8.8X%8.8X",
265			   new_table_desc.signature.ascii,
266			   ACPI_FORMAT_UINT64(address)));
267		goto release_and_exit;
268	}
269
270	/* Validate and verify a table before installation */
271
272	status = acpi_tb_verify_temp_table(&new_table_desc, NULL);
273	if (ACPI_FAILURE(status)) {
274		goto release_and_exit;
275	}
276
277	if (reload) {
278		/*
279		 * Validate the incoming table signature.
280		 *
281		 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
282		 * 2) We added support for OEMx tables, signature "OEM".
283		 * 3) Valid tables were encountered with a null signature, so we just
284		 *    gave up on validating the signature, (05/2008).
285		 * 4) We encountered non-AML tables such as the MADT, which caused
286		 *    interpreter errors and kernel faults. So now, we once again allow
287		 *    only "SSDT", "OEMx", and now, also a null signature. (05/2011).
288		 */
289		if ((new_table_desc.signature.ascii[0] != 0x00) &&
290		    (!ACPI_COMPARE_NAME
291		     (&new_table_desc.signature, ACPI_SIG_SSDT))
292		    && (ACPI_STRNCMP(new_table_desc.signature.ascii, "OEM", 3)))
293		{
294			ACPI_BIOS_ERROR((AE_INFO,
295					 "Table has invalid signature [%4.4s] (0x%8.8X), "
296					 "must be SSDT or OEMx",
297					 acpi_ut_valid_acpi_name(new_table_desc.
298								 signature.
299								 ascii) ?
300					 new_table_desc.signature.
301					 ascii : "????",
302					 new_table_desc.signature.integer));
303
304			status = AE_BAD_SIGNATURE;
305			goto release_and_exit;
306		}
307
308		/* Check if table is already registered */
309
310		for (i = 0; i < acpi_gbl_root_table_list.current_table_count;
311		     ++i) {
312			/*
313			 * Check for a table match on the entire table length,
314			 * not just the header.
315			 */
316			if (!acpi_tb_compare_tables(&new_table_desc, i)) {
317				continue;
318			}
319
320			/*
321			 * Note: the current mechanism does not unregister a table if it is
322			 * dynamically unloaded. The related namespace entries are deleted,
323			 * but the table remains in the root table list.
324			 *
325			 * The assumption here is that the number of different tables that
326			 * will be loaded is actually small, and there is minimal overhead
327			 * in just keeping the table in case it is needed again.
328			 *
329			 * If this assumption changes in the future (perhaps on large
330			 * machines with many table load/unload operations), tables will
331			 * need to be unregistered when they are unloaded, and slots in the
332			 * root table list should be reused when empty.
333			 */
334			if (acpi_gbl_root_table_list.tables[i].
335			    flags & ACPI_TABLE_IS_LOADED) {
336
337				/* Table is still loaded, this is an error */
338
339				status = AE_ALREADY_EXISTS;
340				goto release_and_exit;
341			} else {
342				/*
343				 * Table was unloaded, allow it to be reloaded.
344				 * As we are going to return AE_OK to the caller, we should
345				 * take the responsibility of freeing the input descriptor.
346				 * Refill the input descriptor to ensure
347				 * acpi_tb_install_table_with_override() can be called again to
348				 * indicate the re-installation.
349				 */
350				acpi_tb_uninstall_table(&new_table_desc);
351				*table_index = i;
352				return_ACPI_STATUS(AE_OK);
353			}
354		}
355	}
356
357	/* Add the table to the global root table list */
358
359	status = acpi_tb_get_next_table_descriptor(&i, NULL);
360	if (ACPI_FAILURE(status)) {
361		goto release_and_exit;
362	}
363
364	*table_index = i;
365	acpi_tb_install_table_with_override(i, &new_table_desc, override);
366
367release_and_exit:
368
369	/* Release the temporary table descriptor */
370
371	acpi_tb_release_temp_table(&new_table_desc);
372	return_ACPI_STATUS(status);
373}
374
375/*******************************************************************************
376 *
377 * FUNCTION:    acpi_tb_override_table
378 *
379 * PARAMETERS:  old_table_desc      - Validated table descriptor to be
380 *                                    overridden
381 *
382 * RETURN:      None
383 *
384 * DESCRIPTION: Attempt table override by calling the OSL override functions.
385 *              Note: If the table is overridden, then the entire new table
386 *              is acquired and returned by this function.
387 *              Before/after invocation, the table descriptor is in a state
388 *              that is "VALIDATED".
389 *
390 ******************************************************************************/
391
392void acpi_tb_override_table(struct acpi_table_desc *old_table_desc)
393{
394	acpi_status status;
395	char *override_type;
396	struct acpi_table_desc new_table_desc;
397	struct acpi_table_header *table;
398	acpi_physical_address address;
399	u32 length;
400
401	/* (1) Attempt logical override (returns a logical address) */
402
403	status = acpi_os_table_override(old_table_desc->pointer, &table);
404	if (ACPI_SUCCESS(status) && table) {
405		acpi_tb_acquire_temp_table(&new_table_desc,
406					   ACPI_PTR_TO_PHYSADDR(table),
407					   ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL);
408		override_type = "Logical";
409		goto finish_override;
410	}
411
412	/* (2) Attempt physical override (returns a physical address) */
413
414	status = acpi_os_physical_table_override(old_table_desc->pointer,
415						 &address, &length);
416	if (ACPI_SUCCESS(status) && address && length) {
417		acpi_tb_acquire_temp_table(&new_table_desc, address,
418					   ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL);
419		override_type = "Physical";
420		goto finish_override;
421	}
422
423	return;			/* There was no override */
424
425finish_override:
426
427	/* Validate and verify a table before overriding */
428
429	status = acpi_tb_verify_temp_table(&new_table_desc, NULL);
430	if (ACPI_FAILURE(status)) {
431		return;
432	}
433
434	ACPI_INFO((AE_INFO, "%4.4s 0x%8.8X%8.8X"
435		   " %s table override, new table: 0x%8.8X%8.8X",
436		   old_table_desc->signature.ascii,
437		   ACPI_FORMAT_UINT64(old_table_desc->address),
438		   override_type, ACPI_FORMAT_UINT64(new_table_desc.address)));
439
440	/* We can now uninstall the original table */
441
442	acpi_tb_uninstall_table(old_table_desc);
443
444	/*
445	 * Replace the original table descriptor and keep its state as
446	 * "VALIDATED".
447	 */
448	acpi_tb_init_table_descriptor(old_table_desc, new_table_desc.address,
449				      new_table_desc.flags,
450				      new_table_desc.pointer);
451	acpi_tb_validate_temp_table(old_table_desc);
452
453	/* Release the temporary table descriptor */
454
455	acpi_tb_release_temp_table(&new_table_desc);
456}
457
458/*******************************************************************************
459 *
460 * FUNCTION:    acpi_tb_uninstall_table
461 *
462 * PARAMETERS:  table_desc          - Table descriptor
463 *
464 * RETURN:      None
465 *
466 * DESCRIPTION: Delete one internal ACPI table
467 *
468 ******************************************************************************/
469
470void acpi_tb_uninstall_table(struct acpi_table_desc *table_desc)
471{
472
473	ACPI_FUNCTION_TRACE(tb_uninstall_table);
474
475	/* Table must be installed */
476
477	if (!table_desc->address) {
478		return_VOID;
479	}
480
481	acpi_tb_invalidate_table(table_desc);
482
483	if ((table_desc->flags & ACPI_TABLE_ORIGIN_MASK) ==
484	    ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL) {
485		ACPI_FREE(ACPI_PHYSADDR_TO_PTR(table_desc->address));
486	}
487
488	table_desc->address = ACPI_PTR_TO_PHYSADDR(NULL);
489	return_VOID;
490}
491