[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / utosi.c

/******************************************************************************
 *
 * Module Name: utosi - Support for the _OSI predefined control method
 *
 *****************************************************************************/

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

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

#define _COMPONENT          ACPI_UTILITIES
ACPI_MODULE_NAME("utosi")

/******************************************************************************
 *
 * ACPICA policy for new _OSI strings:
 *
 * It is the stated policy of ACPICA that new _OSI strings will be integrated
 * into this module as soon as possible after they are defined. It is strongly
 * recommended that all ACPICA hosts mirror this policy and integrate any
 * changes to this module as soon as possible. There are several historical
 * reasons behind this policy:
 *
 * 1) New BIOSs tend to test only the case where the host responds TRUE to
 *    the latest version of Windows, which would respond to the latest/newest
 *    _OSI string. Not responding TRUE to the latest version of Windows will
 *    risk executing untested code paths throughout the DSDT and SSDTs.
 *
 * 2) If a new _OSI string is recognized only after a significant delay, this
 *    has the potential to cause problems on existing working machines because
 *    of the possibility that a new and different path through the ASL code
 *    will be executed.
 *
 * 3) New _OSI strings are tending to come out about once per year. A delay
 *    in recognizing a new string for a significant amount of time risks the
 *    release of another string which only compounds the initial problem.
 *
 *****************************************************************************/
/*
 * Strings supported by the _OSI predefined control method (which is
 * implemented internally within this module.)
 *
 * March 2009: Removed "Linux" as this host no longer wants to respond true
 * for this string. Basically, the only safe OS strings are windows-related
 * and in many or most cases represent the only test path within the
 * BIOS-provided ASL code.
 *
 * The last element of each entry is used to track the newest version of
 * Windows that the BIOS has requested.
 */
static struct acpi_interface_info acpi_default_supported_interfaces[] = {
	/* Operating System Vendor Strings */

	{"Windows 2000", NULL, 0, ACPI_OSI_WIN_2000},	/* Windows 2000 */
	{"Windows 2001", NULL, 0, ACPI_OSI_WIN_XP},	/* Windows XP */
	{"Windows 2001 SP1", NULL, 0, ACPI_OSI_WIN_XP_SP1},	/* Windows XP SP1 */
	{"Windows 2001.1", NULL, 0, ACPI_OSI_WINSRV_2003},	/* Windows Server 2003 */
	{"Windows 2001 SP2", NULL, 0, ACPI_OSI_WIN_XP_SP2},	/* Windows XP SP2 */
	{"Windows 2001.1 SP1", NULL, 0, ACPI_OSI_WINSRV_2003_SP1},	/* Windows Server 2003 SP1 - Added 03/2006 */
	{"Windows 2006", NULL, 0, ACPI_OSI_WIN_VISTA},	/* Windows vista - Added 03/2006 */
	{"Windows 2006.1", NULL, 0, ACPI_OSI_WINSRV_2008},	/* Windows Server 2008 - Added 09/2009 */
	{"Windows 2006 SP1", NULL, 0, ACPI_OSI_WIN_VISTA_SP1},	/* Windows Vista SP1 - Added 09/2009 */
	{"Windows 2006 SP2", NULL, 0, ACPI_OSI_WIN_VISTA_SP2},	/* Windows Vista SP2 - Added 09/2010 */
	{"Windows 2009", NULL, 0, ACPI_OSI_WIN_7},	/* Windows 7 and Server 2008 R2 - Added 09/2009 */
	{"Windows 2012", NULL, 0, ACPI_OSI_WIN_8},	/* Windows 8 and Server 2012 - Added 08/2012 */
	{"Windows 2013", NULL, 0, ACPI_OSI_WIN_8},	/* Windows 8.1 and Server 2012 R2 - Added 01/2014 */
	{"Windows 2015", NULL, 0, ACPI_OSI_WIN_10},	/* Windows 10 - Added 03/2015 */

	/* Feature Group Strings */

	{"Extended Address Space Descriptor", NULL, ACPI_OSI_FEATURE, 0},

	/*
	 * All "optional" feature group strings (features that are implemented
	 * by the host) should be dynamically modified to VALID by the host via
	 * acpi_install_interface or acpi_update_interfaces. Such optional feature
	 * group strings are set as INVALID by default here.
	 */

	{"Module Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	{"Processor Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	{"3.0 Thermal Model", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	{"3.0 _SCP Extensions", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	{"Processor Aggregator Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}
};

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_initialize_interfaces
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Initialize the global _OSI supported interfaces list
 *
 ******************************************************************************/

acpi_status acpi_ut_initialize_interfaces(void)
{
	acpi_status status;
	u32 i;

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

	acpi_gbl_supported_interfaces = acpi_default_supported_interfaces;

	/* Link the static list of supported interfaces */

	for (i = 0;
	     i < (ACPI_ARRAY_LENGTH(acpi_default_supported_interfaces) - 1);
	     i++) {
		acpi_default_supported_interfaces[i].next =
		    &acpi_default_supported_interfaces[(acpi_size)i + 1];
	}

	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	return (AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_interface_terminate
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Delete all interfaces in the global list. Sets
 *              acpi_gbl_supported_interfaces to NULL.
 *
 ******************************************************************************/

acpi_status acpi_ut_interface_terminate(void)
{
	acpi_status status;
	struct acpi_interface_info *next_interface;

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

	next_interface = acpi_gbl_supported_interfaces;
	while (next_interface) {
		acpi_gbl_supported_interfaces = next_interface->next;

		if (next_interface->flags & ACPI_OSI_DYNAMIC) {

			/* Only interfaces added at runtime can be freed */

			ACPI_FREE(next_interface->name);
			ACPI_FREE(next_interface);
		} else {
			/* Interface is in static list. Reset it to invalid or valid. */

			if (next_interface->flags & ACPI_OSI_DEFAULT_INVALID) {
				next_interface->flags |= ACPI_OSI_INVALID;
			} else {
				next_interface->flags &= ~ACPI_OSI_INVALID;
			}
		}

		next_interface = acpi_gbl_supported_interfaces;
	}

	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	return (AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_install_interface
 *
 * PARAMETERS:  interface_name      - The interface to install
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Install the interface into the global interface list.
 *              Caller MUST hold acpi_gbl_osi_mutex
 *
 ******************************************************************************/

acpi_status acpi_ut_install_interface(acpi_string interface_name)
{
	struct acpi_interface_info *interface_info;

	/* Allocate info block and space for the name string */

	interface_info =
	    ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_interface_info));
	if (!interface_info) {
		return (AE_NO_MEMORY);
	}

	interface_info->name = ACPI_ALLOCATE_ZEROED(strlen(interface_name) + 1);
	if (!interface_info->name) {
		ACPI_FREE(interface_info);
		return (AE_NO_MEMORY);
	}

	/* Initialize new info and insert at the head of the global list */

	strcpy(interface_info->name, interface_name);
	interface_info->flags = ACPI_OSI_DYNAMIC;
	interface_info->next = acpi_gbl_supported_interfaces;

	acpi_gbl_supported_interfaces = interface_info;
	return (AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_remove_interface
 *
 * PARAMETERS:  interface_name      - The interface to remove
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Remove the interface from the global interface list.
 *              Caller MUST hold acpi_gbl_osi_mutex
 *
 ******************************************************************************/

acpi_status acpi_ut_remove_interface(acpi_string interface_name)
{
	struct acpi_interface_info *previous_interface;
	struct acpi_interface_info *next_interface;

	previous_interface = next_interface = acpi_gbl_supported_interfaces;
	while (next_interface) {
		if (!strcmp(interface_name, next_interface->name)) {
			/*
			 * Found: name is in either the static list
			 * or was added at runtime
			 */
			if (next_interface->flags & ACPI_OSI_DYNAMIC) {

				/* Interface was added dynamically, remove and free it */

				if (previous_interface == next_interface) {
					acpi_gbl_supported_interfaces =
					    next_interface->next;
				} else {
					previous_interface->next =
					    next_interface->next;
				}

				ACPI_FREE(next_interface->name);
				ACPI_FREE(next_interface);
			} else {
				/*
				 * Interface is in static list. If marked invalid, then
				 * it does not actually exist. Else, mark it invalid.
				 */
				if (next_interface->flags & ACPI_OSI_INVALID) {
					return (AE_NOT_EXIST);
				}

				next_interface->flags |= ACPI_OSI_INVALID;
			}

			return (AE_OK);
		}

		previous_interface = next_interface;
		next_interface = next_interface->next;
	}

	/* Interface was not found */

	return (AE_NOT_EXIST);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_update_interfaces
 *
 * PARAMETERS:  action              - Actions to be performed during the
 *                                    update
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
 *              strings or/and feature group strings.
 *              Caller MUST hold acpi_gbl_osi_mutex
 *
 ******************************************************************************/

acpi_status acpi_ut_update_interfaces(u8 action)
{
	struct acpi_interface_info *next_interface;

	next_interface = acpi_gbl_supported_interfaces;
	while (next_interface) {
		if (((next_interface->flags & ACPI_OSI_FEATURE) &&
		     (action & ACPI_FEATURE_STRINGS)) ||
		    (!(next_interface->flags & ACPI_OSI_FEATURE) &&
		     (action & ACPI_VENDOR_STRINGS))) {
			if (action & ACPI_DISABLE_INTERFACES) {

				/* Mark the interfaces as invalid */

				next_interface->flags |= ACPI_OSI_INVALID;
			} else {
				/* Mark the interfaces as valid */

				next_interface->flags &= ~ACPI_OSI_INVALID;
			}
		}

		next_interface = next_interface->next;
	}

	return (AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_get_interface
 *
 * PARAMETERS:  interface_name      - The interface to find
 *
 * RETURN:      struct acpi_interface_info if found. NULL if not found.
 *
 * DESCRIPTION: Search for the specified interface name in the global list.
 *              Caller MUST hold acpi_gbl_osi_mutex
 *
 ******************************************************************************/

struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name)
{
	struct acpi_interface_info *next_interface;

	next_interface = acpi_gbl_supported_interfaces;
	while (next_interface) {
		if (!strcmp(interface_name, next_interface->name)) {
			return (next_interface);
		}

		next_interface = next_interface->next;
	}

	return (NULL);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_osi_implementation
 *
 * PARAMETERS:  walk_state          - Current walk state
 *
 * RETURN:      Status
 *              Integer: TRUE (0) if input string is matched
 *                       FALSE (-1) if string is not matched
 *
 * DESCRIPTION: Implementation of the _OSI predefined control method. When
 *              an invocation of _OSI is encountered in the system AML,
 *              control is transferred to this function.
 *
 * (August 2016)
 * Note:  _OSI is now defined to return "Ones" to indicate a match, for
 * compatibility with other ACPI implementations. On a 32-bit DSDT, Ones
 * is 0xFFFFFFFF. On a 64-bit DSDT, Ones is 0xFFFFFFFFFFFFFFFF
 * (ACPI_UINT64_MAX).
 *
 * This function always returns ACPI_UINT64_MAX for TRUE, and later code
 * will truncate this to 32 bits if necessary.
 *
 ******************************************************************************/

acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state)
{
	union acpi_operand_object *string_desc;
	union acpi_operand_object *return_desc;
	struct acpi_interface_info *interface_info;
	acpi_interface_handler interface_handler;
	acpi_status status;
	u64 return_value;

	ACPI_FUNCTION_TRACE(ut_osi_implementation);

	/* Validate the string input argument (from the AML caller) */

	string_desc = walk_state->arguments[0].object;
	if (!string_desc || (string_desc->common.type != ACPI_TYPE_STRING)) {
		return_ACPI_STATUS(AE_TYPE);
	}

	/* Create a return object */

	return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
	if (!return_desc) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	/* Default return value is 0, NOT SUPPORTED */

	return_value = 0;
	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	if (ACPI_FAILURE(status)) {
		acpi_ut_remove_reference(return_desc);
		return_ACPI_STATUS(status);
	}

	/* Lookup the interface in the global _OSI list */

	interface_info = acpi_ut_get_interface(string_desc->string.pointer);
	if (interface_info && !(interface_info->flags & ACPI_OSI_INVALID)) {
		/*
		 * The interface is supported.
		 * Update the osi_data if necessary. We keep track of the latest
		 * version of Windows that has been requested by the BIOS.
		 */
		if (interface_info->value > acpi_gbl_osi_data) {
			acpi_gbl_osi_data = interface_info->value;
		}

		return_value = ACPI_UINT64_MAX;
	}

	acpi_os_release_mutex(acpi_gbl_osi_mutex);

	/*
	 * Invoke an optional _OSI interface handler. The host OS may wish
	 * to do some interface-specific handling. For example, warn about
	 * certain interfaces or override the true/false support value.
	 */
	interface_handler = acpi_gbl_interface_handler;
	if (interface_handler) {
		if (interface_handler
		    (string_desc->string.pointer, (u32)return_value)) {
			return_value = ACPI_UINT64_MAX;
		}
	}

	ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO,
			      "ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
			      string_desc->string.pointer,
			      return_value == 0 ? "not " : ""));

	/* Complete the return object */

	return_desc->integer.value = return_value;
	walk_state->return_desc = return_desc;
	return_ACPI_STATUS(AE_OK);
}
Commit	Line	Data
b0ed7a91 LM	1	/******************************************************************************
	2	*
	3	* Module Name: utosi - Support for the _OSI predefined control method
	4	*
	5	*****************************************************************************/
	6
	7	/*
7735ca0e	8	* Copyright (C) 2000 - 2017, Intel Corp.
b0ed7a91 LM	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	#include <acpi/acpi.h>
	45	#include "accommon.h"
	46
	47	#define _COMPONENT ACPI_UTILITIES
	48	ACPI_MODULE_NAME("utosi")
	49
73581c02 BM	50	/******************************************************************************
	51	*
	52	* ACPICA policy for new _OSI strings:
	53	*
	54	* It is the stated policy of ACPICA that new _OSI strings will be integrated
	55	* into this module as soon as possible after they are defined. It is strongly
	56	* recommended that all ACPICA hosts mirror this policy and integrate any
	57	* changes to this module as soon as possible. There are several historical
	58	* reasons behind this policy:
	59	*
	60	* 1) New BIOSs tend to test only the case where the host responds TRUE to
	61	* the latest version of Windows, which would respond to the latest/newest
	62	* _OSI string. Not responding TRUE to the latest version of Windows will
	63	* risk executing untested code paths throughout the DSDT and SSDTs.
	64	*
	65	* 2) If a new _OSI string is recognized only after a significant delay, this
	66	* has the potential to cause problems on existing working machines because
	67	* of the possibility that a new and different path through the ASL code
	68	* will be executed.
	69	*
	70	* 3) New _OSI strings are tending to come out about once per year. A delay
	71	* in recognizing a new string for a significant amount of time risks the
	72	* release of another string which only compounds the initial problem.
	73	*
	74	*****************************************************************************/
b0ed7a91 LM	75	/*
	76	* Strings supported by the _OSI predefined control method (which is
	77	* implemented internally within this module.)
	78	*
	79	* March 2009: Removed "Linux" as this host no longer wants to respond true
	80	* for this string. Basically, the only safe OS strings are windows-related
	81	* and in many or most cases represent the only test path within the
	82	* BIOS-provided ASL code.
	83	*
	84	* The last element of each entry is used to track the newest version of
	85	* Windows that the BIOS has requested.
	86	*/
	87	static struct acpi_interface_info acpi_default_supported_interfaces[] = {
	88	/* Operating System Vendor Strings */
	89
	90	{"Windows 2000", NULL, 0, ACPI_OSI_WIN_2000}, /* Windows 2000 */
	91	{"Windows 2001", NULL, 0, ACPI_OSI_WIN_XP}, /* Windows XP */
	92	{"Windows 2001 SP1", NULL, 0, ACPI_OSI_WIN_XP_SP1}, /* Windows XP SP1 */
	93	{"Windows 2001.1", NULL, 0, ACPI_OSI_WINSRV_2003}, /* Windows Server 2003 */
	94	{"Windows 2001 SP2", NULL, 0, ACPI_OSI_WIN_XP_SP2}, /* Windows XP SP2 */
	95	{"Windows 2001.1 SP1", NULL, 0, ACPI_OSI_WINSRV_2003_SP1}, /* Windows Server 2003 SP1 - Added 03/2006 */
ba494bee	96	{"Windows 2006", NULL, 0, ACPI_OSI_WIN_VISTA}, /* Windows vista - Added 03/2006 */
b0ed7a91 LM	97	{"Windows 2006.1", NULL, 0, ACPI_OSI_WINSRV_2008}, /* Windows Server 2008 - Added 09/2009 */
b0ed7a91 LM	98	{"Windows 2006 SP1", NULL, 0, ACPI_OSI_WIN_VISTA_SP1}, /* Windows Vista SP1 - Added 09/2009 */
23ebbf07	99	{"Windows 2006 SP2", NULL, 0, ACPI_OSI_WIN_VISTA_SP2}, /* Windows Vista SP2 - Added 09/2010 */
b0ed7a91	100	{"Windows 2009", NULL, 0, ACPI_OSI_WIN_7}, /* Windows 7 and Server 2008 R2 - Added 09/2009 */
a57f7f91	101	{"Windows 2012", NULL, 0, ACPI_OSI_WIN_8}, /* Windows 8 and Server 2012 - Added 08/2012 */
faae404e	102	{"Windows 2013", NULL, 0, ACPI_OSI_WIN_8}, /* Windows 8.1 and Server 2012 R2 - Added 01/2014 */
796888e9	103	{"Windows 2015", NULL, 0, ACPI_OSI_WIN_10}, /* Windows 10 - Added 03/2015 */
b0ed7a91 LM	104
	105	/* Feature Group Strings */
	106
2cf9f5bc	107	{"Extended Address Space Descriptor", NULL, ACPI_OSI_FEATURE, 0},
b0ed7a91 LM	108
	109	/*
	110	* All "optional" feature group strings (features that are implemented
2cf9f5bc LZ	111	* by the host) should be dynamically modified to VALID by the host via
	112	* acpi_install_interface or acpi_update_interfaces. Such optional feature
	113	* group strings are set as INVALID by default here.
b0ed7a91	114	*/
2cf9f5bc LZ	115
	116	{"Module Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	117	{"Processor Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	118	{"3.0 Thermal Model", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	119	{"3.0 _SCP Extensions", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
	120	{"Processor Aggregator Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}
b0ed7a91 LM	121	};
	122
	123	/*******************************************************************************
	124	*
	125	* FUNCTION: acpi_ut_initialize_interfaces
	126	*
	127	* PARAMETERS: None
	128	*
	129	* RETURN: Status
	130	*
	131	* DESCRIPTION: Initialize the global _OSI supported interfaces list
	132	*
	133	******************************************************************************/
	134
	135	acpi_status acpi_ut_initialize_interfaces(void)
	136	{
388a9902	137	acpi_status status;
b0ed7a91 LM	138	u32 i;
b0ed7a91 LM	139
388a9902 JK	140	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	141	if (ACPI_FAILURE(status)) {
	142	return (status);
	143	}
	144
b0ed7a91 LM	145	acpi_gbl_supported_interfaces = acpi_default_supported_interfaces;
	146
	147	/* Link the static list of supported interfaces */
	148
	149	for (i = 0;
	150	i < (ACPI_ARRAY_LENGTH(acpi_default_supported_interfaces) - 1);
	151	i++) {
	152	acpi_default_supported_interfaces[i].next =
f5c1e1c5	153	&acpi_default_supported_interfaces[(acpi_size)i + 1];
b0ed7a91 LM	154	}
	155
	156	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	157	return (AE_OK);
	158	}
	159
	160	/*******************************************************************************
	161	*
	162	* FUNCTION: acpi_ut_interface_terminate
	163	*
	164	* PARAMETERS: None
	165	*
388a9902	166	* RETURN: Status
b0ed7a91 LM	167	*
	168	* DESCRIPTION: Delete all interfaces in the global list. Sets
	169	* acpi_gbl_supported_interfaces to NULL.
	170	*
	171	******************************************************************************/
	172
388a9902	173	acpi_status acpi_ut_interface_terminate(void)
b0ed7a91	174	{
388a9902	175	acpi_status status;
b0ed7a91 LM	176	struct acpi_interface_info *next_interface;
b0ed7a91 LM	177
388a9902 JK	178	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
	179	if (ACPI_FAILURE(status)) {
	180	return (status);
	181	}
b0ed7a91	182
388a9902	183	next_interface = acpi_gbl_supported_interfaces;
b0ed7a91 LM	184	while (next_interface) {
	185	acpi_gbl_supported_interfaces = next_interface->next;
	186
b0ed7a91	187	if (next_interface->flags & ACPI_OSI_DYNAMIC) {
2cf9f5bc LZ	188
	189	/* Only interfaces added at runtime can be freed */
	190
b0ed7a91 LM	191	ACPI_FREE(next_interface->name);
b0ed7a91 LM	192	ACPI_FREE(next_interface);
2cf9f5bc LZ	193	} else {
	194	/* Interface is in static list. Reset it to invalid or valid. */
	195
	196	if (next_interface->flags & ACPI_OSI_DEFAULT_INVALID) {
	197	next_interface->flags \|= ACPI_OSI_INVALID;
	198	} else {
	199	next_interface->flags &= ~ACPI_OSI_INVALID;
	200	}
b0ed7a91 LM	201	}
	202
	203	next_interface = acpi_gbl_supported_interfaces;
	204	}
	205
	206	acpi_os_release_mutex(acpi_gbl_osi_mutex);
388a9902	207	return (AE_OK);
b0ed7a91 LM	208	}
	209
	210	/*******************************************************************************
	211	*
	212	* FUNCTION: acpi_ut_install_interface
	213	*
	214	* PARAMETERS: interface_name - The interface to install
	215	*
	216	* RETURN: Status
	217	*
	218	* DESCRIPTION: Install the interface into the global interface list.
	219	* Caller MUST hold acpi_gbl_osi_mutex
	220	*
	221	******************************************************************************/
	222
	223	acpi_status acpi_ut_install_interface(acpi_string interface_name)
	224	{
	225	struct acpi_interface_info *interface_info;
	226
	227	/* Allocate info block and space for the name string */
	228
	229	interface_info =
	230	ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_interface_info));
	231	if (!interface_info) {
	232	return (AE_NO_MEMORY);
	233	}
	234
4fa4616e	235	interface_info->name = ACPI_ALLOCATE_ZEROED(strlen(interface_name) + 1);
b0ed7a91 LM	236	if (!interface_info->name) {
	237	ACPI_FREE(interface_info);
	238	return (AE_NO_MEMORY);
	239	}
	240
	241	/* Initialize new info and insert at the head of the global list */
	242
4fa4616e	243	strcpy(interface_info->name, interface_name);
b0ed7a91 LM	244	interface_info->flags = ACPI_OSI_DYNAMIC;
	245	interface_info->next = acpi_gbl_supported_interfaces;
	246
	247	acpi_gbl_supported_interfaces = interface_info;
	248	return (AE_OK);
	249	}
	250
	251	/*******************************************************************************
	252	*
	253	* FUNCTION: acpi_ut_remove_interface
	254	*
	255	* PARAMETERS: interface_name - The interface to remove
	256	*
	257	* RETURN: Status
	258	*
	259	* DESCRIPTION: Remove the interface from the global interface list.
	260	* Caller MUST hold acpi_gbl_osi_mutex
	261	*
	262	******************************************************************************/
	263
	264	acpi_status acpi_ut_remove_interface(acpi_string interface_name)
	265	{
	266	struct acpi_interface_info *previous_interface;
	267	struct acpi_interface_info *next_interface;
	268
	269	previous_interface = next_interface = acpi_gbl_supported_interfaces;
	270	while (next_interface) {
4fa4616e	271	if (!strcmp(interface_name, next_interface->name)) {
1fad8738 BM	272	/*
	273	* Found: name is in either the static list
	274	* or was added at runtime
	275	*/
b0ed7a91 LM	276	if (next_interface->flags & ACPI_OSI_DYNAMIC) {
	277
	278	/* Interface was added dynamically, remove and free it */
	279
	280	if (previous_interface == next_interface) {
	281	acpi_gbl_supported_interfaces =
	282	next_interface->next;
	283	} else {
	284	previous_interface->next =
	285	next_interface->next;
	286	}
	287
	288	ACPI_FREE(next_interface->name);
	289	ACPI_FREE(next_interface);
	290	} else {
	291	/*
1fad8738 BM	292	* Interface is in static list. If marked invalid, then
1fad8738 BM	293	* it does not actually exist. Else, mark it invalid.
b0ed7a91 LM	294	*/
	295	if (next_interface->flags & ACPI_OSI_INVALID) {
	296	return (AE_NOT_EXIST);
	297	}
	298
	299	next_interface->flags \|= ACPI_OSI_INVALID;
	300	}
	301
	302	return (AE_OK);
	303	}
	304
	305	previous_interface = next_interface;
	306	next_interface = next_interface->next;
	307	}
	308
	309	/* Interface was not found */
	310
	311	return (AE_NOT_EXIST);
	312	}
	313
2cf9f5bc LZ	314	/*******************************************************************************
	315	*
	316	* FUNCTION: acpi_ut_update_interfaces
	317	*
	318	* PARAMETERS: action - Actions to be performed during the
	319	* update
	320	*
	321	* RETURN: Status
	322	*
	323	* DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
	324	* strings or/and feature group strings.
	325	* Caller MUST hold acpi_gbl_osi_mutex
	326	*
	327	******************************************************************************/
	328
	329	acpi_status acpi_ut_update_interfaces(u8 action)
	330	{
	331	struct acpi_interface_info *next_interface;
	332
	333	next_interface = acpi_gbl_supported_interfaces;
	334	while (next_interface) {
	335	if (((next_interface->flags & ACPI_OSI_FEATURE) &&
	336	(action & ACPI_FEATURE_STRINGS)) \|\|
	337	(!(next_interface->flags & ACPI_OSI_FEATURE) &&
	338	(action & ACPI_VENDOR_STRINGS))) {
	339	if (action & ACPI_DISABLE_INTERFACES) {
	340
	341	/* Mark the interfaces as invalid */
	342
	343	next_interface->flags \|= ACPI_OSI_INVALID;
	344	} else {
	345	/* Mark the interfaces as valid */
	346
	347	next_interface->flags &= ~ACPI_OSI_INVALID;
	348	}
	349	}
	350
	351	next_interface = next_interface->next;
	352	}
	353
	354	return (AE_OK);
	355	}
	356
b0ed7a91 LM	357	/*******************************************************************************
	358	*
	359	* FUNCTION: acpi_ut_get_interface
	360	*
	361	* PARAMETERS: interface_name - The interface to find
	362	*
	363	* RETURN: struct acpi_interface_info if found. NULL if not found.
	364	*
	365	* DESCRIPTION: Search for the specified interface name in the global list.
	366	* Caller MUST hold acpi_gbl_osi_mutex
	367	*
	368	******************************************************************************/
	369
	370	struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name)
	371	{
	372	struct acpi_interface_info *next_interface;
	373
	374	next_interface = acpi_gbl_supported_interfaces;
	375	while (next_interface) {
4fa4616e	376	if (!strcmp(interface_name, next_interface->name)) {
b0ed7a91 LM	377	return (next_interface);
	378	}
	379
	380	next_interface = next_interface->next;
	381	}
	382
	383	return (NULL);
	384	}
	385
	386	/*******************************************************************************
	387	*
	388	* FUNCTION: acpi_ut_osi_implementation
	389	*
	390	* PARAMETERS: walk_state - Current walk state
	391	*
	392	* RETURN: Status
955f485d BM	393	* Integer: TRUE (0) if input string is matched
955f485d BM	394	* FALSE (-1) if string is not matched
b0ed7a91 LM	395	*
	396	* DESCRIPTION: Implementation of the _OSI predefined control method. When
	397	* an invocation of _OSI is encountered in the system AML,
	398	* control is transferred to this function.
	399	*
955f485d BM	400	* (August 2016)
	401	* Note: _OSI is now defined to return "Ones" to indicate a match, for
	402	* compatibility with other ACPI implementations. On a 32-bit DSDT, Ones
	403	* is 0xFFFFFFFF. On a 64-bit DSDT, Ones is 0xFFFFFFFFFFFFFFFF
	404	* (ACPI_UINT64_MAX).
	405	*
	406	* This function always returns ACPI_UINT64_MAX for TRUE, and later code
	407	* will truncate this to 32 bits if necessary.
	408	*
b0ed7a91 LM	409	******************************************************************************/
b0ed7a91 LM	410
f5c1e1c5	411	acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state)
b0ed7a91 LM	412	{
	413	union acpi_operand_object *string_desc;
	414	union acpi_operand_object *return_desc;
	415	struct acpi_interface_info *interface_info;
	416	acpi_interface_handler interface_handler;
388a9902	417	acpi_status status;
955f485d	418	u64 return_value;
b0ed7a91 LM	419
	420	ACPI_FUNCTION_TRACE(ut_osi_implementation);
	421
	422	/* Validate the string input argument (from the AML caller) */
	423
	424	string_desc = walk_state->arguments[0].object;
	425	if (!string_desc \|\| (string_desc->common.type != ACPI_TYPE_STRING)) {
	426	return_ACPI_STATUS(AE_TYPE);
	427	}
	428
	429	/* Create a return object */
	430
	431	return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
	432	if (!return_desc) {
	433	return_ACPI_STATUS(AE_NO_MEMORY);
	434	}
	435
	436	/* Default return value is 0, NOT SUPPORTED */
	437
	438	return_value = 0;
388a9902 JK	439	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
388a9902 JK	440	if (ACPI_FAILURE(status)) {
3aa2eeac JK	441	acpi_ut_remove_reference(return_desc);
3aa2eeac JK	442	return_ACPI_STATUS(status);
388a9902	443	}
b0ed7a91 LM	444
	445	/* Lookup the interface in the global _OSI list */
	446
	447	interface_info = acpi_ut_get_interface(string_desc->string.pointer);
	448	if (interface_info && !(interface_info->flags & ACPI_OSI_INVALID)) {
	449	/*
	450	* The interface is supported.
	451	* Update the osi_data if necessary. We keep track of the latest
	452	* version of Windows that has been requested by the BIOS.
	453	*/
	454	if (interface_info->value > acpi_gbl_osi_data) {
	455	acpi_gbl_osi_data = interface_info->value;
	456	}
	457
955f485d	458	return_value = ACPI_UINT64_MAX;
b0ed7a91 LM	459	}
	460
	461	acpi_os_release_mutex(acpi_gbl_osi_mutex);
	462
	463	/*
	464	* Invoke an optional _OSI interface handler. The host OS may wish
	465	* to do some interface-specific handling. For example, warn about
	466	* certain interfaces or override the true/false support value.
	467	*/
	468	interface_handler = acpi_gbl_interface_handler;
	469	if (interface_handler) {
955f485d BM	470	if (interface_handler
	471	(string_desc->string.pointer, (u32)return_value)) {
	472	return_value = ACPI_UINT64_MAX;
	473	}
b0ed7a91 LM	474	}
	475
	476	ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO,
	477	"ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
	478	string_desc->string.pointer,
	479	return_value == 0 ? "not " : ""));
	480
	481	/* Complete the return object */
	482
	483	return_desc->integer.value = return_value;
	484	walk_state->return_desc = return_desc;
	485	return_ACPI_STATUS(AE_OK);
	486	}