1 /******************************************************************************
2 *
3 * Module Name: utosi - Support for the _OSI predefined control method
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2013, 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/acpi.h>
45 #include "accommon.h"
46
47 #define _COMPONENT ACPI_UTILITIES
48 ACPI_MODULE_NAME("utosi")
49
50 /*
51 * Strings supported by the _OSI predefined control method (which is
52 * implemented internally within this module.)
53 *
54 * March 2009: Removed "Linux" as this host no longer wants to respond true
55 * for this string. Basically, the only safe OS strings are windows-related
56 * and in many or most cases represent the only test path within the
57 * BIOS-provided ASL code.
58 *
59 * The last element of each entry is used to track the newest version of
60 * Windows that the BIOS has requested.
61 */
62 static struct acpi_interface_info acpi_default_supported_interfaces[] = {
63 /* Operating System Vendor Strings */
64
65 {"Windows 2000", NULL, 0, ACPI_OSI_WIN_2000}, /* Windows 2000 */
66 {"Windows 2001", NULL, 0, ACPI_OSI_WIN_XP}, /* Windows XP */
67 {"Windows 2001 SP1", NULL, 0, ACPI_OSI_WIN_XP_SP1}, /* Windows XP SP1 */
68 {"Windows 2001.1", NULL, 0, ACPI_OSI_WINSRV_2003}, /* Windows Server 2003 */
69 {"Windows 2001 SP2", NULL, 0, ACPI_OSI_WIN_XP_SP2}, /* Windows XP SP2 */
70 {"Windows 2001.1 SP1", NULL, 0, ACPI_OSI_WINSRV_2003_SP1}, /* Windows Server 2003 SP1 - Added 03/2006 */
71 {"Windows 2006", NULL, 0, ACPI_OSI_WIN_VISTA}, /* Windows vista - Added 03/2006 */
72 {"Windows 2006.1", NULL, 0, ACPI_OSI_WINSRV_2008}, /* Windows Server 2008 - Added 09/2009 */
73 {"Windows 2006 SP1", NULL, 0, ACPI_OSI_WIN_VISTA_SP1}, /* Windows Vista SP1 - Added 09/2009 */
74 {"Windows 2006 SP2", NULL, 0, ACPI_OSI_WIN_VISTA_SP2}, /* Windows Vista SP2 - Added 09/2010 */
75 {"Windows 2009", NULL, 0, ACPI_OSI_WIN_7}, /* Windows 7 and Server 2008 R2 - Added 09/2009 */
76 {"Windows 2012", NULL, 0, ACPI_OSI_WIN_8}, /* Windows 8 and Server 2012 - Added 08/2012 */
77
78 /* Feature Group Strings */
79
80 {"Extended Address Space Descriptor", NULL, 0, 0}
81
82 /*
83 * All "optional" feature group strings (features that are implemented
84 * by the host) should be dynamically added by the host via
85 * acpi_install_interface and should not be manually added here.
86 *
87 * Examples of optional feature group strings:
88 *
89 * "Module Device"
90 * "Processor Device"
91 * "3.0 Thermal Model"
92 * "3.0 _SCP Extensions"
93 * "Processor Aggregator Device"
94 */
95 };
96
97 /*******************************************************************************
98 *
99 * FUNCTION: acpi_ut_initialize_interfaces
100 *
101 * PARAMETERS: None
102 *
103 * RETURN: Status
104 *
105 * DESCRIPTION: Initialize the global _OSI supported interfaces list
106 *
107 ******************************************************************************/
108
acpi_ut_initialize_interfaces(void)109 acpi_status acpi_ut_initialize_interfaces(void)
110 {
111 acpi_status status;
112 u32 i;
113
114 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
115 if (ACPI_FAILURE(status)) {
116 return (status);
117 }
118
119 acpi_gbl_supported_interfaces = acpi_default_supported_interfaces;
120
121 /* Link the static list of supported interfaces */
122
123 for (i = 0;
124 i < (ACPI_ARRAY_LENGTH(acpi_default_supported_interfaces) - 1);
125 i++) {
126 acpi_default_supported_interfaces[i].next =
127 &acpi_default_supported_interfaces[(acpi_size) i + 1];
128 }
129
130 acpi_os_release_mutex(acpi_gbl_osi_mutex);
131 return (AE_OK);
132 }
133
134 /*******************************************************************************
135 *
136 * FUNCTION: acpi_ut_interface_terminate
137 *
138 * PARAMETERS: None
139 *
140 * RETURN: Status
141 *
142 * DESCRIPTION: Delete all interfaces in the global list. Sets
143 * acpi_gbl_supported_interfaces to NULL.
144 *
145 ******************************************************************************/
146
acpi_ut_interface_terminate(void)147 acpi_status acpi_ut_interface_terminate(void)
148 {
149 acpi_status status;
150 struct acpi_interface_info *next_interface;
151
152 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
153 if (ACPI_FAILURE(status)) {
154 return (status);
155 }
156
157 next_interface = acpi_gbl_supported_interfaces;
158 while (next_interface) {
159 acpi_gbl_supported_interfaces = next_interface->next;
160
161 /* Only interfaces added at runtime can be freed */
162
163 if (next_interface->flags & ACPI_OSI_DYNAMIC) {
164 ACPI_FREE(next_interface->name);
165 ACPI_FREE(next_interface);
166 }
167
168 next_interface = acpi_gbl_supported_interfaces;
169 }
170
171 acpi_os_release_mutex(acpi_gbl_osi_mutex);
172 return (AE_OK);
173 }
174
175 /*******************************************************************************
176 *
177 * FUNCTION: acpi_ut_install_interface
178 *
179 * PARAMETERS: interface_name - The interface to install
180 *
181 * RETURN: Status
182 *
183 * DESCRIPTION: Install the interface into the global interface list.
184 * Caller MUST hold acpi_gbl_osi_mutex
185 *
186 ******************************************************************************/
187
acpi_ut_install_interface(acpi_string interface_name)188 acpi_status acpi_ut_install_interface(acpi_string interface_name)
189 {
190 struct acpi_interface_info *interface_info;
191
192 /* Allocate info block and space for the name string */
193
194 interface_info =
195 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_interface_info));
196 if (!interface_info) {
197 return (AE_NO_MEMORY);
198 }
199
200 interface_info->name =
201 ACPI_ALLOCATE_ZEROED(ACPI_STRLEN(interface_name) + 1);
202 if (!interface_info->name) {
203 ACPI_FREE(interface_info);
204 return (AE_NO_MEMORY);
205 }
206
207 /* Initialize new info and insert at the head of the global list */
208
209 ACPI_STRCPY(interface_info->name, interface_name);
210 interface_info->flags = ACPI_OSI_DYNAMIC;
211 interface_info->next = acpi_gbl_supported_interfaces;
212
213 acpi_gbl_supported_interfaces = interface_info;
214 return (AE_OK);
215 }
216
217 /*******************************************************************************
218 *
219 * FUNCTION: acpi_ut_remove_interface
220 *
221 * PARAMETERS: interface_name - The interface to remove
222 *
223 * RETURN: Status
224 *
225 * DESCRIPTION: Remove the interface from the global interface list.
226 * Caller MUST hold acpi_gbl_osi_mutex
227 *
228 ******************************************************************************/
229
acpi_ut_remove_interface(acpi_string interface_name)230 acpi_status acpi_ut_remove_interface(acpi_string interface_name)
231 {
232 struct acpi_interface_info *previous_interface;
233 struct acpi_interface_info *next_interface;
234
235 previous_interface = next_interface = acpi_gbl_supported_interfaces;
236 while (next_interface) {
237 if (!ACPI_STRCMP(interface_name, next_interface->name)) {
238
239 /* Found: name is in either the static list or was added at runtime */
240
241 if (next_interface->flags & ACPI_OSI_DYNAMIC) {
242
243 /* Interface was added dynamically, remove and free it */
244
245 if (previous_interface == next_interface) {
246 acpi_gbl_supported_interfaces =
247 next_interface->next;
248 } else {
249 previous_interface->next =
250 next_interface->next;
251 }
252
253 ACPI_FREE(next_interface->name);
254 ACPI_FREE(next_interface);
255 } else {
256 /*
257 * Interface is in static list. If marked invalid, then it
258 * does not actually exist. Else, mark it invalid.
259 */
260 if (next_interface->flags & ACPI_OSI_INVALID) {
261 return (AE_NOT_EXIST);
262 }
263
264 next_interface->flags |= ACPI_OSI_INVALID;
265 }
266
267 return (AE_OK);
268 }
269
270 previous_interface = next_interface;
271 next_interface = next_interface->next;
272 }
273
274 /* Interface was not found */
275
276 return (AE_NOT_EXIST);
277 }
278
279 /*******************************************************************************
280 *
281 * FUNCTION: acpi_ut_get_interface
282 *
283 * PARAMETERS: interface_name - The interface to find
284 *
285 * RETURN: struct acpi_interface_info if found. NULL if not found.
286 *
287 * DESCRIPTION: Search for the specified interface name in the global list.
288 * Caller MUST hold acpi_gbl_osi_mutex
289 *
290 ******************************************************************************/
291
acpi_ut_get_interface(acpi_string interface_name)292 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name)
293 {
294 struct acpi_interface_info *next_interface;
295
296 next_interface = acpi_gbl_supported_interfaces;
297 while (next_interface) {
298 if (!ACPI_STRCMP(interface_name, next_interface->name)) {
299 return (next_interface);
300 }
301
302 next_interface = next_interface->next;
303 }
304
305 return (NULL);
306 }
307
308 /*******************************************************************************
309 *
310 * FUNCTION: acpi_ut_osi_implementation
311 *
312 * PARAMETERS: walk_state - Current walk state
313 *
314 * RETURN: Status
315 *
316 * DESCRIPTION: Implementation of the _OSI predefined control method. When
317 * an invocation of _OSI is encountered in the system AML,
318 * control is transferred to this function.
319 *
320 ******************************************************************************/
321
acpi_ut_osi_implementation(struct acpi_walk_state * walk_state)322 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state * walk_state)
323 {
324 union acpi_operand_object *string_desc;
325 union acpi_operand_object *return_desc;
326 struct acpi_interface_info *interface_info;
327 acpi_interface_handler interface_handler;
328 acpi_status status;
329 u32 return_value;
330
331 ACPI_FUNCTION_TRACE(ut_osi_implementation);
332
333 /* Validate the string input argument (from the AML caller) */
334
335 string_desc = walk_state->arguments[0].object;
336 if (!string_desc || (string_desc->common.type != ACPI_TYPE_STRING)) {
337 return_ACPI_STATUS(AE_TYPE);
338 }
339
340 /* Create a return object */
341
342 return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
343 if (!return_desc) {
344 return_ACPI_STATUS(AE_NO_MEMORY);
345 }
346
347 /* Default return value is 0, NOT SUPPORTED */
348
349 return_value = 0;
350 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
351 if (ACPI_FAILURE(status)) {
352 acpi_ut_remove_reference(return_desc);
353 return_ACPI_STATUS(status);
354 }
355
356 /* Lookup the interface in the global _OSI list */
357
358 interface_info = acpi_ut_get_interface(string_desc->string.pointer);
359 if (interface_info && !(interface_info->flags & ACPI_OSI_INVALID)) {
360 /*
361 * The interface is supported.
362 * Update the osi_data if necessary. We keep track of the latest
363 * version of Windows that has been requested by the BIOS.
364 */
365 if (interface_info->value > acpi_gbl_osi_data) {
366 acpi_gbl_osi_data = interface_info->value;
367 }
368
369 return_value = ACPI_UINT32_MAX;
370 }
371
372 acpi_os_release_mutex(acpi_gbl_osi_mutex);
373
374 /*
375 * Invoke an optional _OSI interface handler. The host OS may wish
376 * to do some interface-specific handling. For example, warn about
377 * certain interfaces or override the true/false support value.
378 */
379 interface_handler = acpi_gbl_interface_handler;
380 if (interface_handler) {
381 return_value =
382 interface_handler(string_desc->string.pointer,
383 return_value);
384 }
385
386 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO,
387 "ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
388 string_desc->string.pointer,
389 return_value == 0 ? "not " : ""));
390
391 /* Complete the return object */
392
393 return_desc->integer.value = return_value;
394 walk_state->return_desc = return_desc;
395 return_ACPI_STATUS(AE_OK);
396 }
397