[deliverable/linux.git] / drivers / acpi / tables / tbxface.c

/******************************************************************************
 *
 * Module Name: tbxface - Public interfaces to the ACPI subsystem
 *                         ACPI table oriented interfaces
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2005, R. Byron Moore
 * 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.
 */

#include <linux/module.h>

#include <acpi/acpi.h>
#include <acpi/acnamesp.h>
#include <acpi/actables.h>


#define _COMPONENT          ACPI_TABLES
	 ACPI_MODULE_NAME    ("tbxface")


/*******************************************************************************
 *
 * FUNCTION:    acpi_load_tables
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: This function is called to load the ACPI tables from the
 *              provided RSDT
 *
 ******************************************************************************/

acpi_status
acpi_load_tables (
	void)
{
	struct acpi_pointer             rsdp_address;
	acpi_status                     status;


	ACPI_FUNCTION_TRACE ("acpi_load_tables");


	/* Get the RSDP */

	status = acpi_os_get_root_pointer (ACPI_LOGICAL_ADDRESSING,
			  &rsdp_address);
	if (ACPI_FAILURE (status)) {
		ACPI_REPORT_ERROR (("acpi_load_tables: Could not get RSDP, %s\n",
			acpi_format_exception (status)));
		goto error_exit;
	}

	/* Map and validate the RSDP */

	acpi_gbl_table_flags = rsdp_address.pointer_type;

	status = acpi_tb_verify_rsdp (&rsdp_address);
	if (ACPI_FAILURE (status)) {
		ACPI_REPORT_ERROR (("acpi_load_tables: RSDP Failed validation: %s\n",
			acpi_format_exception (status)));
		goto error_exit;
	}

	/* Get the RSDT via the RSDP */

	status = acpi_tb_get_table_rsdt ();
	if (ACPI_FAILURE (status)) {
		ACPI_REPORT_ERROR (("acpi_load_tables: Could not load RSDT: %s\n",
			acpi_format_exception (status)));
		goto error_exit;
	}

	/* Now get the tables needed by this subsystem (FADT, DSDT, etc.) */

	status = acpi_tb_get_required_tables ();
	if (ACPI_FAILURE (status)) {
		ACPI_REPORT_ERROR ((
			"acpi_load_tables: Error getting required tables (DSDT/FADT/FACS): %s\n",
			acpi_format_exception (status)));
		goto error_exit;
	}

	ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI Tables successfully acquired\n"));

	/* Load the namespace from the tables */

	status = acpi_ns_load_namespace ();
	if (ACPI_FAILURE (status)) {
		ACPI_REPORT_ERROR (("acpi_load_tables: Could not load namespace: %s\n",
			acpi_format_exception (status)));
		goto error_exit;
	}

	return_ACPI_STATUS (AE_OK);


error_exit:
	ACPI_REPORT_ERROR (("acpi_load_tables: Could not load tables: %s\n",
			  acpi_format_exception (status)));

	return_ACPI_STATUS (status);
}


#ifdef ACPI_FUTURE_USAGE
/*******************************************************************************
 *
 * FUNCTION:    acpi_load_table
 *
 * PARAMETERS:  table_ptr       - pointer to a buffer containing the entire
 *                                table to be loaded
 *
 * RETURN:      Status
 *
 * DESCRIPTION: This function is called to load a table from the caller's
 *              buffer.  The buffer must contain an entire ACPI Table including
 *              a valid header.  The header fields will be verified, and if it
 *              is determined that the table is invalid, the call will fail.
 *
 ******************************************************************************/

acpi_status
acpi_load_table (
	struct acpi_table_header        *table_ptr)
{
	acpi_status                     status;
	struct acpi_table_desc          table_info;
	struct acpi_pointer             address;


	ACPI_FUNCTION_TRACE ("acpi_load_table");


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

	/* Copy the table to a local buffer */

	address.pointer_type    = ACPI_LOGICAL_POINTER | ACPI_LOGICAL_ADDRESSING;
	address.pointer.logical = table_ptr;

	status = acpi_tb_get_table_body (&address, table_ptr, &table_info);
	if (ACPI_FAILURE (status)) {
		return_ACPI_STATUS (status);
	}

	/* Install the new table into the local data structures */

	status = acpi_tb_install_table (&table_info);
	if (ACPI_FAILURE (status)) {
		/* Free table allocated by acpi_tb_get_table_body */

		acpi_tb_delete_single_table (&table_info);
		return_ACPI_STATUS (status);
	}

	/* Convert the table to common format if necessary */

	switch (table_info.type) {
	case ACPI_TABLE_FADT:

		status = acpi_tb_convert_table_fadt ();
		break;

	case ACPI_TABLE_FACS:

		status = acpi_tb_build_common_facs (&table_info);
		break;

	default:
		/* Load table into namespace if it contains executable AML */

		status = acpi_ns_load_table (table_info.installed_desc, acpi_gbl_root_node);
		break;
	}

	if (ACPI_FAILURE (status)) {
		/* Uninstall table and free the buffer */

		(void) acpi_tb_uninstall_table (table_info.installed_desc);
	}

	return_ACPI_STATUS (status);
}


/*******************************************************************************
 *
 * FUNCTION:    acpi_unload_table
 *
 * PARAMETERS:  table_type    - Type of table to be unloaded
 *
 * RETURN:      Status
 *
 * DESCRIPTION: This routine is used to force the unload of a table
 *
 ******************************************************************************/

acpi_status
acpi_unload_table (
	acpi_table_type                 table_type)
{
	struct acpi_table_desc          *table_desc;


	ACPI_FUNCTION_TRACE ("acpi_unload_table");


	/* Parameter validation */

	if (table_type > ACPI_TABLE_MAX) {
		return_ACPI_STATUS (AE_BAD_PARAMETER);
	}

	/* Find all tables of the requested type */

	table_desc = acpi_gbl_table_lists[table_type].next;
	while (table_desc) {
		/*
		 * Delete all namespace entries owned by this table.  Note that these
		 * entries 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
		 */
		acpi_ns_delete_namespace_by_owner (table_desc->owner_id);
		table_desc = table_desc->next;
	}

	/* Delete (or unmap) all tables of this type */

	acpi_tb_delete_tables_by_type (table_type);
	return_ACPI_STATUS (AE_OK);
}


/*******************************************************************************
 *
 * FUNCTION:    acpi_get_table_header
 *
 * PARAMETERS:  table_type      - one of the defined table types
 *              Instance        - the non zero instance of the table, allows
 *                                support for multiple tables of the same type
 *                                see acpi_gbl_acpi_table_flag
 *              out_table_header - pointer to the struct acpi_table_header if successful
 *
 * DESCRIPTION: This function is called to get an ACPI table header.  The caller
 *              supplies an pointer to a data area sufficient to contain an ACPI
 *              struct acpi_table_header structure.
 *
 *              The header contains a length field that can be used to determine
 *              the size of the buffer needed to contain the entire table.  This
 *              function is not valid for the RSD PTR table since it does not
 *              have a standard header and is fixed length.
 *
 ******************************************************************************/

acpi_status
acpi_get_table_header (
	acpi_table_type                 table_type,
	u32                             instance,
	struct acpi_table_header        *out_table_header)
{
	struct acpi_table_header        *tbl_ptr;
	acpi_status                     status;


	ACPI_FUNCTION_TRACE ("acpi_get_table_header");


	if ((instance == 0)                 ||
		(table_type == ACPI_TABLE_RSDP) ||
		(!out_table_header)) {
		return_ACPI_STATUS (AE_BAD_PARAMETER);
	}

	/* Check the table type and instance */

	if ((table_type > ACPI_TABLE_MAX)   ||
		(ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags) &&
		 instance > 1)) {
		return_ACPI_STATUS (AE_BAD_PARAMETER);
	}

	/* Get a pointer to the entire table */

	status = acpi_tb_get_table_ptr (table_type, instance, &tbl_ptr);
	if (ACPI_FAILURE (status)) {
		return_ACPI_STATUS (status);
	}

	/* The function will return a NULL pointer if the table is not loaded */

	if (tbl_ptr == NULL) {
		return_ACPI_STATUS (AE_NOT_EXIST);
	}

	/* Copy the header to the caller's buffer */

	ACPI_MEMCPY ((void *) out_table_header, (void *) tbl_ptr,
		sizeof (struct acpi_table_header));

	return_ACPI_STATUS (status);
}

#endif  /*  ACPI_FUTURE_USAGE  */

/*******************************************************************************
 *
 * FUNCTION:    acpi_get_table
 *
 * PARAMETERS:  table_type      - one of the defined table types
 *              Instance        - the non zero instance of the table, allows
 *                                support for multiple tables of the same type
 *                                see acpi_gbl_acpi_table_flag
 *              ret_buffer      - pointer to a structure containing a buffer to
 *                                receive the table
 *
 * RETURN:      Status
 *
 * DESCRIPTION: This function is called to get an ACPI table.  The caller
 *              supplies an out_buffer large enough to contain the entire ACPI
 *              table.  The caller should call the acpi_get_table_header function
 *              first to determine the buffer size needed.  Upon completion
 *              the out_buffer->Length field will indicate the number of bytes
 *              copied into the out_buffer->buf_ptr buffer. This table will be
 *              a complete table including the header.
 *
 ******************************************************************************/

acpi_status
acpi_get_table (
	acpi_table_type                 table_type,
	u32                             instance,
	struct acpi_buffer              *ret_buffer)
{
	struct acpi_table_header        *tbl_ptr;
	acpi_status                     status;
	acpi_size                       table_length;


	ACPI_FUNCTION_TRACE ("acpi_get_table");


	/* Parameter validation */

	if (instance == 0) {
		return_ACPI_STATUS (AE_BAD_PARAMETER);
	}

	status = acpi_ut_validate_buffer (ret_buffer);
	if (ACPI_FAILURE (status)) {
		return_ACPI_STATUS (status);
	}

	/* Check the table type and instance */

	if ((table_type > ACPI_TABLE_MAX)   ||
		(ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags) &&
		 instance > 1)) {
		return_ACPI_STATUS (AE_BAD_PARAMETER);
	}

	/* Get a pointer to the entire table */

	status = acpi_tb_get_table_ptr (table_type, instance, &tbl_ptr);
	if (ACPI_FAILURE (status)) {
		return_ACPI_STATUS (status);
	}

	/*
	 * acpi_tb_get_table_ptr will return a NULL pointer if the
	 * table is not loaded.
	 */
	if (tbl_ptr == NULL) {
		return_ACPI_STATUS (AE_NOT_EXIST);
	}

	/* Get the table length */

	if (table_type == ACPI_TABLE_RSDP) {
		/* RSD PTR is the only "table" without a header */

		table_length = sizeof (struct rsdp_descriptor);
	}
	else {
		table_length = (acpi_size) tbl_ptr->length;
	}

	/* Validate/Allocate/Clear caller buffer */

	status = acpi_ut_initialize_buffer (ret_buffer, table_length);
	if (ACPI_FAILURE (status)) {
		return_ACPI_STATUS (status);
	}

	/* Copy the table to the buffer */

	ACPI_MEMCPY ((void *) ret_buffer->pointer, (void *) tbl_ptr, table_length);
	return_ACPI_STATUS (AE_OK);
}
EXPORT_SYMBOL(acpi_get_table);
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: tbxface - Public interfaces to the ACPI subsystem
	4	* ACPI table oriented interfaces
	5	*
	6	*****************************************************************************/
	7
	8	/*
	9	* Copyright (C) 2000 - 2005, R. Byron Moore
	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
	45	#include <linux/module.h>
	46
	47	#include <acpi/acpi.h>
	48	#include <acpi/acnamesp.h>
	49	#include <acpi/actables.h>
	50
	51
	52	#define _COMPONENT ACPI_TABLES
	53	ACPI_MODULE_NAME ("tbxface")
	54
	55
	56	/*******************************************************************************
	57	*
	58	* FUNCTION: acpi_load_tables
	59	*
	60	* PARAMETERS: None
	61	*
	62	* RETURN: Status
	63	*
	64	* DESCRIPTION: This function is called to load the ACPI tables from the
65	* provided RSDT
66	*
67	******************************************************************************/
68
69	acpi_status
44f6c012 RM	70	acpi_load_tables (
44f6c012 RM	71	void)
1da177e4 LT	72	{
	73	struct acpi_pointer rsdp_address;
	74	acpi_status status;
	75
	76
	77	ACPI_FUNCTION_TRACE ("acpi_load_tables");
	78
	79
	80	/* Get the RSDP */
	81
	82	status = acpi_os_get_root_pointer (ACPI_LOGICAL_ADDRESSING,
	83	&rsdp_address);
	84	if (ACPI_FAILURE (status)) {
	85	ACPI_REPORT_ERROR (("acpi_load_tables: Could not get RSDP, %s\n",
44f6c012	86	acpi_format_exception (status)));
1da177e4 LT	87	goto error_exit;
	88	}
	89
	90	/* Map and validate the RSDP */
	91
	92	acpi_gbl_table_flags = rsdp_address.pointer_type;
	93
	94	status = acpi_tb_verify_rsdp (&rsdp_address);
	95	if (ACPI_FAILURE (status)) {
	96	ACPI_REPORT_ERROR (("acpi_load_tables: RSDP Failed validation: %s\n",
44f6c012	97	acpi_format_exception (status)));
1da177e4 LT	98	goto error_exit;
	99	}
	100
	101	/* Get the RSDT via the RSDP */
	102
	103	status = acpi_tb_get_table_rsdt ();
	104	if (ACPI_FAILURE (status)) {
	105	ACPI_REPORT_ERROR (("acpi_load_tables: Could not load RSDT: %s\n",
44f6c012	106	acpi_format_exception (status)));
1da177e4 LT	107	goto error_exit;
	108	}
	109
	110	/* Now get the tables needed by this subsystem (FADT, DSDT, etc.) */
	111
	112	status = acpi_tb_get_required_tables ();
	113	if (ACPI_FAILURE (status)) {
44f6c012 RM	114	ACPI_REPORT_ERROR ((
	115	"acpi_load_tables: Error getting required tables (DSDT/FADT/FACS): %s\n",
	116	acpi_format_exception (status)));
1da177e4 LT	117	goto error_exit;
	118	}
	119
	120	ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI Tables successfully acquired\n"));
	121
1da177e4 LT	122	/* Load the namespace from the tables */
	123
	124	status = acpi_ns_load_namespace ();
	125	if (ACPI_FAILURE (status)) {
	126	ACPI_REPORT_ERROR (("acpi_load_tables: Could not load namespace: %s\n",
44f6c012	127	acpi_format_exception (status)));
1da177e4 LT	128	goto error_exit;
	129	}
	130
	131	return_ACPI_STATUS (AE_OK);
	132
	133
	134	error_exit:
	135	ACPI_REPORT_ERROR (("acpi_load_tables: Could not load tables: %s\n",
	136	acpi_format_exception (status)));
	137
	138	return_ACPI_STATUS (status);
	139	}
	140
	141
	142	#ifdef ACPI_FUTURE_USAGE
1da177e4 LT	143	/*******************************************************************************
	144	*
	145	* FUNCTION: acpi_load_table
	146	*
	147	* PARAMETERS: table_ptr - pointer to a buffer containing the entire
	148	* table to be loaded
	149	*
	150	* RETURN: Status
	151	*
	152	* DESCRIPTION: This function is called to load a table from the caller's
	153	* buffer. The buffer must contain an entire ACPI Table including
	154	* a valid header. The header fields will be verified, and if it
	155	* is determined that the table is invalid, the call will fail.
	156	*
	157	******************************************************************************/
	158
	159	acpi_status
	160	acpi_load_table (
	161	struct acpi_table_header *table_ptr)
	162	{
	163	acpi_status status;
	164	struct acpi_table_desc table_info;
	165	struct acpi_pointer address;
	166
	167
	168	ACPI_FUNCTION_TRACE ("acpi_load_table");
	169
	170
	171	if (!table_ptr) {
	172	return_ACPI_STATUS (AE_BAD_PARAMETER);
	173	}
	174
	175	/* Copy the table to a local buffer */
	176
	177	address.pointer_type = ACPI_LOGICAL_POINTER \| ACPI_LOGICAL_ADDRESSING;
	178	address.pointer.logical = table_ptr;
	179
	180	status = acpi_tb_get_table_body (&address, table_ptr, &table_info);
	181	if (ACPI_FAILURE (status)) {
	182	return_ACPI_STATUS (status);
	183	}
	184
	185	/* Install the new table into the local data structures */
	186
	187	status = acpi_tb_install_table (&table_info);
	188	if (ACPI_FAILURE (status)) {
	189	/* Free table allocated by acpi_tb_get_table_body */
	190
	191	acpi_tb_delete_single_table (&table_info);
	192	return_ACPI_STATUS (status);
	193	}
	194
	195	/* Convert the table to common format if necessary */
	196
	197	switch (table_info.type) {
	198	case ACPI_TABLE_FADT:
	199
	200	status = acpi_tb_convert_table_fadt ();
	201	break;
	202
	203	case ACPI_TABLE_FACS:
	204
	205	status = acpi_tb_build_common_facs (&table_info);
	206	break;
207
208	default:
209	/* Load table into namespace if it contains executable AML */
210
211	status = acpi_ns_load_table (table_info.installed_desc, acpi_gbl_root_node);
212	break;
213	}
214
215	if (ACPI_FAILURE (status)) {
216	/* Uninstall table and free the buffer */
217
218	(void) acpi_tb_uninstall_table (table_info.installed_desc);
219	}
220
221	return_ACPI_STATUS (status);
222	}
223
224
225	/*******************************************************************************
226	*
227	* FUNCTION: acpi_unload_table
228	*
229	* PARAMETERS: table_type - Type of table to be unloaded
230	*
231	* RETURN: Status
232	*
233	* DESCRIPTION: This routine is used to force the unload of a table
234	*
235	******************************************************************************/
236
237	acpi_status
238	acpi_unload_table (
239	acpi_table_type table_type)
240	{
241	struct acpi_table_desc *table_desc;
242
243
244	ACPI_FUNCTION_TRACE ("acpi_unload_table");
245
246
247	/* Parameter validation */
248
249	if (table_type > ACPI_TABLE_MAX) {
250	return_ACPI_STATUS (AE_BAD_PARAMETER);
251	}
252
1da177e4 LT	253	/* Find all tables of the requested type */
	254
	255	table_desc = acpi_gbl_table_lists[table_type].next;
	256	while (table_desc) {
	257	/*
	258	* Delete all namespace entries owned by this table. Note that these
	259	* entries can appear anywhere in the namespace by virtue of the AML
	260	* "Scope" operator. Thus, we need to track ownership by an ID, not
	261	* simply a position within the hierarchy
	262	*/
f9f4601f	263	acpi_ns_delete_namespace_by_owner (table_desc->owner_id);
1da177e4 LT	264	table_desc = table_desc->next;
	265	}
	266
	267	/* Delete (or unmap) all tables of this type */
	268
	269	acpi_tb_delete_tables_by_type (table_type);
	270	return_ACPI_STATUS (AE_OK);
	271	}
	272
	273
	274	/*******************************************************************************
	275	*
	276	* FUNCTION: acpi_get_table_header
	277	*
	278	* PARAMETERS: table_type - one of the defined table types
	279	* Instance - the non zero instance of the table, allows
	280	* support for multiple tables of the same type
	281	* see acpi_gbl_acpi_table_flag
	282	* out_table_header - pointer to the struct acpi_table_header if successful
	283	*
	284	* DESCRIPTION: This function is called to get an ACPI table header. The caller
	285	* supplies an pointer to a data area sufficient to contain an ACPI
	286	* struct acpi_table_header structure.
	287	*
	288	* The header contains a length field that can be used to determine
	289	* the size of the buffer needed to contain the entire table. This
	290	* function is not valid for the RSD PTR table since it does not
	291	* have a standard header and is fixed length.
	292	*
	293	******************************************************************************/
	294
	295	acpi_status
	296	acpi_get_table_header (
	297	acpi_table_type table_type,
	298	u32 instance,
	299	struct acpi_table_header *out_table_header)
	300	{
	301	struct acpi_table_header *tbl_ptr;
	302	acpi_status status;
	303
	304
	305	ACPI_FUNCTION_TRACE ("acpi_get_table_header");
	306
	307
	308	if ((instance == 0) \|\|
	309	(table_type == ACPI_TABLE_RSDP) \|\|
	310	(!out_table_header)) {
	311	return_ACPI_STATUS (AE_BAD_PARAMETER);
	312	}
	313
	314	/* Check the table type and instance */
	315
	316	if ((table_type > ACPI_TABLE_MAX) \|\|
	317	(ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags) &&
	318	instance > 1)) {
	319	return_ACPI_STATUS (AE_BAD_PARAMETER);
	320	}
	321
1da177e4 LT	322	/* Get a pointer to the entire table */
	323
	324	status = acpi_tb_get_table_ptr (table_type, instance, &tbl_ptr);
	325	if (ACPI_FAILURE (status)) {
	326	return_ACPI_STATUS (status);
	327	}
	328
44f6c012 RM	329	/* The function will return a NULL pointer if the table is not loaded */
44f6c012 RM	330
1da177e4 LT	331	if (tbl_ptr == NULL) {
	332	return_ACPI_STATUS (AE_NOT_EXIST);
	333	}
	334
44f6c012 RM	335	/* Copy the header to the caller's buffer */
44f6c012 RM	336
1da177e4	337	ACPI_MEMCPY ((void ) out_table_header, (void ) tbl_ptr,
44f6c012	338	sizeof (struct acpi_table_header));
1da177e4 LT	339
	340	return_ACPI_STATUS (status);
	341	}
	342
1da177e4 LT	343	#endif /* ACPI_FUTURE_USAGE */
	344
	345	/*******************************************************************************
	346	*
	347	* FUNCTION: acpi_get_table
	348	*
	349	* PARAMETERS: table_type - one of the defined table types
	350	* Instance - the non zero instance of the table, allows
	351	* support for multiple tables of the same type
	352	* see acpi_gbl_acpi_table_flag
	353	* ret_buffer - pointer to a structure containing a buffer to
	354	* receive the table
	355	*
	356	* RETURN: Status
	357	*
	358	* DESCRIPTION: This function is called to get an ACPI table. The caller
	359	* supplies an out_buffer large enough to contain the entire ACPI
	360	* table. The caller should call the acpi_get_table_header function
	361	* first to determine the buffer size needed. Upon completion
	362	* the out_buffer->Length field will indicate the number of bytes
	363	* copied into the out_buffer->buf_ptr buffer. This table will be
	364	* a complete table including the header.
	365	*
	366	******************************************************************************/
	367
	368	acpi_status
	369	acpi_get_table (
	370	acpi_table_type table_type,
	371	u32 instance,
	372	struct acpi_buffer *ret_buffer)
	373	{
	374	struct acpi_table_header *tbl_ptr;
	375	acpi_status status;
	376	acpi_size table_length;
	377
	378
	379	ACPI_FUNCTION_TRACE ("acpi_get_table");
	380
	381
	382	/* Parameter validation */
	383
	384	if (instance == 0) {
	385	return_ACPI_STATUS (AE_BAD_PARAMETER);
	386	}
	387
	388	status = acpi_ut_validate_buffer (ret_buffer);
	389	if (ACPI_FAILURE (status)) {
	390	return_ACPI_STATUS (status);
	391	}
	392
	393	/* Check the table type and instance */
	394
	395	if ((table_type > ACPI_TABLE_MAX) \|\|
	396	(ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags) &&
	397	instance > 1)) {
	398	return_ACPI_STATUS (AE_BAD_PARAMETER);
	399	}
	400
1da177e4 LT	401	/* Get a pointer to the entire table */
	402
	403	status = acpi_tb_get_table_ptr (table_type, instance, &tbl_ptr);
	404	if (ACPI_FAILURE (status)) {
	405	return_ACPI_STATUS (status);
	406	}
	407
	408	/*
	409	* acpi_tb_get_table_ptr will return a NULL pointer if the
	410	* table is not loaded.
	411	*/
	412	if (tbl_ptr == NULL) {
	413	return_ACPI_STATUS (AE_NOT_EXIST);
	414	}
	415
	416	/* Get the table length */
	417
	418	if (table_type == ACPI_TABLE_RSDP) {
44f6c012 RM	419	/* RSD PTR is the only "table" without a header */
44f6c012 RM	420
1da177e4 LT	421	table_length = sizeof (struct rsdp_descriptor);
	422	}
	423	else {
	424	table_length = (acpi_size) tbl_ptr->length;
	425	}
	426
	427	/* Validate/Allocate/Clear caller buffer */
	428
	429	status = acpi_ut_initialize_buffer (ret_buffer, table_length);
	430	if (ACPI_FAILURE (status)) {
	431	return_ACPI_STATUS (status);
	432	}
	433
	434	/* Copy the table to the buffer */
	435
	436	ACPI_MEMCPY ((void ) ret_buffer->pointer, (void ) tbl_ptr, table_length);
	437	return_ACPI_STATUS (AE_OK);
	438	}
	439	EXPORT_SYMBOL(acpi_get_table);
	440