utosi.c

Go to the documentation of this file.

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

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

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

    /* Feature Group Strings */

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

    /*
     * All "optional" feature group strings (features that are implemented
     * by the host) should be dynamically added by the host via
     * acpi_install_interface and should not be manually added here.
     *
     * Examples of optional feature group strings:
     *
     * "Module Device"
     * "Processor Device"
     * "3.0 Thermal Model"
     * "3.0 _SCP Extensions"
     * "Processor Aggregator Device"
     */
};

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

acpi_status acpi_ut_initialize_interfaces(void)
{
    u32 i;

    (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
    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:      None
 *
 * DESCRIPTION: Delete all interfaces in the global list. Sets
 *              acpi_gbl_supported_interfaces to NULL.
 *
 ******************************************************************************/

void acpi_ut_interface_terminate(void)
{
    struct acpi_interface_info *next_interface;

    (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
    next_interface = acpi_gbl_supported_interfaces;

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

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

        if (next_interface->flags & ACPI_OSI_DYNAMIC) {
            ACPI_FREE(next_interface->name);
            ACPI_FREE(next_interface);
        }

        next_interface = acpi_gbl_supported_interfaces;
    }

    acpi_os_release_mutex(acpi_gbl_osi_mutex);
}

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

    ACPI_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 (!ACPI_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_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 (!ACPI_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
 *
 * 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.
 *
 ******************************************************************************/

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;
    u32 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;
    (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);

    /* 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_UINT32_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) {
        return_value =
            interface_handler(string_desc->string.pointer,
                      return_value);
    }

    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);
}