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