blob: 22c09952e177918fdefa400b02a51f483c6fb880 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 */
21
22#include <linux/kernel.h>
23#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/init.h>
26#include <linux/types.h>
Toshi Kanifbfddae2012-11-21 01:36:28 +000027#include <linux/hardirq.h>
28#include <linux/acpi.h>
Bjørn Mork45fef5b2014-05-22 12:47:47 +020029#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Len Browna192a952009-07-28 16:45:54 -040031#include "internal.h"
Lukas Wunner2d12b6b2015-11-25 21:19:55 +010032#include "sleep.h"
Len Browna192a952009-07-28 16:45:54 -040033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#define _COMPONENT ACPI_BUS_COMPONENT
Len Brownf52fd662007-02-12 22:42:12 -050035ACPI_MODULE_NAME("utils");
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37/* --------------------------------------------------------------------------
38 Object Evaluation Helpers
39 -------------------------------------------------------------------------- */
Harvey Harrison4fd7f512008-02-15 17:07:19 -080040static void
41acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
42{
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#ifdef ACPI_DEBUG_OUTPUT
Harvey Harrison4fd7f512008-02-15 17:07:19 -080044 char prefix[80] = {'\0'};
45 struct acpi_buffer buffer = {sizeof(prefix), prefix};
46 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
47 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
48 (char *) prefix, p, acpi_format_exception(s)));
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#else
Harvey Harrison4fd7f512008-02-15 17:07:19 -080050 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#endif
Harvey Harrison4fd7f512008-02-15 17:07:19 -080052}
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040055acpi_extract_package(union acpi_object *package,
56 struct acpi_buffer *format, struct acpi_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
Len Brown4be44fc2005-08-05 00:44:28 -040058 u32 size_required = 0;
59 u32 tail_offset = 0;
60 char *format_string = NULL;
61 u32 format_count = 0;
62 u32 i = 0;
63 u8 *head = NULL;
64 u8 *tail = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Len Brown4be44fc2005-08-05 00:44:28 -040067 if (!package || (package->type != ACPI_TYPE_PACKAGE)
68 || (package->package.count < 1)) {
Len Browncece9292006-06-26 23:04:31 -040069 printk(KERN_WARNING PREFIX "Invalid package argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040070 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 }
72
73 if (!format || !format->pointer || (format->length < 1)) {
Len Browncece9292006-06-26 23:04:31 -040074 printk(KERN_WARNING PREFIX "Invalid format argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040075 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 }
77
78 if (!buffer) {
Len Browncece9292006-06-26 23:04:31 -040079 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040080 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 }
82
Len Brown4be44fc2005-08-05 00:44:28 -040083 format_count = (format->length / sizeof(char)) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 if (format_count > package->package.count) {
Len Browncece9292006-06-26 23:04:31 -040085 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
86 " than exist in package [%d].\n",
87 format_count, package->package.count);
Patrick Mocheld550d982006-06-27 00:41:40 -040088 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 }
90
Jan Engelhardt50dd0962006-10-01 00:28:50 +020091 format_string = format->pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93 /*
94 * Calculate size_required.
95 */
Len Brown4be44fc2005-08-05 00:44:28 -040096 for (i = 0; i < format_count; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98 union acpi_object *element = &(package->package.elements[i]);
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 switch (element->type) {
101
102 case ACPI_TYPE_INTEGER:
103 switch (format_string[i]) {
104 case 'N':
Lin Ming439913f2010-01-28 10:53:19 +0800105 size_required += sizeof(u64);
106 tail_offset += sizeof(u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 break;
108 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400109 size_required +=
Lin Ming439913f2010-01-28 10:53:19 +0800110 sizeof(char *) + sizeof(u64) +
Len Brown4be44fc2005-08-05 00:44:28 -0400111 sizeof(char);
112 tail_offset += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 break;
114 default:
Len Browncece9292006-06-26 23:04:31 -0400115 printk(KERN_WARNING PREFIX "Invalid package element"
Colin Ian Kinge7e92ec92013-10-29 10:34:19 +0000116 " [%d]: got number, expecting"
Len Browncece9292006-06-26 23:04:31 -0400117 " [%c]\n",
118 i, format_string[i]);
Patrick Mocheld550d982006-06-27 00:41:40 -0400119 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 break;
121 }
122 break;
123
124 case ACPI_TYPE_STRING:
125 case ACPI_TYPE_BUFFER:
126 switch (format_string[i]) {
127 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400128 size_required +=
129 sizeof(char *) +
130 (element->string.length * sizeof(char)) +
131 sizeof(char);
132 tail_offset += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 break;
134 case 'B':
Len Brown4be44fc2005-08-05 00:44:28 -0400135 size_required +=
Fabian Frederickd93de342014-11-16 10:57:00 +0100136 sizeof(u8 *) + element->buffer.length;
Len Brown4be44fc2005-08-05 00:44:28 -0400137 tail_offset += sizeof(u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 break;
139 default:
Len Browncece9292006-06-26 23:04:31 -0400140 printk(KERN_WARNING PREFIX "Invalid package element"
Thomas Renningera6fc6722006-06-26 23:58:43 -0400141 " [%d] got string/buffer,"
Colin Ian Kinge7e92ec92013-10-29 10:34:19 +0000142 " expecting [%c]\n",
Len Browncece9292006-06-26 23:04:31 -0400143 i, format_string[i]);
Patrick Mocheld550d982006-06-27 00:41:40 -0400144 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 break;
146 }
147 break;
Zhang Ruie3ec4832014-03-16 21:34:16 +0800148 case ACPI_TYPE_LOCAL_REFERENCE:
149 switch (format_string[i]) {
150 case 'R':
151 size_required += sizeof(void *);
152 tail_offset += sizeof(void *);
153 break;
154 default:
155 printk(KERN_WARNING PREFIX "Invalid package element"
156 " [%d] got reference,"
157 " expecting [%c]\n",
158 i, format_string[i]);
159 return AE_BAD_DATA;
160 break;
161 }
162 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164 case ACPI_TYPE_PACKAGE:
165 default:
Len Brown4be44fc2005-08-05 00:44:28 -0400166 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
167 "Found unsupported element at index=%d\n",
168 i));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 /* TBD: handle nested packages... */
Patrick Mocheld550d982006-06-27 00:41:40 -0400170 return AE_SUPPORT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 break;
172 }
173 }
174
175 /*
176 * Validate output buffer.
177 */
Al Stonee83dda02013-10-09 14:21:10 -0600178 if (buffer->length == ACPI_ALLOCATE_BUFFER) {
jhbird.choi@samsung.com2d0acb42014-03-20 16:35:56 +0900179 buffer->pointer = ACPI_ALLOCATE_ZEROED(size_required);
Al Stonee83dda02013-10-09 14:21:10 -0600180 if (!buffer->pointer)
181 return AE_NO_MEMORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 buffer->length = size_required;
Al Stonee83dda02013-10-09 14:21:10 -0600183 } else {
184 if (buffer->length < size_required) {
185 buffer->length = size_required;
186 return AE_BUFFER_OVERFLOW;
187 } else if (buffer->length != size_required ||
188 !buffer->pointer) {
189 return AE_BAD_PARAMETER;
190 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 }
192
193 head = buffer->pointer;
194 tail = buffer->pointer + tail_offset;
195
196 /*
197 * Extract package data.
198 */
Len Brown4be44fc2005-08-05 00:44:28 -0400199 for (i = 0; i < format_count; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201 u8 **pointer = NULL;
202 union acpi_object *element = &(package->package.elements[i]);
203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 switch (element->type) {
205
206 case ACPI_TYPE_INTEGER:
207 switch (format_string[i]) {
208 case 'N':
Lin Ming439913f2010-01-28 10:53:19 +0800209 *((u64 *) head) =
Len Brown4be44fc2005-08-05 00:44:28 -0400210 element->integer.value;
Lin Ming439913f2010-01-28 10:53:19 +0800211 head += sizeof(u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 break;
213 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400214 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 *pointer = tail;
Lin Ming439913f2010-01-28 10:53:19 +0800216 *((u64 *) tail) =
Len Brown4be44fc2005-08-05 00:44:28 -0400217 element->integer.value;
Lin Ming439913f2010-01-28 10:53:19 +0800218 head += sizeof(u64 *);
219 tail += sizeof(u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 /* NULL terminate string */
221 *tail = (char)0;
222 tail += sizeof(char);
223 break;
224 default:
225 /* Should never get here */
226 break;
227 }
228 break;
229
230 case ACPI_TYPE_STRING:
231 case ACPI_TYPE_BUFFER:
232 switch (format_string[i]) {
233 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400234 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400236 memcpy(tail, element->string.pointer,
237 element->string.length);
238 head += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 tail += element->string.length * sizeof(char);
240 /* NULL terminate string */
241 *tail = (char)0;
242 tail += sizeof(char);
243 break;
244 case 'B':
Len Brown4be44fc2005-08-05 00:44:28 -0400245 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400247 memcpy(tail, element->buffer.pointer,
248 element->buffer.length);
249 head += sizeof(u8 *);
Fabian Frederickd93de342014-11-16 10:57:00 +0100250 tail += element->buffer.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 break;
252 default:
253 /* Should never get here */
254 break;
255 }
256 break;
Zhang Ruie3ec4832014-03-16 21:34:16 +0800257 case ACPI_TYPE_LOCAL_REFERENCE:
258 switch (format_string[i]) {
259 case 'R':
260 *(void **)head =
261 (void *)element->reference.handle;
262 head += sizeof(void *);
263 break;
264 default:
265 /* Should never get here */
266 break;
267 }
268 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 case ACPI_TYPE_PACKAGE:
270 /* TBD: handle nested packages... */
271 default:
272 /* Should never get here */
273 break;
274 }
275 }
276
Patrick Mocheld550d982006-06-27 00:41:40 -0400277 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
Len Brown4be44fc2005-08-05 00:44:28 -0400279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280EXPORT_SYMBOL(acpi_extract_package);
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400283acpi_evaluate_integer(acpi_handle handle,
284 acpi_string pathname,
Matthew Wilcox27663c52008-10-10 02:22:59 -0400285 struct acpi_object_list *arguments, unsigned long long *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Len Brown4be44fc2005-08-05 00:44:28 -0400287 acpi_status status = AE_OK;
Pavel Machek40599072008-11-25 12:05:08 +0100288 union acpi_object element;
Len Brown4be44fc2005-08-05 00:44:28 -0400289 struct acpi_buffer buffer = { 0, NULL };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 if (!data)
Patrick Mocheld550d982006-06-27 00:41:40 -0400292 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 buffer.length = sizeof(union acpi_object);
Pavel Machek40599072008-11-25 12:05:08 +0100295 buffer.pointer = &element;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
297 if (ACPI_FAILURE(status)) {
298 acpi_util_eval_error(handle, pathname, status);
Patrick Mocheld550d982006-06-27 00:41:40 -0400299 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 }
301
Pavel Machek40599072008-11-25 12:05:08 +0100302 if (element.type != ACPI_TYPE_INTEGER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
Patrick Mocheld550d982006-06-27 00:41:40 -0400304 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 }
306
Pavel Machek40599072008-11-25 12:05:08 +0100307 *data = element.integer.value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Matthew Wilcox27663c52008-10-10 02:22:59 -0400309 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Patrick Mocheld550d982006-06-27 00:41:40 -0400311 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Len Brown4be44fc2005-08-05 00:44:28 -0400314EXPORT_SYMBOL(acpi_evaluate_integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400317acpi_evaluate_reference(acpi_handle handle,
318 acpi_string pathname,
319 struct acpi_object_list *arguments,
320 struct acpi_handle_list *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
Len Brown4be44fc2005-08-05 00:44:28 -0400322 acpi_status status = AE_OK;
323 union acpi_object *package = NULL;
324 union acpi_object *element = NULL;
325 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
326 u32 i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329 if (!list) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400330 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 }
332
333 /* Evaluate object. */
334
335 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
336 if (ACPI_FAILURE(status))
337 goto end;
338
Jan Engelhardt50dd0962006-10-01 00:28:50 +0200339 package = buffer.pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341 if ((buffer.length == 0) || !package) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 status = AE_BAD_DATA;
343 acpi_util_eval_error(handle, pathname, status);
344 goto end;
345 }
346 if (package->type != ACPI_TYPE_PACKAGE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 status = AE_BAD_DATA;
348 acpi_util_eval_error(handle, pathname, status);
349 goto end;
350 }
351 if (!package->package.count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 status = AE_BAD_DATA;
353 acpi_util_eval_error(handle, pathname, status);
354 goto end;
355 }
356
357 if (package->package.count > ACPI_MAX_HANDLES) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400358 return AE_NO_MEMORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 }
360 list->count = package->package.count;
361
362 /* Extract package data. */
363
364 for (i = 0; i < list->count; i++) {
365
366 element = &(package->package.elements[i]);
367
Bob Moorecd0b2242008-04-10 19:06:43 +0400368 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 status = AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 acpi_util_eval_error(handle, pathname, status);
371 break;
372 }
373
Thomas Renningerb6a16382008-03-12 01:06:24 +0100374 if (!element->reference.handle) {
Thomas Renningerb6a16382008-03-12 01:06:24 +0100375 status = AE_NULL_ENTRY;
Rafael J. Wysockic48cf1b2014-12-12 22:51:01 +0100376 acpi_util_eval_error(handle, pathname, status);
Thomas Renningerb6a16382008-03-12 01:06:24 +0100377 break;
378 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 /* Get the acpi_handle. */
380
381 list->handles[i] = element->reference.handle;
382 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400383 list->handles[i]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 }
385
Len Brown4be44fc2005-08-05 00:44:28 -0400386 end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 if (ACPI_FAILURE(status)) {
388 list->count = 0;
389 //kfree(list->handles);
390 }
391
Len Brown02438d82006-06-30 03:19:10 -0400392 kfree(buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Patrick Mocheld550d982006-06-27 00:41:40 -0400394 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Len Brown4be44fc2005-08-05 00:44:28 -0400397EXPORT_SYMBOL(acpi_evaluate_reference);
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800398
399acpi_status
Feng Tang8ede06a2012-08-21 09:56:58 +0800400acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800401{
402 acpi_status status;
403 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
404 union acpi_object *output;
405
406 status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
407
408 if (ACPI_FAILURE(status))
409 return status;
410
411 output = buffer.pointer;
412
413 if (!output || output->type != ACPI_TYPE_PACKAGE
414 || !output->package.count
415 || output->package.elements[0].type != ACPI_TYPE_BUFFER
Feng Tang8ede06a2012-08-21 09:56:58 +0800416 || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800417 status = AE_TYPE;
418 goto out;
419 }
420
Feng Tang8ede06a2012-08-21 09:56:58 +0800421 status = acpi_decode_pld_buffer(
422 output->package.elements[0].buffer.pointer,
423 output->package.elements[0].buffer.length,
424 pld);
425
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800426out:
427 kfree(buffer.pointer);
428 return status;
429}
430EXPORT_SYMBOL(acpi_get_physical_device_location);
Toshi Kani275c58d2012-05-23 20:25:19 -0600431
432/**
Rafael J. Wysocki700b8422014-02-21 01:07:17 +0100433 * acpi_evaluate_ost: Evaluate _OST for hotplug operations
Toshi Kani275c58d2012-05-23 20:25:19 -0600434 * @handle: ACPI device handle
435 * @source_event: source event code
436 * @status_code: status code
437 * @status_buf: optional detailed information (NULL if none)
438 *
439 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
440 * must call this function when evaluating _OST for hotplug operations.
441 * When the platform does not support _OST, this function has no effect.
442 */
443acpi_status
Jiang Liu05730c12014-02-19 14:02:15 +0800444acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
445 struct acpi_buffer *status_buf)
Toshi Kani275c58d2012-05-23 20:25:19 -0600446{
Toshi Kani275c58d2012-05-23 20:25:19 -0600447 union acpi_object params[3] = {
448 {.type = ACPI_TYPE_INTEGER,},
449 {.type = ACPI_TYPE_INTEGER,},
450 {.type = ACPI_TYPE_BUFFER,}
451 };
452 struct acpi_object_list arg_list = {3, params};
Toshi Kani275c58d2012-05-23 20:25:19 -0600453
454 params[0].integer.value = source_event;
455 params[1].integer.value = status_code;
456 if (status_buf != NULL) {
457 params[2].buffer.pointer = status_buf->pointer;
458 params[2].buffer.length = status_buf->length;
459 } else {
460 params[2].buffer.pointer = NULL;
461 params[2].buffer.length = 0;
462 }
463
Jiang Liu05730c12014-02-19 14:02:15 +0800464 return acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
Toshi Kani275c58d2012-05-23 20:25:19 -0600465}
Jiang Liu05730c12014-02-19 14:02:15 +0800466EXPORT_SYMBOL(acpi_evaluate_ost);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000467
468/**
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200469 * acpi_handle_path: Return the object path of handle
470 *
471 * Caller must free the returned buffer
472 */
473static char *acpi_handle_path(acpi_handle handle)
474{
475 struct acpi_buffer buffer = {
476 .length = ACPI_ALLOCATE_BUFFER,
477 .pointer = NULL
478 };
479
480 if (in_interrupt() ||
481 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
482 return NULL;
483 return buffer.pointer;
484}
485
486/**
Toshi Kanifbfddae2012-11-21 01:36:28 +0000487 * acpi_handle_printk: Print message with ACPI prefix and object path
488 *
489 * This function is called through acpi_handle_<level> macros and prints
490 * a message with ACPI prefix and object path. This function acquires
491 * the global namespace mutex to obtain an object path. In interrupt
492 * context, it shows the object path as <n/a>.
493 */
494void
495acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
496{
497 struct va_format vaf;
498 va_list args;
Toshi Kanifbfddae2012-11-21 01:36:28 +0000499 const char *path;
500
501 va_start(args, fmt);
502 vaf.fmt = fmt;
503 vaf.va = &args;
504
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200505 path = acpi_handle_path(handle);
506 printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000507
508 va_end(args);
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200509 kfree(path);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000510}
511EXPORT_SYMBOL(acpi_handle_printk);
Jiang Liu952c63e2013-06-29 00:24:38 +0800512
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200513#if defined(CONFIG_DYNAMIC_DEBUG)
514/**
515 * __acpi_handle_debug: pr_debug with ACPI prefix and object path
516 *
517 * This function is called through acpi_handle_debug macro and debug
518 * prints a message with ACPI prefix and object path. This function
519 * acquires the global namespace mutex to obtain an object path. In
520 * interrupt context, it shows the object path as <n/a>.
521 */
522void
523__acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
524 const char *fmt, ...)
525{
526 struct va_format vaf;
527 va_list args;
528 const char *path;
529
530 va_start(args, fmt);
531 vaf.fmt = fmt;
532 vaf.va = &args;
533
534 path = acpi_handle_path(handle);
535 __dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
536
537 va_end(args);
538 kfree(path);
539}
540EXPORT_SYMBOL(__acpi_handle_debug);
541#endif
542
Jiang Liu952c63e2013-06-29 00:24:38 +0800543/**
544 * acpi_has_method: Check whether @handle has a method named @name
545 * @handle: ACPI device handle
546 * @name: name of object or method
547 *
548 * Check whether @handle has a method named @name.
549 */
550bool acpi_has_method(acpi_handle handle, char *name)
551{
552 acpi_handle tmp;
553
554 return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
555}
556EXPORT_SYMBOL(acpi_has_method);
Jiang Liu0db98202013-06-29 00:24:39 +0800557
558acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
559 u64 arg)
560{
561 union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
562 struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
563
564 obj.integer.value = arg;
565
566 return acpi_evaluate_object(handle, method, &arg_list, NULL);
567}
568EXPORT_SYMBOL(acpi_execute_simple_method);
Jiang Liu7d2421f2013-06-29 00:24:40 +0800569
570/**
571 * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
572 * @handle: ACPI device handle
573 *
574 * Evaluate device's _EJ0 method for hotplug operations.
575 */
576acpi_status acpi_evaluate_ej0(acpi_handle handle)
577{
578 acpi_status status;
579
580 status = acpi_execute_simple_method(handle, "_EJ0", 1);
581 if (status == AE_NOT_FOUND)
582 acpi_handle_warn(handle, "No _EJ0 support for device\n");
583 else if (ACPI_FAILURE(status))
584 acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
585
586 return status;
587}
588
589/**
590 * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
591 * @handle: ACPI device handle
592 * @lock: lock device if non-zero, otherwise unlock device
593 *
594 * Evaluate device's _LCK method if present to lock/unlock device
595 */
596acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
597{
598 acpi_status status;
599
600 status = acpi_execute_simple_method(handle, "_LCK", !!lock);
601 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
602 if (lock)
603 acpi_handle_warn(handle,
604 "Locking device failed (0x%x)\n", status);
605 else
606 acpi_handle_warn(handle,
607 "Unlocking device failed (0x%x)\n", status);
608 }
609
610 return status;
611}
Jiang Liua65ac522013-12-19 20:38:10 +0800612
613/**
614 * acpi_evaluate_dsm - evaluate device's _DSM method
615 * @handle: ACPI device handle
616 * @uuid: UUID of requested functions, should be 16 bytes
617 * @rev: revision number of requested function
618 * @func: requested function number
619 * @argv4: the function specific parameter
620 *
621 * Evaluate device's _DSM method with specified UUID, revision id and
622 * function number. Caller needs to free the returned object.
623 *
624 * Though ACPI defines the fourth parameter for _DSM should be a package,
625 * some old BIOSes do expect a buffer or an integer etc.
626 */
627union acpi_object *
Jerry Hoemannc7e16e52016-04-11 15:02:26 -0700628acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid, u64 rev, u64 func,
Jiang Liua65ac522013-12-19 20:38:10 +0800629 union acpi_object *argv4)
630{
631 acpi_status ret;
632 struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
633 union acpi_object params[4];
634 struct acpi_object_list input = {
635 .count = 4,
636 .pointer = params,
637 };
638
639 params[0].type = ACPI_TYPE_BUFFER;
640 params[0].buffer.length = 16;
641 params[0].buffer.pointer = (char *)uuid;
642 params[1].type = ACPI_TYPE_INTEGER;
643 params[1].integer.value = rev;
644 params[2].type = ACPI_TYPE_INTEGER;
645 params[2].integer.value = func;
646 if (argv4) {
647 params[3] = *argv4;
648 } else {
649 params[3].type = ACPI_TYPE_PACKAGE;
650 params[3].package.count = 0;
651 params[3].package.elements = NULL;
652 }
653
654 ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
655 if (ACPI_SUCCESS(ret))
656 return (union acpi_object *)buf.pointer;
657
658 if (ret != AE_NOT_FOUND)
659 acpi_handle_warn(handle,
660 "failed to evaluate _DSM (0x%x)\n", ret);
661
662 return NULL;
663}
664EXPORT_SYMBOL(acpi_evaluate_dsm);
665
666/**
667 * acpi_check_dsm - check if _DSM method supports requested functions.
668 * @handle: ACPI device handle
669 * @uuid: UUID of requested functions, should be 16 bytes at least
670 * @rev: revision number of requested functions
671 * @funcs: bitmap of requested functions
Jiang Liua65ac522013-12-19 20:38:10 +0800672 *
673 * Evaluate device's _DSM method to check whether it supports requested
674 * functions. Currently only support 64 functions at maximum, should be
675 * enough for now.
676 */
Jerry Hoemannc7e16e52016-04-11 15:02:26 -0700677bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, u64 rev, u64 funcs)
Jiang Liua65ac522013-12-19 20:38:10 +0800678{
679 int i;
680 u64 mask = 0;
681 union acpi_object *obj;
682
683 if (funcs == 0)
684 return false;
685
686 obj = acpi_evaluate_dsm(handle, uuid, rev, 0, NULL);
687 if (!obj)
688 return false;
689
690 /* For compatibility, old BIOSes may return an integer */
691 if (obj->type == ACPI_TYPE_INTEGER)
692 mask = obj->integer.value;
693 else if (obj->type == ACPI_TYPE_BUFFER)
694 for (i = 0; i < obj->buffer.length && i < 8; i++)
Colin Ian King4a798f52016-03-18 15:08:01 +0000695 mask |= (((u64)obj->buffer.pointer[i]) << (i * 8));
Jiang Liua65ac522013-12-19 20:38:10 +0800696 ACPI_FREE(obj);
697
698 /*
699 * Bit 0 indicates whether there's support for any functions other than
700 * function 0 for the specified UUID and revision.
701 */
702 if ((mask & 0x1) && (mask & funcs) == funcs)
703 return true;
704
705 return false;
706}
707EXPORT_SYMBOL(acpi_check_dsm);
Hans de Goede14ca7a472015-06-16 16:27:47 +0200708
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100709/**
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100710 * acpi_dev_found - Detect presence of a given ACPI device in the namespace.
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100711 * @hid: Hardware ID of the device.
712 *
713 * Return %true if the device was present at the moment of invocation.
714 * Note that if the device is pluggable, it may since have disappeared.
715 *
716 * For this function to work, acpi_bus_scan() must have been executed
717 * which happens in the subsys_initcall() subsection. Hence, do not
718 * call from a subsys_initcall() or earlier (use acpi_get_devices()
719 * instead). Calling from module_init() is fine (which is synonymous
720 * with device_initcall()).
721 */
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100722bool acpi_dev_found(const char *hid)
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100723{
724 struct acpi_device_bus_id *acpi_device_bus_id;
725 bool found = false;
726
727 mutex_lock(&acpi_device_lock);
728 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
729 if (!strcmp(acpi_device_bus_id->bus_id, hid)) {
730 found = true;
731 break;
732 }
733 mutex_unlock(&acpi_device_lock);
734
735 return found;
736}
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100737EXPORT_SYMBOL(acpi_dev_found);
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100738
Hans de Goede14ca7a472015-06-16 16:27:47 +0200739/*
740 * acpi_backlight= handling, this is done here rather then in video_detect.c
741 * because __setup cannot be used in modules.
742 */
743char acpi_video_backlight_string[16];
744EXPORT_SYMBOL(acpi_video_backlight_string);
745
746static int __init acpi_backlight(char *str)
747{
748 strlcpy(acpi_video_backlight_string, str,
749 sizeof(acpi_video_backlight_string));
750 return 1;
751}
752__setup("acpi_backlight=", acpi_backlight);