osi.h File Reference

#include <uacpi/types.h>
#include <uacpi/status.h>

Include dependency graph for osi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef enum uacpi_vendor_interface	uacpi_vendor_interface
typedef enum uacpi_interface_kind	uacpi_interface_kind
typedef enum uacpi_host_interface	uacpi_host_interface
typedef uacpi_bool(*	uacpi_interface_handler) (const uacpi_char *name, uacpi_bool supported)
typedef enum uacpi_interface_action	uacpi_interface_action

Enumerations
enum	uacpi_vendor_interface {   UACPI_VENDOR_INTERFACE_NONE = 0 , UACPI_VENDOR_INTERFACE_WINDOWS_2000 , UACPI_VENDOR_INTERFACE_WINDOWS_XP , UACPI_VENDOR_INTERFACE_WINDOWS_XP_SP1 ,   UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2003 , UACPI_VENDOR_INTERFACE_WINDOWS_XP_SP2 , UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2003_SP1 , UACPI_VENDOR_INTERFACE_WINDOWS_VISTA ,   UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2008 , UACPI_VENDOR_INTERFACE_WINDOWS_VISTA_SP1 , UACPI_VENDOR_INTERFACE_WINDOWS_VISTA_SP2 , UACPI_VENDOR_INTERFACE_WINDOWS_7 ,   UACPI_VENDOR_INTERFACE_WINDOWS_8 , UACPI_VENDOR_INTERFACE_WINDOWS_8_1 , UACPI_VENDOR_INTERFACE_WINDOWS_10 , UACPI_VENDOR_INTERFACE_WINDOWS_10_RS1 ,   UACPI_VENDOR_INTERFACE_WINDOWS_10_RS2 , UACPI_VENDOR_INTERFACE_WINDOWS_10_RS3 , UACPI_VENDOR_INTERFACE_WINDOWS_10_RS4 , UACPI_VENDOR_INTERFACE_WINDOWS_10_RS5 ,   UACPI_VENDOR_INTERFACE_WINDOWS_10_19H1 , UACPI_VENDOR_INTERFACE_WINDOWS_10_20H1 , UACPI_VENDOR_INTERFACE_WINDOWS_11 , UACPI_VENDOR_INTERFACE_WINDOWS_11_22H2 }
enum	uacpi_interface_kind { UACPI_INTERFACE_KIND_VENDOR = (1 << 0) , UACPI_INTERFACE_KIND_FEATURE = (1 << 1) , UACPI_INTERFACE_KIND_ALL }
enum	uacpi_host_interface {   UACPI_HOST_INTERFACE_MODULE_DEVICE = 1 , UACPI_HOST_INTERFACE_PROCESSOR_DEVICE , UACPI_HOST_INTERFACE_3_0_THERMAL_MODEL , UACPI_HOST_INTERFACE_3_0_SCP_EXTENSIONS ,   UACPI_HOST_INTERFACE_PROCESSOR_AGGREGATOR_DEVICE }
enum	uacpi_interface_action { UACPI_INTERFACE_ACTION_DISABLE = 0 , UACPI_INTERFACE_ACTION_ENABLE }

Functions
uacpi_vendor_interface	uacpi_latest_queried_vendor_interface (void)
uacpi_status	uacpi_install_interface (const uacpi_char *name, uacpi_interface_kind)
uacpi_status	uacpi_uninstall_interface (const uacpi_char *name)
uacpi_status	uacpi_enable_host_interface (uacpi_host_interface)
uacpi_status	uacpi_disable_host_interface (uacpi_host_interface)
uacpi_status	uacpi_set_interface_query_handler (uacpi_interface_handler)
uacpi_status	uacpi_bulk_configure_interfaces (uacpi_interface_action action, uacpi_interface_kind kind)

Typedef Documentation

uacpi_host_interface

typedef enum uacpi_host_interface uacpi_host_interface

uacpi_interface_action

typedef enum uacpi_interface_action uacpi_interface_action

uacpi_interface_handler

typedef uacpi_bool(* uacpi_interface_handler) (const uacpi_char *name, uacpi_bool supported)

Definition at line 88 of file osi.h.

uacpi_interface_kind

typedef enum uacpi_interface_kind uacpi_interface_kind

uacpi_vendor_interface

typedef enum uacpi_vendor_interface uacpi_vendor_interface

Enumeration Type Documentation

uacpi_host_interface

enum uacpi_host_interface

Enumerator
UACPI_HOST_INTERFACE_MODULE_DEVICE
UACPI_HOST_INTERFACE_PROCESSOR_DEVICE
UACPI_HOST_INTERFACE_3_0_THERMAL_MODEL
UACPI_HOST_INTERFACE_3_0_SCP_EXTENSIONS
UACPI_HOST_INTERFACE_PROCESSOR_AGGREGATOR_DEVICE

Definition at line 72 of file osi.h.

                                  {
    UACPI_HOST_INTERFACE_MODULE_DEVICE = 1,
    UACPI_HOST_INTERFACE_PROCESSOR_DEVICE,
    UACPI_HOST_INTERFACE_3_0_THERMAL_MODEL,
    UACPI_HOST_INTERFACE_3_0_SCP_EXTENSIONS,
    UACPI_HOST_INTERFACE_PROCESSOR_AGGREGATOR_DEVICE,
} uacpi_host_interface;

uacpi_interface_action

enum uacpi_interface_action

Enumerator
UACPI_INTERFACE_ACTION_DISABLE
UACPI_INTERFACE_ACTION_ENABLE

Definition at line 102 of file osi.h.

                                    {
    UACPI_INTERFACE_ACTION_DISABLE = 0,
    UACPI_INTERFACE_ACTION_ENABLE,
} uacpi_interface_action;

uacpi_interface_kind

enum uacpi_interface_kind

Enumerator
UACPI_INTERFACE_KIND_VENDOR
UACPI_INTERFACE_KIND_FEATURE
UACPI_INTERFACE_KIND_ALL

Definition at line 52 of file osi.h.

                                  {
    UACPI_INTERFACE_KIND_VENDOR = (1 << 0),
    UACPI_INTERFACE_KIND_FEATURE = (1 << 1),
    UACPI_INTERFACE_KIND_ALL = UACPI_INTERFACE_KIND_VENDOR |
                               UACPI_INTERFACE_KIND_FEATURE,
} uacpi_interface_kind;

uacpi_vendor_interface

enum uacpi_vendor_interface

Enumerator
UACPI_VENDOR_INTERFACE_NONE
UACPI_VENDOR_INTERFACE_WINDOWS_2000
UACPI_VENDOR_INTERFACE_WINDOWS_XP
UACPI_VENDOR_INTERFACE_WINDOWS_XP_SP1
UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2003
UACPI_VENDOR_INTERFACE_WINDOWS_XP_SP2
UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2003_SP1
UACPI_VENDOR_INTERFACE_WINDOWS_VISTA
UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2008
UACPI_VENDOR_INTERFACE_WINDOWS_VISTA_SP1
UACPI_VENDOR_INTERFACE_WINDOWS_VISTA_SP2
UACPI_VENDOR_INTERFACE_WINDOWS_7
UACPI_VENDOR_INTERFACE_WINDOWS_8
UACPI_VENDOR_INTERFACE_WINDOWS_8_1
UACPI_VENDOR_INTERFACE_WINDOWS_10
UACPI_VENDOR_INTERFACE_WINDOWS_10_RS1
UACPI_VENDOR_INTERFACE_WINDOWS_10_RS2
UACPI_VENDOR_INTERFACE_WINDOWS_10_RS3
UACPI_VENDOR_INTERFACE_WINDOWS_10_RS4
UACPI_VENDOR_INTERFACE_WINDOWS_10_RS5
UACPI_VENDOR_INTERFACE_WINDOWS_10_19H1
UACPI_VENDOR_INTERFACE_WINDOWS_10_20H1
UACPI_VENDOR_INTERFACE_WINDOWS_11
UACPI_VENDOR_INTERFACE_WINDOWS_11_22H2

Definition at line 12 of file osi.h.

                                    {
    UACPI_VENDOR_INTERFACE_NONE = 0,
    UACPI_VENDOR_INTERFACE_WINDOWS_2000,
    UACPI_VENDOR_INTERFACE_WINDOWS_XP,
    UACPI_VENDOR_INTERFACE_WINDOWS_XP_SP1,
    UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2003,
    UACPI_VENDOR_INTERFACE_WINDOWS_XP_SP2,
    UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2003_SP1,
    UACPI_VENDOR_INTERFACE_WINDOWS_VISTA,
    UACPI_VENDOR_INTERFACE_WINDOWS_SERVER_2008,
    UACPI_VENDOR_INTERFACE_WINDOWS_VISTA_SP1,
    UACPI_VENDOR_INTERFACE_WINDOWS_VISTA_SP2,
    UACPI_VENDOR_INTERFACE_WINDOWS_7,
    UACPI_VENDOR_INTERFACE_WINDOWS_8,
    UACPI_VENDOR_INTERFACE_WINDOWS_8_1,
    UACPI_VENDOR_INTERFACE_WINDOWS_10,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_RS1,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_RS2,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_RS3,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_RS4,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_RS5,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_19H1,
    UACPI_VENDOR_INTERFACE_WINDOWS_10_20H1,
    UACPI_VENDOR_INTERFACE_WINDOWS_11,
    UACPI_VENDOR_INTERFACE_WINDOWS_11_22H2,
} uacpi_vendor_interface;

Function Documentation

uacpi_bulk_configure_interfaces()

uacpi_status uacpi_bulk_configure_interfaces	(	uacpi_interface_action	action,
		uacpi_interface_kind	kind
	)

Bulk interface configuration, used to disable or enable all interfaces that match 'kind'.

This is generally only needed to work around buggy hardware, for example if requested from the kernel command line.

By default, all vendor strings (like "Windows 2000") are enabled, and all host features (like "3.0 Thermal Model") are disabled.

Definition at line 337 of file osi.c.

{
    uacpi_status ret;
    struct registered_interface *interface;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = uacpi_acquire_native_mutex(interface_mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    interface = registered_interfaces;
    while (interface) {
        if (kind & interface->kind)
            interface->disabled = (action == UACPI_INTERFACE_ACTION_DISABLE);
 
        interface = interface->next;
    }
 
    uacpi_release_native_mutex(interface_mutex);
    return ret;
}

uacpi_disable_host_interface()

uacpi_status uacpi_disable_host_interface

(

uacpi_host_interface

type

)

Definition at line 309 of file osi.c.

{
    return configure_host_interface(type, UACPI_FALSE);
}

uacpi_enable_host_interface()

uacpi_status uacpi_enable_host_interface

(

uacpi_host_interface

type

)

Same as install/uninstall interface, but comes with an enum of known interfaces defined by the ACPI specification. These are disabled by default as they depend on the host kernel support.

Definition at line 304 of file osi.c.

{
    return configure_host_interface(type, UACPI_TRUE);
}

uacpi_install_interface()

uacpi_status uacpi_install_interface	(	const uacpi_char *	name,
		uacpi_interface_kind	kind
	)

Install or uninstall an interface.

The interface kind is used for matching during interface enumeration in uacpi_bulk_configure_interfaces().

After installing an interface, all _OSI queries report it as supported.

Definition at line 173 of file osi.c.

{
    struct registered_interface *interface;
    uacpi_status ret;
    uacpi_char *name_copy;
    uacpi_size name_size;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = uacpi_acquire_native_mutex(interface_mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    interface = find_interface_unlocked(name);
    if (interface != UACPI_NULL) {
        if (interface->disabled)
            interface->disabled = UACPI_FALSE;
 
        ret = UACPI_STATUS_ALREADY_EXISTS;
        goto out;
    }
 
    interface = uacpi_kernel_alloc(sizeof(*interface));
    if (uacpi_unlikely(interface == UACPI_NULL)) {
        ret = UACPI_STATUS_OUT_OF_MEMORY;
        goto out;
    }
 
    name_size = uacpi_strlen(name) + 1;
    name_copy = uacpi_kernel_alloc(name_size);
    if (uacpi_unlikely(name_copy == UACPI_NULL)) {
        uacpi_free(interface, sizeof(*interface));
        ret = UACPI_STATUS_OUT_OF_MEMORY;
        goto out;
    }
 
    uacpi_memcpy(name_copy, name, name_size);
    interface->name = name_copy;
    interface->weight = 0;
    interface->kind = kind;
    interface->host_type = 0;
    interface->disabled = 0;
    interface->dynamic = 1;
    interface->next = registered_interfaces;
    registered_interfaces = interface;
 
out:
    uacpi_release_native_mutex(interface_mutex);
    return ret;
}

uacpi_latest_queried_vendor_interface()

uacpi_vendor_interface uacpi_latest_queried_vendor_interface

(

void

)

Returns the "latest" AML-queried _OSI vendor interface.

E.g. for the following AML code: _OSI("Windows 2021") _OSI("Windows 2000")

This function will return UACPI_VENDOR_INTERFACE_WINDOWS_11, since this is the latest version of the interface the code queried, even though the "Windows 2000" query came after "Windows 2021".

Definition at line 136 of file osi.c.

{
    return uacpi_atomic_load32(&latest_queried_interface);
}

uacpi_set_interface_query_handler()

uacpi_status uacpi_set_interface_query_handler

(

uacpi_interface_handler

handler

)

Set a custom interface query (_OSI) handler.

This callback will be invoked for each _OSI query with the value passed in the _OSI, as well as whether the interface was detected as supported. The callback is able to override the return value dynamically or leave it untouched if desired (e.g. if it simply wants to log something or do internal bookkeeping of some kind).

Definition at line 314 of file osi.c.

{
    uacpi_status ret;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = uacpi_acquire_native_mutex(interface_mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    if (interface_handler != UACPI_NULL && handler != UACPI_NULL) {
        ret = UACPI_STATUS_ALREADY_EXISTS;
        goto out;
    }
 
    interface_handler = handler;
out:
    uacpi_release_native_mutex(interface_mutex);
    return ret;
}

uacpi_uninstall_interface()

uacpi_status uacpi_uninstall_interface

(

const uacpi_char *

name

)

Definition at line 226 of file osi.c.

{
    struct registered_interface *cur, *prev;
    uacpi_status ret;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = uacpi_acquire_native_mutex(interface_mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    cur = registered_interfaces;
    prev = cur;
 
    ret = UACPI_STATUS_NOT_FOUND;
    while (cur) {
        if (uacpi_strcmp(cur->name, name) != 0) {
            prev = cur;
            cur = cur->next;
            continue;
        }
 
        if (cur->dynamic) {
            if (prev == cur) {
                registered_interfaces = cur->next;
            } else {
                prev->next = cur->next;
            }
 
            uacpi_release_native_mutex(interface_mutex);
            uacpi_free_dynamic_string(cur->name);
            uacpi_free(cur, sizeof(*cur));
            return UACPI_STATUS_OK;
        }
 
        /*
         * If this interface was already disabled, pretend we didn't actually
         * find it and keep ret as UACPI_STATUS_NOT_FOUND. The fact that it's
         * still in the registered list is an implementation detail of
         * predefined interfaces.
         */
        if (!cur->disabled) {
            cur->disabled = UACPI_TRUE;
            ret = UACPI_STATUS_OK;
        }
 
        break;
    }
 
    uacpi_release_native_mutex(interface_mutex);
    return ret;
}