[deliverable/linux.git] / drivers / acpi / acpica / utxface.c

/******************************************************************************
 *
 * Module Name: utxface - External interfaces, miscellaneous utility functions
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2013, Intel Corp.
 * 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.
 */

#define EXPORT_ACPI_INTERFACES

#include <acpi/acpi.h>
#include "accommon.h"
#include "acdebug.h"

#define _COMPONENT          ACPI_UTILITIES
ACPI_MODULE_NAME("utxface")

/*******************************************************************************
 *
 * FUNCTION:    acpi_terminate
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
 *
 ******************************************************************************/
acpi_status acpi_terminate(void)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_terminate);

	/* Just exit if subsystem is already shutdown */

	if (acpi_gbl_shutdown) {
		ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
		return_ACPI_STATUS(AE_OK);
	}

	/* Subsystem appears active, go ahead and shut it down */

	acpi_gbl_shutdown = TRUE;
	acpi_gbl_startup_flags = 0;
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));

	/* Terminate the AML Debugger if present */

	ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);

	/* Shutdown and free all resources */

	acpi_ut_subsystem_shutdown();

	/* Free the mutex objects */

	acpi_ut_mutex_terminate();

#ifdef ACPI_DEBUGGER

	/* Shut down the debugger */

	acpi_db_terminate();
#endif

	/* Now we can shutdown the OS-dependent layer */

	status = acpi_os_terminate();
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL_INIT(acpi_terminate)

#ifndef ACPI_ASL_COMPILER
#ifdef ACPI_FUTURE_USAGE
/*******************************************************************************
 *
 * FUNCTION:    acpi_subsystem_status
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status of the ACPI subsystem
 *
 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
 *              before making any other calls, to ensure the subsystem
 *              initialized successfully.
 *
 ******************************************************************************/
acpi_status acpi_subsystem_status(void)
{

	if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
		return (AE_OK);
	} else {
		return (AE_ERROR);
	}
}

ACPI_EXPORT_SYMBOL(acpi_subsystem_status)

/*******************************************************************************
 *
 * FUNCTION:    acpi_get_system_info
 *
 * PARAMETERS:  out_buffer      - A buffer to receive the resources for the
 *                                device
 *
 * RETURN:      status          - the status of the call
 *
 * DESCRIPTION: This function is called to get information about the current
 *              state of the ACPI subsystem. It will return system information
 *              in the out_buffer.
 *
 *              If the function fails an appropriate status will be returned
 *              and the value of out_buffer is undefined.
 *
 ******************************************************************************/
acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
{
	struct acpi_system_info *info_ptr;
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_get_system_info);

	/* Parameter validation */

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

	/* Validate/Allocate/Clear caller buffer */

	status =
	    acpi_ut_initialize_buffer(out_buffer,
				      sizeof(struct acpi_system_info));
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/*
	 * Populate the return buffer
	 */
	info_ptr = (struct acpi_system_info *)out_buffer->pointer;

	info_ptr->acpi_ca_version = ACPI_CA_VERSION;

	/* System flags (ACPI capabilities) */

	info_ptr->flags = ACPI_SYS_MODE_ACPI;

	/* Timer resolution - 24 or 32 bits  */

	if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
		info_ptr->timer_resolution = 24;
	} else {
		info_ptr->timer_resolution = 32;
	}

	/* Clear the reserved fields */

	info_ptr->reserved1 = 0;
	info_ptr->reserved2 = 0;

	/* Current debug levels */

	info_ptr->debug_layer = acpi_dbg_layer;
	info_ptr->debug_level = acpi_dbg_level;

	return_ACPI_STATUS(AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_get_system_info)

/*****************************************************************************
 *
 * FUNCTION:    acpi_install_initialization_handler
 *
 * PARAMETERS:  handler             - Callback procedure
 *              function            - Not (currently) used, see below
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Install an initialization handler
 *
 * TBD: When a second function is added, must save the Function also.
 *
 ****************************************************************************/
acpi_status
acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
{

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

	if (acpi_gbl_init_handler) {
		return (AE_ALREADY_EXISTS);
	}

	acpi_gbl_init_handler = handler;
	return (AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
#endif				/*  ACPI_FUTURE_USAGE  */

/*****************************************************************************
 *
 * FUNCTION:    acpi_purge_cached_objects
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Empty all caches (delete the cached objects)
 *
 ****************************************************************************/
acpi_status acpi_purge_cached_objects(void)
{
	ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);

	(void)acpi_os_purge_cache(acpi_gbl_state_cache);
	(void)acpi_os_purge_cache(acpi_gbl_operand_cache);
	(void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
	(void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);

	return_ACPI_STATUS(AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)

/*****************************************************************************
 *
 * FUNCTION:    acpi_install_interface
 *
 * PARAMETERS:  interface_name      - The interface to install
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Install an _OSI interface to the global list
 *
 ****************************************************************************/
acpi_status acpi_install_interface(acpi_string interface_name)
{
	acpi_status status;
	struct acpi_interface_info *interface_info;

	/* Parameter validation */

	if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
		return (AE_BAD_PARAMETER);
	}

	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	if (ACPI_FAILURE(status)) {
		return (status);
	}

	/* Check if the interface name is already in the global list */

	interface_info = acpi_ut_get_interface(interface_name);
	if (interface_info) {
		/*
		 * The interface already exists in the list. This is OK if the
		 * interface has been marked invalid -- just clear the bit.
		 */
		if (interface_info->flags & ACPI_OSI_INVALID) {
			interface_info->flags &= ~ACPI_OSI_INVALID;
			status = AE_OK;
		} else {
			status = AE_ALREADY_EXISTS;
		}
	} else {
		/* New interface name, install into the global list */

		status = acpi_ut_install_interface(interface_name);
	}

	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	return (status);
}

ACPI_EXPORT_SYMBOL(acpi_install_interface)

/*****************************************************************************
 *
 * FUNCTION:    acpi_remove_interface
 *
 * PARAMETERS:  interface_name      - The interface to remove
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Remove an _OSI interface from the global list
 *
 ****************************************************************************/
acpi_status acpi_remove_interface(acpi_string interface_name)
{
	acpi_status status;

	/* Parameter validation */

	if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
		return (AE_BAD_PARAMETER);
	}

	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	if (ACPI_FAILURE(status)) {
		return (status);
	}

	status = acpi_ut_remove_interface(interface_name);

	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	return (status);
}

ACPI_EXPORT_SYMBOL(acpi_remove_interface)

/*****************************************************************************
 *
 * FUNCTION:    acpi_install_interface_handler
 *
 * PARAMETERS:  handler             - The _OSI interface handler to install
 *                                    NULL means "remove existing handler"
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
 *              invoked during execution of the internal implementation of
 *              _OSI. A NULL handler simply removes any existing handler.
 *
 ****************************************************************************/
acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
{
	acpi_status status;

	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	if (ACPI_FAILURE(status)) {
		return (status);
	}

	if (handler && acpi_gbl_interface_handler) {
		status = AE_ALREADY_EXISTS;
	} else {
		acpi_gbl_interface_handler = handler;
	}

	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	return (status);
}

ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)

/*****************************************************************************
 *
 * FUNCTION:    acpi_update_interfaces
 *
 * PARAMETERS:  action              - Actions to be performed during the
 *                                    update
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
 *              string or/and feature group strings.
 *
 ****************************************************************************/
acpi_status acpi_update_interfaces(u8 action)
{
	acpi_status status;

	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	if (ACPI_FAILURE(status)) {
		return (status);
	}

	status = acpi_ut_update_interfaces(action);

	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	return (status);
}

/*****************************************************************************
 *
 * FUNCTION:    acpi_check_address_range
 *
 * PARAMETERS:  space_id            - Address space ID
 *              address             - Start address
 *              length              - Length
 *              warn                - TRUE if warning on overlap desired
 *
 * RETURN:      Count of the number of conflicts detected.
 *
 * DESCRIPTION: Check if the input address range overlaps any of the
 *              ASL operation region address ranges.
 *
 ****************************************************************************/

u32
acpi_check_address_range(acpi_adr_space_type space_id,
			 acpi_physical_address address,
			 acpi_size length, u8 warn)
{
	u32 overlaps;
	acpi_status status;

	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
		return (0);
	}

	overlaps = acpi_ut_check_address_range(space_id, address,
					       (u32)length, warn);

	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	return (overlaps);
}

ACPI_EXPORT_SYMBOL(acpi_check_address_range)
#endif				/* !ACPI_ASL_COMPILER */
/*******************************************************************************
 *
 * FUNCTION:    acpi_decode_pld_buffer
 *
 * PARAMETERS:  in_buffer           - Buffer returned by _PLD method
 *              length              - Length of the in_buffer
 *              return_buffer       - Where the decode buffer is returned
 *
 * RETURN:      Status and the decoded _PLD buffer. User must deallocate
 *              the buffer via ACPI_FREE.
 *
 * DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
 *              a local struct that is much more useful to an ACPI driver.
 *
 ******************************************************************************/
acpi_status
acpi_decode_pld_buffer(u8 *in_buffer,
		       acpi_size length, struct acpi_pld_info ** return_buffer)
{
	struct acpi_pld_info *pld_info;
	u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
	u32 dword;

	/* Parameter validation */

	if (!in_buffer || !return_buffer || (length < 16)) {
		return (AE_BAD_PARAMETER);
	}

	pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
	if (!pld_info) {
		return (AE_NO_MEMORY);
	}

	/* First 32-bit DWord */

	ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
	pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
	pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
	pld_info->color = ACPI_PLD_GET_COLOR(&dword);

	/* Second 32-bit DWord */

	ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
	pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
	pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);

	/* Third 32-bit DWord */

	ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
	pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
	pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
	pld_info->lid = ACPI_PLD_GET_LID(&dword);
	pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
	pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
	pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
	pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
	pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
	pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
	pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
	pld_info->bay = ACPI_PLD_GET_BAY(&dword);

	/* Fourth 32-bit DWord */

	ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
	pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
	pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
	pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
	pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
	pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
	pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
	pld_info->order = ACPI_PLD_GET_ORDER(&dword);

	if (length >= ACPI_PLD_BUFFER_SIZE) {

		/* Fifth 32-bit DWord (Revision 2 of _PLD) */

		ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
		pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
		pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
	}

	*return_buffer = pld_info;
	return (AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
1da177e4 LT	2	*
d978348b	3	* Module Name: utxface - External interfaces, miscellaneous utility functions
1da177e4 LT	4	*
	5	*****************************************************************************/
	6
	7	/*
25f044e6	8	* Copyright (C) 2000 - 2013, 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
839e928f LZ	45
1da177e4	46	#include <acpi/acpi.h>
e2f7a777	47	#include "accommon.h"
e2f7a777	48	#include "acdebug.h"
1da177e4 LT	49
1da177e4 LT	50	#define _COMPONENT ACPI_UTILITIES
4be44fcd	51	ACPI_MODULE_NAME("utxface")
1da177e4	52
1da177e4 LT	53	/*******************************************************************************
	54	*
	55	* FUNCTION: acpi_terminate
	56	*
	57	* PARAMETERS: None
	58	*
	59	* RETURN: Status
	60	*
2f977b36	61	* DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
1da177e4 LT	62	*
1da177e4 LT	63	******************************************************************************/
4be44fcd	64	acpi_status acpi_terminate(void)
1da177e4	65	{
4be44fcd	66	acpi_status status;
1da177e4	67
b229cf92	68	ACPI_FUNCTION_TRACE(acpi_terminate);
1da177e4	69
2f977b36 BM	70	/* Just exit if subsystem is already shutdown */
	71
	72	if (acpi_gbl_shutdown) {
	73	ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
	74	return_ACPI_STATUS(AE_OK);
	75	}
	76
	77	/* Subsystem appears active, go ahead and shut it down */
	78
	79	acpi_gbl_shutdown = TRUE;
	80	acpi_gbl_startup_flags = 0;
	81	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
	82
1da177e4 LT	83	/* Terminate the AML Debugger if present */
	84
	85	ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
	86
	87	/* Shutdown and free all resources */
	88
4be44fcd	89	acpi_ut_subsystem_shutdown();
1da177e4 LT	90
	91	/* Free the mutex objects */
	92
4be44fcd	93	acpi_ut_mutex_terminate();
1da177e4 LT	94
	95	#ifdef ACPI_DEBUGGER
	96
	97	/* Shut down the debugger */
	98
4be44fcd	99	acpi_db_terminate();
1da177e4 LT	100	#endif
	101
	102	/* Now we can shutdown the OS-dependent layer */
	103
4be44fcd LB	104	status = acpi_os_terminate();
4be44fcd LB	105	return_ACPI_STATUS(status);
1da177e4 LT	106	}
1da177e4 LT	107
d21f600b	108	ACPI_EXPORT_SYMBOL_INIT(acpi_terminate)
2f977b36	109
e20a679b	110	#ifndef ACPI_ASL_COMPILER
1da177e4	111	#ifdef ACPI_FUTURE_USAGE
44f6c012	112	/*******************************************************************************
1da177e4 LT	113	*
	114	* FUNCTION: acpi_subsystem_status
	115	*
	116	* PARAMETERS: None
	117	*
	118	* RETURN: Status of the ACPI subsystem
	119	*
	120	* DESCRIPTION: Other drivers that use the ACPI subsystem should call this
44f6c012 RM	121	* before making any other calls, to ensure the subsystem
44f6c012 RM	122	* initialized successfully.
1da177e4	123	*
44f6c012	124	******************************************************************************/
4be44fcd	125	acpi_status acpi_subsystem_status(void)
1da177e4	126	{
44f6c012	127
1da177e4 LT	128	if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
1da177e4 LT	129	return (AE_OK);
4be44fcd	130	} else {
1da177e4 LT	131	return (AE_ERROR);
	132	}
	133	}
	134
8313524a BM	135	ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
8313524a BM	136
44f6c012	137	/*******************************************************************************
1da177e4 LT	138	*
	139	* FUNCTION: acpi_get_system_info
	140	*
44f6c012 RM	141	* PARAMETERS: out_buffer - A buffer to receive the resources for the
44f6c012 RM	142	* device
1da177e4	143	*
ba494bee	144	* RETURN: status - the status of the call
1da177e4 LT	145	*
1da177e4 LT	146	* DESCRIPTION: This function is called to get information about the current
73a3090a	147	* state of the ACPI subsystem. It will return system information
1da177e4 LT	148	* in the out_buffer.
	149	*
	150	* If the function fails an appropriate status will be returned
	151	* and the value of out_buffer is undefined.
	152	*
	153	******************************************************************************/
4be44fcd	154	acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
1da177e4	155	{
4be44fcd LB	156	struct acpi_system_info *info_ptr;
4be44fcd LB	157	acpi_status status;
1da177e4	158
b229cf92	159	ACPI_FUNCTION_TRACE(acpi_get_system_info);
1da177e4 LT	160
	161	/* Parameter validation */
	162
4be44fcd LB	163	status = acpi_ut_validate_buffer(out_buffer);
	164	if (ACPI_FAILURE(status)) {
	165	return_ACPI_STATUS(status);
1da177e4 LT	166	}
	167
	168	/* Validate/Allocate/Clear caller buffer */
	169
4be44fcd LB	170	status =
	171	acpi_ut_initialize_buffer(out_buffer,
	172	sizeof(struct acpi_system_info));
	173	if (ACPI_FAILURE(status)) {
	174	return_ACPI_STATUS(status);
1da177e4 LT	175	}
	176
	177	/*
	178	* Populate the return buffer
	179	*/
4be44fcd	180	info_ptr = (struct acpi_system_info *)out_buffer->pointer;
1da177e4	181
4be44fcd	182	info_ptr->acpi_ca_version = ACPI_CA_VERSION;
1da177e4 LT	183
	184	/* System flags (ACPI capabilities) */
	185
4be44fcd	186	info_ptr->flags = ACPI_SYS_MODE_ACPI;
1da177e4 LT	187
	188	/* Timer resolution - 24 or 32 bits */
	189
f3d2e786	190	if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
1da177e4	191	info_ptr->timer_resolution = 24;
4be44fcd	192	} else {
1da177e4 LT	193	info_ptr->timer_resolution = 32;
	194	}
	195
	196	/* Clear the reserved fields */
	197
4be44fcd LB	198	info_ptr->reserved1 = 0;
4be44fcd LB	199	info_ptr->reserved2 = 0;
1da177e4 LT	200
	201	/* Current debug levels */
	202
4be44fcd LB	203	info_ptr->debug_layer = acpi_dbg_layer;
4be44fcd LB	204	info_ptr->debug_level = acpi_dbg_level;
1da177e4	205
4be44fcd	206	return_ACPI_STATUS(AE_OK);
1da177e4	207	}
1da177e4	208
8313524a	209	ACPI_EXPORT_SYMBOL(acpi_get_system_info)
1da177e4 LT	210
	211	/*****************************************************************************
	212	*
	213	* FUNCTION: acpi_install_initialization_handler
	214	*
ba494bee BM	215	* PARAMETERS: handler - Callback procedure
ba494bee BM	216	* function - Not (currently) used, see below
1da177e4 LT	217	*
	218	* RETURN: Status
	219	*
	220	* DESCRIPTION: Install an initialization handler
	221	*
	222	* TBD: When a second function is added, must save the Function also.
	223	*
	224	****************************************************************************/
1da177e4	225	acpi_status
4be44fcd	226	acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
1da177e4 LT	227	{
	228
	229	if (!handler) {
	230	return (AE_BAD_PARAMETER);
	231	}
	232
	233	if (acpi_gbl_init_handler) {
	234	return (AE_ALREADY_EXISTS);
	235	}
	236
	237	acpi_gbl_init_handler = handler;
68aafc35	238	return (AE_OK);
1da177e4 LT	239	}
1da177e4 LT	240
8313524a	241	ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
4be44fcd	242	#endif /* ACPI_FUTURE_USAGE */
b0ed7a91	243
1da177e4 LT	244	/*****************************************************************************
	245	*
	246	* FUNCTION: acpi_purge_cached_objects
	247	*
	248	* PARAMETERS: None
	249	*
	250	* RETURN: Status
	251	*
	252	* DESCRIPTION: Empty all caches (delete the cached objects)
	253	*
	254	****************************************************************************/
4be44fcd	255	acpi_status acpi_purge_cached_objects(void)
1da177e4	256	{
b229cf92	257	ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
1da177e4	258
4be44fcd LB	259	(void)acpi_os_purge_cache(acpi_gbl_state_cache);
	260	(void)acpi_os_purge_cache(acpi_gbl_operand_cache);
	261	(void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
	262	(void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
68aafc35	263
4be44fcd	264	return_ACPI_STATUS(AE_OK);
1da177e4	265	}
8313524a BM	266
8313524a BM	267	ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
b0ed7a91 LM	268
	269	/*****************************************************************************
	270	*
	271	* FUNCTION: acpi_install_interface
	272	*
	273	* PARAMETERS: interface_name - The interface to install
	274	*
	275	* RETURN: Status
	276	*
	277	* DESCRIPTION: Install an _OSI interface to the global list
	278	*
	279	****************************************************************************/
	280	acpi_status acpi_install_interface(acpi_string interface_name)
	281	{
	282	acpi_status status;
	283	struct acpi_interface_info *interface_info;
	284
	285	/* Parameter validation */
	286
	287	if (!interface_name \|\| (ACPI_STRLEN(interface_name) == 0)) {
	288	return (AE_BAD_PARAMETER);
	289	}
	290
388a9902 JK	291	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	292	if (ACPI_FAILURE(status)) {
	293	return (status);
	294	}
b0ed7a91 LM	295
	296	/* Check if the interface name is already in the global list */
	297
	298	interface_info = acpi_ut_get_interface(interface_name);
	299	if (interface_info) {
	300	/*
	301	* The interface already exists in the list. This is OK if the
	302	* interface has been marked invalid -- just clear the bit.
	303	*/
	304	if (interface_info->flags & ACPI_OSI_INVALID) {
	305	interface_info->flags &= ~ACPI_OSI_INVALID;
	306	status = AE_OK;
	307	} else {
	308	status = AE_ALREADY_EXISTS;
	309	}
	310	} else {
	311	/* New interface name, install into the global list */
	312
	313	status = acpi_ut_install_interface(interface_name);
	314	}
	315
	316	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	317	return (status);
	318	}
	319
	320	ACPI_EXPORT_SYMBOL(acpi_install_interface)
	321
	322	/*****************************************************************************
	323	*
	324	* FUNCTION: acpi_remove_interface
	325	*
	326	* PARAMETERS: interface_name - The interface to remove
	327	*
	328	* RETURN: Status
	329	*
	330	* DESCRIPTION: Remove an _OSI interface from the global list
	331	*
	332	****************************************************************************/
	333	acpi_status acpi_remove_interface(acpi_string interface_name)
	334	{
	335	acpi_status status;
	336
	337	/* Parameter validation */
	338
	339	if (!interface_name \|\| (ACPI_STRLEN(interface_name) == 0)) {
	340	return (AE_BAD_PARAMETER);
	341	}
	342
388a9902 JK	343	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	344	if (ACPI_FAILURE(status)) {
	345	return (status);
	346	}
b0ed7a91 LM	347
	348	status = acpi_ut_remove_interface(interface_name);
	349
	350	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	351	return (status);
	352	}
	353
	354	ACPI_EXPORT_SYMBOL(acpi_remove_interface)
	355
	356	/*****************************************************************************
	357	*
	358	* FUNCTION: acpi_install_interface_handler
	359	*
ba494bee	360	* PARAMETERS: handler - The _OSI interface handler to install
b0ed7a91 LM	361	* NULL means "remove existing handler"
	362	*
	363	* RETURN: Status
	364	*
	365	* DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
	366	* invoked during execution of the internal implementation of
	367	* _OSI. A NULL handler simply removes any existing handler.
	368	*
	369	****************************************************************************/
	370	acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
	371	{
388a9902	372	acpi_status status;
b0ed7a91	373
388a9902 JK	374	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	375	if (ACPI_FAILURE(status)) {
	376	return (status);
	377	}
b0ed7a91 LM	378
	379	if (handler && acpi_gbl_interface_handler) {
	380	status = AE_ALREADY_EXISTS;
	381	} else {
	382	acpi_gbl_interface_handler = handler;
	383	}
	384
	385	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	386	return (status);
	387	}
	388
	389	ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
f654c0fe	390
2cf9f5bc LZ	391	/*****************************************************************************
	392	*
	393	* FUNCTION: acpi_update_interfaces
	394	*
	395	* PARAMETERS: action - Actions to be performed during the
	396	* update
	397	*
	398	* RETURN: Status
	399	*
	400	* DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
	401	* string or/and feature group strings.
	402	*
	403	****************************************************************************/
	404	acpi_status acpi_update_interfaces(u8 action)
	405	{
	406	acpi_status status;
	407
	408	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	409	if (ACPI_FAILURE(status)) {
	410	return (status);
	411	}
	412
	413	status = acpi_ut_update_interfaces(action);
	414
	415	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	416	return (status);
	417	}
	418
f654c0fe LM	419	/*****************************************************************************
	420	*
	421	* FUNCTION: acpi_check_address_range
	422	*
	423	* PARAMETERS: space_id - Address space ID
ba494bee BM	424	* address - Start address
	425	* length - Length
	426	* warn - TRUE if warning on overlap desired
f654c0fe LM	427	*
	428	* RETURN: Count of the number of conflicts detected.
	429	*
	430	* DESCRIPTION: Check if the input address range overlaps any of the
	431	* ASL operation region address ranges.
	432	*
	433	****************************************************************************/
2cf9f5bc	434
f654c0fe LM	435	u32
	436	acpi_check_address_range(acpi_adr_space_type space_id,
	437	acpi_physical_address address,
	438	acpi_size length, u8 warn)
	439	{
	440	u32 overlaps;
	441	acpi_status status;
	442
	443	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	444	if (ACPI_FAILURE(status)) {
	445	return (0);
	446	}
	447
	448	overlaps = acpi_ut_check_address_range(space_id, address,
	449	(u32)length, warn);
	450
	451	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	452	return (overlaps);
	453	}
	454
	455	ACPI_EXPORT_SYMBOL(acpi_check_address_range)
b0ed7a91	456	#endif /* !ACPI_ASL_COMPILER */
be030a57 BM	457	/*******************************************************************************
	458	*
	459	* FUNCTION: acpi_decode_pld_buffer
	460	*
	461	* PARAMETERS: in_buffer - Buffer returned by _PLD method
	462	* length - Length of the in_buffer
	463	* return_buffer - Where the decode buffer is returned
	464	*
	465	* RETURN: Status and the decoded _PLD buffer. User must deallocate
	466	* the buffer via ACPI_FREE.
	467	*
	468	* DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
	469	* a local struct that is much more useful to an ACPI driver.
	470	*
	471	******************************************************************************/
	472	acpi_status
	473	acpi_decode_pld_buffer(u8 *in_buffer,
	474	acpi_size length, struct acpi_pld_info ** return_buffer)
	475	{
	476	struct acpi_pld_info *pld_info;
	477	u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
	478	u32 dword;
	479
	480	/* Parameter validation */
	481
	482	if (!in_buffer \|\| !return_buffer \|\| (length < 16)) {
	483	return (AE_BAD_PARAMETER);
	484	}
	485
	486	pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
	487	if (!pld_info) {
	488	return (AE_NO_MEMORY);
	489	}
	490
	491	/* First 32-bit DWord */
	492
	493	ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
	494	pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
	495	pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
	496	pld_info->color = ACPI_PLD_GET_COLOR(&dword);
	497
	498	/* Second 32-bit DWord */
	499
	500	ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
	501	pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
	502	pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);
	503
	504	/* Third 32-bit DWord */
	505
	506	ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
	507	pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
	508	pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
	509	pld_info->lid = ACPI_PLD_GET_LID(&dword);
	510	pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
	511	pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
	512	pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
	513	pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
	514	pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
	515	pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
	516	pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
	517	pld_info->bay = ACPI_PLD_GET_BAY(&dword);
	518
	519	/* Fourth 32-bit DWord */
	520
521	ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
522	pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
523	pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
524	pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
525	pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
526	pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
527	pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
528	pld_info->order = ACPI_PLD_GET_ORDER(&dword);
529
530	if (length >= ACPI_PLD_BUFFER_SIZE) {
531
532	/* Fifth 32-bit DWord (Revision 2 of _PLD) */
533
534	ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
535	pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
536	pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
537	}
538
539	*return_buffer = pld_info;
540	return (AE_OK);
541	}
542
543	ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)