tbxface.c 14.0 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 - 2015, 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 45
#define EXPORT_ACPI_INTERFACES

L
Linus Torvalds 已提交
46
#include <acpi/acpi.h>
L
Len Brown 已提交
47 48
#include "accommon.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
/*******************************************************************************
 *
 * FUNCTION:    acpi_allocate_root_table
 *
 * PARAMETERS:  initial_table_count - Size of initial_table_array, in number of
 *                                    struct acpi_table_desc structures
 *
 * RETURN:      Status
 *
62
 * DESCRIPTION: Allocate a root table array. Used by iASL compiler and
63 64 65 66 67 68
 *              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
 * 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
84
 *              allow_resize        - Flag to tell Table Manager if resize of
85 86
 *                                    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
	 * Setup the Root Table Array and allocate the table array
	 * if requested
113 114
	 */
	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
ACPI_EXPORT_SYMBOL_INIT(acpi_initialize_tables)

153 154 155 156 157 158 159 160 161 162 163
/*******************************************************************************
 *
 * 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
164
 *              kernel.
165 166
 *
 ******************************************************************************/
167
acpi_status __init acpi_reallocate_root_table(void)
168
{
169
	acpi_status status;
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
	acpi_gbl_root_table_list.flags |= ACPI_ROOT_ALLOW_RESIZE;
L
Linus Torvalds 已提交
182

183 184
	status = acpi_tb_resize_root_table_list();
	return_ACPI_STATUS(status);
185
}
L
Len Brown 已提交
186

187 188
ACPI_EXPORT_SYMBOL_INIT(acpi_reallocate_root_table)

189
/*******************************************************************************
190 191 192
 *
 * FUNCTION:    acpi_get_table_header
 *
193 194
 * PARAMETERS:  signature           - ACPI signature of needed table
 *              instance            - Which instance (for SSDTs)
195
 *              out_table_header    - The pointer to the table header to fill
196 197 198 199 200 201 202 203
 *
 * 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
 *
204
 ******************************************************************************/
205 206
acpi_status
acpi_get_table_header(char *signature,
207
		      u32 instance, struct acpi_table_header *out_table_header)
208
{
209 210
	u32 i;
	u32 j;
211
	struct acpi_table_header *header;
212

213 214 215 216 217 218
	/* Parameter validation */

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

219 220
	/* Walk the root table list */

221 222
	for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
	     i++) {
223 224 225 226
		if (!ACPI_COMPARE_NAME
		    (&(acpi_gbl_root_table_list.tables[i].signature),
		     signature)) {
			continue;
227 228
		}

229 230 231
		if (++j < instance) {
			continue;
		}
L
Linus Torvalds 已提交
232

233
		if (!acpi_gbl_root_table_list.tables[i].pointer) {
234 235
			if ((acpi_gbl_root_table_list.tables[i].flags &
			     ACPI_TABLE_ORIGIN_MASK) ==
236
			    ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL) {
237 238 239 240 241 242
				header =
				    acpi_os_map_memory(acpi_gbl_root_table_list.
						       tables[i].address,
						       sizeof(struct
							      acpi_table_header));
				if (!header) {
243
					return (AE_NO_MEMORY);
244 245 246 247 248 249 250
				}
				ACPI_MEMCPY(out_table_header, header,
					    sizeof(struct acpi_table_header));
				acpi_os_unmap_memory(header,
						     sizeof(struct
							    acpi_table_header));
			} else {
251
				return (AE_NOT_FOUND);
252 253 254 255 256
			}
		} else {
			ACPI_MEMCPY(out_table_header,
				    acpi_gbl_root_table_list.tables[i].pointer,
				    sizeof(struct acpi_table_header));
257 258
		}
		return (AE_OK);
L
Linus Torvalds 已提交
259 260
	}

261
	return (AE_NOT_FOUND);
L
Linus Torvalds 已提交
262 263
}

264
ACPI_EXPORT_SYMBOL(acpi_get_table_header)
B
Bob Moore 已提交
265

L
Linus Torvalds 已提交
266 267
/*******************************************************************************
 *
268
 * FUNCTION:    acpi_get_table_with_size
L
Linus Torvalds 已提交
269
 *
270 271
 * PARAMETERS:  signature           - ACPI signature of needed table
 *              instance            - Which instance (for SSDTs)
272
 *              out_table           - Where the pointer to the table is returned
L
Linus Torvalds 已提交
273
 *
274
 * RETURN:      Status and pointer to the requested table
L
Linus Torvalds 已提交
275
 *
276 277
 * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the
 *              RSDT/XSDT.
L
Linus Torvalds 已提交
278
 *
279
 ******************************************************************************/
280
acpi_status
281 282 283
acpi_get_table_with_size(char *signature,
	       u32 instance, struct acpi_table_header **out_table,
	       acpi_size *tbl_size)
L
Linus Torvalds 已提交
284
{
285 286
	u32 i;
	u32 j;
287
	acpi_status status;
L
Linus Torvalds 已提交
288

289 290 291 292 293 294
	/* Parameter validation */

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

295 296
	/* Walk the root table list */

297 298
	for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
	     i++) {
299 300 301 302 303
		if (!ACPI_COMPARE_NAME
		    (&(acpi_gbl_root_table_list.tables[i].signature),
		     signature)) {
			continue;
		}
L
Linus Torvalds 已提交
304

305 306 307
		if (++j < instance) {
			continue;
		}
L
Linus Torvalds 已提交
308

309
		status =
310
		    acpi_tb_validate_table(&acpi_gbl_root_table_list.tables[i]);
311 312
		if (ACPI_SUCCESS(status)) {
			*out_table = acpi_gbl_root_table_list.tables[i].pointer;
313
			*tbl_size = acpi_gbl_root_table_list.tables[i].length;
314
		}
B
Bob Moore 已提交
315

316
		if (!acpi_gbl_permanent_mmap) {
R
Randy Dunlap 已提交
317
			acpi_gbl_root_table_list.tables[i].pointer = NULL;
318 319
		}

320
		return (status);
L
Linus Torvalds 已提交
321 322
	}

323
	return (AE_NOT_FOUND);
L
Linus Torvalds 已提交
324
}
325

326
ACPI_EXPORT_SYMBOL(acpi_get_table_with_size)
L
Linus Torvalds 已提交
327

328 329 330 331 332 333 334 335 336
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);
}
337

338
ACPI_EXPORT_SYMBOL(acpi_get_table)
B
Bob Moore 已提交
339

L
Linus Torvalds 已提交
340 341
/*******************************************************************************
 *
342
 * FUNCTION:    acpi_get_table_by_index
L
Linus Torvalds 已提交
343
 *
344
 * PARAMETERS:  table_index         - Table index
345
 *              table               - Where the pointer to the table is returned
L
Linus Torvalds 已提交
346
 *
347
 * RETURN:      Status and pointer to the requested table
L
Linus Torvalds 已提交
348
 *
349 350
 * DESCRIPTION: Obtain a table by an index into the global table list. Used
 *              internally also.
L
Linus Torvalds 已提交
351 352 353
 *
 ******************************************************************************/
acpi_status
354
acpi_get_table_by_index(u32 table_index, struct acpi_table_header ** table)
L
Linus Torvalds 已提交
355
{
L
Len Brown 已提交
356
	acpi_status status;
L
Linus Torvalds 已提交
357

358
	ACPI_FUNCTION_TRACE(acpi_get_table_by_index);
L
Linus Torvalds 已提交
359

360 361 362 363 364 365
	/* Parameter validation */

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

366
	(void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
L
Linus Torvalds 已提交
367

368
	/* Validate index */
L
Linus Torvalds 已提交
369

370
	if (table_index >= acpi_gbl_root_table_list.current_table_count) {
371
		(void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
L
Len Brown 已提交
372
		return_ACPI_STATUS(AE_BAD_PARAMETER);
L
Linus Torvalds 已提交
373 374
	}

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

377
		/* Table is not mapped, map it */
L
Linus Torvalds 已提交
378

379
		status =
380 381
		    acpi_tb_validate_table(&acpi_gbl_root_table_list.
					   tables[table_index]);
382 383 384 385
		if (ACPI_FAILURE(status)) {
			(void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
			return_ACPI_STATUS(status);
		}
L
Linus Torvalds 已提交
386 387
	}

388 389 390
	*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 已提交
391 392
}

393
ACPI_EXPORT_SYMBOL(acpi_get_table_by_index)
L
Linus Torvalds 已提交
394

395 396 397 398
/*******************************************************************************
 *
 * FUNCTION:    acpi_install_table_handler
 *
399 400
 * PARAMETERS:  handler         - Table event handler
 *              context         - Value passed to the handler on each event
401 402 403
 *
 * RETURN:      Status
 *
404
 * DESCRIPTION: Install a global table event handler.
405 406 407
 *
 ******************************************************************************/
acpi_status
408
acpi_install_table_handler(acpi_table_handler handler, void *context)
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
{
	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;

435
cleanup:
436 437 438 439 440 441 442 443 444 445
	(void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_install_table_handler)

/*******************************************************************************
 *
 * FUNCTION:    acpi_remove_table_handler
 *
446
 * PARAMETERS:  handler         - Table event handler that was installed
447 448 449 450
 *                                previously.
 *
 * RETURN:      Status
 *
451
 * DESCRIPTION: Remove a table event handler
452 453
 *
 ******************************************************************************/
454
acpi_status acpi_remove_table_handler(acpi_table_handler handler)
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
{
	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;

476
cleanup:
477 478 479 480 481
	(void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_remove_table_handler)