1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 2 /****************************************************************************** 3 * 4 * Module Name: utosi - Support for the _OSI predefined control method 5 * 6 * Copyright (C) 2000 - 2021, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #include <acpi/acpi.h> 11 #include "accommon.h" 12 13 #define _COMPONENT ACPI_UTILITIES 14 ACPI_MODULE_NAME("utosi") 15 16 /****************************************************************************** 17 * 18 * ACPICA policy for new _OSI strings: 19 * 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: 25 * 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. 30 * 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 34 * will be executed. 35 * 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. 39 * 40 *****************************************************************************/ 41 /* 42 * Strings supported by the _OSI predefined control method (which is 43 * implemented internally within this module.) 44 * 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. 49 * 50 * The last element of each entry is used to track the newest version of 51 * Windows that the BIOS has requested. 52 */ 53 static struct acpi_interface_info acpi_default_supported_interfaces[] = { 54 /* Operating System Vendor Strings */ 55 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_1}, /* 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 */ 73 {"Windows 2018", NULL, 0, ACPI_OSI_WIN_10_RS4}, /* Windows 10 version 1803 - Added 11/2018 */ 74 {"Windows 2018.2", NULL, 0, ACPI_OSI_WIN_10_RS5}, /* Windows 10 version 1809 - Added 11/2018 */ 75 {"Windows 2019", NULL, 0, ACPI_OSI_WIN_10_19H1}, /* Windows 10 version 1903 - Added 08/2019 */ 76 {"Windows 2020", NULL, 0, ACPI_OSI_WIN_10_20H1}, /* Windows 10 version 2004 - Added 08/2021 */ 77 78 /* Feature Group Strings */ 79 80 {"Extended Address Space Descriptor", NULL, ACPI_OSI_FEATURE, 0}, 81 82 /* 83 * All "optional" feature group strings (features that are implemented 84 * by the host) should be dynamically modified to VALID by the host via 85 * acpi_install_interface or acpi_update_interfaces. Such optional feature 86 * group strings are set as INVALID by default here. 87 */ 88 89 {"Module Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}, 90 {"Processor Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}, 91 {"3.0 Thermal Model", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}, 92 {"3.0 _SCP Extensions", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}, 93 {"Processor Aggregator Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0} 94 }; 95 96 /******************************************************************************* 97 * 98 * FUNCTION: acpi_ut_initialize_interfaces 99 * 100 * PARAMETERS: None 101 * 102 * RETURN: Status 103 * 104 * DESCRIPTION: Initialize the global _OSI supported interfaces list 105 * 106 ******************************************************************************/ 107 108 acpi_status acpi_ut_initialize_interfaces(void) 109 { 110 acpi_status status; 111 u32 i; 112 113 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER); 114 if (ACPI_FAILURE(status)) { 115 return (status); 116 } 117 118 acpi_gbl_supported_interfaces = acpi_default_supported_interfaces; 119 120 /* Link the static list of supported interfaces */ 121 122 for (i = 0; 123 i < (ACPI_ARRAY_LENGTH(acpi_default_supported_interfaces) - 1); 124 i++) { 125 acpi_default_supported_interfaces[i].next = 126 &acpi_default_supported_interfaces[(acpi_size)i + 1]; 127 } 128 129 acpi_os_release_mutex(acpi_gbl_osi_mutex); 130 return (AE_OK); 131 } 132 133 /******************************************************************************* 134 * 135 * FUNCTION: acpi_ut_interface_terminate 136 * 137 * PARAMETERS: None 138 * 139 * RETURN: Status 140 * 141 * DESCRIPTION: Delete all interfaces in the global list. Sets 142 * acpi_gbl_supported_interfaces to NULL. 143 * 144 ******************************************************************************/ 145 146 acpi_status acpi_ut_interface_terminate(void) 147 { 148 acpi_status status; 149 struct acpi_interface_info *next_interface; 150 151 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER); 152 if (ACPI_FAILURE(status)) { 153 return (status); 154 } 155 156 next_interface = acpi_gbl_supported_interfaces; 157 while (next_interface) { 158 acpi_gbl_supported_interfaces = next_interface->next; 159 160 if (next_interface->flags & ACPI_OSI_DYNAMIC) { 161 162 /* Only interfaces added at runtime can be freed */ 163 164 ACPI_FREE(next_interface->name); 165 ACPI_FREE(next_interface); 166 } else { 167 /* Interface is in static list. Reset it to invalid or valid. */ 168 169 if (next_interface->flags & ACPI_OSI_DEFAULT_INVALID) { 170 next_interface->flags |= ACPI_OSI_INVALID; 171 } else { 172 next_interface->flags &= ~ACPI_OSI_INVALID; 173 } 174 } 175 176 next_interface = acpi_gbl_supported_interfaces; 177 } 178 179 acpi_os_release_mutex(acpi_gbl_osi_mutex); 180 return (AE_OK); 181 } 182 183 /******************************************************************************* 184 * 185 * FUNCTION: acpi_ut_install_interface 186 * 187 * PARAMETERS: interface_name - The interface to install 188 * 189 * RETURN: Status 190 * 191 * DESCRIPTION: Install the interface into the global interface list. 192 * Caller MUST hold acpi_gbl_osi_mutex 193 * 194 ******************************************************************************/ 195 196 acpi_status acpi_ut_install_interface(acpi_string interface_name) 197 { 198 struct acpi_interface_info *interface_info; 199 200 /* Allocate info block and space for the name string */ 201 202 interface_info = 203 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_interface_info)); 204 if (!interface_info) { 205 return (AE_NO_MEMORY); 206 } 207 208 interface_info->name = ACPI_ALLOCATE_ZEROED(strlen(interface_name) + 1); 209 if (!interface_info->name) { 210 ACPI_FREE(interface_info); 211 return (AE_NO_MEMORY); 212 } 213 214 /* Initialize new info and insert at the head of the global list */ 215 216 strcpy(interface_info->name, interface_name); 217 interface_info->flags = ACPI_OSI_DYNAMIC; 218 interface_info->next = acpi_gbl_supported_interfaces; 219 220 acpi_gbl_supported_interfaces = interface_info; 221 return (AE_OK); 222 } 223 224 /******************************************************************************* 225 * 226 * FUNCTION: acpi_ut_remove_interface 227 * 228 * PARAMETERS: interface_name - The interface to remove 229 * 230 * RETURN: Status 231 * 232 * DESCRIPTION: Remove the interface from the global interface list. 233 * Caller MUST hold acpi_gbl_osi_mutex 234 * 235 ******************************************************************************/ 236 237 acpi_status acpi_ut_remove_interface(acpi_string interface_name) 238 { 239 struct acpi_interface_info *previous_interface; 240 struct acpi_interface_info *next_interface; 241 242 previous_interface = next_interface = acpi_gbl_supported_interfaces; 243 while (next_interface) { 244 if (!strcmp(interface_name, next_interface->name)) { 245 /* 246 * Found: name is in either the static list 247 * or was added at runtime 248 */ 249 if (next_interface->flags & ACPI_OSI_DYNAMIC) { 250 251 /* Interface was added dynamically, remove and free it */ 252 253 if (previous_interface == next_interface) { 254 acpi_gbl_supported_interfaces = 255 next_interface->next; 256 } else { 257 previous_interface->next = 258 next_interface->next; 259 } 260 261 ACPI_FREE(next_interface->name); 262 ACPI_FREE(next_interface); 263 } else { 264 /* 265 * Interface is in static list. If marked invalid, then 266 * it does not actually exist. Else, mark it invalid. 267 */ 268 if (next_interface->flags & ACPI_OSI_INVALID) { 269 return (AE_NOT_EXIST); 270 } 271 272 next_interface->flags |= ACPI_OSI_INVALID; 273 } 274 275 return (AE_OK); 276 } 277 278 previous_interface = next_interface; 279 next_interface = next_interface->next; 280 } 281 282 /* Interface was not found */ 283 284 return (AE_NOT_EXIST); 285 } 286 287 /******************************************************************************* 288 * 289 * FUNCTION: acpi_ut_update_interfaces 290 * 291 * PARAMETERS: action - Actions to be performed during the 292 * update 293 * 294 * RETURN: Status 295 * 296 * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor 297 * strings or/and feature group strings. 298 * Caller MUST hold acpi_gbl_osi_mutex 299 * 300 ******************************************************************************/ 301 302 acpi_status acpi_ut_update_interfaces(u8 action) 303 { 304 struct acpi_interface_info *next_interface; 305 306 next_interface = acpi_gbl_supported_interfaces; 307 while (next_interface) { 308 if (((next_interface->flags & ACPI_OSI_FEATURE) && 309 (action & ACPI_FEATURE_STRINGS)) || 310 (!(next_interface->flags & ACPI_OSI_FEATURE) && 311 (action & ACPI_VENDOR_STRINGS))) { 312 if (action & ACPI_DISABLE_INTERFACES) { 313 314 /* Mark the interfaces as invalid */ 315 316 next_interface->flags |= ACPI_OSI_INVALID; 317 } else { 318 /* Mark the interfaces as valid */ 319 320 next_interface->flags &= ~ACPI_OSI_INVALID; 321 } 322 } 323 324 next_interface = next_interface->next; 325 } 326 327 return (AE_OK); 328 } 329 330 /******************************************************************************* 331 * 332 * FUNCTION: acpi_ut_get_interface 333 * 334 * PARAMETERS: interface_name - The interface to find 335 * 336 * RETURN: struct acpi_interface_info if found. NULL if not found. 337 * 338 * DESCRIPTION: Search for the specified interface name in the global list. 339 * Caller MUST hold acpi_gbl_osi_mutex 340 * 341 ******************************************************************************/ 342 343 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name) 344 { 345 struct acpi_interface_info *next_interface; 346 347 next_interface = acpi_gbl_supported_interfaces; 348 while (next_interface) { 349 if (!strcmp(interface_name, next_interface->name)) { 350 return (next_interface); 351 } 352 353 next_interface = next_interface->next; 354 } 355 356 return (NULL); 357 } 358 359 /******************************************************************************* 360 * 361 * FUNCTION: acpi_ut_osi_implementation 362 * 363 * PARAMETERS: walk_state - Current walk state 364 * 365 * RETURN: Status 366 * Integer: TRUE (0) if input string is matched 367 * FALSE (-1) if string is not matched 368 * 369 * DESCRIPTION: Implementation of the _OSI predefined control method. When 370 * an invocation of _OSI is encountered in the system AML, 371 * control is transferred to this function. 372 * 373 * (August 2016) 374 * Note: _OSI is now defined to return "Ones" to indicate a match, for 375 * compatibility with other ACPI implementations. On a 32-bit DSDT, Ones 376 * is 0xFFFFFFFF. On a 64-bit DSDT, Ones is 0xFFFFFFFFFFFFFFFF 377 * (ACPI_UINT64_MAX). 378 * 379 * This function always returns ACPI_UINT64_MAX for TRUE, and later code 380 * will truncate this to 32 bits if necessary. 381 * 382 ******************************************************************************/ 383 384 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state) 385 { 386 union acpi_operand_object *string_desc; 387 union acpi_operand_object *return_desc; 388 struct acpi_interface_info *interface_info; 389 acpi_interface_handler interface_handler; 390 acpi_status status; 391 u64 return_value; 392 393 ACPI_FUNCTION_TRACE(ut_osi_implementation); 394 395 /* Validate the string input argument (from the AML caller) */ 396 397 string_desc = walk_state->arguments[0].object; 398 if (!string_desc || (string_desc->common.type != ACPI_TYPE_STRING)) { 399 return_ACPI_STATUS(AE_TYPE); 400 } 401 402 /* Create a return object */ 403 404 return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER); 405 if (!return_desc) { 406 return_ACPI_STATUS(AE_NO_MEMORY); 407 } 408 409 /* Default return value is 0, NOT SUPPORTED */ 410 411 return_value = 0; 412 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER); 413 if (ACPI_FAILURE(status)) { 414 acpi_ut_remove_reference(return_desc); 415 return_ACPI_STATUS(status); 416 } 417 418 /* Lookup the interface in the global _OSI list */ 419 420 interface_info = acpi_ut_get_interface(string_desc->string.pointer); 421 if (interface_info && !(interface_info->flags & ACPI_OSI_INVALID)) { 422 /* 423 * The interface is supported. 424 * Update the osi_data if necessary. We keep track of the latest 425 * version of Windows that has been requested by the BIOS. 426 */ 427 if (interface_info->value > acpi_gbl_osi_data) { 428 acpi_gbl_osi_data = interface_info->value; 429 } 430 431 return_value = ACPI_UINT64_MAX; 432 } 433 434 acpi_os_release_mutex(acpi_gbl_osi_mutex); 435 436 /* 437 * Invoke an optional _OSI interface handler. The host OS may wish 438 * to do some interface-specific handling. For example, warn about 439 * certain interfaces or override the true/false support value. 440 */ 441 interface_handler = acpi_gbl_interface_handler; 442 if (interface_handler) { 443 if (interface_handler 444 (string_desc->string.pointer, (u32)return_value)) { 445 return_value = ACPI_UINT64_MAX; 446 } 447 } 448 449 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO, 450 "ACPI: BIOS _OSI(\"%s\") is %ssupported\n", 451 string_desc->string.pointer, 452 return_value == 0 ? "not " : "")); 453 454 /* Complete the return object */ 455 456 return_desc->integer.value = return_value; 457 walk_state->return_desc = return_desc; 458 return_ACPI_STATUS(AE_OK); 459 } 460