[deliverable/linux.git] / drivers / acpi / utilities / utinit.c

/******************************************************************************
 *
 * Module Name: utinit - Common ACPI subsystem initialization
 *
 *****************************************************************************/

/*
 * 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 <acpi/acpi.h>
#include <acpi/acnamesp.h>
#include <acpi/acevents.h>

#define _COMPONENT          ACPI_UTILITIES
	 ACPI_MODULE_NAME    ("utinit")

/* Local prototypes */

static void
acpi_ut_fadt_register_error (
	char                            *register_name,
	u32                             value,
	acpi_size                       offset);

static void acpi_ut_terminate (
	void);


/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_fadt_register_error
 *
 * PARAMETERS:  register_name           - Pointer to string identifying register
 *              Value                   - Actual register contents value
 *              Offset                  - Byte offset in the FADT
 *
 * RETURN:      AE_BAD_VALUE
 *
 * DESCRIPTION: Display failure message
 *
 ******************************************************************************/

static void
acpi_ut_fadt_register_error (
	char                            *register_name,
	u32                             value,
	acpi_size                       offset)
{

	ACPI_REPORT_WARNING (
		("Invalid FADT value %s=%X at offset %X FADT=%p\n",
		register_name, value, (u32) offset, acpi_gbl_FADT));
}


/******************************************************************************
 *
 * FUNCTION:    acpi_ut_validate_fadt
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Validate various ACPI registers in the FADT
 *
 ******************************************************************************/

acpi_status
acpi_ut_validate_fadt (
	void)
{

	/*
	 * Verify Fixed ACPI Description Table fields,
	 * but don't abort on any problems, just display error
	 */
	if (acpi_gbl_FADT->pm1_evt_len < 4) {
		acpi_ut_fadt_register_error ("PM1_EVT_LEN",
				  (u32) acpi_gbl_FADT->pm1_evt_len,
				  ACPI_FADT_OFFSET (pm1_evt_len));
	}

	if (!acpi_gbl_FADT->pm1_cnt_len) {
		acpi_ut_fadt_register_error ("PM1_CNT_LEN", 0,
				  ACPI_FADT_OFFSET (pm1_cnt_len));
	}

	if (!acpi_gbl_FADT->xpm1a_evt_blk.address) {
		acpi_ut_fadt_register_error ("X_PM1a_EVT_BLK", 0,
				  ACPI_FADT_OFFSET (xpm1a_evt_blk.address));
	}

	if (!acpi_gbl_FADT->xpm1a_cnt_blk.address) {
		acpi_ut_fadt_register_error ("X_PM1a_CNT_BLK", 0,
				  ACPI_FADT_OFFSET (xpm1a_cnt_blk.address));
	}

	if (!acpi_gbl_FADT->xpm_tmr_blk.address) {
		acpi_ut_fadt_register_error ("X_PM_TMR_BLK", 0,
				  ACPI_FADT_OFFSET (xpm_tmr_blk.address));
	}

	if ((acpi_gbl_FADT->xpm2_cnt_blk.address &&
		!acpi_gbl_FADT->pm2_cnt_len)) {
		acpi_ut_fadt_register_error ("PM2_CNT_LEN",
				  (u32) acpi_gbl_FADT->pm2_cnt_len,
				  ACPI_FADT_OFFSET (pm2_cnt_len));
	}

	if (acpi_gbl_FADT->pm_tm_len < 4) {
		acpi_ut_fadt_register_error ("PM_TM_LEN",
				  (u32) acpi_gbl_FADT->pm_tm_len,
				  ACPI_FADT_OFFSET (pm_tm_len));
	}

	/* Length of GPE blocks must be a multiple of 2 */

	if (acpi_gbl_FADT->xgpe0_blk.address &&
		(acpi_gbl_FADT->gpe0_blk_len & 1)) {
		acpi_ut_fadt_register_error ("(x)GPE0_BLK_LEN",
				  (u32) acpi_gbl_FADT->gpe0_blk_len,
				  ACPI_FADT_OFFSET (gpe0_blk_len));
	}

	if (acpi_gbl_FADT->xgpe1_blk.address &&
		(acpi_gbl_FADT->gpe1_blk_len & 1)) {
		acpi_ut_fadt_register_error ("(x)GPE1_BLK_LEN",
				  (u32) acpi_gbl_FADT->gpe1_blk_len,
				  ACPI_FADT_OFFSET (gpe1_blk_len));
	}

	return (AE_OK);
}


/******************************************************************************
 *
 * FUNCTION:    acpi_ut_terminate
 *
 * PARAMETERS:  none
 *
 * RETURN:      none
 *
 * DESCRIPTION: Free global memory
 *
 ******************************************************************************/

static void
acpi_ut_terminate (
	void)
{
	struct acpi_gpe_block_info      *gpe_block;
	struct acpi_gpe_block_info      *next_gpe_block;
	struct acpi_gpe_xrupt_info      *gpe_xrupt_info;
	struct acpi_gpe_xrupt_info      *next_gpe_xrupt_info;


	ACPI_FUNCTION_TRACE ("ut_terminate");


	/* Free global tables, etc. */
	/* Free global GPE blocks and related info structures */

	gpe_xrupt_info = acpi_gbl_gpe_xrupt_list_head;
	while (gpe_xrupt_info) {
		gpe_block = gpe_xrupt_info->gpe_block_list_head;
		while (gpe_block) {
			next_gpe_block = gpe_block->next;
			ACPI_MEM_FREE (gpe_block->event_info);
			ACPI_MEM_FREE (gpe_block->register_info);
			ACPI_MEM_FREE (gpe_block);

			gpe_block = next_gpe_block;
		}
		next_gpe_xrupt_info = gpe_xrupt_info->next;
		ACPI_MEM_FREE (gpe_xrupt_info);
		gpe_xrupt_info = next_gpe_xrupt_info;
	}

	return_VOID;
}


/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_subsystem_shutdown
 *
 * PARAMETERS:  none
 *
 * RETURN:      none
 *
 * DESCRIPTION: Shutdown the various subsystems.  Don't delete the mutex
 *              objects here -- because the AML debugger may be still running.
 *
 ******************************************************************************/

void
acpi_ut_subsystem_shutdown (
	void)
{

	ACPI_FUNCTION_TRACE ("ut_subsystem_shutdown");

	/* Just exit if subsystem is already shutdown */

	if (acpi_gbl_shutdown) {
		ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
			"ACPI Subsystem is already terminated\n"));
		return_VOID;
	}

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

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

	/* Close the acpi_event Handling */

	acpi_ev_terminate ();

	/* Close the Namespace */

	acpi_ns_terminate ();

	/* Close the globals */

	acpi_ut_terminate ();

	/* Purge the local caches */

	(void) acpi_ut_delete_caches ();

	/* Debug only - display leftover memory allocation, if any */

#ifdef ACPI_DBG_TRACK_ALLOCATIONS
	acpi_ut_dump_allocations (ACPI_UINT32_MAX, NULL);
#endif

	return_VOID;
}
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: utinit - Common ACPI subsystem initialization
	4	*
	5	*****************************************************************************/
	6
	7	/*
	8	* Copyright (C) 2000 - 2005, R. Byron Moore
	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions, and the following disclaimer,
	16	* without modification.
	17	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	18	* substantially similar to the "NO WARRANTY" disclaimer below
	19	* ("Disclaimer") and any redistribution must be conditioned upon
	20	* including a substantially similar Disclaimer requirement for further
	21	* binary redistribution.
	22	* 3. Neither the names of the above-listed copyright holders nor the names
	23	* of any contributors may be used to endorse or promote products derived
	24	* from this software without specific prior written permission.
	25	*
	26	* Alternatively, this software may be distributed under the terms of the
	27	* GNU General Public License ("GPL") version 2 as published by the Free
	28	* Software Foundation.
	29	*
	30	* NO WARRANTY
	31	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	32	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	33	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	34	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	35	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	36	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	37	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	38	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	39	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	40	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	41	* POSSIBILITY OF SUCH DAMAGES.
	42	*/
	43
	44
	45	#include <acpi/acpi.h>
	46	#include <acpi/acnamesp.h>
	47	#include <acpi/acevents.h>
	48
	49	#define _COMPONENT ACPI_UTILITIES
	50	ACPI_MODULE_NAME ("utinit")
	51
44f6c012 RM	52	/* Local prototypes */
	53
	54	static void
	55	acpi_ut_fadt_register_error (
	56	char *register_name,
	57	u32 value,
	58	acpi_size offset);
	59
	60	static void acpi_ut_terminate (
	61	void);
	62
1da177e4 LT	63
	64	/*******************************************************************************
	65	*
	66	* FUNCTION: acpi_ut_fadt_register_error
	67	*
44f6c012	68	* PARAMETERS: register_name - Pointer to string identifying register
1da177e4	69	* Value - Actual register contents value
44f6c012	70	* Offset - Byte offset in the FADT
1da177e4 LT	71	*
	72	* RETURN: AE_BAD_VALUE
	73	*
44f6c012	74	* DESCRIPTION: Display failure message
1da177e4 LT	75	*
	76	******************************************************************************/
	77
	78	static void
	79	acpi_ut_fadt_register_error (
	80	char *register_name,
	81	u32 value,
	82	acpi_size offset)
	83	{
	84
	85	ACPI_REPORT_WARNING (
	86	("Invalid FADT value %s=%X at offset %X FADT=%p\n",
	87	register_name, value, (u32) offset, acpi_gbl_FADT));
	88	}
	89
	90
	91	/******************************************************************************
	92	*
	93	* FUNCTION: acpi_ut_validate_fadt
	94	*
	95	* PARAMETERS: None
	96	*
	97	* RETURN: Status
	98	*
	99	* DESCRIPTION: Validate various ACPI registers in the FADT
	100	*
	101	******************************************************************************/
	102
	103	acpi_status
	104	acpi_ut_validate_fadt (
	105	void)
	106	{
	107
	108	/*
	109	* Verify Fixed ACPI Description Table fields,
	110	* but don't abort on any problems, just display error
	111	*/
	112	if (acpi_gbl_FADT->pm1_evt_len < 4) {
	113	acpi_ut_fadt_register_error ("PM1_EVT_LEN",
	114	(u32) acpi_gbl_FADT->pm1_evt_len,
	115	ACPI_FADT_OFFSET (pm1_evt_len));
	116	}
	117
	118	if (!acpi_gbl_FADT->pm1_cnt_len) {
	119	acpi_ut_fadt_register_error ("PM1_CNT_LEN", 0,
	120	ACPI_FADT_OFFSET (pm1_cnt_len));
	121	}
	122
	123	if (!acpi_gbl_FADT->xpm1a_evt_blk.address) {
	124	acpi_ut_fadt_register_error ("X_PM1a_EVT_BLK", 0,
	125	ACPI_FADT_OFFSET (xpm1a_evt_blk.address));
	126	}
	127
	128	if (!acpi_gbl_FADT->xpm1a_cnt_blk.address) {
	129	acpi_ut_fadt_register_error ("X_PM1a_CNT_BLK", 0,
	130	ACPI_FADT_OFFSET (xpm1a_cnt_blk.address));
	131	}
	132
	133	if (!acpi_gbl_FADT->xpm_tmr_blk.address) {
	134	acpi_ut_fadt_register_error ("X_PM_TMR_BLK", 0,
	135	ACPI_FADT_OFFSET (xpm_tmr_blk.address));
	136	}
	137
	138	if ((acpi_gbl_FADT->xpm2_cnt_blk.address &&
139	!acpi_gbl_FADT->pm2_cnt_len)) {
140	acpi_ut_fadt_register_error ("PM2_CNT_LEN",
141	(u32) acpi_gbl_FADT->pm2_cnt_len,
142	ACPI_FADT_OFFSET (pm2_cnt_len));
143	}
144
145	if (acpi_gbl_FADT->pm_tm_len < 4) {
146	acpi_ut_fadt_register_error ("PM_TM_LEN",
147	(u32) acpi_gbl_FADT->pm_tm_len,
148	ACPI_FADT_OFFSET (pm_tm_len));
149	}
150
151	/* Length of GPE blocks must be a multiple of 2 */
152
153	if (acpi_gbl_FADT->xgpe0_blk.address &&
154	(acpi_gbl_FADT->gpe0_blk_len & 1)) {
155	acpi_ut_fadt_register_error ("(x)GPE0_BLK_LEN",
156	(u32) acpi_gbl_FADT->gpe0_blk_len,
157	ACPI_FADT_OFFSET (gpe0_blk_len));
158	}
159
160	if (acpi_gbl_FADT->xgpe1_blk.address &&
161	(acpi_gbl_FADT->gpe1_blk_len & 1)) {
162	acpi_ut_fadt_register_error ("(x)GPE1_BLK_LEN",
163	(u32) acpi_gbl_FADT->gpe1_blk_len,
164	ACPI_FADT_OFFSET (gpe1_blk_len));
165	}
166
167	return (AE_OK);
168	}
169
170
171	/******************************************************************************
172	*
173	* FUNCTION: acpi_ut_terminate
174	*
175	* PARAMETERS: none
176	*
177	* RETURN: none
178	*
44f6c012	179	* DESCRIPTION: Free global memory
1da177e4 LT	180	*
	181	******************************************************************************/
	182
44f6c012 RM	183	static void
	184	acpi_ut_terminate (
	185	void)
1da177e4 LT	186	{
	187	struct acpi_gpe_block_info *gpe_block;
	188	struct acpi_gpe_block_info *next_gpe_block;
	189	struct acpi_gpe_xrupt_info *gpe_xrupt_info;
	190	struct acpi_gpe_xrupt_info *next_gpe_xrupt_info;
	191
	192
	193	ACPI_FUNCTION_TRACE ("ut_terminate");
	194
	195
	196	/* Free global tables, etc. */
1da177e4 LT	197	/* Free global GPE blocks and related info structures */
	198
	199	gpe_xrupt_info = acpi_gbl_gpe_xrupt_list_head;
	200	while (gpe_xrupt_info) {
	201	gpe_block = gpe_xrupt_info->gpe_block_list_head;
	202	while (gpe_block) {
	203	next_gpe_block = gpe_block->next;
	204	ACPI_MEM_FREE (gpe_block->event_info);
	205	ACPI_MEM_FREE (gpe_block->register_info);
	206	ACPI_MEM_FREE (gpe_block);
	207
	208	gpe_block = next_gpe_block;
	209	}
	210	next_gpe_xrupt_info = gpe_xrupt_info->next;
	211	ACPI_MEM_FREE (gpe_xrupt_info);
	212	gpe_xrupt_info = next_gpe_xrupt_info;
	213	}
	214
	215	return_VOID;
	216	}
	217
	218
	219	/*******************************************************************************
	220	*
	221	* FUNCTION: acpi_ut_subsystem_shutdown
	222	*
	223	* PARAMETERS: none
	224	*
	225	* RETURN: none
	226	*
	227	* DESCRIPTION: Shutdown the various subsystems. Don't delete the mutex
	228	* objects here -- because the AML debugger may be still running.
	229	*
	230	******************************************************************************/
	231
	232	void
44f6c012 RM	233	acpi_ut_subsystem_shutdown (
44f6c012 RM	234	void)
1da177e4 LT	235	{
	236
	237	ACPI_FUNCTION_TRACE ("ut_subsystem_shutdown");
	238
	239	/* Just exit if subsystem is already shutdown */
	240
	241	if (acpi_gbl_shutdown) {
44f6c012 RM	242	ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
44f6c012 RM	243	"ACPI Subsystem is already terminated\n"));
1da177e4 LT	244	return_VOID;
	245	}
	246
	247	/* Subsystem appears active, go ahead and shut it down */
	248
	249	acpi_gbl_shutdown = TRUE;
44f6c012 RM	250	ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
44f6c012 RM	251	"Shutting down ACPI Subsystem...\n"));
1da177e4 LT	252
	253	/* Close the acpi_event Handling */
	254
	255	acpi_ev_terminate ();
	256
	257	/* Close the Namespace */
	258
	259	acpi_ns_terminate ();
	260
	261	/* Close the globals */
	262
	263	acpi_ut_terminate ();
	264
	265	/* Purge the local caches */
	266
73459f73	267	(void) acpi_ut_delete_caches ();
1da177e4 LT	268
	269	/* Debug only - display leftover memory allocation, if any */
	270
	271	#ifdef ACPI_DBG_TRACK_ALLOCATIONS
	272	acpi_ut_dump_allocations (ACPI_UINT32_MAX, NULL);
	273	#endif
	274
	275	return_VOID;
	276	}
	277
	278