2 * acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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>
33 #define _COMPONENT ACPI_BUS_COMPONENT
34 ACPI_MODULE_NAME("acpi_utils")
36 /* --------------------------------------------------------------------------
37 Object Evaluation Helpers
38 -------------------------------------------------------------------------- */
39 #ifdef ACPI_DEBUG_OUTPUT
40 #define acpi_util_eval_error(h,p,s) {\
41 char prefix[80] = {'\0'};\
42 struct acpi_buffer buffer = {sizeof(prefix), prefix};\
43 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);\
44 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",\
45 (char *) prefix, p, acpi_format_exception(s))); }
47 #define acpi_util_eval_error(h,p,s)
50 acpi_extract_package(union acpi_object *package,
51 struct acpi_buffer *format, struct acpi_buffer *buffer)
53 u32 size_required = 0;
55 char *format_string = NULL;
61 ACPI_FUNCTION_TRACE("acpi_extract_package");
63 if (!package || (package->type != ACPI_TYPE_PACKAGE)
64 || (package->package.count < 1)) {
65 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
66 "Invalid 'package' argument\n"));
67 return_ACPI_STATUS(AE_BAD_PARAMETER);
70 if (!format || !format->pointer || (format->length < 1)) {
71 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "Invalid 'format' argument\n"));
72 return_ACPI_STATUS(AE_BAD_PARAMETER);
76 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "Invalid 'buffer' argument\n"));
77 return_ACPI_STATUS(AE_BAD_PARAMETER);
80 format_count = (format->length / sizeof(char)) - 1;
81 if (format_count > package->package.count) {
82 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
83 "Format specifies more objects [%d] than exist in package [%d].",
84 format_count, package->package.count));
85 return_ACPI_STATUS(AE_BAD_DATA);
88 format_string = (char *)format->pointer;
91 * Calculate size_required.
93 for (i = 0; i < format_count; i++) {
95 union acpi_object *element = &(package->package.elements[i]);
98 return_ACPI_STATUS(AE_BAD_DATA);
101 switch (element->type) {
103 case ACPI_TYPE_INTEGER:
104 switch (format_string[i]) {
106 size_required += sizeof(acpi_integer);
107 tail_offset += sizeof(acpi_integer);
111 sizeof(char *) + sizeof(acpi_integer) +
113 tail_offset += sizeof(char *);
116 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
117 "Invalid package element [%d]: got number, expecing [%c].\n",
118 i, format_string[i]));
119 return_ACPI_STATUS(AE_BAD_DATA);
124 case ACPI_TYPE_STRING:
125 case ACPI_TYPE_BUFFER:
126 switch (format_string[i]) {
130 (element->string.length * sizeof(char)) +
132 tail_offset += sizeof(char *);
137 (element->buffer.length * sizeof(u8));
138 tail_offset += sizeof(u8 *);
141 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
142 "Invalid package element [%d] got string/buffer, expecing [%c].\n",
143 i, format_string[i]));
144 return_ACPI_STATUS(AE_BAD_DATA);
149 case ACPI_TYPE_PACKAGE:
151 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
152 "Found unsupported element at index=%d\n",
154 /* TBD: handle nested packages... */
155 return_ACPI_STATUS(AE_SUPPORT);
161 * Validate output buffer.
163 if (buffer->length < size_required) {
164 buffer->length = size_required;
165 return_ACPI_STATUS(AE_BUFFER_OVERFLOW);
166 } else if (buffer->length != size_required || !buffer->pointer) {
167 return_ACPI_STATUS(AE_BAD_PARAMETER);
170 head = buffer->pointer;
171 tail = buffer->pointer + tail_offset;
174 * Extract package data.
176 for (i = 0; i < format_count; i++) {
179 union acpi_object *element = &(package->package.elements[i]);
182 return_ACPI_STATUS(AE_BAD_DATA);
185 switch (element->type) {
187 case ACPI_TYPE_INTEGER:
188 switch (format_string[i]) {
190 *((acpi_integer *) head) =
191 element->integer.value;
192 head += sizeof(acpi_integer);
195 pointer = (u8 **) head;
197 *((acpi_integer *) tail) =
198 element->integer.value;
199 head += sizeof(acpi_integer *);
200 tail += sizeof(acpi_integer);
201 /* NULL terminate string */
203 tail += sizeof(char);
206 /* Should never get here */
211 case ACPI_TYPE_STRING:
212 case ACPI_TYPE_BUFFER:
213 switch (format_string[i]) {
215 pointer = (u8 **) head;
217 memcpy(tail, element->string.pointer,
218 element->string.length);
219 head += sizeof(char *);
220 tail += element->string.length * sizeof(char);
221 /* NULL terminate string */
223 tail += sizeof(char);
226 pointer = (u8 **) head;
228 memcpy(tail, element->buffer.pointer,
229 element->buffer.length);
230 head += sizeof(u8 *);
231 tail += element->buffer.length * sizeof(u8);
234 /* Should never get here */
239 case ACPI_TYPE_PACKAGE:
240 /* TBD: handle nested packages... */
242 /* Should never get here */
247 return_ACPI_STATUS(AE_OK);
250 EXPORT_SYMBOL(acpi_extract_package);
252 extern int acpi_in_resume;
254 acpi_evaluate_integer(acpi_handle handle,
255 acpi_string pathname,
256 struct acpi_object_list *arguments, unsigned long *data)
258 acpi_status status = AE_OK;
259 union acpi_object *element;
260 struct acpi_buffer buffer = { 0, NULL };
262 ACPI_FUNCTION_TRACE("acpi_evaluate_integer");
265 return_ACPI_STATUS(AE_BAD_PARAMETER);
268 element = kmalloc(sizeof(union acpi_object), GFP_ATOMIC);
270 element = kmalloc(sizeof(union acpi_object), GFP_KERNEL);
272 return_ACPI_STATUS(AE_NO_MEMORY);
274 memset(element, 0, sizeof(union acpi_object));
275 buffer.length = sizeof(union acpi_object);
276 buffer.pointer = element;
277 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
278 if (ACPI_FAILURE(status)) {
279 acpi_util_eval_error(handle, pathname, status);
280 return_ACPI_STATUS(status);
283 if (element->type != ACPI_TYPE_INTEGER) {
284 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
285 return_ACPI_STATUS(AE_BAD_DATA);
288 *data = element->integer.value;
291 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%lu]\n", *data));
293 return_ACPI_STATUS(AE_OK);
296 EXPORT_SYMBOL(acpi_evaluate_integer);
300 acpi_evaluate_string(acpi_handle handle,
301 acpi_string pathname,
302 acpi_object_list * arguments, acpi_string * data)
304 acpi_status status = AE_OK;
305 acpi_object *element = NULL;
306 acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
308 ACPI_FUNCTION_TRACE("acpi_evaluate_string");
311 return_ACPI_STATUS(AE_BAD_PARAMETER);
313 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
314 if (ACPI_FAILURE(status)) {
315 acpi_util_eval_error(handle, pathname, status);
316 return_ACPI_STATUS(status);
319 element = (acpi_object *) buffer.pointer;
321 if ((element->type != ACPI_TYPE_STRING)
322 || (element->type != ACPI_TYPE_BUFFER)
323 || !element->string.length) {
324 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
325 return_ACPI_STATUS(AE_BAD_DATA);
328 *data = kmalloc(element->string.length + 1, GFP_KERNEL);
330 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Memory allocation error\n"));
331 return_VALUE(-ENOMEM);
333 memset(*data, 0, element->string.length + 1);
335 memcpy(*data, element->string.pointer, element->string.length);
337 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%s]\n", *data));
339 acpi_os_free(buffer.pointer);
341 return_ACPI_STATUS(AE_OK);
346 acpi_evaluate_reference(acpi_handle handle,
347 acpi_string pathname,
348 struct acpi_object_list *arguments,
349 struct acpi_handle_list *list)
351 acpi_status status = AE_OK;
352 union acpi_object *package = NULL;
353 union acpi_object *element = NULL;
354 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
357 ACPI_FUNCTION_TRACE("acpi_evaluate_reference");
360 return_ACPI_STATUS(AE_BAD_PARAMETER);
363 /* Evaluate object. */
365 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
366 if (ACPI_FAILURE(status))
369 package = (union acpi_object *)buffer.pointer;
371 if ((buffer.length == 0) || !package) {
372 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
373 "No return object (len %X ptr %p)\n",
374 (unsigned)buffer.length, package));
375 status = AE_BAD_DATA;
376 acpi_util_eval_error(handle, pathname, status);
379 if (package->type != ACPI_TYPE_PACKAGE) {
380 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
381 "Expecting a [Package], found type %X\n",
383 status = AE_BAD_DATA;
384 acpi_util_eval_error(handle, pathname, status);
387 if (!package->package.count) {
388 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
389 "[Package] has zero elements (%p)\n",
391 status = AE_BAD_DATA;
392 acpi_util_eval_error(handle, pathname, status);
396 if (package->package.count > ACPI_MAX_HANDLES) {
397 return_ACPI_STATUS(AE_NO_MEMORY);
399 list->count = package->package.count;
401 /* Extract package data. */
403 for (i = 0; i < list->count; i++) {
405 element = &(package->package.elements[i]);
407 if (element->type != ACPI_TYPE_ANY) {
408 status = AE_BAD_DATA;
409 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
410 "Expecting a [Reference] package element, found type %X\n",
412 acpi_util_eval_error(handle, pathname, status);
416 /* Get the acpi_handle. */
418 list->handles[i] = element->reference.handle;
419 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
424 if (ACPI_FAILURE(status)) {
426 //kfree(list->handles);
429 acpi_os_free(buffer.pointer);
431 return_ACPI_STATUS(status);
434 EXPORT_SYMBOL(acpi_evaluate_reference);