Merge branch 'from-linus' into upstream
[linux-2.6] / drivers / acpi / dispatcher / dsobject.c
1 /******************************************************************************
2  *
3  * Module Name: dsobject - Dispatcher object management routines
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, R. Byron Moore
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43
44 #include <acpi/acpi.h>
45 #include <acpi/acparser.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acdispat.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acinterp.h>
50
51 #define _COMPONENT          ACPI_DISPATCHER
52 ACPI_MODULE_NAME("dsobject")
53
54 /* Local prototypes */
55 static acpi_status
56 acpi_ds_build_internal_object(struct acpi_walk_state *walk_state,
57                               union acpi_parse_object *op,
58                               union acpi_operand_object **obj_desc_ptr);
59
60 #ifndef ACPI_NO_METHOD_EXECUTION
61 /*******************************************************************************
62  *
63  * FUNCTION:    acpi_ds_build_internal_object
64  *
65  * PARAMETERS:  walk_state      - Current walk state
66  *              Op              - Parser object to be translated
67  *              obj_desc_ptr    - Where the ACPI internal object is returned
68  *
69  * RETURN:      Status
70  *
71  * DESCRIPTION: Translate a parser Op object to the equivalent namespace object
72  *              Simple objects are any objects other than a package object!
73  *
74  ******************************************************************************/
75
76 static acpi_status
77 acpi_ds_build_internal_object(struct acpi_walk_state *walk_state,
78                               union acpi_parse_object *op,
79                               union acpi_operand_object **obj_desc_ptr)
80 {
81         union acpi_operand_object *obj_desc;
82         acpi_status status;
83
84         ACPI_FUNCTION_TRACE(ds_build_internal_object);
85
86         *obj_desc_ptr = NULL;
87         if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
88                 /*
89                  * This is a named object reference. If this name was
90                  * previously looked up in the namespace, it was stored in this op.
91                  * Otherwise, go ahead and look it up now
92                  */
93                 if (!op->common.node) {
94                         status = acpi_ns_lookup(walk_state->scope_info,
95                                                 op->common.value.string,
96                                                 ACPI_TYPE_ANY,
97                                                 ACPI_IMODE_EXECUTE,
98                                                 ACPI_NS_SEARCH_PARENT |
99                                                 ACPI_NS_DONT_OPEN_SCOPE, NULL,
100                                                 ACPI_CAST_INDIRECT_PTR(struct
101                                                                        acpi_namespace_node,
102                                                                        &(op->
103                                                                          common.
104                                                                          node)));
105                         if (ACPI_FAILURE(status)) {
106
107                                 /* Check if we are resolving a named reference within a package */
108
109                                 if ((status == AE_NOT_FOUND)
110                                     && (acpi_gbl_enable_interpreter_slack)
111                                     &&
112                                     ((op->common.parent->common.aml_opcode ==
113                                       AML_PACKAGE_OP)
114                                      || (op->common.parent->common.aml_opcode ==
115                                          AML_VAR_PACKAGE_OP))) {
116                                         /*
117                                          * We didn't find the target and we are populating elements
118                                          * of a package - ignore if slack enabled. Some ASL code
119                                          * contains dangling invalid references in packages and
120                                          * expects that no exception will be issued. Leave the
121                                          * element as a null element. It cannot be used, but it
122                                          * can be overwritten by subsequent ASL code - this is
123                                          * typically the case.
124                                          */
125                                         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
126                                                           "Ignoring unresolved reference in package [%4.4s]\n",
127                                                           walk_state->
128                                                           scope_info->scope.
129                                                           node->name.ascii));
130
131                                         return_ACPI_STATUS(AE_OK);
132                                 } else {
133                                         ACPI_ERROR_NAMESPACE(op->common.value.
134                                                              string, status);
135                                 }
136
137                                 return_ACPI_STATUS(status);
138                         }
139                 }
140         }
141
142         /* Create and init a new internal ACPI object */
143
144         obj_desc = acpi_ut_create_internal_object((acpi_ps_get_opcode_info
145                                                    (op->common.aml_opcode))->
146                                                   object_type);
147         if (!obj_desc) {
148                 return_ACPI_STATUS(AE_NO_MEMORY);
149         }
150
151         status =
152             acpi_ds_init_object_from_op(walk_state, op, op->common.aml_opcode,
153                                         &obj_desc);
154         if (ACPI_FAILURE(status)) {
155                 acpi_ut_remove_reference(obj_desc);
156                 return_ACPI_STATUS(status);
157         }
158
159         *obj_desc_ptr = obj_desc;
160         return_ACPI_STATUS(AE_OK);
161 }
162
163 /*******************************************************************************
164  *
165  * FUNCTION:    acpi_ds_build_internal_buffer_obj
166  *
167  * PARAMETERS:  walk_state      - Current walk state
168  *              Op              - Parser object to be translated
169  *              buffer_length   - Length of the buffer
170  *              obj_desc_ptr    - Where the ACPI internal object is returned
171  *
172  * RETURN:      Status
173  *
174  * DESCRIPTION: Translate a parser Op package object to the equivalent
175  *              namespace object
176  *
177  ******************************************************************************/
178
179 acpi_status
180 acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
181                                   union acpi_parse_object *op,
182                                   u32 buffer_length,
183                                   union acpi_operand_object **obj_desc_ptr)
184 {
185         union acpi_parse_object *arg;
186         union acpi_operand_object *obj_desc;
187         union acpi_parse_object *byte_list;
188         u32 byte_list_length = 0;
189
190         ACPI_FUNCTION_TRACE(ds_build_internal_buffer_obj);
191
192         /*
193          * If we are evaluating a Named buffer object "Name (xxxx, Buffer)".
194          * The buffer object already exists (from the NS node), otherwise it must
195          * be created.
196          */
197         obj_desc = *obj_desc_ptr;
198         if (!obj_desc) {
199
200                 /* Create a new buffer object */
201
202                 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
203                 *obj_desc_ptr = obj_desc;
204                 if (!obj_desc) {
205                         return_ACPI_STATUS(AE_NO_MEMORY);
206                 }
207         }
208
209         /*
210          * Second arg is the buffer data (optional) byte_list can be either
211          * individual bytes or a string initializer.  In either case, a
212          * byte_list appears in the AML.
213          */
214         arg = op->common.value.arg;     /* skip first arg */
215
216         byte_list = arg->named.next;
217         if (byte_list) {
218                 if (byte_list->common.aml_opcode != AML_INT_BYTELIST_OP) {
219                         ACPI_ERROR((AE_INFO,
220                                     "Expecting bytelist, got AML opcode %X in op %p",
221                                     byte_list->common.aml_opcode, byte_list));
222
223                         acpi_ut_remove_reference(obj_desc);
224                         return (AE_TYPE);
225                 }
226
227                 byte_list_length = (u32) byte_list->common.value.integer;
228         }
229
230         /*
231          * The buffer length (number of bytes) will be the larger of:
232          * 1) The specified buffer length and
233          * 2) The length of the initializer byte list
234          */
235         obj_desc->buffer.length = buffer_length;
236         if (byte_list_length > buffer_length) {
237                 obj_desc->buffer.length = byte_list_length;
238         }
239
240         /* Allocate the buffer */
241
242         if (obj_desc->buffer.length == 0) {
243                 obj_desc->buffer.pointer = NULL;
244                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
245                                   "Buffer defined with zero length in AML, creating\n"));
246         } else {
247                 obj_desc->buffer.pointer =
248                     ACPI_ALLOCATE_ZEROED(obj_desc->buffer.length);
249                 if (!obj_desc->buffer.pointer) {
250                         acpi_ut_delete_object_desc(obj_desc);
251                         return_ACPI_STATUS(AE_NO_MEMORY);
252                 }
253
254                 /* Initialize buffer from the byte_list (if present) */
255
256                 if (byte_list) {
257                         ACPI_MEMCPY(obj_desc->buffer.pointer,
258                                     byte_list->named.data, byte_list_length);
259                 }
260         }
261
262         obj_desc->buffer.flags |= AOPOBJ_DATA_VALID;
263         op->common.node = (struct acpi_namespace_node *)obj_desc;
264         return_ACPI_STATUS(AE_OK);
265 }
266
267 /*******************************************************************************
268  *
269  * FUNCTION:    acpi_ds_build_internal_package_obj
270  *
271  * PARAMETERS:  walk_state      - Current walk state
272  *              Op              - Parser object to be translated
273  *              package_length  - Number of elements in the package
274  *              obj_desc_ptr    - Where the ACPI internal object is returned
275  *
276  * RETURN:      Status
277  *
278  * DESCRIPTION: Translate a parser Op package object to the equivalent
279  *              namespace object
280  *
281  ******************************************************************************/
282
283 acpi_status
284 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
285                                    union acpi_parse_object *op,
286                                    u32 package_length,
287                                    union acpi_operand_object **obj_desc_ptr)
288 {
289         union acpi_parse_object *arg;
290         union acpi_parse_object *parent;
291         union acpi_operand_object *obj_desc = NULL;
292         u32 package_list_length;
293         acpi_status status = AE_OK;
294         acpi_native_uint i;
295
296         ACPI_FUNCTION_TRACE(ds_build_internal_package_obj);
297
298         /* Find the parent of a possibly nested package */
299
300         parent = op->common.parent;
301         while ((parent->common.aml_opcode == AML_PACKAGE_OP) ||
302                (parent->common.aml_opcode == AML_VAR_PACKAGE_OP)) {
303                 parent = parent->common.parent;
304         }
305
306         /*
307          * If we are evaluating a Named package object "Name (xxxx, Package)",
308          * the package object already exists, otherwise it must be created.
309          */
310         obj_desc = *obj_desc_ptr;
311         if (!obj_desc) {
312                 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
313                 *obj_desc_ptr = obj_desc;
314                 if (!obj_desc) {
315                         return_ACPI_STATUS(AE_NO_MEMORY);
316                 }
317
318                 obj_desc->package.node = parent->common.node;
319         }
320
321         obj_desc->package.count = package_length;
322
323         /* Count the number of items in the package list */
324
325         arg = op->common.value.arg;
326         arg = arg->common.next;
327         for (package_list_length = 0; arg; package_list_length++) {
328                 arg = arg->common.next;
329         }
330
331         /*
332          * The package length (number of elements) will be the greater
333          * of the specified length and the length of the initializer list
334          */
335         if (package_list_length > package_length) {
336                 obj_desc->package.count = package_list_length;
337         }
338
339         /*
340          * Allocate the pointer array (array of pointers to the
341          * individual objects). Add an extra pointer slot so
342          * that the list is always null terminated.
343          */
344         obj_desc->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
345                                                            obj_desc->package.
346                                                            count +
347                                                            1) * sizeof(void *));
348
349         if (!obj_desc->package.elements) {
350                 acpi_ut_delete_object_desc(obj_desc);
351                 return_ACPI_STATUS(AE_NO_MEMORY);
352         }
353
354         /*
355          * Initialize all elements of the package
356          */
357         arg = op->common.value.arg;
358         arg = arg->common.next;
359         for (i = 0; arg; i++) {
360                 if (arg->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
361
362                         /* Object (package or buffer) is already built */
363
364                         obj_desc->package.elements[i] =
365                             ACPI_CAST_PTR(union acpi_operand_object,
366                                           arg->common.node);
367                 } else {
368                         status = acpi_ds_build_internal_object(walk_state, arg,
369                                                                &obj_desc->
370                                                                package.
371                                                                elements[i]);
372                 }
373                 arg = arg->common.next;
374         }
375
376         obj_desc->package.flags |= AOPOBJ_DATA_VALID;
377         op->common.node = (struct acpi_namespace_node *)obj_desc;
378         return_ACPI_STATUS(status);
379 }
380
381 /*******************************************************************************
382  *
383  * FUNCTION:    acpi_ds_create_node
384  *
385  * PARAMETERS:  walk_state      - Current walk state
386  *              Node            - NS Node to be initialized
387  *              Op              - Parser object to be translated
388  *
389  * RETURN:      Status
390  *
391  * DESCRIPTION: Create the object to be associated with a namespace node
392  *
393  ******************************************************************************/
394
395 acpi_status
396 acpi_ds_create_node(struct acpi_walk_state *walk_state,
397                     struct acpi_namespace_node *node,
398                     union acpi_parse_object *op)
399 {
400         acpi_status status;
401         union acpi_operand_object *obj_desc;
402
403         ACPI_FUNCTION_TRACE_PTR(ds_create_node, op);
404
405         /*
406          * Because of the execution pass through the non-control-method
407          * parts of the table, we can arrive here twice.  Only init
408          * the named object node the first time through
409          */
410         if (acpi_ns_get_attached_object(node)) {
411                 return_ACPI_STATUS(AE_OK);
412         }
413
414         if (!op->common.value.arg) {
415
416                 /* No arguments, there is nothing to do */
417
418                 return_ACPI_STATUS(AE_OK);
419         }
420
421         /* Build an internal object for the argument(s) */
422
423         status = acpi_ds_build_internal_object(walk_state, op->common.value.arg,
424                                                &obj_desc);
425         if (ACPI_FAILURE(status)) {
426                 return_ACPI_STATUS(status);
427         }
428
429         /* Re-type the object according to its argument */
430
431         node->type = ACPI_GET_OBJECT_TYPE(obj_desc);
432
433         /* Attach obj to node */
434
435         status = acpi_ns_attach_object(node, obj_desc, node->type);
436
437         /* Remove local reference to the object */
438
439         acpi_ut_remove_reference(obj_desc);
440         return_ACPI_STATUS(status);
441 }
442
443 #endif                          /* ACPI_NO_METHOD_EXECUTION */
444
445 /*******************************************************************************
446  *
447  * FUNCTION:    acpi_ds_init_object_from_op
448  *
449  * PARAMETERS:  walk_state      - Current walk state
450  *              Op              - Parser op used to init the internal object
451  *              Opcode          - AML opcode associated with the object
452  *              ret_obj_desc    - Namespace object to be initialized
453  *
454  * RETURN:      Status
455  *
456  * DESCRIPTION: Initialize a namespace object from a parser Op and its
457  *              associated arguments.  The namespace object is a more compact
458  *              representation of the Op and its arguments.
459  *
460  ******************************************************************************/
461
462 acpi_status
463 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
464                             union acpi_parse_object *op,
465                             u16 opcode,
466                             union acpi_operand_object **ret_obj_desc)
467 {
468         const struct acpi_opcode_info *op_info;
469         union acpi_operand_object *obj_desc;
470         acpi_status status = AE_OK;
471
472         ACPI_FUNCTION_TRACE(ds_init_object_from_op);
473
474         obj_desc = *ret_obj_desc;
475         op_info = acpi_ps_get_opcode_info(opcode);
476         if (op_info->class == AML_CLASS_UNKNOWN) {
477
478                 /* Unknown opcode */
479
480                 return_ACPI_STATUS(AE_TYPE);
481         }
482
483         /* Perform per-object initialization */
484
485         switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
486         case ACPI_TYPE_BUFFER:
487
488                 /*
489                  * Defer evaluation of Buffer term_arg operand
490                  */
491                 obj_desc->buffer.node = (struct acpi_namespace_node *)
492                     walk_state->operands[0];
493                 obj_desc->buffer.aml_start = op->named.data;
494                 obj_desc->buffer.aml_length = op->named.length;
495                 break;
496
497         case ACPI_TYPE_PACKAGE:
498
499                 /*
500                  * Defer evaluation of Package term_arg operand
501                  */
502                 obj_desc->package.node = (struct acpi_namespace_node *)
503                     walk_state->operands[0];
504                 obj_desc->package.aml_start = op->named.data;
505                 obj_desc->package.aml_length = op->named.length;
506                 break;
507
508         case ACPI_TYPE_INTEGER:
509
510                 switch (op_info->type) {
511                 case AML_TYPE_CONSTANT:
512                         /*
513                          * Resolve AML Constants here - AND ONLY HERE!
514                          * All constants are integers.
515                          * We mark the integer with a flag that indicates that it started
516                          * life as a constant -- so that stores to constants will perform
517                          * as expected (noop). zero_op is used as a placeholder for optional
518                          * target operands.
519                          */
520                         obj_desc->common.flags = AOPOBJ_AML_CONSTANT;
521
522                         switch (opcode) {
523                         case AML_ZERO_OP:
524
525                                 obj_desc->integer.value = 0;
526                                 break;
527
528                         case AML_ONE_OP:
529
530                                 obj_desc->integer.value = 1;
531                                 break;
532
533                         case AML_ONES_OP:
534
535                                 obj_desc->integer.value = ACPI_INTEGER_MAX;
536
537                                 /* Truncate value if we are executing from a 32-bit ACPI table */
538
539 #ifndef ACPI_NO_METHOD_EXECUTION
540                                 acpi_ex_truncate_for32bit_table(obj_desc);
541 #endif
542                                 break;
543
544                         case AML_REVISION_OP:
545
546                                 obj_desc->integer.value = ACPI_CA_VERSION;
547                                 break;
548
549                         default:
550
551                                 ACPI_ERROR((AE_INFO,
552                                             "Unknown constant opcode %X",
553                                             opcode));
554                                 status = AE_AML_OPERAND_TYPE;
555                                 break;
556                         }
557                         break;
558
559                 case AML_TYPE_LITERAL:
560
561                         obj_desc->integer.value = op->common.value.integer;
562 #ifndef ACPI_NO_METHOD_EXECUTION
563                         acpi_ex_truncate_for32bit_table(obj_desc);
564 #endif
565                         break;
566
567                 default:
568                         ACPI_ERROR((AE_INFO, "Unknown Integer type %X",
569                                     op_info->type));
570                         status = AE_AML_OPERAND_TYPE;
571                         break;
572                 }
573                 break;
574
575         case ACPI_TYPE_STRING:
576
577                 obj_desc->string.pointer = op->common.value.string;
578                 obj_desc->string.length =
579                     (u32) ACPI_STRLEN(op->common.value.string);
580
581                 /*
582                  * The string is contained in the ACPI table, don't ever try
583                  * to delete it
584                  */
585                 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
586                 break;
587
588         case ACPI_TYPE_METHOD:
589                 break;
590
591         case ACPI_TYPE_LOCAL_REFERENCE:
592
593                 switch (op_info->type) {
594                 case AML_TYPE_LOCAL_VARIABLE:
595
596                         /* Split the opcode into a base opcode + offset */
597
598                         obj_desc->reference.opcode = AML_LOCAL_OP;
599                         obj_desc->reference.offset = opcode - AML_LOCAL_OP;
600
601 #ifndef ACPI_NO_METHOD_EXECUTION
602                         status = acpi_ds_method_data_get_node(AML_LOCAL_OP,
603                                                               obj_desc->
604                                                               reference.offset,
605                                                               walk_state,
606                                                               (struct
607                                                                acpi_namespace_node
608                                                                **)&obj_desc->
609                                                               reference.object);
610 #endif
611                         break;
612
613                 case AML_TYPE_METHOD_ARGUMENT:
614
615                         /* Split the opcode into a base opcode + offset */
616
617                         obj_desc->reference.opcode = AML_ARG_OP;
618                         obj_desc->reference.offset = opcode - AML_ARG_OP;
619
620 #ifndef ACPI_NO_METHOD_EXECUTION
621                         status = acpi_ds_method_data_get_node(AML_ARG_OP,
622                                                               obj_desc->
623                                                               reference.offset,
624                                                               walk_state,
625                                                               (struct
626                                                                acpi_namespace_node
627                                                                **)&obj_desc->
628                                                               reference.object);
629 #endif
630                         break;
631
632                 default:        /* Other literals, etc.. */
633
634                         if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
635
636                                 /* Node was saved in Op */
637
638                                 obj_desc->reference.node = op->common.node;
639                         }
640
641                         obj_desc->reference.opcode = opcode;
642                         break;
643                 }
644                 break;
645
646         default:
647
648                 ACPI_ERROR((AE_INFO, "Unimplemented data type: %X",
649                             ACPI_GET_OBJECT_TYPE(obj_desc)));
650
651                 status = AE_AML_OPERAND_TYPE;
652                 break;
653         }
654
655         return_ACPI_STATUS(status);
656 }