]> Git Repo - linux.git/blob - drivers/acpi/utils.c
ACPI / utils: Drop error messages from acpi_evaluate_reference()
[linux.git] / drivers / acpi / utils.c
1 /*
2  *  acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
3  *
4  *  Copyright (C) 2001, 2002 Andy Grover <[email protected]>
5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <[email protected]>
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/slab.h>
29 #include <linux/init.h>
30 #include <linux/types.h>
31 #include <linux/hardirq.h>
32 #include <linux/acpi.h>
33 #include <linux/dynamic_debug.h>
34
35 #include "internal.h"
36
37 #define _COMPONENT              ACPI_BUS_COMPONENT
38 ACPI_MODULE_NAME("utils");
39
40 /* --------------------------------------------------------------------------
41                             Object Evaluation Helpers
42    -------------------------------------------------------------------------- */
43 static void
44 acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
45 {
46 #ifdef ACPI_DEBUG_OUTPUT
47         char prefix[80] = {'\0'};
48         struct acpi_buffer buffer = {sizeof(prefix), prefix};
49         acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
50         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
51                 (char *) prefix, p, acpi_format_exception(s)));
52 #else
53         return;
54 #endif
55 }
56
57 acpi_status
58 acpi_extract_package(union acpi_object *package,
59                      struct acpi_buffer *format, struct acpi_buffer *buffer)
60 {
61         u32 size_required = 0;
62         u32 tail_offset = 0;
63         char *format_string = NULL;
64         u32 format_count = 0;
65         u32 i = 0;
66         u8 *head = NULL;
67         u8 *tail = NULL;
68
69
70         if (!package || (package->type != ACPI_TYPE_PACKAGE)
71             || (package->package.count < 1)) {
72                 printk(KERN_WARNING PREFIX "Invalid package argument\n");
73                 return AE_BAD_PARAMETER;
74         }
75
76         if (!format || !format->pointer || (format->length < 1)) {
77                 printk(KERN_WARNING PREFIX "Invalid format argument\n");
78                 return AE_BAD_PARAMETER;
79         }
80
81         if (!buffer) {
82                 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
83                 return AE_BAD_PARAMETER;
84         }
85
86         format_count = (format->length / sizeof(char)) - 1;
87         if (format_count > package->package.count) {
88                 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
89                               " than exist in package [%d].\n",
90                               format_count, package->package.count);
91                 return AE_BAD_DATA;
92         }
93
94         format_string = format->pointer;
95
96         /*
97          * Calculate size_required.
98          */
99         for (i = 0; i < format_count; i++) {
100
101                 union acpi_object *element = &(package->package.elements[i]);
102
103                 switch (element->type) {
104
105                 case ACPI_TYPE_INTEGER:
106                         switch (format_string[i]) {
107                         case 'N':
108                                 size_required += sizeof(u64);
109                                 tail_offset += sizeof(u64);
110                                 break;
111                         case 'S':
112                                 size_required +=
113                                     sizeof(char *) + sizeof(u64) +
114                                     sizeof(char);
115                                 tail_offset += sizeof(char *);
116                                 break;
117                         default:
118                                 printk(KERN_WARNING PREFIX "Invalid package element"
119                                               " [%d]: got number, expecting"
120                                               " [%c]\n",
121                                               i, format_string[i]);
122                                 return AE_BAD_DATA;
123                                 break;
124                         }
125                         break;
126
127                 case ACPI_TYPE_STRING:
128                 case ACPI_TYPE_BUFFER:
129                         switch (format_string[i]) {
130                         case 'S':
131                                 size_required +=
132                                     sizeof(char *) +
133                                     (element->string.length * sizeof(char)) +
134                                     sizeof(char);
135                                 tail_offset += sizeof(char *);
136                                 break;
137                         case 'B':
138                                 size_required +=
139                                     sizeof(u8 *) +
140                                     (element->buffer.length * sizeof(u8));
141                                 tail_offset += sizeof(u8 *);
142                                 break;
143                         default:
144                                 printk(KERN_WARNING PREFIX "Invalid package element"
145                                               " [%d] got string/buffer,"
146                                               " expecting [%c]\n",
147                                               i, format_string[i]);
148                                 return AE_BAD_DATA;
149                                 break;
150                         }
151                         break;
152                 case ACPI_TYPE_LOCAL_REFERENCE:
153                         switch (format_string[i]) {
154                         case 'R':
155                                 size_required += sizeof(void *);
156                                 tail_offset += sizeof(void *);
157                                 break;
158                         default:
159                                 printk(KERN_WARNING PREFIX "Invalid package element"
160                                               " [%d] got reference,"
161                                               " expecting [%c]\n",
162                                               i, format_string[i]);
163                                 return AE_BAD_DATA;
164                                 break;
165                         }
166                         break;
167
168                 case ACPI_TYPE_PACKAGE:
169                 default:
170                         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
171                                           "Found unsupported element at index=%d\n",
172                                           i));
173                         /* TBD: handle nested packages... */
174                         return AE_SUPPORT;
175                         break;
176                 }
177         }
178
179         /*
180          * Validate output buffer.
181          */
182         if (buffer->length == ACPI_ALLOCATE_BUFFER) {
183                 buffer->pointer = ACPI_ALLOCATE_ZEROED(size_required);
184                 if (!buffer->pointer)
185                         return AE_NO_MEMORY;
186                 buffer->length = size_required;
187         } else {
188                 if (buffer->length < size_required) {
189                         buffer->length = size_required;
190                         return AE_BUFFER_OVERFLOW;
191                 } else if (buffer->length != size_required ||
192                            !buffer->pointer) {
193                         return AE_BAD_PARAMETER;
194                 }
195         }
196
197         head = buffer->pointer;
198         tail = buffer->pointer + tail_offset;
199
200         /*
201          * Extract package data.
202          */
203         for (i = 0; i < format_count; i++) {
204
205                 u8 **pointer = NULL;
206                 union acpi_object *element = &(package->package.elements[i]);
207
208                 if (!element) {
209                         return AE_BAD_DATA;
210                 }
211
212                 switch (element->type) {
213
214                 case ACPI_TYPE_INTEGER:
215                         switch (format_string[i]) {
216                         case 'N':
217                                 *((u64 *) head) =
218                                     element->integer.value;
219                                 head += sizeof(u64);
220                                 break;
221                         case 'S':
222                                 pointer = (u8 **) head;
223                                 *pointer = tail;
224                                 *((u64 *) tail) =
225                                     element->integer.value;
226                                 head += sizeof(u64 *);
227                                 tail += sizeof(u64);
228                                 /* NULL terminate string */
229                                 *tail = (char)0;
230                                 tail += sizeof(char);
231                                 break;
232                         default:
233                                 /* Should never get here */
234                                 break;
235                         }
236                         break;
237
238                 case ACPI_TYPE_STRING:
239                 case ACPI_TYPE_BUFFER:
240                         switch (format_string[i]) {
241                         case 'S':
242                                 pointer = (u8 **) head;
243                                 *pointer = tail;
244                                 memcpy(tail, element->string.pointer,
245                                        element->string.length);
246                                 head += sizeof(char *);
247                                 tail += element->string.length * sizeof(char);
248                                 /* NULL terminate string */
249                                 *tail = (char)0;
250                                 tail += sizeof(char);
251                                 break;
252                         case 'B':
253                                 pointer = (u8 **) head;
254                                 *pointer = tail;
255                                 memcpy(tail, element->buffer.pointer,
256                                        element->buffer.length);
257                                 head += sizeof(u8 *);
258                                 tail += element->buffer.length * sizeof(u8);
259                                 break;
260                         default:
261                                 /* Should never get here */
262                                 break;
263                         }
264                         break;
265                 case ACPI_TYPE_LOCAL_REFERENCE:
266                         switch (format_string[i]) {
267                         case 'R':
268                                 *(void **)head =
269                                     (void *)element->reference.handle;
270                                 head += sizeof(void *);
271                                 break;
272                         default:
273                                 /* Should never get here */
274                                 break;
275                         }
276                         break;
277                 case ACPI_TYPE_PACKAGE:
278                         /* TBD: handle nested packages... */
279                 default:
280                         /* Should never get here */
281                         break;
282                 }
283         }
284
285         return AE_OK;
286 }
287
288 EXPORT_SYMBOL(acpi_extract_package);
289
290 acpi_status
291 acpi_evaluate_integer(acpi_handle handle,
292                       acpi_string pathname,
293                       struct acpi_object_list *arguments, unsigned long long *data)
294 {
295         acpi_status status = AE_OK;
296         union acpi_object element;
297         struct acpi_buffer buffer = { 0, NULL };
298
299         if (!data)
300                 return AE_BAD_PARAMETER;
301
302         buffer.length = sizeof(union acpi_object);
303         buffer.pointer = &element;
304         status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
305         if (ACPI_FAILURE(status)) {
306                 acpi_util_eval_error(handle, pathname, status);
307                 return status;
308         }
309
310         if (element.type != ACPI_TYPE_INTEGER) {
311                 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
312                 return AE_BAD_DATA;
313         }
314
315         *data = element.integer.value;
316
317         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
318
319         return AE_OK;
320 }
321
322 EXPORT_SYMBOL(acpi_evaluate_integer);
323
324 acpi_status
325 acpi_evaluate_reference(acpi_handle handle,
326                         acpi_string pathname,
327                         struct acpi_object_list *arguments,
328                         struct acpi_handle_list *list)
329 {
330         acpi_status status = AE_OK;
331         union acpi_object *package = NULL;
332         union acpi_object *element = NULL;
333         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
334         u32 i = 0;
335
336
337         if (!list) {
338                 return AE_BAD_PARAMETER;
339         }
340
341         /* Evaluate object. */
342
343         status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
344         if (ACPI_FAILURE(status))
345                 goto end;
346
347         package = buffer.pointer;
348
349         if ((buffer.length == 0) || !package) {
350                 status = AE_BAD_DATA;
351                 acpi_util_eval_error(handle, pathname, status);
352                 goto end;
353         }
354         if (package->type != ACPI_TYPE_PACKAGE) {
355                 status = AE_BAD_DATA;
356                 acpi_util_eval_error(handle, pathname, status);
357                 goto end;
358         }
359         if (!package->package.count) {
360                 status = AE_BAD_DATA;
361                 acpi_util_eval_error(handle, pathname, status);
362                 goto end;
363         }
364
365         if (package->package.count > ACPI_MAX_HANDLES) {
366                 return AE_NO_MEMORY;
367         }
368         list->count = package->package.count;
369
370         /* Extract package data. */
371
372         for (i = 0; i < list->count; i++) {
373
374                 element = &(package->package.elements[i]);
375
376                 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
377                         status = AE_BAD_DATA;
378                         acpi_util_eval_error(handle, pathname, status);
379                         break;
380                 }
381
382                 if (!element->reference.handle) {
383                         status = AE_NULL_ENTRY;
384                         acpi_util_eval_error(handle, pathname, status);
385                         break;
386                 }
387                 /* Get the  acpi_handle. */
388
389                 list->handles[i] = element->reference.handle;
390                 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
391                                   list->handles[i]));
392         }
393
394       end:
395         if (ACPI_FAILURE(status)) {
396                 list->count = 0;
397                 //kfree(list->handles);
398         }
399
400         kfree(buffer.pointer);
401
402         return status;
403 }
404
405 EXPORT_SYMBOL(acpi_evaluate_reference);
406
407 acpi_status
408 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
409 {
410         acpi_status status;
411         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
412         union acpi_object *output;
413
414         status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
415
416         if (ACPI_FAILURE(status))
417                 return status;
418
419         output = buffer.pointer;
420
421         if (!output || output->type != ACPI_TYPE_PACKAGE
422             || !output->package.count
423             || output->package.elements[0].type != ACPI_TYPE_BUFFER
424             || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
425                 status = AE_TYPE;
426                 goto out;
427         }
428
429         status = acpi_decode_pld_buffer(
430                         output->package.elements[0].buffer.pointer,
431                         output->package.elements[0].buffer.length,
432                         pld);
433
434 out:
435         kfree(buffer.pointer);
436         return status;
437 }
438 EXPORT_SYMBOL(acpi_get_physical_device_location);
439
440 /**
441  * acpi_evaluate_ost: Evaluate _OST for hotplug operations
442  * @handle: ACPI device handle
443  * @source_event: source event code
444  * @status_code: status code
445  * @status_buf: optional detailed information (NULL if none)
446  *
447  * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
448  * must call this function when evaluating _OST for hotplug operations.
449  * When the platform does not support _OST, this function has no effect.
450  */
451 acpi_status
452 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
453                   struct acpi_buffer *status_buf)
454 {
455         union acpi_object params[3] = {
456                 {.type = ACPI_TYPE_INTEGER,},
457                 {.type = ACPI_TYPE_INTEGER,},
458                 {.type = ACPI_TYPE_BUFFER,}
459         };
460         struct acpi_object_list arg_list = {3, params};
461
462         params[0].integer.value = source_event;
463         params[1].integer.value = status_code;
464         if (status_buf != NULL) {
465                 params[2].buffer.pointer = status_buf->pointer;
466                 params[2].buffer.length = status_buf->length;
467         } else {
468                 params[2].buffer.pointer = NULL;
469                 params[2].buffer.length = 0;
470         }
471
472         return acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
473 }
474 EXPORT_SYMBOL(acpi_evaluate_ost);
475
476 /**
477  * acpi_handle_path: Return the object path of handle
478  *
479  * Caller must free the returned buffer
480  */
481 static char *acpi_handle_path(acpi_handle handle)
482 {
483         struct acpi_buffer buffer = {
484                 .length = ACPI_ALLOCATE_BUFFER,
485                 .pointer = NULL
486         };
487
488         if (in_interrupt() ||
489             acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
490                 return NULL;
491         return buffer.pointer;
492 }
493
494 /**
495  * acpi_handle_printk: Print message with ACPI prefix and object path
496  *
497  * This function is called through acpi_handle_<level> macros and prints
498  * a message with ACPI prefix and object path.  This function acquires
499  * the global namespace mutex to obtain an object path.  In interrupt
500  * context, it shows the object path as <n/a>.
501  */
502 void
503 acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
504 {
505         struct va_format vaf;
506         va_list args;
507         const char *path;
508
509         va_start(args, fmt);
510         vaf.fmt = fmt;
511         vaf.va = &args;
512
513         path = acpi_handle_path(handle);
514         printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
515
516         va_end(args);
517         kfree(path);
518 }
519 EXPORT_SYMBOL(acpi_handle_printk);
520
521 #if defined(CONFIG_DYNAMIC_DEBUG)
522 /**
523  * __acpi_handle_debug: pr_debug with ACPI prefix and object path
524  *
525  * This function is called through acpi_handle_debug macro and debug
526  * prints a message with ACPI prefix and object path. This function
527  * acquires the global namespace mutex to obtain an object path.  In
528  * interrupt context, it shows the object path as <n/a>.
529  */
530 void
531 __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
532                     const char *fmt, ...)
533 {
534         struct va_format vaf;
535         va_list args;
536         const char *path;
537
538         va_start(args, fmt);
539         vaf.fmt = fmt;
540         vaf.va = &args;
541
542         path = acpi_handle_path(handle);
543         __dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
544
545         va_end(args);
546         kfree(path);
547 }
548 EXPORT_SYMBOL(__acpi_handle_debug);
549 #endif
550
551 /**
552  * acpi_has_method: Check whether @handle has a method named @name
553  * @handle: ACPI device handle
554  * @name: name of object or method
555  *
556  * Check whether @handle has a method named @name.
557  */
558 bool acpi_has_method(acpi_handle handle, char *name)
559 {
560         acpi_handle tmp;
561
562         return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
563 }
564 EXPORT_SYMBOL(acpi_has_method);
565
566 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
567                                        u64 arg)
568 {
569         union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
570         struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
571
572         obj.integer.value = arg;
573
574         return acpi_evaluate_object(handle, method, &arg_list, NULL);
575 }
576 EXPORT_SYMBOL(acpi_execute_simple_method);
577
578 /**
579  * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
580  * @handle: ACPI device handle
581  *
582  * Evaluate device's _EJ0 method for hotplug operations.
583  */
584 acpi_status acpi_evaluate_ej0(acpi_handle handle)
585 {
586         acpi_status status;
587
588         status = acpi_execute_simple_method(handle, "_EJ0", 1);
589         if (status == AE_NOT_FOUND)
590                 acpi_handle_warn(handle, "No _EJ0 support for device\n");
591         else if (ACPI_FAILURE(status))
592                 acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
593
594         return status;
595 }
596
597 /**
598  * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
599  * @handle: ACPI device handle
600  * @lock: lock device if non-zero, otherwise unlock device
601  *
602  * Evaluate device's _LCK method if present to lock/unlock device
603  */
604 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
605 {
606         acpi_status status;
607
608         status = acpi_execute_simple_method(handle, "_LCK", !!lock);
609         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
610                 if (lock)
611                         acpi_handle_warn(handle,
612                                 "Locking device failed (0x%x)\n", status);
613                 else
614                         acpi_handle_warn(handle,
615                                 "Unlocking device failed (0x%x)\n", status);
616         }
617
618         return status;
619 }
620
621 /**
622  * acpi_evaluate_dsm - evaluate device's _DSM method
623  * @handle: ACPI device handle
624  * @uuid: UUID of requested functions, should be 16 bytes
625  * @rev: revision number of requested function
626  * @func: requested function number
627  * @argv4: the function specific parameter
628  *
629  * Evaluate device's _DSM method with specified UUID, revision id and
630  * function number. Caller needs to free the returned object.
631  *
632  * Though ACPI defines the fourth parameter for _DSM should be a package,
633  * some old BIOSes do expect a buffer or an integer etc.
634  */
635 union acpi_object *
636 acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid, int rev, int func,
637                   union acpi_object *argv4)
638 {
639         acpi_status ret;
640         struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
641         union acpi_object params[4];
642         struct acpi_object_list input = {
643                 .count = 4,
644                 .pointer = params,
645         };
646
647         params[0].type = ACPI_TYPE_BUFFER;
648         params[0].buffer.length = 16;
649         params[0].buffer.pointer = (char *)uuid;
650         params[1].type = ACPI_TYPE_INTEGER;
651         params[1].integer.value = rev;
652         params[2].type = ACPI_TYPE_INTEGER;
653         params[2].integer.value = func;
654         if (argv4) {
655                 params[3] = *argv4;
656         } else {
657                 params[3].type = ACPI_TYPE_PACKAGE;
658                 params[3].package.count = 0;
659                 params[3].package.elements = NULL;
660         }
661
662         ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
663         if (ACPI_SUCCESS(ret))
664                 return (union acpi_object *)buf.pointer;
665
666         if (ret != AE_NOT_FOUND)
667                 acpi_handle_warn(handle,
668                                 "failed to evaluate _DSM (0x%x)\n", ret);
669
670         return NULL;
671 }
672 EXPORT_SYMBOL(acpi_evaluate_dsm);
673
674 /**
675  * acpi_check_dsm - check if _DSM method supports requested functions.
676  * @handle: ACPI device handle
677  * @uuid: UUID of requested functions, should be 16 bytes at least
678  * @rev: revision number of requested functions
679  * @funcs: bitmap of requested functions
680  *
681  * Evaluate device's _DSM method to check whether it supports requested
682  * functions. Currently only support 64 functions at maximum, should be
683  * enough for now.
684  */
685 bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, int rev, u64 funcs)
686 {
687         int i;
688         u64 mask = 0;
689         union acpi_object *obj;
690
691         if (funcs == 0)
692                 return false;
693
694         obj = acpi_evaluate_dsm(handle, uuid, rev, 0, NULL);
695         if (!obj)
696                 return false;
697
698         /* For compatibility, old BIOSes may return an integer */
699         if (obj->type == ACPI_TYPE_INTEGER)
700                 mask = obj->integer.value;
701         else if (obj->type == ACPI_TYPE_BUFFER)
702                 for (i = 0; i < obj->buffer.length && i < 8; i++)
703                         mask |= (((u8)obj->buffer.pointer[i]) << (i * 8));
704         ACPI_FREE(obj);
705
706         /*
707          * Bit 0 indicates whether there's support for any functions other than
708          * function 0 for the specified UUID and revision.
709          */
710         if ((mask & 0x1) && (mask & funcs) == funcs)
711                 return true;
712
713         return false;
714 }
715 EXPORT_SYMBOL(acpi_check_dsm);
This page took 0.116423 seconds and 4 git commands to generate.