Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[sfrench/cifs-2.6.git] / drivers / acpi / dispatcher / dsobject.c
1 /******************************************************************************
2  *
3  * Module Name: dsobject - Dispatcher object management routines
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2007, 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 = ACPI_CAST_PTR(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  *              element_count   - Number of elements in the package - this is
274  *                                the num_elements argument to Package()
275  *              obj_desc_ptr    - Where the ACPI internal object is returned
276  *
277  * RETURN:      Status
278  *
279  * DESCRIPTION: Translate a parser Op package object to the equivalent
280  *              namespace object
281  *
282  * NOTE: The number of elements in the package will be always be the num_elements
283  * count, regardless of the number of elements in the package list. If
284  * num_elements is smaller, only that many package list elements are used.
285  * if num_elements is larger, the Package object is padded out with
286  * objects of type Uninitialized (as per ACPI spec.)
287  *
288  * Even though the ASL compilers do not allow num_elements to be smaller
289  * than the Package list length (for the fixed length package opcode), some
290  * BIOS code modifies the AML on the fly to adjust the num_elements, and
291  * this code compensates for that. This also provides compatibility with
292  * other AML interpreters.
293  *
294  ******************************************************************************/
295
296 acpi_status
297 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
298                                    union acpi_parse_object *op,
299                                    u32 element_count,
300                                    union acpi_operand_object **obj_desc_ptr)
301 {
302         union acpi_parse_object *arg;
303         union acpi_parse_object *parent;
304         union acpi_operand_object *obj_desc = NULL;
305         acpi_status status = AE_OK;
306         acpi_native_uint i;
307
308         ACPI_FUNCTION_TRACE(ds_build_internal_package_obj);
309
310         /* Find the parent of a possibly nested package */
311
312         parent = op->common.parent;
313         while ((parent->common.aml_opcode == AML_PACKAGE_OP) ||
314                (parent->common.aml_opcode == AML_VAR_PACKAGE_OP)) {
315                 parent = parent->common.parent;
316         }
317
318         /*
319          * If we are evaluating a Named package object "Name (xxxx, Package)",
320          * the package object already exists, otherwise it must be created.
321          */
322         obj_desc = *obj_desc_ptr;
323         if (!obj_desc) {
324                 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
325                 *obj_desc_ptr = obj_desc;
326                 if (!obj_desc) {
327                         return_ACPI_STATUS(AE_NO_MEMORY);
328                 }
329
330                 obj_desc->package.node = parent->common.node;
331         }
332
333         /*
334          * Allocate the element array (array of pointers to the individual
335          * objects) based on the num_elements parameter. Add an extra pointer slot
336          * so that the list is always null terminated.
337          */
338         obj_desc->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
339                                                            element_count +
340                                                            1) * sizeof(void *));
341
342         if (!obj_desc->package.elements) {
343                 acpi_ut_delete_object_desc(obj_desc);
344                 return_ACPI_STATUS(AE_NO_MEMORY);
345         }
346
347         obj_desc->package.count = element_count;
348
349         /*
350          * Initialize the elements of the package, up to the num_elements count.
351          * Package is automatically padded with uninitialized (NULL) elements
352          * if num_elements is greater than the package list length. Likewise,
353          * Package is truncated if num_elements is less than the list length.
354          */
355         arg = op->common.value.arg;
356         arg = arg->common.next;
357         for (i = 0; arg && (i < element_count); i++) {
358                 if (arg->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
359
360                         /* This package element is already built, just get it */
361
362                         obj_desc->package.elements[i] =
363                             ACPI_CAST_PTR(union acpi_operand_object,
364                                           arg->common.node);
365                 } else {
366                         status = acpi_ds_build_internal_object(walk_state, arg,
367                                                                &obj_desc->
368                                                                package.
369                                                                elements[i]);
370                 }
371                 arg = arg->common.next;
372         }
373
374         if (!arg) {
375                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
376                                   "Package List length larger than NumElements count (%X), truncated\n",
377                                   element_count));
378         }
379
380         obj_desc->package.flags |= AOPOBJ_DATA_VALID;
381         op->common.node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_desc);
382         return_ACPI_STATUS(status);
383 }
384
385 /*******************************************************************************
386  *
387  * FUNCTION:    acpi_ds_create_node
388  *
389  * PARAMETERS:  walk_state      - Current walk state
390  *              Node            - NS Node to be initialized
391  *              Op              - Parser object to be translated
392  *
393  * RETURN:      Status
394  *
395  * DESCRIPTION: Create the object to be associated with a namespace node
396  *
397  ******************************************************************************/
398
399 acpi_status
400 acpi_ds_create_node(struct acpi_walk_state *walk_state,
401                     struct acpi_namespace_node *node,
402                     union acpi_parse_object *op)
403 {
404         acpi_status status;
405         union acpi_operand_object *obj_desc;
406
407         ACPI_FUNCTION_TRACE_PTR(ds_create_node, op);
408
409         /*
410          * Because of the execution pass through the non-control-method
411          * parts of the table, we can arrive here twice.  Only init
412          * the named object node the first time through
413          */
414         if (acpi_ns_get_attached_object(node)) {
415                 return_ACPI_STATUS(AE_OK);
416         }
417
418         if (!op->common.value.arg) {
419
420                 /* No arguments, there is nothing to do */
421
422                 return_ACPI_STATUS(AE_OK);
423         }
424
425         /* Build an internal object for the argument(s) */
426
427         status = acpi_ds_build_internal_object(walk_state, op->common.value.arg,
428                                                &obj_desc);
429         if (ACPI_FAILURE(status)) {
430                 return_ACPI_STATUS(status);
431         }
432
433         /* Re-type the object according to its argument */
434
435         node->type = ACPI_GET_OBJECT_TYPE(obj_desc);
436
437         /* Attach obj to node */
438
439         status = acpi_ns_attach_object(node, obj_desc, node->type);
440
441         /* Remove local reference to the object */
442
443         acpi_ut_remove_reference(obj_desc);
444         return_ACPI_STATUS(status);
445 }
446
447 #endif                          /* ACPI_NO_METHOD_EXECUTION */
448
449 /*******************************************************************************
450  *
451  * FUNCTION:    acpi_ds_init_object_from_op
452  *
453  * PARAMETERS:  walk_state      - Current walk state
454  *              Op              - Parser op used to init the internal object
455  *              Opcode          - AML opcode associated with the object
456  *              ret_obj_desc    - Namespace object to be initialized
457  *
458  * RETURN:      Status
459  *
460  * DESCRIPTION: Initialize a namespace object from a parser Op and its
461  *              associated arguments.  The namespace object is a more compact
462  *              representation of the Op and its arguments.
463  *
464  ******************************************************************************/
465
466 acpi_status
467 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
468                             union acpi_parse_object *op,
469                             u16 opcode,
470                             union acpi_operand_object **ret_obj_desc)
471 {
472         const struct acpi_opcode_info *op_info;
473         union acpi_operand_object *obj_desc;
474         acpi_status status = AE_OK;
475
476         ACPI_FUNCTION_TRACE(ds_init_object_from_op);
477
478         obj_desc = *ret_obj_desc;
479         op_info = acpi_ps_get_opcode_info(opcode);
480         if (op_info->class == AML_CLASS_UNKNOWN) {
481
482                 /* Unknown opcode */
483
484                 return_ACPI_STATUS(AE_TYPE);
485         }
486
487         /* Perform per-object initialization */
488
489         switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
490         case ACPI_TYPE_BUFFER:
491
492                 /*
493                  * Defer evaluation of Buffer term_arg operand
494                  */
495                 obj_desc->buffer.node =
496                     ACPI_CAST_PTR(struct acpi_namespace_node,
497                                   walk_state->operands[0]);
498                 obj_desc->buffer.aml_start = op->named.data;
499                 obj_desc->buffer.aml_length = op->named.length;
500                 break;
501
502         case ACPI_TYPE_PACKAGE:
503
504                 /*
505                  * Defer evaluation of Package term_arg operand
506                  */
507                 obj_desc->package.node =
508                     ACPI_CAST_PTR(struct acpi_namespace_node,
509                                   walk_state->operands[0]);
510                 obj_desc->package.aml_start = op->named.data;
511                 obj_desc->package.aml_length = op->named.length;
512                 break;
513
514         case ACPI_TYPE_INTEGER:
515
516                 switch (op_info->type) {
517                 case AML_TYPE_CONSTANT:
518                         /*
519                          * Resolve AML Constants here - AND ONLY HERE!
520                          * All constants are integers.
521                          * We mark the integer with a flag that indicates that it started
522                          * life as a constant -- so that stores to constants will perform
523                          * as expected (noop). zero_op is used as a placeholder for optional
524                          * target operands.
525                          */
526                         obj_desc->common.flags = AOPOBJ_AML_CONSTANT;
527
528                         switch (opcode) {
529                         case AML_ZERO_OP:
530
531                                 obj_desc->integer.value = 0;
532                                 break;
533
534                         case AML_ONE_OP:
535
536                                 obj_desc->integer.value = 1;
537                                 break;
538
539                         case AML_ONES_OP:
540
541                                 obj_desc->integer.value = ACPI_INTEGER_MAX;
542
543                                 /* Truncate value if we are executing from a 32-bit ACPI table */
544
545 #ifndef ACPI_NO_METHOD_EXECUTION
546                                 acpi_ex_truncate_for32bit_table(obj_desc);
547 #endif
548                                 break;
549
550                         case AML_REVISION_OP:
551
552                                 obj_desc->integer.value = ACPI_CA_VERSION;
553                                 break;
554
555                         default:
556
557                                 ACPI_ERROR((AE_INFO,
558                                             "Unknown constant opcode %X",
559                                             opcode));
560                                 status = AE_AML_OPERAND_TYPE;
561                                 break;
562                         }
563                         break;
564
565                 case AML_TYPE_LITERAL:
566
567                         obj_desc->integer.value = op->common.value.integer;
568 #ifndef ACPI_NO_METHOD_EXECUTION
569                         acpi_ex_truncate_for32bit_table(obj_desc);
570 #endif
571                         break;
572
573                 default:
574                         ACPI_ERROR((AE_INFO, "Unknown Integer type %X",
575                                     op_info->type));
576                         status = AE_AML_OPERAND_TYPE;
577                         break;
578                 }
579                 break;
580
581         case ACPI_TYPE_STRING:
582
583                 obj_desc->string.pointer = op->common.value.string;
584                 obj_desc->string.length =
585                     (u32) ACPI_STRLEN(op->common.value.string);
586
587                 /*
588                  * The string is contained in the ACPI table, don't ever try
589                  * to delete it
590                  */
591                 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
592                 break;
593
594         case ACPI_TYPE_METHOD:
595                 break;
596
597         case ACPI_TYPE_LOCAL_REFERENCE:
598
599                 switch (op_info->type) {
600                 case AML_TYPE_LOCAL_VARIABLE:
601
602                         /* Split the opcode into a base opcode + offset */
603
604                         obj_desc->reference.opcode = AML_LOCAL_OP;
605                         obj_desc->reference.offset = opcode - AML_LOCAL_OP;
606
607 #ifndef ACPI_NO_METHOD_EXECUTION
608                         status = acpi_ds_method_data_get_node(AML_LOCAL_OP,
609                                                               obj_desc->
610                                                               reference.offset,
611                                                               walk_state,
612                                                               (struct
613                                                                acpi_namespace_node
614                                                                **)&obj_desc->
615                                                               reference.object);
616 #endif
617                         break;
618
619                 case AML_TYPE_METHOD_ARGUMENT:
620
621                         /* Split the opcode into a base opcode + offset */
622
623                         obj_desc->reference.opcode = AML_ARG_OP;
624                         obj_desc->reference.offset = opcode - AML_ARG_OP;
625
626 #ifndef ACPI_NO_METHOD_EXECUTION
627                         status = acpi_ds_method_data_get_node(AML_ARG_OP,
628                                                               obj_desc->
629                                                               reference.offset,
630                                                               walk_state,
631                                                               (struct
632                                                                acpi_namespace_node
633                                                                **)&obj_desc->
634                                                               reference.object);
635 #endif
636                         break;
637
638                 default:        /* Other literals, etc.. */
639
640                         if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
641
642                                 /* Node was saved in Op */
643
644                                 obj_desc->reference.node = op->common.node;
645                         }
646
647                         obj_desc->reference.opcode = opcode;
648                         break;
649                 }
650                 break;
651
652         default:
653
654                 ACPI_ERROR((AE_INFO, "Unimplemented data type: %X",
655                             ACPI_GET_OBJECT_TYPE(obj_desc)));
656
657                 status = AE_AML_OPERAND_TYPE;
658                 break;
659         }
660
661         return_ACPI_STATUS(status);
662 }