blob: 7def63ab00c0ce411f385217d037b2e393faea01 [file] [log] [blame]
Thomas Gleixnerc942fdd2019-05-27 08:55:06 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
4 *
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
9#include <linux/kernel.h>
10#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/init.h>
13#include <linux/types.h>
Toshi Kanifbfddae2012-11-21 01:36:28 +000014#include <linux/hardirq.h>
15#include <linux/acpi.h>
Bjørn Mork45fef5b2014-05-22 12:47:47 +020016#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Len Browna192a952009-07-28 16:45:54 -040018#include "internal.h"
Lukas Wunner2d12b6b2015-11-25 21:19:55 +010019#include "sleep.h"
Len Browna192a952009-07-28 16:45:54 -040020
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#define _COMPONENT ACPI_BUS_COMPONENT
Len Brownf52fd662007-02-12 22:42:12 -050022ACPI_MODULE_NAME("utils");
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24/* --------------------------------------------------------------------------
25 Object Evaluation Helpers
26 -------------------------------------------------------------------------- */
Harvey Harrison4fd7f512008-02-15 17:07:19 -080027static void
28acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
29{
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#ifdef ACPI_DEBUG_OUTPUT
Harvey Harrison4fd7f512008-02-15 17:07:19 -080031 char prefix[80] = {'\0'};
32 struct acpi_buffer buffer = {sizeof(prefix), prefix};
33 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
34 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
35 (char *) prefix, p, acpi_format_exception(s)));
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#else
Harvey Harrison4fd7f512008-02-15 17:07:19 -080037 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#endif
Harvey Harrison4fd7f512008-02-15 17:07:19 -080039}
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040042acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -070044{
Len Brown4be44fc2005-08-05 00:44:28 -040045 u32 size_required = 0;
46 u32 tail_offset = 0;
47 char *format_string = NULL;
48 u32 format_count = 0;
49 u32 i = 0;
50 u8 *head = NULL;
51 u8 *tail = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Len Brown4be44fc2005-08-05 00:44:28 -040054 if (!package || (package->type != ACPI_TYPE_PACKAGE)
55 || (package->package.count < 1)) {
Len Browncece9292006-06-26 23:04:31 -040056 printk(KERN_WARNING PREFIX "Invalid package argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040057 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 }
59
60 if (!format || !format->pointer || (format->length < 1)) {
Len Browncece9292006-06-26 23:04:31 -040061 printk(KERN_WARNING PREFIX "Invalid format argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040062 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 }
64
65 if (!buffer) {
Len Browncece9292006-06-26 23:04:31 -040066 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040067 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 }
69
Len Brown4be44fc2005-08-05 00:44:28 -040070 format_count = (format->length / sizeof(char)) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 if (format_count > package->package.count) {
Len Browncece9292006-06-26 23:04:31 -040072 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
73 " than exist in package [%d].\n",
74 format_count, package->package.count);
Patrick Mocheld550d982006-06-27 00:41:40 -040075 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 }
77
Jan Engelhardt50dd0962006-10-01 00:28:50 +020078 format_string = format->pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80 /*
81 * Calculate size_required.
82 */
Len Brown4be44fc2005-08-05 00:44:28 -040083 for (i = 0; i < format_count; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85 union acpi_object *element = &(package->package.elements[i]);
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 switch (element->type) {
88
89 case ACPI_TYPE_INTEGER:
90 switch (format_string[i]) {
91 case 'N':
Lin Ming439913f2010-01-28 10:53:19 +080092 size_required += sizeof(u64);
93 tail_offset += sizeof(u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 break;
95 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -040096 size_required +=
Lin Ming439913f2010-01-28 10:53:19 +080097 sizeof(char *) + sizeof(u64) +
Len Brown4be44fc2005-08-05 00:44:28 -040098 sizeof(char);
99 tail_offset += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 break;
101 default:
Len Browncece9292006-06-26 23:04:31 -0400102 printk(KERN_WARNING PREFIX "Invalid package element"
Colin Ian Kinge7e92ec92013-10-29 10:34:19 +0000103 " [%d]: got number, expecting"
Len Browncece9292006-06-26 23:04:31 -0400104 " [%c]\n",
105 i, format_string[i]);
Patrick Mocheld550d982006-06-27 00:41:40 -0400106 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 break;
108 }
109 break;
110
111 case ACPI_TYPE_STRING:
112 case ACPI_TYPE_BUFFER:
113 switch (format_string[i]) {
114 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400115 size_required +=
116 sizeof(char *) +
117 (element->string.length * sizeof(char)) +
118 sizeof(char);
119 tail_offset += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 break;
121 case 'B':
Len Brown4be44fc2005-08-05 00:44:28 -0400122 size_required +=
Fabian Frederickd93de342014-11-16 10:57:00 +0100123 sizeof(u8 *) + element->buffer.length;
Len Brown4be44fc2005-08-05 00:44:28 -0400124 tail_offset += sizeof(u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 break;
126 default:
Len Browncece9292006-06-26 23:04:31 -0400127 printk(KERN_WARNING PREFIX "Invalid package element"
Thomas Renningera6fc6722006-06-26 23:58:43 -0400128 " [%d] got string/buffer,"
Colin Ian Kinge7e92ec92013-10-29 10:34:19 +0000129 " expecting [%c]\n",
Len Browncece9292006-06-26 23:04:31 -0400130 i, format_string[i]);
Patrick Mocheld550d982006-06-27 00:41:40 -0400131 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 break;
133 }
134 break;
Zhang Ruie3ec4832014-03-16 21:34:16 +0800135 case ACPI_TYPE_LOCAL_REFERENCE:
136 switch (format_string[i]) {
137 case 'R':
138 size_required += sizeof(void *);
139 tail_offset += sizeof(void *);
140 break;
141 default:
142 printk(KERN_WARNING PREFIX "Invalid package element"
143 " [%d] got reference,"
144 " expecting [%c]\n",
145 i, format_string[i]);
146 return AE_BAD_DATA;
147 break;
148 }
149 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151 case ACPI_TYPE_PACKAGE:
152 default:
Len Brown4be44fc2005-08-05 00:44:28 -0400153 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
154 "Found unsupported element at index=%d\n",
155 i));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 /* TBD: handle nested packages... */
Patrick Mocheld550d982006-06-27 00:41:40 -0400157 return AE_SUPPORT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 break;
159 }
160 }
161
162 /*
163 * Validate output buffer.
164 */
Al Stonee83dda02013-10-09 14:21:10 -0600165 if (buffer->length == ACPI_ALLOCATE_BUFFER) {
jhbird.choi@samsung.com2d0acb42014-03-20 16:35:56 +0900166 buffer->pointer = ACPI_ALLOCATE_ZEROED(size_required);
Al Stonee83dda02013-10-09 14:21:10 -0600167 if (!buffer->pointer)
168 return AE_NO_MEMORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 buffer->length = size_required;
Al Stonee83dda02013-10-09 14:21:10 -0600170 } else {
171 if (buffer->length < size_required) {
172 buffer->length = size_required;
173 return AE_BUFFER_OVERFLOW;
174 } else if (buffer->length != size_required ||
175 !buffer->pointer) {
176 return AE_BAD_PARAMETER;
177 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 }
179
180 head = buffer->pointer;
181 tail = buffer->pointer + tail_offset;
182
183 /*
184 * Extract package data.
185 */
Len Brown4be44fc2005-08-05 00:44:28 -0400186 for (i = 0; i < format_count; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188 u8 **pointer = NULL;
189 union acpi_object *element = &(package->package.elements[i]);
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 switch (element->type) {
192
193 case ACPI_TYPE_INTEGER:
194 switch (format_string[i]) {
195 case 'N':
Lin Ming439913f2010-01-28 10:53:19 +0800196 *((u64 *) head) =
Len Brown4be44fc2005-08-05 00:44:28 -0400197 element->integer.value;
Lin Ming439913f2010-01-28 10:53:19 +0800198 head += sizeof(u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 break;
200 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400201 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 *pointer = tail;
Lin Ming439913f2010-01-28 10:53:19 +0800203 *((u64 *) tail) =
Len Brown4be44fc2005-08-05 00:44:28 -0400204 element->integer.value;
Lin Ming439913f2010-01-28 10:53:19 +0800205 head += sizeof(u64 *);
206 tail += sizeof(u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 /* NULL terminate string */
208 *tail = (char)0;
209 tail += sizeof(char);
210 break;
211 default:
212 /* Should never get here */
213 break;
214 }
215 break;
216
217 case ACPI_TYPE_STRING:
218 case ACPI_TYPE_BUFFER:
219 switch (format_string[i]) {
220 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400221 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400223 memcpy(tail, element->string.pointer,
224 element->string.length);
225 head += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 tail += element->string.length * sizeof(char);
227 /* NULL terminate string */
228 *tail = (char)0;
229 tail += sizeof(char);
230 break;
231 case 'B':
Len Brown4be44fc2005-08-05 00:44:28 -0400232 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400234 memcpy(tail, element->buffer.pointer,
235 element->buffer.length);
236 head += sizeof(u8 *);
Fabian Frederickd93de342014-11-16 10:57:00 +0100237 tail += element->buffer.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 break;
239 default:
240 /* Should never get here */
241 break;
242 }
243 break;
Zhang Ruie3ec4832014-03-16 21:34:16 +0800244 case ACPI_TYPE_LOCAL_REFERENCE:
245 switch (format_string[i]) {
246 case 'R':
247 *(void **)head =
248 (void *)element->reference.handle;
249 head += sizeof(void *);
250 break;
251 default:
252 /* Should never get here */
253 break;
254 }
255 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 case ACPI_TYPE_PACKAGE:
257 /* TBD: handle nested packages... */
258 default:
259 /* Should never get here */
260 break;
261 }
262 }
263
Patrick Mocheld550d982006-06-27 00:41:40 -0400264 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
Len Brown4be44fc2005-08-05 00:44:28 -0400266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267EXPORT_SYMBOL(acpi_extract_package);
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400270acpi_evaluate_integer(acpi_handle handle,
271 acpi_string pathname,
Matthew Wilcox27663c52008-10-10 02:22:59 -0400272 struct acpi_object_list *arguments, unsigned long long *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
Len Brown4be44fc2005-08-05 00:44:28 -0400274 acpi_status status = AE_OK;
Pavel Machek40599072008-11-25 12:05:08 +0100275 union acpi_object element;
Len Brown4be44fc2005-08-05 00:44:28 -0400276 struct acpi_buffer buffer = { 0, NULL };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 if (!data)
Patrick Mocheld550d982006-06-27 00:41:40 -0400279 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 buffer.length = sizeof(union acpi_object);
Pavel Machek40599072008-11-25 12:05:08 +0100282 buffer.pointer = &element;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
284 if (ACPI_FAILURE(status)) {
285 acpi_util_eval_error(handle, pathname, status);
Patrick Mocheld550d982006-06-27 00:41:40 -0400286 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 }
288
Pavel Machek40599072008-11-25 12:05:08 +0100289 if (element.type != ACPI_TYPE_INTEGER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
Patrick Mocheld550d982006-06-27 00:41:40 -0400291 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 }
293
Pavel Machek40599072008-11-25 12:05:08 +0100294 *data = element.integer.value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Matthew Wilcox27663c52008-10-10 02:22:59 -0400296 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Patrick Mocheld550d982006-06-27 00:41:40 -0400298 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Len Brown4be44fc2005-08-05 00:44:28 -0400301EXPORT_SYMBOL(acpi_evaluate_integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400304acpi_evaluate_reference(acpi_handle handle,
305 acpi_string pathname,
306 struct acpi_object_list *arguments,
307 struct acpi_handle_list *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308{
Len Brown4be44fc2005-08-05 00:44:28 -0400309 acpi_status status = AE_OK;
310 union acpi_object *package = NULL;
311 union acpi_object *element = NULL;
312 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
313 u32 i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316 if (!list) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400317 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 }
319
320 /* Evaluate object. */
321
322 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
323 if (ACPI_FAILURE(status))
324 goto end;
325
Jan Engelhardt50dd0962006-10-01 00:28:50 +0200326 package = buffer.pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328 if ((buffer.length == 0) || !package) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 status = AE_BAD_DATA;
330 acpi_util_eval_error(handle, pathname, status);
331 goto end;
332 }
333 if (package->type != ACPI_TYPE_PACKAGE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 status = AE_BAD_DATA;
335 acpi_util_eval_error(handle, pathname, status);
336 goto end;
337 }
338 if (!package->package.count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 status = AE_BAD_DATA;
340 acpi_util_eval_error(handle, pathname, status);
341 goto end;
342 }
343
344 if (package->package.count > ACPI_MAX_HANDLES) {
Xiongfeng Wang09e15082017-11-09 14:22:39 +0800345 kfree(package);
Patrick Mocheld550d982006-06-27 00:41:40 -0400346 return AE_NO_MEMORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 }
348 list->count = package->package.count;
349
350 /* Extract package data. */
351
352 for (i = 0; i < list->count; i++) {
353
354 element = &(package->package.elements[i]);
355
Bob Moorecd0b2242008-04-10 19:06:43 +0400356 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 status = AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 acpi_util_eval_error(handle, pathname, status);
359 break;
360 }
361
Thomas Renningerb6a16382008-03-12 01:06:24 +0100362 if (!element->reference.handle) {
Thomas Renningerb6a16382008-03-12 01:06:24 +0100363 status = AE_NULL_ENTRY;
Rafael J. Wysockic48cf1b2014-12-12 22:51:01 +0100364 acpi_util_eval_error(handle, pathname, status);
Thomas Renningerb6a16382008-03-12 01:06:24 +0100365 break;
366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 /* Get the acpi_handle. */
368
369 list->handles[i] = element->reference.handle;
370 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400371 list->handles[i]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 }
373
Len Brown4be44fc2005-08-05 00:44:28 -0400374 end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 if (ACPI_FAILURE(status)) {
376 list->count = 0;
377 //kfree(list->handles);
378 }
379
Len Brown02438d82006-06-30 03:19:10 -0400380 kfree(buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Patrick Mocheld550d982006-06-27 00:41:40 -0400382 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Len Brown4be44fc2005-08-05 00:44:28 -0400385EXPORT_SYMBOL(acpi_evaluate_reference);
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800386
387acpi_status
Feng Tang8ede06a2012-08-21 09:56:58 +0800388acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800389{
390 acpi_status status;
391 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
392 union acpi_object *output;
393
394 status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
395
396 if (ACPI_FAILURE(status))
397 return status;
398
399 output = buffer.pointer;
400
401 if (!output || output->type != ACPI_TYPE_PACKAGE
402 || !output->package.count
403 || output->package.elements[0].type != ACPI_TYPE_BUFFER
Feng Tang8ede06a2012-08-21 09:56:58 +0800404 || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800405 status = AE_TYPE;
406 goto out;
407 }
408
Feng Tang8ede06a2012-08-21 09:56:58 +0800409 status = acpi_decode_pld_buffer(
410 output->package.elements[0].buffer.pointer,
411 output->package.elements[0].buffer.length,
412 pld);
413
Matthew Garrett38ac0f12012-05-11 16:08:26 +0800414out:
415 kfree(buffer.pointer);
416 return status;
417}
418EXPORT_SYMBOL(acpi_get_physical_device_location);
Toshi Kani275c58d2012-05-23 20:25:19 -0600419
420/**
Rafael J. Wysocki700b8422014-02-21 01:07:17 +0100421 * acpi_evaluate_ost: Evaluate _OST for hotplug operations
Toshi Kani275c58d2012-05-23 20:25:19 -0600422 * @handle: ACPI device handle
423 * @source_event: source event code
424 * @status_code: status code
425 * @status_buf: optional detailed information (NULL if none)
426 *
427 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
428 * must call this function when evaluating _OST for hotplug operations.
429 * When the platform does not support _OST, this function has no effect.
430 */
431acpi_status
Jiang Liu05730c12014-02-19 14:02:15 +0800432acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
433 struct acpi_buffer *status_buf)
Toshi Kani275c58d2012-05-23 20:25:19 -0600434{
Toshi Kani275c58d2012-05-23 20:25:19 -0600435 union acpi_object params[3] = {
436 {.type = ACPI_TYPE_INTEGER,},
437 {.type = ACPI_TYPE_INTEGER,},
438 {.type = ACPI_TYPE_BUFFER,}
439 };
440 struct acpi_object_list arg_list = {3, params};
Toshi Kani275c58d2012-05-23 20:25:19 -0600441
442 params[0].integer.value = source_event;
443 params[1].integer.value = status_code;
444 if (status_buf != NULL) {
445 params[2].buffer.pointer = status_buf->pointer;
446 params[2].buffer.length = status_buf->length;
447 } else {
448 params[2].buffer.pointer = NULL;
449 params[2].buffer.length = 0;
450 }
451
Jiang Liu05730c12014-02-19 14:02:15 +0800452 return acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
Toshi Kani275c58d2012-05-23 20:25:19 -0600453}
Jiang Liu05730c12014-02-19 14:02:15 +0800454EXPORT_SYMBOL(acpi_evaluate_ost);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000455
456/**
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200457 * acpi_handle_path: Return the object path of handle
458 *
459 * Caller must free the returned buffer
460 */
461static char *acpi_handle_path(acpi_handle handle)
462{
463 struct acpi_buffer buffer = {
464 .length = ACPI_ALLOCATE_BUFFER,
465 .pointer = NULL
466 };
467
468 if (in_interrupt() ||
469 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
470 return NULL;
471 return buffer.pointer;
472}
473
474/**
Toshi Kanifbfddae2012-11-21 01:36:28 +0000475 * acpi_handle_printk: Print message with ACPI prefix and object path
476 *
477 * This function is called through acpi_handle_<level> macros and prints
478 * a message with ACPI prefix and object path. This function acquires
479 * the global namespace mutex to obtain an object path. In interrupt
480 * context, it shows the object path as <n/a>.
481 */
482void
483acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
484{
485 struct va_format vaf;
486 va_list args;
Toshi Kanifbfddae2012-11-21 01:36:28 +0000487 const char *path;
488
489 va_start(args, fmt);
490 vaf.fmt = fmt;
491 vaf.va = &args;
492
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200493 path = acpi_handle_path(handle);
494 printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000495
496 va_end(args);
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200497 kfree(path);
Toshi Kanifbfddae2012-11-21 01:36:28 +0000498}
499EXPORT_SYMBOL(acpi_handle_printk);
Jiang Liu952c63e2013-06-29 00:24:38 +0800500
Bjørn Mork45fef5b2014-05-22 12:47:47 +0200501#if defined(CONFIG_DYNAMIC_DEBUG)
502/**
503 * __acpi_handle_debug: pr_debug with ACPI prefix and object path
504 *
505 * This function is called through acpi_handle_debug macro and debug
506 * prints a message with ACPI prefix and object path. This function
507 * acquires the global namespace mutex to obtain an object path. In
508 * interrupt context, it shows the object path as <n/a>.
509 */
510void
511__acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
512 const char *fmt, ...)
513{
514 struct va_format vaf;
515 va_list args;
516 const char *path;
517
518 va_start(args, fmt);
519 vaf.fmt = fmt;
520 vaf.va = &args;
521
522 path = acpi_handle_path(handle);
523 __dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
524
525 va_end(args);
526 kfree(path);
527}
528EXPORT_SYMBOL(__acpi_handle_debug);
529#endif
530
Jiang Liu952c63e2013-06-29 00:24:38 +0800531/**
532 * acpi_has_method: Check whether @handle has a method named @name
533 * @handle: ACPI device handle
534 * @name: name of object or method
535 *
536 * Check whether @handle has a method named @name.
537 */
538bool acpi_has_method(acpi_handle handle, char *name)
539{
540 acpi_handle tmp;
541
542 return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
543}
544EXPORT_SYMBOL(acpi_has_method);
Jiang Liu0db98202013-06-29 00:24:39 +0800545
546acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
547 u64 arg)
548{
549 union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
550 struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
551
552 obj.integer.value = arg;
553
554 return acpi_evaluate_object(handle, method, &arg_list, NULL);
555}
556EXPORT_SYMBOL(acpi_execute_simple_method);
Jiang Liu7d2421f2013-06-29 00:24:40 +0800557
558/**
559 * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
560 * @handle: ACPI device handle
561 *
562 * Evaluate device's _EJ0 method for hotplug operations.
563 */
564acpi_status acpi_evaluate_ej0(acpi_handle handle)
565{
566 acpi_status status;
567
568 status = acpi_execute_simple_method(handle, "_EJ0", 1);
569 if (status == AE_NOT_FOUND)
570 acpi_handle_warn(handle, "No _EJ0 support for device\n");
571 else if (ACPI_FAILURE(status))
572 acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
573
574 return status;
575}
576
577/**
578 * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
579 * @handle: ACPI device handle
580 * @lock: lock device if non-zero, otherwise unlock device
581 *
582 * Evaluate device's _LCK method if present to lock/unlock device
583 */
584acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
585{
586 acpi_status status;
587
588 status = acpi_execute_simple_method(handle, "_LCK", !!lock);
589 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
590 if (lock)
591 acpi_handle_warn(handle,
592 "Locking device failed (0x%x)\n", status);
593 else
594 acpi_handle_warn(handle,
595 "Unlocking device failed (0x%x)\n", status);
596 }
597
598 return status;
599}
Jiang Liua65ac522013-12-19 20:38:10 +0800600
601/**
602 * acpi_evaluate_dsm - evaluate device's _DSM method
603 * @handle: ACPI device handle
Andy Shevchenko94116f82017-06-05 19:40:46 +0300604 * @guid: GUID of requested functions, should be 16 bytes
Jiang Liua65ac522013-12-19 20:38:10 +0800605 * @rev: revision number of requested function
606 * @func: requested function number
607 * @argv4: the function specific parameter
608 *
Andy Shevchenko94116f82017-06-05 19:40:46 +0300609 * Evaluate device's _DSM method with specified GUID, revision id and
Jiang Liua65ac522013-12-19 20:38:10 +0800610 * function number. Caller needs to free the returned object.
611 *
612 * Though ACPI defines the fourth parameter for _DSM should be a package,
613 * some old BIOSes do expect a buffer or an integer etc.
614 */
615union acpi_object *
Andy Shevchenko94116f82017-06-05 19:40:46 +0300616acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 func,
Jiang Liua65ac522013-12-19 20:38:10 +0800617 union acpi_object *argv4)
618{
619 acpi_status ret;
620 struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
621 union acpi_object params[4];
622 struct acpi_object_list input = {
623 .count = 4,
624 .pointer = params,
625 };
626
627 params[0].type = ACPI_TYPE_BUFFER;
628 params[0].buffer.length = 16;
Andy Shevchenko94116f82017-06-05 19:40:46 +0300629 params[0].buffer.pointer = (u8 *)guid;
Jiang Liua65ac522013-12-19 20:38:10 +0800630 params[1].type = ACPI_TYPE_INTEGER;
631 params[1].integer.value = rev;
632 params[2].type = ACPI_TYPE_INTEGER;
633 params[2].integer.value = func;
634 if (argv4) {
635 params[3] = *argv4;
636 } else {
637 params[3].type = ACPI_TYPE_PACKAGE;
638 params[3].package.count = 0;
639 params[3].package.elements = NULL;
640 }
641
642 ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
643 if (ACPI_SUCCESS(ret))
644 return (union acpi_object *)buf.pointer;
645
646 if (ret != AE_NOT_FOUND)
647 acpi_handle_warn(handle,
648 "failed to evaluate _DSM (0x%x)\n", ret);
649
650 return NULL;
651}
652EXPORT_SYMBOL(acpi_evaluate_dsm);
653
654/**
655 * acpi_check_dsm - check if _DSM method supports requested functions.
656 * @handle: ACPI device handle
Andy Shevchenko94116f82017-06-05 19:40:46 +0300657 * @guid: GUID of requested functions, should be 16 bytes at least
Jiang Liua65ac522013-12-19 20:38:10 +0800658 * @rev: revision number of requested functions
659 * @funcs: bitmap of requested functions
Jiang Liua65ac522013-12-19 20:38:10 +0800660 *
661 * Evaluate device's _DSM method to check whether it supports requested
662 * functions. Currently only support 64 functions at maximum, should be
663 * enough for now.
664 */
Andy Shevchenko94116f82017-06-05 19:40:46 +0300665bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs)
Jiang Liua65ac522013-12-19 20:38:10 +0800666{
667 int i;
668 u64 mask = 0;
669 union acpi_object *obj;
670
Dan Williamsa7225592016-07-19 12:32:39 -0700671 if (funcs == 0)
672 return false;
673
Andy Shevchenko94116f82017-06-05 19:40:46 +0300674 obj = acpi_evaluate_dsm(handle, guid, rev, 0, NULL);
Jiang Liua65ac522013-12-19 20:38:10 +0800675 if (!obj)
676 return false;
677
678 /* For compatibility, old BIOSes may return an integer */
679 if (obj->type == ACPI_TYPE_INTEGER)
680 mask = obj->integer.value;
681 else if (obj->type == ACPI_TYPE_BUFFER)
682 for (i = 0; i < obj->buffer.length && i < 8; i++)
Colin Ian King4a798f52016-03-18 15:08:01 +0000683 mask |= (((u64)obj->buffer.pointer[i]) << (i * 8));
Jiang Liua65ac522013-12-19 20:38:10 +0800684 ACPI_FREE(obj);
685
686 /*
687 * Bit 0 indicates whether there's support for any functions other than
Andy Shevchenko94116f82017-06-05 19:40:46 +0300688 * function 0 for the specified GUID and revision.
Jiang Liua65ac522013-12-19 20:38:10 +0800689 */
690 if ((mask & 0x1) && (mask & funcs) == funcs)
691 return true;
692
693 return false;
694}
695EXPORT_SYMBOL(acpi_check_dsm);
Hans de Goede14ca7a472015-06-16 16:27:47 +0200696
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100697/**
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100698 * acpi_dev_found - Detect presence of a given ACPI device in the namespace.
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100699 * @hid: Hardware ID of the device.
700 *
701 * Return %true if the device was present at the moment of invocation.
702 * Note that if the device is pluggable, it may since have disappeared.
703 *
704 * For this function to work, acpi_bus_scan() must have been executed
705 * which happens in the subsys_initcall() subsection. Hence, do not
706 * call from a subsys_initcall() or earlier (use acpi_get_devices()
707 * instead). Calling from module_init() is fine (which is synonymous
708 * with device_initcall()).
709 */
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100710bool acpi_dev_found(const char *hid)
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100711{
712 struct acpi_device_bus_id *acpi_device_bus_id;
713 bool found = false;
714
715 mutex_lock(&acpi_device_lock);
716 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
717 if (!strcmp(acpi_device_bus_id->bus_id, hid)) {
718 found = true;
719 break;
720 }
721 mutex_unlock(&acpi_device_lock);
722
723 return found;
724}
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +0100725EXPORT_SYMBOL(acpi_dev_found);
Lukas Wunner2d12b6b2015-11-25 21:19:55 +0100726
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200727struct acpi_dev_match_info {
728 const char *dev_name;
Andy Shevchenko817b4d62019-03-18 23:00:54 +0300729 struct acpi_device *adev;
Hans de Goede86614232017-04-19 14:02:08 +0200730 struct acpi_device_id hid[2];
731 const char *uid;
732 s64 hrv;
733};
734
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200735static int acpi_dev_match_cb(struct device *dev, void *data)
Hans de Goede86614232017-04-19 14:02:08 +0200736{
737 struct acpi_device *adev = to_acpi_device(dev);
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200738 struct acpi_dev_match_info *match = data;
Hans de Goede86614232017-04-19 14:02:08 +0200739 unsigned long long hrv;
740 acpi_status status;
741
742 if (acpi_match_device_ids(adev, match->hid))
743 return 0;
744
745 if (match->uid && (!adev->pnp.unique_id ||
746 strcmp(adev->pnp.unique_id, match->uid)))
747 return 0;
748
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200749 match->dev_name = acpi_dev_name(adev);
Andy Shevchenko817b4d62019-03-18 23:00:54 +0300750 match->adev = adev;
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200751
Hans de Goede86614232017-04-19 14:02:08 +0200752 if (match->hrv == -1)
753 return 1;
754
755 status = acpi_evaluate_integer(adev->handle, "_HRV", NULL, &hrv);
756 if (ACPI_FAILURE(status))
757 return 0;
758
759 return hrv == match->hrv;
760}
761
762/**
763 * acpi_dev_present - Detect that a given ACPI device is present
764 * @hid: Hardware ID of the device.
765 * @uid: Unique ID of the device, pass NULL to not check _UID
766 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
767 *
768 * Return %true if a matching device was present at the moment of invocation.
769 * Note that if the device is pluggable, it may since have disappeared.
770 *
771 * Note that unlike acpi_dev_found() this function checks the status
772 * of the device. So for devices which are present in the dsdt, but
773 * which are disabled (their _STA callback returns 0) this function
774 * will return false.
775 *
776 * For this function to work, acpi_bus_scan() must have been executed
777 * which happens in the subsys_initcall() subsection. Hence, do not
778 * call from a subsys_initcall() or earlier (use acpi_get_devices()
779 * instead). Calling from module_init() is fine (which is synonymous
780 * with device_initcall()).
781 */
782bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
783{
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200784 struct acpi_dev_match_info match = {};
Hans de Goede86614232017-04-19 14:02:08 +0200785 struct device *dev;
786
787 strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
788 match.uid = uid;
789 match.hrv = hrv;
790
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200791 dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
Andy Shevchenko54e3aca2019-03-18 21:47:09 +0300792 put_device(dev);
Hans de Goede86614232017-04-19 14:02:08 +0200793 return !!dev;
794}
795EXPORT_SYMBOL(acpi_dev_present);
796
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200797/**
Andy Shevchenko817b4d62019-03-18 23:00:54 +0300798 * acpi_dev_get_first_match_dev - Return the first match of ACPI device
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200799 * @hid: Hardware ID of the device.
800 * @uid: Unique ID of the device, pass NULL to not check _UID
801 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
802 *
Andy Shevchenko817b4d62019-03-18 23:00:54 +0300803 * Return the first match of ACPI device if a matching device was present
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200804 * at the moment of invocation, or NULL otherwise.
805 *
Andy Shevchenko817b4d62019-03-18 23:00:54 +0300806 * The caller is responsible to call put_device() on the returned device.
807 *
Andy Shevchenko67dcf8a2018-01-05 18:09:33 +0200808 * See additional information in acpi_dev_present() as well.
809 */
Andy Shevchenko817b4d62019-03-18 23:00:54 +0300810struct acpi_device *
811acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
812{
813 struct acpi_dev_match_info match = {};
814 struct device *dev;
815
816 strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
817 match.uid = uid;
818 match.hrv = hrv;
819
820 dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
821 return dev ? match.adev : NULL;
822}
823EXPORT_SYMBOL(acpi_dev_get_first_match_dev);
824
Hans de Goede14ca7a472015-06-16 16:27:47 +0200825/*
826 * acpi_backlight= handling, this is done here rather then in video_detect.c
827 * because __setup cannot be used in modules.
828 */
829char acpi_video_backlight_string[16];
830EXPORT_SYMBOL(acpi_video_backlight_string);
831
832static int __init acpi_backlight(char *str)
833{
834 strlcpy(acpi_video_backlight_string, str,
835 sizeof(acpi_video_backlight_string));
836 return 1;
837}
838__setup("acpi_backlight=", acpi_backlight);
Toshi Kani5aa59112017-08-23 16:54:43 -0600839
840/**
841 * acpi_match_platform_list - Check if the system matches with a given list
842 * @plat: pointer to acpi_platform_list table terminated by a NULL entry
843 *
844 * Return the matched index if the system is found in the platform list.
845 * Otherwise, return a negative error code.
846 */
847int acpi_match_platform_list(const struct acpi_platform_list *plat)
848{
849 struct acpi_table_header hdr;
850 int idx = 0;
851
852 if (acpi_disabled)
853 return -ENODEV;
854
855 for (; plat->oem_id[0]; plat++, idx++) {
856 if (ACPI_FAILURE(acpi_get_table_header(plat->table, 0, &hdr)))
857 continue;
858
859 if (strncmp(plat->oem_id, hdr.oem_id, ACPI_OEM_ID_SIZE))
860 continue;
861
862 if (strncmp(plat->oem_table_id, hdr.oem_table_id, ACPI_OEM_TABLE_ID_SIZE))
863 continue;
864
865 if ((plat->pred == all_versions) ||
866 (plat->pred == less_than_or_equal && hdr.oem_revision <= plat->oem_revision) ||
867 (plat->pred == greater_than_or_equal && hdr.oem_revision >= plat->oem_revision) ||
868 (plat->pred == equal && hdr.oem_revision == plat->oem_revision))
869 return idx;
870 }
871
872 return -ENODEV;
873}
874EXPORT_SYMBOL(acpi_match_platform_list);