blob: f844941089bb30786b143bee118e9e1e9b1cac54 [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 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#include <linux/kernel.h>
27#include <linux/module.h>
28#include <linux/init.h>
29#include <linux/types.h>
30#include <acpi/acpi_bus.h>
31#include <acpi/acpi_drivers.h>
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define _COMPONENT ACPI_BUS_COMPONENT
Len Brownf52fd662007-02-12 22:42:12 -050034ACPI_MODULE_NAME("utils");
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36/* --------------------------------------------------------------------------
37 Object Evaluation Helpers
38 -------------------------------------------------------------------------- */
Harvey Harrison4fd7f512008-02-15 17:07:19 -080039static void
40acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
41{
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#ifdef ACPI_DEBUG_OUTPUT
Harvey Harrison4fd7f512008-02-15 17:07:19 -080043 char prefix[80] = {'\0'};
44 struct acpi_buffer buffer = {sizeof(prefix), prefix};
45 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
46 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
47 (char *) prefix, p, acpi_format_exception(s)));
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#else
Harvey Harrison4fd7f512008-02-15 17:07:19 -080049 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#endif
Harvey Harrison4fd7f512008-02-15 17:07:19 -080051}
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040054acpi_extract_package(union acpi_object *package,
55 struct acpi_buffer *format, struct acpi_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
Len Brown4be44fc2005-08-05 00:44:28 -040057 u32 size_required = 0;
58 u32 tail_offset = 0;
59 char *format_string = NULL;
60 u32 format_count = 0;
61 u32 i = 0;
62 u8 *head = NULL;
63 u8 *tail = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Len Brown4be44fc2005-08-05 00:44:28 -040066 if (!package || (package->type != ACPI_TYPE_PACKAGE)
67 || (package->package.count < 1)) {
Len Browncece9292006-06-26 23:04:31 -040068 printk(KERN_WARNING PREFIX "Invalid package argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040069 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 }
71
72 if (!format || !format->pointer || (format->length < 1)) {
Len Browncece9292006-06-26 23:04:31 -040073 printk(KERN_WARNING PREFIX "Invalid format argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040074 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 }
76
77 if (!buffer) {
Len Browncece9292006-06-26 23:04:31 -040078 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
Patrick Mocheld550d982006-06-27 00:41:40 -040079 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 }
81
Len Brown4be44fc2005-08-05 00:44:28 -040082 format_count = (format->length / sizeof(char)) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 if (format_count > package->package.count) {
Len Browncece9292006-06-26 23:04:31 -040084 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
85 " than exist in package [%d].\n",
86 format_count, package->package.count);
Patrick Mocheld550d982006-06-27 00:41:40 -040087 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 }
89
Jan Engelhardt50dd0962006-10-01 00:28:50 +020090 format_string = format->pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92 /*
93 * Calculate size_required.
94 */
Len Brown4be44fc2005-08-05 00:44:28 -040095 for (i = 0; i < format_count; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97 union acpi_object *element = &(package->package.elements[i]);
98
99 if (!element) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400100 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 }
102
103 switch (element->type) {
104
105 case ACPI_TYPE_INTEGER:
106 switch (format_string[i]) {
107 case 'N':
108 size_required += sizeof(acpi_integer);
109 tail_offset += sizeof(acpi_integer);
110 break;
111 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400112 size_required +=
113 sizeof(char *) + sizeof(acpi_integer) +
114 sizeof(char);
115 tail_offset += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 break;
117 default:
Len Browncece9292006-06-26 23:04:31 -0400118 printk(KERN_WARNING PREFIX "Invalid package element"
Thomas Renningera6fc6722006-06-26 23:58:43 -0400119 " [%d]: got number, expecing"
Len Browncece9292006-06-26 23:04:31 -0400120 " [%c]\n",
121 i, format_string[i]);
Patrick Mocheld550d982006-06-27 00:41:40 -0400122 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 break;
124 }
125 break;
126
127 case ACPI_TYPE_STRING:
128 case ACPI_TYPE_BUFFER:
129 switch (format_string[i]) {
130 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400131 size_required +=
132 sizeof(char *) +
133 (element->string.length * sizeof(char)) +
134 sizeof(char);
135 tail_offset += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 break;
137 case 'B':
Len Brown4be44fc2005-08-05 00:44:28 -0400138 size_required +=
139 sizeof(u8 *) +
140 (element->buffer.length * sizeof(u8));
141 tail_offset += sizeof(u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 break;
143 default:
Len Browncece9292006-06-26 23:04:31 -0400144 printk(KERN_WARNING PREFIX "Invalid package element"
Thomas Renningera6fc6722006-06-26 23:58:43 -0400145 " [%d] got string/buffer,"
Len Browncece9292006-06-26 23:04:31 -0400146 " expecing [%c]\n",
147 i, format_string[i]);
Patrick Mocheld550d982006-06-27 00:41:40 -0400148 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 break;
150 }
151 break;
152
153 case ACPI_TYPE_PACKAGE:
154 default:
Len Brown4be44fc2005-08-05 00:44:28 -0400155 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
156 "Found unsupported element at index=%d\n",
157 i));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /* TBD: handle nested packages... */
Patrick Mocheld550d982006-06-27 00:41:40 -0400159 return AE_SUPPORT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 break;
161 }
162 }
163
164 /*
165 * Validate output buffer.
166 */
167 if (buffer->length < size_required) {
168 buffer->length = size_required;
Patrick Mocheld550d982006-06-27 00:41:40 -0400169 return AE_BUFFER_OVERFLOW;
Len Brown4be44fc2005-08-05 00:44:28 -0400170 } else if (buffer->length != size_required || !buffer->pointer) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400171 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 }
173
174 head = buffer->pointer;
175 tail = buffer->pointer + tail_offset;
176
177 /*
178 * Extract package data.
179 */
Len Brown4be44fc2005-08-05 00:44:28 -0400180 for (i = 0; i < format_count; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
182 u8 **pointer = NULL;
183 union acpi_object *element = &(package->package.elements[i]);
184
185 if (!element) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400186 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 }
188
189 switch (element->type) {
190
191 case ACPI_TYPE_INTEGER:
192 switch (format_string[i]) {
193 case 'N':
Len Brown4be44fc2005-08-05 00:44:28 -0400194 *((acpi_integer *) head) =
195 element->integer.value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 head += sizeof(acpi_integer);
197 break;
198 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400199 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400201 *((acpi_integer *) tail) =
202 element->integer.value;
203 head += sizeof(acpi_integer *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 tail += sizeof(acpi_integer);
205 /* NULL terminate string */
206 *tail = (char)0;
207 tail += sizeof(char);
208 break;
209 default:
210 /* Should never get here */
211 break;
212 }
213 break;
214
215 case ACPI_TYPE_STRING:
216 case ACPI_TYPE_BUFFER:
217 switch (format_string[i]) {
218 case 'S':
Len Brown4be44fc2005-08-05 00:44:28 -0400219 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400221 memcpy(tail, element->string.pointer,
222 element->string.length);
223 head += sizeof(char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 tail += element->string.length * sizeof(char);
225 /* NULL terminate string */
226 *tail = (char)0;
227 tail += sizeof(char);
228 break;
229 case 'B':
Len Brown4be44fc2005-08-05 00:44:28 -0400230 pointer = (u8 **) head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 *pointer = tail;
Len Brown4be44fc2005-08-05 00:44:28 -0400232 memcpy(tail, element->buffer.pointer,
233 element->buffer.length);
234 head += sizeof(u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 tail += element->buffer.length * sizeof(u8);
236 break;
237 default:
238 /* Should never get here */
239 break;
240 }
241 break;
242
243 case ACPI_TYPE_PACKAGE:
244 /* TBD: handle nested packages... */
245 default:
246 /* Should never get here */
247 break;
248 }
249 }
250
Patrick Mocheld550d982006-06-27 00:41:40 -0400251 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252}
Len Brown4be44fc2005-08-05 00:44:28 -0400253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254EXPORT_SYMBOL(acpi_extract_package);
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400257acpi_evaluate_integer(acpi_handle handle,
258 acpi_string pathname,
Matthew Wilcox27663c52008-10-10 02:22:59 -0400259 struct acpi_object_list *arguments, unsigned long long *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
Len Brown4be44fc2005-08-05 00:44:28 -0400261 acpi_status status = AE_OK;
Pavel Machek40599072008-11-25 12:05:08 +0100262 union acpi_object element;
Len Brown4be44fc2005-08-05 00:44:28 -0400263 struct acpi_buffer buffer = { 0, NULL };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 if (!data)
Patrick Mocheld550d982006-06-27 00:41:40 -0400266 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 buffer.length = sizeof(union acpi_object);
Pavel Machek40599072008-11-25 12:05:08 +0100269 buffer.pointer = &element;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
271 if (ACPI_FAILURE(status)) {
272 acpi_util_eval_error(handle, pathname, status);
Patrick Mocheld550d982006-06-27 00:41:40 -0400273 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 }
275
Pavel Machek40599072008-11-25 12:05:08 +0100276 if (element.type != ACPI_TYPE_INTEGER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
Patrick Mocheld550d982006-06-27 00:41:40 -0400278 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 }
280
Pavel Machek40599072008-11-25 12:05:08 +0100281 *data = element.integer.value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Matthew Wilcox27663c52008-10-10 02:22:59 -0400283 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Patrick Mocheld550d982006-06-27 00:41:40 -0400285 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Len Brown4be44fc2005-08-05 00:44:28 -0400288EXPORT_SYMBOL(acpi_evaluate_integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290#if 0
291acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400292acpi_evaluate_string(acpi_handle handle,
293 acpi_string pathname,
294 acpi_object_list * arguments, acpi_string * data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295{
Len Brown4be44fc2005-08-05 00:44:28 -0400296 acpi_status status = AE_OK;
297 acpi_object *element = NULL;
298 acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 if (!data)
Patrick Mocheld550d982006-06-27 00:41:40 -0400302 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
305 if (ACPI_FAILURE(status)) {
306 acpi_util_eval_error(handle, pathname, status);
Patrick Mocheld550d982006-06-27 00:41:40 -0400307 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 }
309
310 element = (acpi_object *) buffer.pointer;
311
Len Brown4be44fc2005-08-05 00:44:28 -0400312 if ((element->type != ACPI_TYPE_STRING)
313 || (element->type != ACPI_TYPE_BUFFER)
314 || !element->string.length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
Patrick Mocheld550d982006-06-27 00:41:40 -0400316 return AE_BAD_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 }
318
Burman Yan36bcbec2006-12-19 12:56:11 -0800319 *data = kzalloc(element->string.length + 1, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 if (!data) {
Len Brown64684632006-06-26 23:41:38 -0400321 printk(KERN_ERR PREFIX "Memory allocation\n");
Patrick Mocheld550d982006-06-27 00:41:40 -0400322 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325 memcpy(*data, element->string.pointer, element->string.length);
326
327 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%s]\n", *data));
328
Len Brown02438d82006-06-30 03:19:10 -0400329 kfree(buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Patrick Mocheld550d982006-06-27 00:41:40 -0400331 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333#endif
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400336acpi_evaluate_reference(acpi_handle handle,
337 acpi_string pathname,
338 struct acpi_object_list *arguments,
339 struct acpi_handle_list *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340{
Len Brown4be44fc2005-08-05 00:44:28 -0400341 acpi_status status = AE_OK;
342 union acpi_object *package = NULL;
343 union acpi_object *element = NULL;
344 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
345 u32 i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 if (!list) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400349 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 }
351
352 /* Evaluate object. */
353
354 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
355 if (ACPI_FAILURE(status))
356 goto end;
357
Jan Engelhardt50dd0962006-10-01 00:28:50 +0200358 package = buffer.pointer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 if ((buffer.length == 0) || !package) {
Len Brown64684632006-06-26 23:41:38 -0400361 printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
362 (unsigned)buffer.length, package);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 status = AE_BAD_DATA;
364 acpi_util_eval_error(handle, pathname, status);
365 goto end;
366 }
367 if (package->type != ACPI_TYPE_PACKAGE) {
Len Brown64684632006-06-26 23:41:38 -0400368 printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
369 package->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 status = AE_BAD_DATA;
371 acpi_util_eval_error(handle, pathname, status);
372 goto end;
373 }
374 if (!package->package.count) {
Len Brown64684632006-06-26 23:41:38 -0400375 printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
376 package);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 status = AE_BAD_DATA;
378 acpi_util_eval_error(handle, pathname, status);
379 goto end;
380 }
381
382 if (package->package.count > ACPI_MAX_HANDLES) {
Patrick Mocheld550d982006-06-27 00:41:40 -0400383 return AE_NO_MEMORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 }
385 list->count = package->package.count;
386
387 /* Extract package data. */
388
389 for (i = 0; i < list->count; i++) {
390
391 element = &(package->package.elements[i]);
392
Bob Moorecd0b2242008-04-10 19:06:43 +0400393 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 status = AE_BAD_DATA;
Len Brown64684632006-06-26 23:41:38 -0400395 printk(KERN_ERR PREFIX
396 "Expecting a [Reference] package element, found type %X\n",
397 element->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 acpi_util_eval_error(handle, pathname, status);
399 break;
400 }
401
Thomas Renningerb6a16382008-03-12 01:06:24 +0100402 if (!element->reference.handle) {
403 printk(KERN_WARNING PREFIX "Invalid reference in"
404 " package %s\n", pathname);
405 status = AE_NULL_ENTRY;
406 break;
407 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 /* Get the acpi_handle. */
409
410 list->handles[i] = element->reference.handle;
411 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400412 list->handles[i]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 }
414
Len Brown4be44fc2005-08-05 00:44:28 -0400415 end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 if (ACPI_FAILURE(status)) {
417 list->count = 0;
418 //kfree(list->handles);
419 }
420
Len Brown02438d82006-06-30 03:19:10 -0400421 kfree(buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Patrick Mocheld550d982006-06-27 00:41:40 -0400423 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Len Brown4be44fc2005-08-05 00:44:28 -0400426EXPORT_SYMBOL(acpi_evaluate_reference);