Merge commit 'v2.6.34-rc2' into perf/core
[linux-2.6-block.git] / drivers / acpi / utils.c
CommitLineData
1da177e4
LT
1/*
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
a192a958
LB
33#include "internal.h"
34
1da177e4 35#define _COMPONENT ACPI_BUS_COMPONENT
f52fd66d 36ACPI_MODULE_NAME("utils");
1da177e4
LT
37
38/* --------------------------------------------------------------------------
39 Object Evaluation Helpers
40 -------------------------------------------------------------------------- */
4fd7f518
HH
41static void
42acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
43{
1da177e4 44#ifdef ACPI_DEBUG_OUTPUT
4fd7f518
HH
45 char prefix[80] = {'\0'};
46 struct acpi_buffer buffer = {sizeof(prefix), prefix};
47 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
48 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
49 (char *) prefix, p, acpi_format_exception(s)));
1da177e4 50#else
4fd7f518 51 return;
1da177e4 52#endif
4fd7f518
HH
53}
54
1da177e4 55acpi_status
4be44fcd
LB
56acpi_extract_package(union acpi_object *package,
57 struct acpi_buffer *format, struct acpi_buffer *buffer)
1da177e4 58{
4be44fcd
LB
59 u32 size_required = 0;
60 u32 tail_offset = 0;
61 char *format_string = NULL;
62 u32 format_count = 0;
63 u32 i = 0;
64 u8 *head = NULL;
65 u8 *tail = NULL;
1da177e4 66
1da177e4 67
4be44fcd
LB
68 if (!package || (package->type != ACPI_TYPE_PACKAGE)
69 || (package->package.count < 1)) {
cece9296 70 printk(KERN_WARNING PREFIX "Invalid package argument\n");
d550d98d 71 return AE_BAD_PARAMETER;
1da177e4
LT
72 }
73
74 if (!format || !format->pointer || (format->length < 1)) {
cece9296 75 printk(KERN_WARNING PREFIX "Invalid format argument\n");
d550d98d 76 return AE_BAD_PARAMETER;
1da177e4
LT
77 }
78
79 if (!buffer) {
cece9296 80 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
d550d98d 81 return AE_BAD_PARAMETER;
1da177e4
LT
82 }
83
4be44fcd 84 format_count = (format->length / sizeof(char)) - 1;
1da177e4 85 if (format_count > package->package.count) {
cece9296
LB
86 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
87 " than exist in package [%d].\n",
88 format_count, package->package.count);
d550d98d 89 return AE_BAD_DATA;
1da177e4
LT
90 }
91
50dd0969 92 format_string = format->pointer;
1da177e4
LT
93
94 /*
95 * Calculate size_required.
96 */
4be44fcd 97 for (i = 0; i < format_count; i++) {
1da177e4
LT
98
99 union acpi_object *element = &(package->package.elements[i]);
100
101 if (!element) {
d550d98d 102 return AE_BAD_DATA;
1da177e4
LT
103 }
104
105 switch (element->type) {
106
107 case ACPI_TYPE_INTEGER:
108 switch (format_string[i]) {
109 case 'N':
439913ff
LM
110 size_required += sizeof(u64);
111 tail_offset += sizeof(u64);
1da177e4
LT
112 break;
113 case 'S':
4be44fcd 114 size_required +=
439913ff 115 sizeof(char *) + sizeof(u64) +
4be44fcd
LB
116 sizeof(char);
117 tail_offset += sizeof(char *);
1da177e4
LT
118 break;
119 default:
cece9296 120 printk(KERN_WARNING PREFIX "Invalid package element"
a6fc6720 121 " [%d]: got number, expecing"
cece9296
LB
122 " [%c]\n",
123 i, format_string[i]);
d550d98d 124 return AE_BAD_DATA;
1da177e4
LT
125 break;
126 }
127 break;
128
129 case ACPI_TYPE_STRING:
130 case ACPI_TYPE_BUFFER:
131 switch (format_string[i]) {
132 case 'S':
4be44fcd
LB
133 size_required +=
134 sizeof(char *) +
135 (element->string.length * sizeof(char)) +
136 sizeof(char);
137 tail_offset += sizeof(char *);
1da177e4
LT
138 break;
139 case 'B':
4be44fcd
LB
140 size_required +=
141 sizeof(u8 *) +
142 (element->buffer.length * sizeof(u8));
143 tail_offset += sizeof(u8 *);
1da177e4
LT
144 break;
145 default:
cece9296 146 printk(KERN_WARNING PREFIX "Invalid package element"
a6fc6720 147 " [%d] got string/buffer,"
cece9296
LB
148 " expecing [%c]\n",
149 i, format_string[i]);
d550d98d 150 return AE_BAD_DATA;
1da177e4
LT
151 break;
152 }
153 break;
154
155 case ACPI_TYPE_PACKAGE:
156 default:
4be44fcd
LB
157 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
158 "Found unsupported element at index=%d\n",
159 i));
1da177e4 160 /* TBD: handle nested packages... */
d550d98d 161 return AE_SUPPORT;
1da177e4
LT
162 break;
163 }
164 }
165
166 /*
167 * Validate output buffer.
168 */
169 if (buffer->length < size_required) {
170 buffer->length = size_required;
d550d98d 171 return AE_BUFFER_OVERFLOW;
4be44fcd 172 } else if (buffer->length != size_required || !buffer->pointer) {
d550d98d 173 return AE_BAD_PARAMETER;
1da177e4
LT
174 }
175
176 head = buffer->pointer;
177 tail = buffer->pointer + tail_offset;
178
179 /*
180 * Extract package data.
181 */
4be44fcd 182 for (i = 0; i < format_count; i++) {
1da177e4
LT
183
184 u8 **pointer = NULL;
185 union acpi_object *element = &(package->package.elements[i]);
186
187 if (!element) {
d550d98d 188 return AE_BAD_DATA;
1da177e4
LT
189 }
190
191 switch (element->type) {
192
193 case ACPI_TYPE_INTEGER:
194 switch (format_string[i]) {
195 case 'N':
439913ff 196 *((u64 *) head) =
4be44fcd 197 element->integer.value;
439913ff 198 head += sizeof(u64);
1da177e4
LT
199 break;
200 case 'S':
4be44fcd 201 pointer = (u8 **) head;
1da177e4 202 *pointer = tail;
439913ff 203 *((u64 *) tail) =
4be44fcd 204 element->integer.value;
439913ff
LM
205 head += sizeof(u64 *);
206 tail += sizeof(u64);
1da177e4
LT
207 /* 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':
4be44fcd 221 pointer = (u8 **) head;
1da177e4 222 *pointer = tail;
4be44fcd
LB
223 memcpy(tail, element->string.pointer,
224 element->string.length);
225 head += sizeof(char *);
1da177e4
LT
226 tail += element->string.length * sizeof(char);
227 /* NULL terminate string */
228 *tail = (char)0;
229 tail += sizeof(char);
230 break;
231 case 'B':
4be44fcd 232 pointer = (u8 **) head;
1da177e4 233 *pointer = tail;
4be44fcd
LB
234 memcpy(tail, element->buffer.pointer,
235 element->buffer.length);
236 head += sizeof(u8 *);
1da177e4
LT
237 tail += element->buffer.length * sizeof(u8);
238 break;
239 default:
240 /* Should never get here */
241 break;
242 }
243 break;
244
245 case ACPI_TYPE_PACKAGE:
246 /* TBD: handle nested packages... */
247 default:
248 /* Should never get here */
249 break;
250 }
251 }
252
d550d98d 253 return AE_OK;
1da177e4 254}
1da177e4 255
4be44fcd 256EXPORT_SYMBOL(acpi_extract_package);
1da177e4
LT
257
258acpi_status
4be44fcd
LB
259acpi_evaluate_integer(acpi_handle handle,
260 acpi_string pathname,
27663c58 261 struct acpi_object_list *arguments, unsigned long long *data)
1da177e4 262{
4be44fcd 263 acpi_status status = AE_OK;
40599072 264 union acpi_object element;
4be44fcd 265 struct acpi_buffer buffer = { 0, NULL };
1da177e4 266
1da177e4 267 if (!data)
d550d98d 268 return AE_BAD_PARAMETER;
1da177e4 269
1da177e4 270 buffer.length = sizeof(union acpi_object);
40599072 271 buffer.pointer = &element;
1da177e4
LT
272 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
273 if (ACPI_FAILURE(status)) {
274 acpi_util_eval_error(handle, pathname, status);
d550d98d 275 return status;
1da177e4
LT
276 }
277
40599072 278 if (element.type != ACPI_TYPE_INTEGER) {
1da177e4 279 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
d550d98d 280 return AE_BAD_DATA;
1da177e4
LT
281 }
282
40599072 283 *data = element.integer.value;
1da177e4 284
27663c58 285 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
1da177e4 286
d550d98d 287 return AE_OK;
1da177e4 288}
1da177e4 289
4be44fcd 290EXPORT_SYMBOL(acpi_evaluate_integer);
1da177e4 291
1da177e4 292acpi_status
4be44fcd
LB
293acpi_evaluate_reference(acpi_handle handle,
294 acpi_string pathname,
295 struct acpi_object_list *arguments,
296 struct acpi_handle_list *list)
1da177e4 297{
4be44fcd
LB
298 acpi_status status = AE_OK;
299 union acpi_object *package = NULL;
300 union acpi_object *element = NULL;
301 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
302 u32 i = 0;
1da177e4 303
1da177e4
LT
304
305 if (!list) {
d550d98d 306 return AE_BAD_PARAMETER;
1da177e4
LT
307 }
308
309 /* Evaluate object. */
310
311 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
312 if (ACPI_FAILURE(status))
313 goto end;
314
50dd0969 315 package = buffer.pointer;
1da177e4
LT
316
317 if ((buffer.length == 0) || !package) {
6468463a
LB
318 printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
319 (unsigned)buffer.length, package);
1da177e4
LT
320 status = AE_BAD_DATA;
321 acpi_util_eval_error(handle, pathname, status);
322 goto end;
323 }
324 if (package->type != ACPI_TYPE_PACKAGE) {
6468463a
LB
325 printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
326 package->type);
1da177e4
LT
327 status = AE_BAD_DATA;
328 acpi_util_eval_error(handle, pathname, status);
329 goto end;
330 }
331 if (!package->package.count) {
6468463a
LB
332 printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
333 package);
1da177e4
LT
334 status = AE_BAD_DATA;
335 acpi_util_eval_error(handle, pathname, status);
336 goto end;
337 }
338
339 if (package->package.count > ACPI_MAX_HANDLES) {
d550d98d 340 return AE_NO_MEMORY;
1da177e4
LT
341 }
342 list->count = package->package.count;
343
344 /* Extract package data. */
345
346 for (i = 0; i < list->count; i++) {
347
348 element = &(package->package.elements[i]);
349
cd0b2248 350 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
1da177e4 351 status = AE_BAD_DATA;
6468463a
LB
352 printk(KERN_ERR PREFIX
353 "Expecting a [Reference] package element, found type %X\n",
354 element->type);
1da177e4
LT
355 acpi_util_eval_error(handle, pathname, status);
356 break;
357 }
358
b6a16387
TR
359 if (!element->reference.handle) {
360 printk(KERN_WARNING PREFIX "Invalid reference in"
361 " package %s\n", pathname);
362 status = AE_NULL_ENTRY;
363 break;
364 }
1da177e4
LT
365 /* Get the acpi_handle. */
366
367 list->handles[i] = element->reference.handle;
368 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
4be44fcd 369 list->handles[i]));
1da177e4
LT
370 }
371
4be44fcd 372 end:
1da177e4
LT
373 if (ACPI_FAILURE(status)) {
374 list->count = 0;
375 //kfree(list->handles);
376 }
377
02438d87 378 kfree(buffer.pointer);
1da177e4 379
d550d98d 380 return status;
1da177e4 381}
1da177e4 382
4be44fcd 383EXPORT_SYMBOL(acpi_evaluate_reference);