tbxface.c 15.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2
/******************************************************************************
 *
3
 * Module Name: tbxface - ACPI table oriented external interfaces
L
Linus Torvalds 已提交
4 5 6 7
 *
 *****************************************************************************/

/*
8
 * Copyright (C) 2000 - 2012, Intel Corp.
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

44
#include <linux/export.h>
L
Linus Torvalds 已提交
45
#include <acpi/acpi.h>
L
Len Brown 已提交
46 47 48
#include "accommon.h"
#include "acnamesp.h"
#include "actables.h"
L
Linus Torvalds 已提交
49 50

#define _COMPONENT          ACPI_TABLES
L
Len Brown 已提交
51
ACPI_MODULE_NAME("tbxface")
L
Linus Torvalds 已提交
52

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/*******************************************************************************
 *
 * FUNCTION:    acpi_allocate_root_table
 *
 * PARAMETERS:  initial_table_count - Size of initial_table_array, in number of
 *                                    struct acpi_table_desc structures
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Allocate a root table array. Used by i_aSL compiler and
 *              acpi_initialize_tables.
 *
 ******************************************************************************/
acpi_status acpi_allocate_root_table(u32 initial_table_count)
{

69
	acpi_gbl_root_table_list.max_table_count = initial_table_count;
70 71 72 73 74
	acpi_gbl_root_table_list.flags = ACPI_ROOT_ALLOW_RESIZE;

	return (acpi_tb_resize_root_table_list());
}

L
Linus Torvalds 已提交
75 76
/*******************************************************************************
 *
77
 * FUNCTION:    acpi_initialize_tables
L
Linus Torvalds 已提交
78
 *
79 80 81 82 83 84 85 86
 * PARAMETERS:  initial_table_array - Pointer to an array of pre-allocated
 *                                    struct acpi_table_desc structures. If NULL, the
 *                                    array is dynamically allocated.
 *              initial_table_count - Size of initial_table_array, in number of
 *                                    struct acpi_table_desc structures
 *              allow_realloc       - Flag to tell Table Manager if resize of
 *                                    pre-allocated array is allowed. Ignored
 *                                    if initial_table_array is NULL.
L
Linus Torvalds 已提交
87 88 89
 *
 * RETURN:      Status
 *
90 91 92 93 94 95 96 97
 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
 *
 * NOTE:        Allows static allocation of the initial table array in order
 *              to avoid the use of dynamic memory in confined environments
 *              such as the kernel boot sequence where it may not be available.
 *
 *              If the host OS memory managers are initialized, use NULL for
 *              initial_table_array, and the table will be dynamically allocated.
L
Linus Torvalds 已提交
98 99
 *
 ******************************************************************************/
100

101
acpi_status __init
102
acpi_initialize_tables(struct acpi_table_desc * initial_table_array,
103
		       u32 initial_table_count, u8 allow_resize)
L
Linus Torvalds 已提交
104
{
105
	acpi_physical_address rsdp_address;
L
Len Brown 已提交
106
	acpi_status status;
L
Linus Torvalds 已提交
107

108
	ACPI_FUNCTION_TRACE(acpi_initialize_tables);
L
Linus Torvalds 已提交
109

110 111 112 113 114
	/*
	 * Set up the Root Table Array
	 * Allocate the table array if requested
	 */
	if (!initial_table_array) {
115
		status = acpi_allocate_root_table(initial_table_count);
116 117 118 119 120 121
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}
	} else {
		/* Root Table Array has been statically allocated by the host */

B
Bob Moore 已提交
122
		ACPI_MEMSET(initial_table_array, 0,
123
			    (acpi_size) initial_table_count *
B
Bob Moore 已提交
124
			    sizeof(struct acpi_table_desc));
125

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;
129
		if (allow_resize) {
130 131
			acpi_gbl_root_table_list.flags |=
			    ACPI_ROOT_ALLOW_RESIZE;
132
		}
L
Linus Torvalds 已提交
133 134
	}

135
	/* Get the address of the RSDP */
L
Linus Torvalds 已提交
136

137 138
	rsdp_address = acpi_os_get_root_pointer();
	if (!rsdp_address) {
139 140
		return_ACPI_STATUS(AE_NOT_FOUND);
	}
L
Linus Torvalds 已提交
141

142 143 144 145 146
	/*
	 * Get the root table (RSDT or XSDT) and extract all entries to the local
	 * Root Table Array. This array contains the information of the RSDT/XSDT
	 * in a common, more useable format.
	 */
147
	status = acpi_tb_parse_root_table(rsdp_address);
148 149
	return_ACPI_STATUS(status);
}
L
Linus Torvalds 已提交
150

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/*******************************************************************************
 *
 * FUNCTION:    acpi_reallocate_root_table
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
 *              root list from the previously provided scratch area. Should
 *              be called once dynamic memory allocation is available in the
 *              kernel
 *
 ******************************************************************************/
acpi_status acpi_reallocate_root_table(void)
{
	struct acpi_table_desc *tables;
	acpi_size new_size;
169
	acpi_size current_size;
170 171 172 173 174 175 176

	ACPI_FUNCTION_TRACE(acpi_reallocate_root_table);

	/*
	 * Only reallocate the root table if the host provided a static buffer
	 * for the table array in the call to acpi_initialize_tables.
	 */
177
	if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
178
		return_ACPI_STATUS(AE_SUPPORT);
L
Linus Torvalds 已提交
179 180
	}

181 182 183 184 185
	/*
	 * Get the current size of the root table and add the default
	 * increment to create the new table size.
	 */
	current_size = (acpi_size)
186 187
	    acpi_gbl_root_table_list.current_table_count *
	    sizeof(struct acpi_table_desc);
188 189 190

	new_size = current_size +
	    (ACPI_ROOT_TABLE_SIZE_INCREMENT * sizeof(struct acpi_table_desc));
L
Linus Torvalds 已提交
191

192
	/* Create new array and copy the old array */
L
Linus Torvalds 已提交
193

194 195 196
	tables = ACPI_ALLOCATE_ZEROED(new_size);
	if (!tables) {
		return_ACPI_STATUS(AE_NO_MEMORY);
L
Linus Torvalds 已提交
197 198
	}

199
	ACPI_MEMCPY(tables, acpi_gbl_root_table_list.tables, current_size);
L
Linus Torvalds 已提交
200

201 202 203 204 205
	/*
	 * Update the root table descriptor. The new size will be the current
	 * number of tables plus the increment, independent of the reserved
	 * size of the original table list.
	 */
206
	acpi_gbl_root_table_list.tables = tables;
207 208 209
	acpi_gbl_root_table_list.max_table_count =
	    acpi_gbl_root_table_list.current_table_count +
	    ACPI_ROOT_TABLE_SIZE_INCREMENT;
210
	acpi_gbl_root_table_list.flags =
211
	    ACPI_ROOT_ORIGIN_ALLOCATED | ACPI_ROOT_ALLOW_RESIZE;
B
Bob Moore 已提交
212

213 214
	return_ACPI_STATUS(AE_OK);
}
L
Len Brown 已提交
215

216
/*******************************************************************************
217 218 219 220 221
 *
 * FUNCTION:    acpi_get_table_header
 *
 * PARAMETERS:  Signature           - ACPI signature of needed table
 *              Instance            - Which instance (for SSDTs)
222
 *              out_table_header    - The pointer to the table header to fill
223 224 225 226 227 228 229 230
 *
 * RETURN:      Status and pointer to mapped table header
 *
 * DESCRIPTION: Finds an ACPI table header.
 *
 * NOTE:        Caller is responsible in unmapping the header with
 *              acpi_os_unmap_memory
 *
231
 ******************************************************************************/
232 233
acpi_status
acpi_get_table_header(char *signature,
234
		      u32 instance, struct acpi_table_header *out_table_header)
235
{
236 237
       u32 i;
       u32 j;
238
	struct acpi_table_header *header;
239

240 241 242 243 244 245
	/* Parameter validation */

	if (!signature || !out_table_header) {
		return (AE_BAD_PARAMETER);
	}

246 247
	/* Walk the root table list */

248 249
	for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
	     i++) {
250 251 252 253
		if (!ACPI_COMPARE_NAME
		    (&(acpi_gbl_root_table_list.tables[i].signature),
		     signature)) {
			continue;
254 255
		}

256 257 258
		if (++j < instance) {
			continue;
		}
L
Linus Torvalds 已提交
259

260
		if (!acpi_gbl_root_table_list.tables[i].pointer) {
261 262
			if ((acpi_gbl_root_table_list.tables[i].flags &
			     ACPI_TABLE_ORIGIN_MASK) ==
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
			    ACPI_TABLE_ORIGIN_MAPPED) {
				header =
				    acpi_os_map_memory(acpi_gbl_root_table_list.
						       tables[i].address,
						       sizeof(struct
							      acpi_table_header));
				if (!header) {
					return AE_NO_MEMORY;
				}
				ACPI_MEMCPY(out_table_header, header,
					    sizeof(struct acpi_table_header));
				acpi_os_unmap_memory(header,
						     sizeof(struct
							    acpi_table_header));
			} else {
				return AE_NOT_FOUND;
			}
		} else {
			ACPI_MEMCPY(out_table_header,
				    acpi_gbl_root_table_list.tables[i].pointer,
				    sizeof(struct acpi_table_header));
284 285
		}
		return (AE_OK);
L
Linus Torvalds 已提交
286 287
	}

288
	return (AE_NOT_FOUND);
L
Linus Torvalds 已提交
289 290
}

291
ACPI_EXPORT_SYMBOL(acpi_get_table_header)
B
Bob Moore 已提交
292

293
/*******************************************************************************
294 295 296
 *
 * FUNCTION:    acpi_unload_table_id
 *
297
 * PARAMETERS:  id            - Owner ID of the table to be removed.
298 299 300 301 302 303
 *
 * RETURN:      Status
 *
 * DESCRIPTION: This routine is used to force the unload of a table (by id)
 *
 ******************************************************************************/
304
acpi_status acpi_unload_table_id(acpi_owner_id id)
305
{
306 307
	int i;
	acpi_status status = AE_NOT_EXIST;
308

309
	ACPI_FUNCTION_TRACE(acpi_unload_table_id);
310

311
	/* Find table in the global table list */
312
	for (i = 0; i < acpi_gbl_root_table_list.current_table_count; ++i) {
313 314 315 316
		if (id != acpi_gbl_root_table_list.tables[i].owner_id) {
			continue;
		}
		/*
L
Len Brown 已提交
317 318 319 320 321
		 * Delete all namespace objects owned by this table. Note that these
		 * objects can appear anywhere in the namespace by virtue of the AML
		 * "Scope" operator. Thus, we need to track ownership by an ID, not
		 * simply a position within the hierarchy
		 */
322
		acpi_tb_delete_namespace_by_owner(i);
323
		status = acpi_tb_release_owner_id(i);
324
		acpi_tb_set_table_loaded_flag(i, FALSE);
325
		break;
326 327
	}
	return_ACPI_STATUS(status);
328 329 330 331
}

ACPI_EXPORT_SYMBOL(acpi_unload_table_id)

L
Linus Torvalds 已提交
332 333
/*******************************************************************************
 *
334
 * FUNCTION:    acpi_get_table_with_size
L
Linus Torvalds 已提交
335
 *
336 337 338
 * PARAMETERS:  Signature           - ACPI signature of needed table
 *              Instance            - Which instance (for SSDTs)
 *              out_table           - Where the pointer to the table is returned
L
Linus Torvalds 已提交
339
 *
340
 * RETURN:      Status and pointer to table
L
Linus Torvalds 已提交
341
 *
342
 * DESCRIPTION: Finds and verifies an ACPI table.
L
Linus Torvalds 已提交
343
 *
344
 ******************************************************************************/
345
acpi_status
346 347 348
acpi_get_table_with_size(char *signature,
	       u32 instance, struct acpi_table_header **out_table,
	       acpi_size *tbl_size)
L
Linus Torvalds 已提交
349
{
350 351
       u32 i;
       u32 j;
352
	acpi_status status;
L
Linus Torvalds 已提交
353

354 355 356 357 358 359
	/* Parameter validation */

	if (!signature || !out_table) {
		return (AE_BAD_PARAMETER);
	}

360 361
	/* Walk the root table list */

362 363
	for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
	     i++) {
364 365 366 367 368
		if (!ACPI_COMPARE_NAME
		    (&(acpi_gbl_root_table_list.tables[i].signature),
		     signature)) {
			continue;
		}
L
Linus Torvalds 已提交
369

370 371 372
		if (++j < instance) {
			continue;
		}
L
Linus Torvalds 已提交
373

374 375 376 377
		status =
		    acpi_tb_verify_table(&acpi_gbl_root_table_list.tables[i]);
		if (ACPI_SUCCESS(status)) {
			*out_table = acpi_gbl_root_table_list.tables[i].pointer;
378
			*tbl_size = acpi_gbl_root_table_list.tables[i].length;
379
		}
B
Bob Moore 已提交
380

381
		if (!acpi_gbl_permanent_mmap) {
R
Randy Dunlap 已提交
382
			acpi_gbl_root_table_list.tables[i].pointer = NULL;
383 384
		}

385
		return (status);
L
Linus Torvalds 已提交
386 387
	}

388
	return (AE_NOT_FOUND);
L
Linus Torvalds 已提交
389 390
}

391 392 393 394 395 396 397 398 399
acpi_status
acpi_get_table(char *signature,
	       u32 instance, struct acpi_table_header **out_table)
{
	acpi_size tbl_size;

	return acpi_get_table_with_size(signature,
		       instance, out_table, &tbl_size);
}
400
ACPI_EXPORT_SYMBOL(acpi_get_table)
B
Bob Moore 已提交
401

L
Linus Torvalds 已提交
402 403
/*******************************************************************************
 *
404
 * FUNCTION:    acpi_get_table_by_index
L
Linus Torvalds 已提交
405
 *
406 407
 * PARAMETERS:  table_index         - Table index
 *              Table               - Where the pointer to the table is returned
L
Linus Torvalds 已提交
408
 *
409
 * RETURN:      Status and pointer to the table
L
Linus Torvalds 已提交
410
 *
411
 * DESCRIPTION: Obtain a table by an index into the global table list.
L
Linus Torvalds 已提交
412 413 414
 *
 ******************************************************************************/
acpi_status
415
acpi_get_table_by_index(u32 table_index, struct acpi_table_header **table)
L
Linus Torvalds 已提交
416
{
L
Len Brown 已提交
417
	acpi_status status;
L
Linus Torvalds 已提交
418

419
	ACPI_FUNCTION_TRACE(acpi_get_table_by_index);
L
Linus Torvalds 已提交
420

421 422 423 424 425 426
	/* Parameter validation */

	if (!table) {
		return_ACPI_STATUS(AE_BAD_PARAMETER);
	}

427
	(void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
L
Linus Torvalds 已提交
428

429
	/* Validate index */
L
Linus Torvalds 已提交
430

431
	if (table_index >= acpi_gbl_root_table_list.current_table_count) {
432
		(void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
L
Len Brown 已提交
433
		return_ACPI_STATUS(AE_BAD_PARAMETER);
L
Linus Torvalds 已提交
434 435
	}

436
	if (!acpi_gbl_root_table_list.tables[table_index].pointer) {
L
Linus Torvalds 已提交
437

438
		/* Table is not mapped, map it */
L
Linus Torvalds 已提交
439

440 441 442 443 444 445 446
		status =
		    acpi_tb_verify_table(&acpi_gbl_root_table_list.
					 tables[table_index]);
		if (ACPI_FAILURE(status)) {
			(void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
			return_ACPI_STATUS(status);
		}
L
Linus Torvalds 已提交
447 448
	}

449 450 451
	*table = acpi_gbl_root_table_list.tables[table_index].pointer;
	(void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
	return_ACPI_STATUS(AE_OK);
L
Linus Torvalds 已提交
452 453
}

454
ACPI_EXPORT_SYMBOL(acpi_get_table_by_index)
L
Linus Torvalds 已提交
455

456

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
/*******************************************************************************
 *
 * FUNCTION:    acpi_install_table_handler
 *
 * PARAMETERS:  Handler         - Table event handler
 *              Context         - Value passed to the handler on each event
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Install table event handler
 *
 ******************************************************************************/
acpi_status
acpi_install_table_handler(acpi_tbl_handler handler, void *context)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_install_table_handler);

	if (!handler) {
		return_ACPI_STATUS(AE_BAD_PARAMETER);
	}

	status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Don't allow more than one handler */

	if (acpi_gbl_table_handler) {
		status = AE_ALREADY_EXISTS;
		goto cleanup;
	}

	/* Install the handler */

	acpi_gbl_table_handler = handler;
	acpi_gbl_table_handler_context = context;

      cleanup:
	(void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_install_table_handler)

/*******************************************************************************
 *
 * FUNCTION:    acpi_remove_table_handler
 *
 * PARAMETERS:  Handler         - Table event handler that was installed
 *                                previously.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Remove table event handler
 *
 ******************************************************************************/
acpi_status acpi_remove_table_handler(acpi_tbl_handler handler)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_remove_table_handler);

	status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Make sure that the installed handler is the same */

	if (!handler || handler != acpi_gbl_table_handler) {
		status = AE_BAD_PARAMETER;
		goto cleanup;
	}

	/* Remove the handler */

	acpi_gbl_table_handler = NULL;

      cleanup:
	(void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_remove_table_handler)