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 #define _COMPONENT              ACPI_BUS_COMPONENT
  34 ACPI_MODULE_NAME("utils");
  35
  36 /* --------------------------------------------------------------------------
  37                             Object Evaluation Helpers
  38    -------------------------------------------------------------------------- */
  39 <<<<<<< HEAD:drivers/acpi/utils.c
  40 =======
  41 static void
  42 acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
  43 {
  44 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/acpi/utils.c
  45 #ifdef ACPI_DEBUG_OUTPUT
  46 <<<<<<< HEAD:drivers/acpi/utils.c
  47 #define acpi_util_eval_error(h,p,s) {\
  48         char prefix[80] = {'\0'};\
  49         struct acpi_buffer buffer = {sizeof(prefix), prefix};\
  50         acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);\
  51         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",\
  52                 (char *) prefix, p, acpi_format_exception(s))); }
  53 =======
  54         char prefix[80] = {'\0'};
  55         struct acpi_buffer buffer = {sizeof(prefix), prefix};
  56         acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
  57         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
  58                 (char *) prefix, p, acpi_format_exception(s)));
  59 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/acpi/utils.c
  60 #else
  61 <<<<<<< HEAD:drivers/acpi/utils.c
  62 #define acpi_util_eval_error(h,p,s)
  63 =======
  64         return;
  65 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/acpi/utils.c
  66 #endif
  67 <<<<<<< HEAD:drivers/acpi/utils.c
  68 =======
  69 }
  70
  71 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/acpi/utils.c
  72 acpi_status
  73 acpi_extract_package(union acpi_object *package,
  74                      struct acpi_buffer *format, struct acpi_buffer *buffer)
  75 {
  76         u32 size_required = 0;
  77         u32 tail_offset = 0;
  78         char *format_string = NULL;
  79         u32 format_count = 0;
  80         u32 i = 0;
  81         u8 *head = NULL;
  82         u8 *tail = NULL;
  83
  84
  85         if (!package || (package->type != ACPI_TYPE_PACKAGE)
  86             || (package->package.count < 1)) {
  87                 printk(KERN_WARNING PREFIX "Invalid package argument\n");
  88                 return AE_BAD_PARAMETER;
  89         }
  90
  91         if (!format || !format->pointer || (format->length < 1)) {
  92                 printk(KERN_WARNING PREFIX "Invalid format argument\n");
  93                 return AE_BAD_PARAMETER;
  94         }
  95
  96         if (!buffer) {
  97                 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
  98                 return AE_BAD_PARAMETER;
  99         }
 100
 101         format_count = (format->length / sizeof(char)) - 1;
 102         if (format_count > package->package.count) {
 103                 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
 104                               " than exist in package [%d].\n",
 105                               format_count, package->package.count);
 106                 return AE_BAD_DATA;
 107         }
 108
 109         format_string = format->pointer;
 110
 111         /*
 112          * Calculate size_required.
 113          */
 114         for (i = 0; i < format_count; i++) {
 115
 116                 union acpi_object *element = &(package->package.elements[i]);
 117
 118                 if (!element) {
 119                         return AE_BAD_DATA;
 120                 }
 121
 122                 switch (element->type) {
 123
 124                 case ACPI_TYPE_INTEGER:
 125                         switch (format_string[i]) {
 126                         case 'N':
 127                                 size_required += sizeof(acpi_integer);
 128                                 tail_offset += sizeof(acpi_integer);
 129                                 break;
 130                         case 'S':
 131                                 size_required +=
 132                                     sizeof(char *) + sizeof(acpi_integer) +
 133                                     sizeof(char);
 134                                 tail_offset += sizeof(char *);
 135                                 break;
 136                         default:
 137                                 printk(KERN_WARNING PREFIX "Invalid package element"
 138                                               " [%d]: got number, expecing"
 139                                               " [%c]\n",
 140                                               i, format_string[i]);
 141                                 return AE_BAD_DATA;
 142                                 break;
 143                         }
 144                         break;
 145
 146                 case ACPI_TYPE_STRING:
 147                 case ACPI_TYPE_BUFFER:
 148                         switch (format_string[i]) {
 149                         case 'S':
 150                                 size_required +=
 151                                     sizeof(char *) +
 152                                     (element->string.length * sizeof(char)) +
 153                                     sizeof(char);
 154                                 tail_offset += sizeof(char *);
 155                                 break;
 156                         case 'B':
 157                                 size_required +=
 158                                     sizeof(u8 *) +
 159                                     (element->buffer.length * sizeof(u8));
 160                                 tail_offset += sizeof(u8 *);
 161                                 break;
 162                         default:
 163                                 printk(KERN_WARNING PREFIX "Invalid package element"
 164                                               " [%d] got string/buffer,"
 165                                               " expecing [%c]\n",
 166                                               i, format_string[i]);
 167                                 return AE_BAD_DATA;
 168                                 break;
 169                         }
 170                         break;
 171
 172                 case ACPI_TYPE_PACKAGE:
 173                 default:
 174                         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 175                                           "Found unsupported element at index=%d\n",
 176                                           i));
 177                         /* TBD: handle nested packages... */
 178                         return AE_SUPPORT;
 179                         break;
 180                 }
 181         }
 182
 183         /*
 184          * Validate output buffer.
 185          */
 186         if (buffer->length < size_required) {
 187                 buffer->length = size_required;
 188                 return AE_BUFFER_OVERFLOW;
 189         } else if (buffer->length != size_required || !buffer->pointer) {
 190                 return AE_BAD_PARAMETER;
 191         }
 192
 193         head = buffer->pointer;
 194         tail = buffer->pointer + tail_offset;
 195
 196         /*
 197          * Extract package data.
 198          */
 199         for (i = 0; i < format_count; i++) {
 200
 201                 u8 **pointer = NULL;
 202                 union acpi_object *element = &(package->package.elements[i]);
 203
 204                 if (!element) {
 205                         return AE_BAD_DATA;
 206                 }
 207
 208                 switch (element->type) {
 209
 210                 case ACPI_TYPE_INTEGER:
 211                         switch (format_string[i]) {
 212                         case 'N':
 213                                 *((acpi_integer *) head) =
 214                                     element->integer.value;
 215                                 head += sizeof(acpi_integer);
 216                                 break;
 217                         case 'S':
 218                                 pointer = (u8 **) head;
 219                                 *pointer = tail;
 220                                 *((acpi_integer *) tail) =
 221                                     element->integer.value;
 222                                 head += sizeof(acpi_integer *);
 223                                 tail += sizeof(acpi_integer);
 224                                 /* NULL terminate string */
 225                                 *tail = (char)0;
 226                                 tail += sizeof(char);
 227                                 break;
 228                         default:
 229                                 /* Should never get here */
 230                                 break;
 231                         }
 232                         break;
 233
 234                 case ACPI_TYPE_STRING:
 235                 case ACPI_TYPE_BUFFER:
 236                         switch (format_string[i]) {
 237                         case 'S':
 238                                 pointer = (u8 **) head;
 239                                 *pointer = tail;
 240                                 memcpy(tail, element->string.pointer,
 241                                        element->string.length);
 242                                 head += sizeof(char *);
 243                                 tail += element->string.length * sizeof(char);
 244                                 /* NULL terminate string */
 245                                 *tail = (char)0;
 246                                 tail += sizeof(char);
 247                                 break;
 248                         case 'B':
 249                                 pointer = (u8 **) head;
 250                                 *pointer = tail;
 251                                 memcpy(tail, element->buffer.pointer,
 252                                        element->buffer.length);
 253                                 head += sizeof(u8 *);
 254                                 tail += element->buffer.length * sizeof(u8);
 255                                 break;
 256                         default:
 257                                 /* Should never get here */
 258                                 break;
 259                         }
 260                         break;
 261
 262                 case ACPI_TYPE_PACKAGE:
 263                         /* TBD: handle nested packages... */
 264                 default:
 265                         /* Should never get here */
 266                         break;
 267                 }
 268         }
 269
 270         return AE_OK;
 271 }
 272
 273 EXPORT_SYMBOL(acpi_extract_package);
 274
 275 acpi_status
 276 acpi_evaluate_integer(acpi_handle handle,
 277                       acpi_string pathname,
 278                       struct acpi_object_list *arguments, unsigned long *data)
 279 {
 280         acpi_status status = AE_OK;
 281         union acpi_object *element;
 282         struct acpi_buffer buffer = { 0, NULL };
 283
 284
 285         if (!data)
 286                 return AE_BAD_PARAMETER;
 287
 288         element = kzalloc(sizeof(union acpi_object), irqs_disabled() ? GFP_ATOMIC: GFP_KERNEL);
 289         if (!element)
 290                 return AE_NO_MEMORY;
 291
 292         buffer.length = sizeof(union acpi_object);
 293         buffer.pointer = element;
 294         status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
 295         if (ACPI_FAILURE(status)) {
 296                 acpi_util_eval_error(handle, pathname, status);
 297                 kfree(element);
 298                 return status;
 299         }
 300
 301         if (element->type != ACPI_TYPE_INTEGER) {
 302                 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
 303                 kfree(element);
 304                 return AE_BAD_DATA;
 305         }
 306
 307         *data = element->integer.value;
 308         kfree(element);
 309
 310         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%lu]\n", *data));
 311
 312         return AE_OK;
 313 }
 314
 315 EXPORT_SYMBOL(acpi_evaluate_integer);
 316
 317 #if 0
 318 acpi_status
 319 acpi_evaluate_string(acpi_handle handle,
 320                      acpi_string pathname,
 321                      acpi_object_list * arguments, acpi_string * data)
 322 {
 323         acpi_status status = AE_OK;
 324         acpi_object *element = NULL;
 325         acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 326
 327
 328         if (!data)
 329                 return AE_BAD_PARAMETER;
 330
 331         status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
 332         if (ACPI_FAILURE(status)) {
 333                 acpi_util_eval_error(handle, pathname, status);
 334                 return status;
 335         }
 336
 337         element = (acpi_object *) buffer.pointer;
 338
 339         if ((element->type != ACPI_TYPE_STRING)
 340             || (element->type != ACPI_TYPE_BUFFER)
 341             || !element->string.length) {
 342                 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
 343                 return AE_BAD_DATA;
 344         }
 345
 346         *data = kzalloc(element->string.length + 1, GFP_KERNEL);
 347         if (!data) {
 348                 printk(KERN_ERR PREFIX "Memory allocation\n");
 349                 return -ENOMEM;
 350         }
 351
 352         memcpy(*data, element->string.pointer, element->string.length);
 353
 354         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%s]\n", *data));
 355
 356         kfree(buffer.pointer);
 357
 358         return AE_OK;
 359 }
 360 #endif
 361
 362 acpi_status
 363 acpi_evaluate_reference(acpi_handle handle,
 364                         acpi_string pathname,
 365                         struct acpi_object_list *arguments,
 366                         struct acpi_handle_list *list)
 367 {
 368         acpi_status status = AE_OK;
 369         union acpi_object *package = NULL;
 370         union acpi_object *element = NULL;
 371         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 372         u32 i = 0;
 373
 374
 375         if (!list) {
 376                 return AE_BAD_PARAMETER;
 377         }
 378
 379         /* Evaluate object. */
 380
 381         status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
 382         if (ACPI_FAILURE(status))
 383                 goto end;
 384
 385         package = buffer.pointer;
 386
 387         if ((buffer.length == 0) || !package) {
 388                 printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
 389                             (unsigned)buffer.length, package);
 390                 status = AE_BAD_DATA;
 391                 acpi_util_eval_error(handle, pathname, status);
 392                 goto end;
 393         }
 394         if (package->type != ACPI_TYPE_PACKAGE) {
 395                 printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
 396                             package->type);
 397                 status = AE_BAD_DATA;
 398                 acpi_util_eval_error(handle, pathname, status);
 399                 goto end;
 400         }
 401         if (!package->package.count) {
 402                 printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
 403                             package);
 404                 status = AE_BAD_DATA;
 405                 acpi_util_eval_error(handle, pathname, status);
 406                 goto end;
 407         }
 408
 409         if (package->package.count > ACPI_MAX_HANDLES) {
 410                 return AE_NO_MEMORY;
 411         }
 412         list->count = package->package.count;
 413
 414         /* Extract package data. */
 415
 416         for (i = 0; i < list->count; i++) {
 417
 418                 element = &(package->package.elements[i]);
 419
 420                 if (element->type != ACPI_TYPE_ANY) {
 421                         status = AE_BAD_DATA;
 422                         printk(KERN_ERR PREFIX
 423                                     "Expecting a [Reference] package element, found type %X\n",
 424                                     element->type);
 425                         acpi_util_eval_error(handle, pathname, status);
 426                         break;
 427                 }
 428
 429 <<<<<<< HEAD:drivers/acpi/utils.c
 430 =======
 431                 if (!element->reference.handle) {
 432                         printk(KERN_WARNING PREFIX "Invalid reference in"
 433                                " package %s\n", pathname);
 434                         status = AE_NULL_ENTRY;
 435                         break;
 436                 }
 437 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/acpi/utils.c
 438                 /* Get the  acpi_handle. */
 439
 440                 list->handles[i] = element->reference.handle;
 441                 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
 442                                   list->handles[i]));
 443         }
 444
 445       end:
 446         if (ACPI_FAILURE(status)) {
 447                 list->count = 0;
 448                 //kfree(list->handles);
 449         }
 450
 451         kfree(buffer.pointer);
 452
 453         return status;
 454 }
 455
 456 EXPORT_SYMBOL(acpi_evaluate_reference);