1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: utosi - Support for the _OSI predefined control method
6 * Copyright (C) 2000 - 2018, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
13 #define _COMPONENT ACPI_UTILITIES
14 ACPI_MODULE_NAME("utosi")
16 /******************************************************************************
18 * ACPICA policy for new _OSI strings:
20 * It is the stated policy of ACPICA that new _OSI strings will be integrated
21 * into this module as soon as possible after they are defined. It is strongly
22 * recommended that all ACPICA hosts mirror this policy and integrate any
23 * changes to this module as soon as possible. There are several historical
24 * reasons behind this policy:
26 * 1) New BIOSs tend to test only the case where the host responds TRUE to
27 * the latest version of Windows, which would respond to the latest/newest
28 * _OSI string. Not responding TRUE to the latest version of Windows will
29 * risk executing untested code paths throughout the DSDT and SSDTs.
31 * 2) If a new _OSI string is recognized only after a significant delay, this
32 * has the potential to cause problems on existing working machines because
33 * of the possibility that a new and different path through the ASL code
36 * 3) New _OSI strings are tending to come out about once per year. A delay
37 * in recognizing a new string for a significant amount of time risks the
38 * release of another string which only compounds the initial problem.
40 *****************************************************************************/
42 * Strings supported by the _OSI predefined control method (which is
43 * implemented internally within this module.)
45 * March 2009: Removed "Linux" as this host no longer wants to respond true
46 * for this string. Basically, the only safe OS strings are windows-related
47 * and in many or most cases represent the only test path within the
48 * BIOS-provided ASL code.
50 * The last element of each entry is used to track the newest version of
51 * Windows that the BIOS has requested.
53 static struct acpi_interface_info acpi_default_supported_interfaces
[] = {
54 /* Operating System Vendor Strings */
56 {"Windows 2000", NULL
, 0, ACPI_OSI_WIN_2000
}, /* Windows 2000 */
57 {"Windows 2001", NULL
, 0, ACPI_OSI_WIN_XP
}, /* Windows XP */
58 {"Windows 2001 SP1", NULL
, 0, ACPI_OSI_WIN_XP_SP1
}, /* Windows XP SP1 */
59 {"Windows 2001.1", NULL
, 0, ACPI_OSI_WINSRV_2003
}, /* Windows Server 2003 */
60 {"Windows 2001 SP2", NULL
, 0, ACPI_OSI_WIN_XP_SP2
}, /* Windows XP SP2 */
61 {"Windows 2001.1 SP1", NULL
, 0, ACPI_OSI_WINSRV_2003_SP1
}, /* Windows Server 2003 SP1 - Added 03/2006 */
62 {"Windows 2006", NULL
, 0, ACPI_OSI_WIN_VISTA
}, /* Windows vista - Added 03/2006 */
63 {"Windows 2006.1", NULL
, 0, ACPI_OSI_WINSRV_2008
}, /* Windows Server 2008 - Added 09/2009 */
64 {"Windows 2006 SP1", NULL
, 0, ACPI_OSI_WIN_VISTA_SP1
}, /* Windows Vista SP1 - Added 09/2009 */
65 {"Windows 2006 SP2", NULL
, 0, ACPI_OSI_WIN_VISTA_SP2
}, /* Windows Vista SP2 - Added 09/2010 */
66 {"Windows 2009", NULL
, 0, ACPI_OSI_WIN_7
}, /* Windows 7 and Server 2008 R2 - Added 09/2009 */
67 {"Windows 2012", NULL
, 0, ACPI_OSI_WIN_8
}, /* Windows 8 and Server 2012 - Added 08/2012 */
68 {"Windows 2013", NULL
, 0, ACPI_OSI_WIN_8
}, /* Windows 8.1 and Server 2012 R2 - Added 01/2014 */
69 {"Windows 2015", NULL
, 0, ACPI_OSI_WIN_10
}, /* Windows 10 - Added 03/2015 */
70 {"Windows 2016", NULL
, 0, ACPI_OSI_WIN_10_RS1
}, /* Windows 10 version 1607 - Added 12/2017 */
71 {"Windows 2017", NULL
, 0, ACPI_OSI_WIN_10_RS2
}, /* Windows 10 version 1703 - Added 12/2017 */
72 {"Windows 2017.2", NULL
, 0, ACPI_OSI_WIN_10_RS3
}, /* Windows 10 version 1709 - Added 02/2018 */
74 /* Feature Group Strings */
76 {"Extended Address Space Descriptor", NULL
, ACPI_OSI_FEATURE
, 0},
79 * All "optional" feature group strings (features that are implemented
80 * by the host) should be dynamically modified to VALID by the host via
81 * acpi_install_interface or acpi_update_interfaces. Such optional feature
82 * group strings are set as INVALID by default here.
85 {"Module Device", NULL
, ACPI_OSI_OPTIONAL_FEATURE
, 0},
86 {"Processor Device", NULL
, ACPI_OSI_OPTIONAL_FEATURE
, 0},
87 {"3.0 Thermal Model", NULL
, ACPI_OSI_OPTIONAL_FEATURE
, 0},
88 {"3.0 _SCP Extensions", NULL
, ACPI_OSI_OPTIONAL_FEATURE
, 0},
89 {"Processor Aggregator Device", NULL
, ACPI_OSI_OPTIONAL_FEATURE
, 0}
92 /*******************************************************************************
94 * FUNCTION: acpi_ut_initialize_interfaces
100 * DESCRIPTION: Initialize the global _OSI supported interfaces list
102 ******************************************************************************/
104 acpi_status
acpi_ut_initialize_interfaces(void)
109 status
= acpi_os_acquire_mutex(acpi_gbl_osi_mutex
, ACPI_WAIT_FOREVER
);
110 if (ACPI_FAILURE(status
)) {
114 acpi_gbl_supported_interfaces
= acpi_default_supported_interfaces
;
116 /* Link the static list of supported interfaces */
119 i
< (ACPI_ARRAY_LENGTH(acpi_default_supported_interfaces
) - 1);
121 acpi_default_supported_interfaces
[i
].next
=
122 &acpi_default_supported_interfaces
[(acpi_size
)i
+ 1];
125 acpi_os_release_mutex(acpi_gbl_osi_mutex
);
129 /*******************************************************************************
131 * FUNCTION: acpi_ut_interface_terminate
137 * DESCRIPTION: Delete all interfaces in the global list. Sets
138 * acpi_gbl_supported_interfaces to NULL.
140 ******************************************************************************/
142 acpi_status
acpi_ut_interface_terminate(void)
145 struct acpi_interface_info
*next_interface
;
147 status
= acpi_os_acquire_mutex(acpi_gbl_osi_mutex
, ACPI_WAIT_FOREVER
);
148 if (ACPI_FAILURE(status
)) {
152 next_interface
= acpi_gbl_supported_interfaces
;
153 while (next_interface
) {
154 acpi_gbl_supported_interfaces
= next_interface
->next
;
156 if (next_interface
->flags
& ACPI_OSI_DYNAMIC
) {
158 /* Only interfaces added at runtime can be freed */
160 ACPI_FREE(next_interface
->name
);
161 ACPI_FREE(next_interface
);
163 /* Interface is in static list. Reset it to invalid or valid. */
165 if (next_interface
->flags
& ACPI_OSI_DEFAULT_INVALID
) {
166 next_interface
->flags
|= ACPI_OSI_INVALID
;
168 next_interface
->flags
&= ~ACPI_OSI_INVALID
;
172 next_interface
= acpi_gbl_supported_interfaces
;
175 acpi_os_release_mutex(acpi_gbl_osi_mutex
);
179 /*******************************************************************************
181 * FUNCTION: acpi_ut_install_interface
183 * PARAMETERS: interface_name - The interface to install
187 * DESCRIPTION: Install the interface into the global interface list.
188 * Caller MUST hold acpi_gbl_osi_mutex
190 ******************************************************************************/
192 acpi_status
acpi_ut_install_interface(acpi_string interface_name
)
194 struct acpi_interface_info
*interface_info
;
196 /* Allocate info block and space for the name string */
199 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_interface_info
));
200 if (!interface_info
) {
201 return (AE_NO_MEMORY
);
204 interface_info
->name
= ACPI_ALLOCATE_ZEROED(strlen(interface_name
) + 1);
205 if (!interface_info
->name
) {
206 ACPI_FREE(interface_info
);
207 return (AE_NO_MEMORY
);
210 /* Initialize new info and insert at the head of the global list */
212 strcpy(interface_info
->name
, interface_name
);
213 interface_info
->flags
= ACPI_OSI_DYNAMIC
;
214 interface_info
->next
= acpi_gbl_supported_interfaces
;
216 acpi_gbl_supported_interfaces
= interface_info
;
220 /*******************************************************************************
222 * FUNCTION: acpi_ut_remove_interface
224 * PARAMETERS: interface_name - The interface to remove
228 * DESCRIPTION: Remove the interface from the global interface list.
229 * Caller MUST hold acpi_gbl_osi_mutex
231 ******************************************************************************/
233 acpi_status
acpi_ut_remove_interface(acpi_string interface_name
)
235 struct acpi_interface_info
*previous_interface
;
236 struct acpi_interface_info
*next_interface
;
238 previous_interface
= next_interface
= acpi_gbl_supported_interfaces
;
239 while (next_interface
) {
240 if (!strcmp(interface_name
, next_interface
->name
)) {
242 * Found: name is in either the static list
243 * or was added at runtime
245 if (next_interface
->flags
& ACPI_OSI_DYNAMIC
) {
247 /* Interface was added dynamically, remove and free it */
249 if (previous_interface
== next_interface
) {
250 acpi_gbl_supported_interfaces
=
251 next_interface
->next
;
253 previous_interface
->next
=
254 next_interface
->next
;
257 ACPI_FREE(next_interface
->name
);
258 ACPI_FREE(next_interface
);
261 * Interface is in static list. If marked invalid, then
262 * it does not actually exist. Else, mark it invalid.
264 if (next_interface
->flags
& ACPI_OSI_INVALID
) {
265 return (AE_NOT_EXIST
);
268 next_interface
->flags
|= ACPI_OSI_INVALID
;
274 previous_interface
= next_interface
;
275 next_interface
= next_interface
->next
;
278 /* Interface was not found */
280 return (AE_NOT_EXIST
);
283 /*******************************************************************************
285 * FUNCTION: acpi_ut_update_interfaces
287 * PARAMETERS: action - Actions to be performed during the
292 * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
293 * strings or/and feature group strings.
294 * Caller MUST hold acpi_gbl_osi_mutex
296 ******************************************************************************/
298 acpi_status
acpi_ut_update_interfaces(u8 action
)
300 struct acpi_interface_info
*next_interface
;
302 next_interface
= acpi_gbl_supported_interfaces
;
303 while (next_interface
) {
304 if (((next_interface
->flags
& ACPI_OSI_FEATURE
) &&
305 (action
& ACPI_FEATURE_STRINGS
)) ||
306 (!(next_interface
->flags
& ACPI_OSI_FEATURE
) &&
307 (action
& ACPI_VENDOR_STRINGS
))) {
308 if (action
& ACPI_DISABLE_INTERFACES
) {
310 /* Mark the interfaces as invalid */
312 next_interface
->flags
|= ACPI_OSI_INVALID
;
314 /* Mark the interfaces as valid */
316 next_interface
->flags
&= ~ACPI_OSI_INVALID
;
320 next_interface
= next_interface
->next
;
326 /*******************************************************************************
328 * FUNCTION: acpi_ut_get_interface
330 * PARAMETERS: interface_name - The interface to find
332 * RETURN: struct acpi_interface_info if found. NULL if not found.
334 * DESCRIPTION: Search for the specified interface name in the global list.
335 * Caller MUST hold acpi_gbl_osi_mutex
337 ******************************************************************************/
339 struct acpi_interface_info
*acpi_ut_get_interface(acpi_string interface_name
)
341 struct acpi_interface_info
*next_interface
;
343 next_interface
= acpi_gbl_supported_interfaces
;
344 while (next_interface
) {
345 if (!strcmp(interface_name
, next_interface
->name
)) {
346 return (next_interface
);
349 next_interface
= next_interface
->next
;
355 /*******************************************************************************
357 * FUNCTION: acpi_ut_osi_implementation
359 * PARAMETERS: walk_state - Current walk state
362 * Integer: TRUE (0) if input string is matched
363 * FALSE (-1) if string is not matched
365 * DESCRIPTION: Implementation of the _OSI predefined control method. When
366 * an invocation of _OSI is encountered in the system AML,
367 * control is transferred to this function.
370 * Note: _OSI is now defined to return "Ones" to indicate a match, for
371 * compatibility with other ACPI implementations. On a 32-bit DSDT, Ones
372 * is 0xFFFFFFFF. On a 64-bit DSDT, Ones is 0xFFFFFFFFFFFFFFFF
375 * This function always returns ACPI_UINT64_MAX for TRUE, and later code
376 * will truncate this to 32 bits if necessary.
378 ******************************************************************************/
380 acpi_status
acpi_ut_osi_implementation(struct acpi_walk_state
*walk_state
)
382 union acpi_operand_object
*string_desc
;
383 union acpi_operand_object
*return_desc
;
384 struct acpi_interface_info
*interface_info
;
385 acpi_interface_handler interface_handler
;
389 ACPI_FUNCTION_TRACE(ut_osi_implementation
);
391 /* Validate the string input argument (from the AML caller) */
393 string_desc
= walk_state
->arguments
[0].object
;
394 if (!string_desc
|| (string_desc
->common
.type
!= ACPI_TYPE_STRING
)) {
395 return_ACPI_STATUS(AE_TYPE
);
398 /* Create a return object */
400 return_desc
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
402 return_ACPI_STATUS(AE_NO_MEMORY
);
405 /* Default return value is 0, NOT SUPPORTED */
408 status
= acpi_os_acquire_mutex(acpi_gbl_osi_mutex
, ACPI_WAIT_FOREVER
);
409 if (ACPI_FAILURE(status
)) {
410 acpi_ut_remove_reference(return_desc
);
411 return_ACPI_STATUS(status
);
414 /* Lookup the interface in the global _OSI list */
416 interface_info
= acpi_ut_get_interface(string_desc
->string
.pointer
);
417 if (interface_info
&& !(interface_info
->flags
& ACPI_OSI_INVALID
)) {
419 * The interface is supported.
420 * Update the osi_data if necessary. We keep track of the latest
421 * version of Windows that has been requested by the BIOS.
423 if (interface_info
->value
> acpi_gbl_osi_data
) {
424 acpi_gbl_osi_data
= interface_info
->value
;
427 return_value
= ACPI_UINT64_MAX
;
430 acpi_os_release_mutex(acpi_gbl_osi_mutex
);
433 * Invoke an optional _OSI interface handler. The host OS may wish
434 * to do some interface-specific handling. For example, warn about
435 * certain interfaces or override the true/false support value.
437 interface_handler
= acpi_gbl_interface_handler
;
438 if (interface_handler
) {
439 if (interface_handler
440 (string_desc
->string
.pointer
, (u32
)return_value
)) {
441 return_value
= ACPI_UINT64_MAX
;
445 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO
,
446 "ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
447 string_desc
->string
.pointer
,
448 return_value
== 0 ? "not " : ""));
450 /* Complete the return object */
452 return_desc
->integer
.value
= return_value
;
453 walk_state
->return_desc
= return_desc
;
454 return_ACPI_STATUS(AE_OK
);