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