blob: 78db97687f26a1512130ffadda01f3372dd4ae34 [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) {
Xiongfeng Wang09e15082017-11-09 14:22:39 +0800358 kfree(package);
Patrick Mocheld550d982006-06-27 00:41:40 -0400359 return AE_NO_MEMORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 }
361 list->count = package->package.count;
362
363 /* Extract package data. */
364
365 for (i = 0; i < list->count; i++) {
366
367 element = &(package->package.elements[i]);
368
Bob Moorecd0b2242008-04-10 19:06:43 +0400369 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 status = AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 acpi_util_eval_error(handle, pathname, status);
372 break;
373 }
374
Thomas Renningerb6a16382008-03-12 01:06:24 +0100375 if (!element->reference.handle) {
Thomas Renningerb6a16382008-03-12 01:06:24 +0100376 status = AE_NULL_ENTRY;
Rafael J. Wysockic48cf1b2014-12-12 22:51:01 +0100377 acpi_util_eval_error(handle, pathname, status);
Thomas Renningerb6a16382008-03-12 01:06:24 +0100378 break;
379 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 /* Get the acpi_handle. */
381
382 list->handles[i] = element->reference.handle;
383 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400384 list->handles[i]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 }
386
Len Brown4be44fc2005-08-05 00:44:28 -0400387 end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 if (ACPI_FAILURE(status)) {
389 list->count = 0;
390 //kfree(list->handles);
391 }
392
Len Brown02438d82006-06-30 03:19:10 -0400393 kfree(buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Patrick Mocheld550d982006-06-27 00:41:40 -0400395 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
Len Brown4be44fc2005-08-05 00:44:28 -0400398EXPORT_SYMBOL(acpi_evaluate_reference);
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800399
400acpi_status
Feng Tang8ede06a2012-08-21 09:56:58 +0800401acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800402{
403 acpi_status status;
404 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
405 union acpi_object *output;
406
407 status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
408
409 if (ACPI_FAILURE(status))
410 return status;
411
412 output = buffer.pointer;
413
414 if (!output || output->type != ACPI_TYPE_PACKAGE
415 || !output->package.count
416 || output->package.elements[0].type != ACPI_TYPE_BUFFER
Feng Tang8ede06a2012-08-21 09:56:58 +0800417 || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800418 status = AE_TYPE;
419 goto out;
420 }
421
Feng Tang8ede06a2012-08-21 09:56:58 +0800422 status = acpi_decode_pld_buffer(
423 output->package.elements[0].buffer.pointer,
424 output->package.elements[0].buffer.length,
425 pld);
426
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800427out:
428 kfree(buffer.pointer);
429 return status;
430}
431EXPORT_SYMBOL(acpi_get_physical_device_location);
Toshi Kani275c58d2012-05-23 20:25:19 -0600432
433/**
Rafael J. Wysocki700b8422014-02-21 01:07:17 +0100434 * acpi_evaluate_ost: Evaluate _OST for hotplug operations
Toshi Kani275c58d2012-05-23 20:25:19 -0600435 * @handle: ACPI device handle
436 * @source_event: source event code
437 * @status_code: status code
438 * @status_buf: optional detailed information (NULL if none)
439 *
440 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
441 * must call this function when evaluating _OST for hotplug operations.
442 * When the platform does not support _OST, this function has no effect.
443 */
444acpi_status
Jiang Liu05730c12014-02-19 14:02:15 +0800445acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
446 struct acpi_buffer *status_buf)
Toshi Kani275c58d2012-05-23 20:25:19 -0600447{
Toshi Kani275c58d2012-05-23 20:25:19 -0600448 union acpi_object params[3] = {
449 {.type = ACPI_TYPE_INTEGER,},
450 {.type = ACPI_TYPE_INTEGER,},
451 {.type = ACPI_TYPE_BUFFER,}
452 };
453 struct acpi_object_list arg_list = {3, params};
Toshi Kani275c58d2012-05-23 20:25:19 -0600454
455 params[0].integer.value = source_event;
456 params[1].integer.value = status_code;
457 if (status_buf != NULL) {
458 params[2].buffer.pointer = status_buf->pointer;
459 params[2].buffer.length = status_buf->length;
460 } else {
461 params[2].buffer.pointer = NULL;
462 params[2].buffer.length = 0;
463 }
464
Jiang Liu05730c12014-02-19 14:02:15 +0800465 return acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
Toshi Kani275c58d2012-05-23 20:25:19 -0600466}
Jiang Liu05730c12014-02-19 14:02:15 +0800467EXPORT_SYMBOL(acpi_evaluate_ost);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000468
469/**
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200470 * acpi_handle_path: Return the object path of handle
471 *
472 * Caller must free the returned buffer
473 */
474static char *acpi_handle_path(acpi_handle handle)
475{
476 struct acpi_buffer buffer = {
477 .length = ACPI_ALLOCATE_BUFFER,
478 .pointer = NULL
479 };
480
481 if (in_interrupt() ||
482 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
483 return NULL;
484 return buffer.pointer;
485}
486
487/**
Toshi Kanifbfddae2012-11-21 01:36:28 +0000488 * acpi_handle_printk: Print message with ACPI prefix and object path
489 *
490 * This function is called through acpi_handle_<level> macros and prints
491 * a message with ACPI prefix and object path. This function acquires
492 * the global namespace mutex to obtain an object path. In interrupt
493 * context, it shows the object path as <n/a>.
494 */
495void
496acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
497{
498 struct va_format vaf;
499 va_list args;
Toshi Kanifbfddae2012-11-21 01:36:28 +0000500 const char *path;
501
502 va_start(args, fmt);
503 vaf.fmt = fmt;
504 vaf.va = &args;
505
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200506 path = acpi_handle_path(handle);
507 printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000508
509 va_end(args);
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200510 kfree(path);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000511}
512EXPORT_SYMBOL(acpi_handle_printk);
Jiang Liu952c63e2013-06-29 00:24:38 +0800513
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200514#if defined(CONFIG_DYNAMIC_DEBUG)
515/**
516 * __acpi_handle_debug: pr_debug with ACPI prefix and object path
517 *
518 * This function is called through acpi_handle_debug macro and debug
519 * prints a message with ACPI prefix and object path. This function
520 * acquires the global namespace mutex to obtain an object path. In
521 * interrupt context, it shows the object path as <n/a>.
522 */
523void
524__acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
525 const char *fmt, ...)
526{
527 struct va_format vaf;
528 va_list args;
529 const char *path;
530
531 va_start(args, fmt);
532 vaf.fmt = fmt;
533 vaf.va = &args;
534
535 path = acpi_handle_path(handle);
536 __dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
537
538 va_end(args);
539 kfree(path);
540}
541EXPORT_SYMBOL(__acpi_handle_debug);
542#endif
543
Jiang Liu952c63e2013-06-29 00:24:38 +0800544/**
545 * acpi_has_method: Check whether @handle has a method named @name
546 * @handle: ACPI device handle
547 * @name: name of object or method
548 *
549 * Check whether @handle has a method named @name.
550 */
551bool acpi_has_method(acpi_handle handle, char *name)
552{
553 acpi_handle tmp;
554
555 return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
556}
557EXPORT_SYMBOL(acpi_has_method);
Jiang Liu0db98202013-06-29 00:24:39 +0800558
559acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
560 u64 arg)
561{
562 union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
563 struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
564
565 obj.integer.value = arg;
566
567 return acpi_evaluate_object(handle, method, &arg_list, NULL);
568}
569EXPORT_SYMBOL(acpi_execute_simple_method);
Jiang Liu7d2421f2013-06-29 00:24:40 +0800570
571/**
572 * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
573 * @handle: ACPI device handle
574 *
575 * Evaluate device's _EJ0 method for hotplug operations.
576 */
577acpi_status acpi_evaluate_ej0(acpi_handle handle)
578{
579 acpi_status status;
580
581 status = acpi_execute_simple_method(handle, "_EJ0", 1);
582 if (status == AE_NOT_FOUND)
583 acpi_handle_warn(handle, "No _EJ0 support for device\n");
584 else if (ACPI_FAILURE(status))
585 acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
586
587 return status;
588}
589
590/**
591 * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
592 * @handle: ACPI device handle
593 * @lock: lock device if non-zero, otherwise unlock device
594 *
595 * Evaluate device's _LCK method if present to lock/unlock device
596 */
597acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
598{
599 acpi_status status;
600
601 status = acpi_execute_simple_method(handle, "_LCK", !!lock);
602 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
603 if (lock)
604 acpi_handle_warn(handle,
605 "Locking device failed (0x%x)\n", status);
606 else
607 acpi_handle_warn(handle,
608 "Unlocking device failed (0x%x)\n", status);
609 }
610
611 return status;
612}
Jiang Liua65ac522013-12-19 20:38:10 +0800613
614/**
615 * acpi_evaluate_dsm - evaluate device's _DSM method
616 * @handle: ACPI device handle
Andy Shevchenko94116f82017-06-05 19:40:46 +0300617 * @guid: GUID of requested functions, should be 16 bytes
Jiang Liua65ac522013-12-19 20:38:10 +0800618 * @rev: revision number of requested function
619 * @func: requested function number
620 * @argv4: the function specific parameter
621 *
Andy Shevchenko94116f82017-06-05 19:40:46 +0300622 * Evaluate device's _DSM method with specified GUID, revision id and
Jiang Liua65ac522013-12-19 20:38:10 +0800623 * function number. Caller needs to free the returned object.
624 *
625 * Though ACPI defines the fourth parameter for _DSM should be a package,
626 * some old BIOSes do expect a buffer or an integer etc.
627 */
628union acpi_object *
Andy Shevchenko94116f82017-06-05 19:40:46 +0300629acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 func,
Jiang Liua65ac522013-12-19 20:38:10 +0800630 union acpi_object *argv4)
631{
632 acpi_status ret;
633 struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
634 union acpi_object params[4];
635 struct acpi_object_list input = {
636 .count = 4,
637 .pointer = params,
638 };
639
640 params[0].type = ACPI_TYPE_BUFFER;
641 params[0].buffer.length = 16;
Andy Shevchenko94116f82017-06-05 19:40:46 +0300642 params[0].buffer.pointer = (u8 *)guid;
Jiang Liua65ac522013-12-19 20:38:10 +0800643 params[1].type = ACPI_TYPE_INTEGER;
644 params[1].integer.value = rev;
645 params[2].type = ACPI_TYPE_INTEGER;
646 params[2].integer.value = func;
647 if (argv4) {
648 params[3] = *argv4;
649 } else {
650 params[3].type = ACPI_TYPE_PACKAGE;
651 params[3].package.count = 0;
652 params[3].package.elements = NULL;
653 }
654
655 ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
656 if (ACPI_SUCCESS(ret))
657 return (union acpi_object *)buf.pointer;
658
659 if (ret != AE_NOT_FOUND)
660 acpi_handle_warn(handle,
661 "failed to evaluate _DSM (0x%x)\n", ret);
662
663 return NULL;
664}
665EXPORT_SYMBOL(acpi_evaluate_dsm);
666
667/**
668 * acpi_check_dsm - check if _DSM method supports requested functions.
669 * @handle: ACPI device handle
Andy Shevchenko94116f82017-06-05 19:40:46 +0300670 * @guid: GUID of requested functions, should be 16 bytes at least
Jiang Liua65ac522013-12-19 20:38:10 +0800671 * @rev: revision number of requested functions
672 * @funcs: bitmap of requested functions
Jiang Liua65ac522013-12-19 20:38:10 +0800673 *
674 * Evaluate device's _DSM method to check whether it supports requested
675 * functions. Currently only support 64 functions at maximum, should be
676 * enough for now.
677 */
Andy Shevchenko94116f82017-06-05 19:40:46 +0300678bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs)
Jiang Liua65ac522013-12-19 20:38:10 +0800679{
680 int i;
681 u64 mask = 0;
682 union acpi_object *obj;
683
Dan Williamsa7225592016-07-19 12:32:39 -0700684 if (funcs == 0)
685 return false;
686
Andy Shevchenko94116f82017-06-05 19:40:46 +0300687 obj = acpi_evaluate_dsm(handle, guid, rev, 0, NULL);
Jiang Liua65ac522013-12-19 20:38:10 +0800688 if (!obj)
689 return false;
690
691 /* For compatibility, old BIOSes may return an integer */
692 if (obj->type == ACPI_TYPE_INTEGER)
693 mask = obj->integer.value;
694 else if (obj->type == ACPI_TYPE_BUFFER)
695 for (i = 0; i < obj->buffer.length && i < 8; i++)
Colin Ian King4a798f52016-03-18 15:08:01 +0000696 mask |= (((u64)obj->buffer.pointer[i]) << (i * 8));
Jiang Liua65ac522013-12-19 20:38:10 +0800697 ACPI_FREE(obj);
698
699 /*
700 * Bit 0 indicates whether there's support for any functions other than
Andy Shevchenko94116f82017-06-05 19:40:46 +0300701 * function 0 for the specified GUID and revision.
Jiang Liua65ac522013-12-19 20:38:10 +0800702 */
703 if ((mask & 0x1) && (mask & funcs) == funcs)
704 return true;
705
706 return false;
707}
708EXPORT_SYMBOL(acpi_check_dsm);
Hans de Goede14ca7a472015-06-16 16:27:47 +0200709
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100710/**
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100711 * acpi_dev_found - Detect presence of a given ACPI device in the namespace.
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100712 * @hid: Hardware ID of the device.
713 *
714 * Return %true if the device was present at the moment of invocation.
715 * Note that if the device is pluggable, it may since have disappeared.
716 *
717 * For this function to work, acpi_bus_scan() must have been executed
718 * which happens in the subsys_initcall() subsection. Hence, do not
719 * call from a subsys_initcall() or earlier (use acpi_get_devices()
720 * instead). Calling from module_init() is fine (which is synonymous
721 * with device_initcall()).
722 */
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100723bool acpi_dev_found(const char *hid)
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100724{
725 struct acpi_device_bus_id *acpi_device_bus_id;
726 bool found = false;
727
728 mutex_lock(&acpi_device_lock);
729 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
730 if (!strcmp(acpi_device_bus_id->bus_id, hid)) {
731 found = true;
732 break;
733 }
734 mutex_unlock(&acpi_device_lock);
735
736 return found;
737}
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100738EXPORT_SYMBOL(acpi_dev_found);
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100739
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200740struct acpi_dev_match_info {
741 const char *dev_name;
Hans de Goede86614232017-04-19 14:02:08 +0200742 struct acpi_device_id hid[2];
743 const char *uid;
744 s64 hrv;
745};
746
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200747static int acpi_dev_match_cb(struct device *dev, void *data)
Hans de Goede86614232017-04-19 14:02:08 +0200748{
749 struct acpi_device *adev = to_acpi_device(dev);
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200750 struct acpi_dev_match_info *match = data;
Hans de Goede86614232017-04-19 14:02:08 +0200751 unsigned long long hrv;
752 acpi_status status;
753
754 if (acpi_match_device_ids(adev, match->hid))
755 return 0;
756
757 if (match->uid && (!adev->pnp.unique_id ||
758 strcmp(adev->pnp.unique_id, match->uid)))
759 return 0;
760
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200761 match->dev_name = acpi_dev_name(adev);
762
Hans de Goede86614232017-04-19 14:02:08 +0200763 if (match->hrv == -1)
764 return 1;
765
766 status = acpi_evaluate_integer(adev->handle, "_HRV", NULL, &hrv);
767 if (ACPI_FAILURE(status))
768 return 0;
769
770 return hrv == match->hrv;
771}
772
773/**
774 * acpi_dev_present - Detect that a given ACPI device is present
775 * @hid: Hardware ID of the device.
776 * @uid: Unique ID of the device, pass NULL to not check _UID
777 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
778 *
779 * Return %true if a matching device was present at the moment of invocation.
780 * Note that if the device is pluggable, it may since have disappeared.
781 *
782 * Note that unlike acpi_dev_found() this function checks the status
783 * of the device. So for devices which are present in the dsdt, but
784 * which are disabled (their _STA callback returns 0) this function
785 * will return false.
786 *
787 * For this function to work, acpi_bus_scan() must have been executed
788 * which happens in the subsys_initcall() subsection. Hence, do not
789 * call from a subsys_initcall() or earlier (use acpi_get_devices()
790 * instead). Calling from module_init() is fine (which is synonymous
791 * with device_initcall()).
792 */
793bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
794{
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200795 struct acpi_dev_match_info match = {};
Hans de Goede86614232017-04-19 14:02:08 +0200796 struct device *dev;
797
798 strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
799 match.uid = uid;
800 match.hrv = hrv;
801
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200802 dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
Hans de Goede86614232017-04-19 14:02:08 +0200803 return !!dev;
804}
805EXPORT_SYMBOL(acpi_dev_present);
806
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200807/**
808 * acpi_dev_get_first_match_name - Return name of first match of ACPI device
809 * @hid: Hardware ID of the device.
810 * @uid: Unique ID of the device, pass NULL to not check _UID
811 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
812 *
813 * Return device name if a matching device was present
814 * at the moment of invocation, or NULL otherwise.
815 *
816 * See additional information in acpi_dev_present() as well.
817 */
818const char *
819acpi_dev_get_first_match_name(const char *hid, const char *uid, s64 hrv)
820{
821 struct acpi_dev_match_info match = {};
822 struct device *dev;
823
824 strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
825 match.uid = uid;
826 match.hrv = hrv;
827
828 dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
829 return dev ? match.dev_name : NULL;
830}
831EXPORT_SYMBOL(acpi_dev_get_first_match_name);
832
Hans de Goede14ca7a472015-06-16 16:27:47 +0200833/*
834 * acpi_backlight= handling, this is done here rather then in video_detect.c
835 * because __setup cannot be used in modules.
836 */
837char acpi_video_backlight_string[16];
838EXPORT_SYMBOL(acpi_video_backlight_string);
839
840static int __init acpi_backlight(char *str)
841{
842 strlcpy(acpi_video_backlight_string, str,
843 sizeof(acpi_video_backlight_string));
844 return 1;
845}
846__setup("acpi_backlight=", acpi_backlight);
Toshi Kani5aa59112017-08-23 16:54:43 -0600847
848/**
849 * acpi_match_platform_list - Check if the system matches with a given list
850 * @plat: pointer to acpi_platform_list table terminated by a NULL entry
851 *
852 * Return the matched index if the system is found in the platform list.
853 * Otherwise, return a negative error code.
854 */
855int acpi_match_platform_list(const struct acpi_platform_list *plat)
856{
857 struct acpi_table_header hdr;
858 int idx = 0;
859
860 if (acpi_disabled)
861 return -ENODEV;
862
863 for (; plat->oem_id[0]; plat++, idx++) {
864 if (ACPI_FAILURE(acpi_get_table_header(plat->table, 0, &hdr)))
865 continue;
866
867 if (strncmp(plat->oem_id, hdr.oem_id, ACPI_OEM_ID_SIZE))
868 continue;
869
870 if (strncmp(plat->oem_table_id, hdr.oem_table_id, ACPI_OEM_TABLE_ID_SIZE))
871 continue;
872
873 if ((plat->pred == all_versions) ||
874 (plat->pred == less_than_or_equal && hdr.oem_revision <= plat->oem_revision) ||
875 (plat->pred == greater_than_or_equal && hdr.oem_revision >= plat->oem_revision) ||
876 (plat->pred == equal && hdr.oem_revision == plat->oem_revision))
877 return idx;
878 }
879
880 return -ENODEV;
881}
882EXPORT_SYMBOL(acpi_match_platform_list);