[mirror_ubuntu-artful-kernel.git] / drivers / acpi / hardware / hwacpi.c


/******************************************************************************
 *
 * Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface
 *
 *****************************************************************************/

/*
 * 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>


#define _COMPONENT          ACPI_HARDWARE
	 ACPI_MODULE_NAME    ("hwacpi")


/******************************************************************************
 *
 * FUNCTION:    acpi_hw_initialize
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Initialize and validate the various ACPI registers defined in
 *              the FADT.
 *
 ******************************************************************************/

acpi_status
acpi_hw_initialize (
	void)
{
	acpi_status                     status;


	ACPI_FUNCTION_TRACE ("hw_initialize");


	/* We must have the ACPI tables by the time we get here */

	if (!acpi_gbl_FADT) {
		ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No FADT is present\n"));

		return_ACPI_STATUS (AE_NO_ACPI_TABLES);
	}

	/* Sanity check the FADT for valid values */

	status = acpi_ut_validate_fadt ();
	if (ACPI_FAILURE (status)) {
		return_ACPI_STATUS (status);
	}

	return_ACPI_STATUS (AE_OK);
}


/******************************************************************************
 *
 * FUNCTION:    acpi_hw_set_mode
 *
 * PARAMETERS:  Mode            - SYS_MODE_ACPI or SYS_MODE_LEGACY
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Transitions the system into the requested mode.
 *
 ******************************************************************************/

acpi_status
acpi_hw_set_mode (
	u32                             mode)
{

	acpi_status                     status;
	u32                             retry;


	ACPI_FUNCTION_TRACE ("hw_set_mode");

	/*
	 * ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
	 * system does not support mode transition.
	 */
	if (!acpi_gbl_FADT->smi_cmd) {
		ACPI_REPORT_ERROR (("No SMI_CMD in FADT, mode transition failed.\n"));
		return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
	}

	/*
	 * ACPI 2.0 clarified the meaning of ACPI_ENABLE and ACPI_DISABLE
	 * in FADT: If it is zero, enabling or disabling is not supported.
	 * As old systems may have used zero for mode transition,
	 * we make sure both the numbers are zero to determine these
	 * transitions are not supported.
	 */
	if (!acpi_gbl_FADT->acpi_enable && !acpi_gbl_FADT->acpi_disable) {
		ACPI_REPORT_ERROR ((
			"No ACPI mode transition supported in this system (enable/disable both zero)\n"));
		return_ACPI_STATUS (AE_OK);
	}

	switch (mode) {
	case ACPI_SYS_MODE_ACPI:

		/* BIOS should have disabled ALL fixed and GP events */

		status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd,
				  (u32) acpi_gbl_FADT->acpi_enable, 8);
		ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n"));
		break;

	case ACPI_SYS_MODE_LEGACY:

		/*
		 * BIOS should clear all fixed status bits and restore fixed event
		 * enable bits to default
		 */
		status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd,
				 (u32) acpi_gbl_FADT->acpi_disable, 8);
		ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
				 "Attempting to enable Legacy (non-ACPI) mode\n"));
		break;

	default:
		return_ACPI_STATUS (AE_BAD_PARAMETER);
	}

	if (ACPI_FAILURE (status)) {
		ACPI_REPORT_ERROR (("Could not write mode change, %s\n",
			acpi_format_exception (status)));
		return_ACPI_STATUS (status);
	}

	/*
	 * Some hardware takes a LONG time to switch modes. Give them 3 sec to
	 * do so, but allow faster systems to proceed more quickly.
	 */
	retry = 3000;
	while (retry) {
		if (acpi_hw_get_mode() == mode) {
			ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Mode %X successfully enabled\n",
				mode));
			return_ACPI_STATUS (AE_OK);
		}
		acpi_os_stall(1000);
		retry--;
	}

	ACPI_REPORT_ERROR (("Hardware never changed modes\n"));
	return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
}


/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_get_mode
 *
 * PARAMETERS:  none
 *
 * RETURN:      SYS_MODE_ACPI or SYS_MODE_LEGACY
 *
 * DESCRIPTION: Return current operating state of system.  Determined by
 *              querying the SCI_EN bit.
 *
 ******************************************************************************/

u32
acpi_hw_get_mode (
	void)
{
	acpi_status                     status;
	u32                             value;


	ACPI_FUNCTION_TRACE ("hw_get_mode");


	/*
	 * ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
	 * system does not support mode transition.
	 */
	if (!acpi_gbl_FADT->smi_cmd) {
		return_VALUE (ACPI_SYS_MODE_ACPI);
	}

	status = acpi_get_register (ACPI_BITREG_SCI_ENABLE, &value, ACPI_MTX_LOCK);
	if (ACPI_FAILURE (status)) {
		return_VALUE (ACPI_SYS_MODE_LEGACY);
	}

	if (value) {
		return_VALUE (ACPI_SYS_MODE_ACPI);
	}
	else {
		return_VALUE (ACPI_SYS_MODE_LEGACY);
	}
}
Commit	Line	Data
1da177e4 LT	1
	2	/******************************************************************************
	3	*
	4	* Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface
	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
	46	#include <acpi/acpi.h>
	47
	48
	49	#define _COMPONENT ACPI_HARDWARE
	50	ACPI_MODULE_NAME ("hwacpi")
	51
	52
	53	/******************************************************************************
	54	*
	55	* FUNCTION: acpi_hw_initialize
	56	*
	57	* PARAMETERS: None
	58	*
	59	* RETURN: Status
	60	*
44f6c012 RM	61	* DESCRIPTION: Initialize and validate the various ACPI registers defined in
44f6c012 RM	62	* the FADT.
1da177e4 LT	63	*
	64	******************************************************************************/
	65
	66	acpi_status
	67	acpi_hw_initialize (
	68	void)
	69	{
	70	acpi_status status;
	71
	72
	73	ACPI_FUNCTION_TRACE ("hw_initialize");
	74
	75
	76	/* We must have the ACPI tables by the time we get here */
	77
	78	if (!acpi_gbl_FADT) {
44f6c012	79	ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No FADT is present\n"));
1da177e4 LT	80
	81	return_ACPI_STATUS (AE_NO_ACPI_TABLES);
	82	}
	83
	84	/* Sanity check the FADT for valid values */
	85
	86	status = acpi_ut_validate_fadt ();
	87	if (ACPI_FAILURE (status)) {
	88	return_ACPI_STATUS (status);
	89	}
	90
	91	return_ACPI_STATUS (AE_OK);
	92	}
	93
	94
	95	/******************************************************************************
	96	*
	97	* FUNCTION: acpi_hw_set_mode
	98	*
	99	* PARAMETERS: Mode - SYS_MODE_ACPI or SYS_MODE_LEGACY
	100	*
	101	* RETURN: Status
	102	*
	103	* DESCRIPTION: Transitions the system into the requested mode.
	104	*
	105	******************************************************************************/
	106
	107	acpi_status
	108	acpi_hw_set_mode (
	109	u32 mode)
	110	{
	111
	112	acpi_status status;
	113	u32 retry;
	114
	115
	116	ACPI_FUNCTION_TRACE ("hw_set_mode");
	117
	118	/*
	119	* ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
	120	* system does not support mode transition.
	121	*/
	122	if (!acpi_gbl_FADT->smi_cmd) {
	123	ACPI_REPORT_ERROR (("No SMI_CMD in FADT, mode transition failed.\n"));
	124	return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
	125	}
	126
	127	/*
	128	* ACPI 2.0 clarified the meaning of ACPI_ENABLE and ACPI_DISABLE
	129	* in FADT: If it is zero, enabling or disabling is not supported.
	130	* As old systems may have used zero for mode transition,
	131	* we make sure both the numbers are zero to determine these
	132	* transitions are not supported.
	133	*/
	134	if (!acpi_gbl_FADT->acpi_enable && !acpi_gbl_FADT->acpi_disable) {
44f6c012 RM	135	ACPI_REPORT_ERROR ((
44f6c012 RM	136	"No ACPI mode transition supported in this system (enable/disable both zero)\n"));
1da177e4 LT	137	return_ACPI_STATUS (AE_OK);
	138	}
	139
	140	switch (mode) {
	141	case ACPI_SYS_MODE_ACPI:
	142
	143	/* BIOS should have disabled ALL fixed and GP events */
	144
	145	status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd,
	146	(u32) acpi_gbl_FADT->acpi_enable, 8);
	147	ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n"));
	148	break;
	149
	150	case ACPI_SYS_MODE_LEGACY:
	151
	152	/*
	153	* BIOS should clear all fixed status bits and restore fixed event
	154	* enable bits to default
	155	*/
	156	status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd,
	157	(u32) acpi_gbl_FADT->acpi_disable, 8);
	158	ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
	159	"Attempting to enable Legacy (non-ACPI) mode\n"));
	160	break;
	161
	162	default:
	163	return_ACPI_STATUS (AE_BAD_PARAMETER);
	164	}
	165
	166	if (ACPI_FAILURE (status)) {
44f6c012 RM	167	ACPI_REPORT_ERROR (("Could not write mode change, %s\n",
44f6c012 RM	168	acpi_format_exception (status)));
1da177e4 LT	169	return_ACPI_STATUS (status);
	170	}
	171
	172	/*
	173	* Some hardware takes a LONG time to switch modes. Give them 3 sec to
	174	* do so, but allow faster systems to proceed more quickly.
	175	*/
	176	retry = 3000;
	177	while (retry) {
	178	if (acpi_hw_get_mode() == mode) {
44f6c012 RM	179	ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Mode %X successfully enabled\n",
44f6c012 RM	180	mode));
1da177e4 LT	181	return_ACPI_STATUS (AE_OK);
	182	}
	183	acpi_os_stall(1000);
	184	retry--;
	185	}
	186
	187	ACPI_REPORT_ERROR (("Hardware never changed modes\n"));
	188	return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
	189	}
	190
	191
44f6c012	192	/*******************************************************************************
1da177e4 LT	193	*
	194	* FUNCTION: acpi_hw_get_mode
	195	*
	196	* PARAMETERS: none
	197	*
	198	* RETURN: SYS_MODE_ACPI or SYS_MODE_LEGACY
	199	*
	200	* DESCRIPTION: Return current operating state of system. Determined by
	201	* querying the SCI_EN bit.
	202	*
	203	******************************************************************************/
	204
	205	u32
44f6c012 RM	206	acpi_hw_get_mode (
44f6c012 RM	207	void)
1da177e4 LT	208	{
	209	acpi_status status;
	210	u32 value;
	211
	212
	213	ACPI_FUNCTION_TRACE ("hw_get_mode");
	214
	215
	216	/*
	217	* ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
	218	* system does not support mode transition.
	219	*/
	220	if (!acpi_gbl_FADT->smi_cmd) {
	221	return_VALUE (ACPI_SYS_MODE_ACPI);
	222	}
	223
	224	status = acpi_get_register (ACPI_BITREG_SCI_ENABLE, &value, ACPI_MTX_LOCK);
	225	if (ACPI_FAILURE (status)) {
	226	return_VALUE (ACPI_SYS_MODE_LEGACY);
	227	}
	228
	229	if (value) {
	230	return_VALUE (ACPI_SYS_MODE_ACPI);
	231	}
	232	else {
	233	return_VALUE (ACPI_SYS_MODE_LEGACY);
	234	}
	235	}