1 /******************************************************************************
3 * Module Name: dsfield - Dispatcher field routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
52 #define _COMPONENT ACPI_DISPATCHER
53 ACPI_MODULE_NAME("dsfield")
55 /* Local prototypes */
57 acpi_ds_get_field_names(struct acpi_create_field_info
*info
,
58 struct acpi_walk_state
*walk_state
,
59 union acpi_parse_object
*arg
);
61 /*******************************************************************************
63 * FUNCTION: acpi_ds_create_buffer_field
65 * PARAMETERS: Op - Current parse op (create_xXField)
66 * walk_state - Current state
70 * DESCRIPTION: Execute the create_field operators:
71 * create_bit_field_op,
72 * create_byte_field_op,
73 * create_word_field_op,
74 * create_dword_field_op,
75 * create_qword_field_op,
76 * create_field_op (all of which define a field in a buffer)
78 ******************************************************************************/
81 acpi_ds_create_buffer_field(union acpi_parse_object
*op
,
82 struct acpi_walk_state
*walk_state
)
84 union acpi_parse_object
*arg
;
85 struct acpi_namespace_node
*node
;
87 union acpi_operand_object
*obj_desc
;
88 union acpi_operand_object
*second_desc
= NULL
;
91 ACPI_FUNCTION_TRACE(ds_create_buffer_field
);
94 * Get the name_string argument (name of the new buffer_field)
96 if (op
->common
.aml_opcode
== AML_CREATE_FIELD_OP
) {
98 /* For create_field, name is the 4th argument */
100 arg
= acpi_ps_get_arg(op
, 3);
102 /* For all other create_xXXField operators, name is the 3rd argument */
104 arg
= acpi_ps_get_arg(op
, 2);
108 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
111 if (walk_state
->deferred_node
) {
112 node
= walk_state
->deferred_node
;
115 /* Execute flag should always be set when this function is entered */
117 if (!(walk_state
->parse_flags
& ACPI_PARSE_EXECUTE
)) {
118 return_ACPI_STATUS(AE_AML_INTERNAL
);
121 /* Creating new namespace node, should not already exist */
123 flags
= ACPI_NS_NO_UPSEARCH
| ACPI_NS_DONT_OPEN_SCOPE
|
124 ACPI_NS_ERROR_IF_FOUND
;
126 /* Mark node temporary if we are executing a method */
128 if (walk_state
->method_node
) {
129 flags
|= ACPI_NS_TEMPORARY
;
132 /* Enter the name_string into the namespace */
135 acpi_ns_lookup(walk_state
->scope_info
,
136 arg
->common
.value
.string
, ACPI_TYPE_ANY
,
137 ACPI_IMODE_LOAD_PASS1
, flags
, walk_state
,
139 if (ACPI_FAILURE(status
)) {
140 ACPI_ERROR_NAMESPACE(arg
->common
.value
.string
, status
);
141 return_ACPI_STATUS(status
);
146 * We could put the returned object (Node) on the object stack for later,
147 * but for now, we will put it in the "op" object that the parser uses,
148 * so we can get it again at the end of this scope.
150 op
->common
.node
= node
;
153 * If there is no object attached to the node, this node was just created
154 * and we need to create the field object. Otherwise, this was a lookup
155 * of an existing node and we don't want to create the field object again.
157 obj_desc
= acpi_ns_get_attached_object(node
);
159 return_ACPI_STATUS(AE_OK
);
163 * The Field definition is not fully parsed at this time.
164 * (We must save the address of the AML for the buffer and index operands)
167 /* Create the buffer field object */
169 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_BUFFER_FIELD
);
171 status
= AE_NO_MEMORY
;
176 * Remember location in AML stream of the field unit opcode and operands --
177 * since the buffer and index operands must be evaluated.
179 second_desc
= obj_desc
->common
.next_object
;
180 second_desc
->extra
.aml_start
= op
->named
.data
;
181 second_desc
->extra
.aml_length
= op
->named
.length
;
182 obj_desc
->buffer_field
.node
= node
;
184 /* Attach constructed field descriptors to parent node */
186 status
= acpi_ns_attach_object(node
, obj_desc
, ACPI_TYPE_BUFFER_FIELD
);
187 if (ACPI_FAILURE(status
)) {
193 /* Remove local reference to the object */
195 acpi_ut_remove_reference(obj_desc
);
196 return_ACPI_STATUS(status
);
199 /*******************************************************************************
201 * FUNCTION: acpi_ds_get_field_names
203 * PARAMETERS: Info - create_field info structure
204 * ` walk_state - Current method state
205 * Arg - First parser arg for the field name list
209 * DESCRIPTION: Process all named fields in a field declaration. Names are
210 * entered into the namespace.
212 ******************************************************************************/
215 acpi_ds_get_field_names(struct acpi_create_field_info
*info
,
216 struct acpi_walk_state
*walk_state
,
217 union acpi_parse_object
*arg
)
220 acpi_integer position
;
222 ACPI_FUNCTION_TRACE_PTR(ds_get_field_names
, info
);
224 /* First field starts at bit zero */
226 info
->field_bit_position
= 0;
228 /* Process all elements in the field list (of parse nodes) */
232 * Three types of field elements are handled:
233 * 1) Offset - specifies a bit offset
234 * 2) access_as - changes the access mode
235 * 3) Name - Enters a new named field into the namespace
237 switch (arg
->common
.aml_opcode
) {
238 case AML_INT_RESERVEDFIELD_OP
:
240 position
= (acpi_integer
) info
->field_bit_position
241 + (acpi_integer
) arg
->common
.value
.size
;
243 if (position
> ACPI_UINT32_MAX
) {
245 "Bit offset within field too large (> 0xFFFFFFFF)"));
246 return_ACPI_STATUS(AE_SUPPORT
);
249 info
->field_bit_position
= (u32
) position
;
252 case AML_INT_ACCESSFIELD_OP
:
255 * Get a new access_type and access_attribute -- to be used for all
256 * field units that follow, until field end or another access_as
259 * In field_flags, preserve the flag bits other than the
262 info
->field_flags
= (u8
)
264 field_flags
& ~(AML_FIELD_ACCESS_TYPE_MASK
)) |
265 ((u8
) ((u32
) arg
->common
.value
.integer
>> 8)));
267 info
->attribute
= (u8
) (arg
->common
.value
.integer
);
270 case AML_INT_NAMEDFIELD_OP
:
272 /* Lookup the name, it should already exist */
274 status
= acpi_ns_lookup(walk_state
->scope_info
,
275 (char *)&arg
->named
.name
,
278 ACPI_NS_DONT_OPEN_SCOPE
,
279 walk_state
, &info
->field_node
);
280 if (ACPI_FAILURE(status
)) {
281 ACPI_ERROR_NAMESPACE((char *)&arg
->named
.name
,
283 return_ACPI_STATUS(status
);
285 arg
->common
.node
= info
->field_node
;
286 info
->field_bit_length
= arg
->common
.value
.size
;
289 * If there is no object attached to the node, this node was
290 * just created and we need to create the field object.
291 * Otherwise, this was a lookup of an existing node and we
292 * don't want to create the field object again.
294 if (!acpi_ns_get_attached_object
295 (info
->field_node
)) {
296 status
= acpi_ex_prep_field_value(info
);
297 if (ACPI_FAILURE(status
)) {
298 return_ACPI_STATUS(status
);
303 /* Keep track of bit position for the next field */
305 position
= (acpi_integer
) info
->field_bit_position
306 + (acpi_integer
) arg
->common
.value
.size
;
308 if (position
> ACPI_UINT32_MAX
) {
310 "Field [%4.4s] bit offset too large (> 0xFFFFFFFF)",
314 return_ACPI_STATUS(AE_SUPPORT
);
317 info
->field_bit_position
+= info
->field_bit_length
;
323 "Invalid opcode in field list: %X",
324 arg
->common
.aml_opcode
));
325 return_ACPI_STATUS(AE_AML_BAD_OPCODE
);
328 arg
= arg
->common
.next
;
331 return_ACPI_STATUS(AE_OK
);
334 /*******************************************************************************
336 * FUNCTION: acpi_ds_create_field
338 * PARAMETERS: Op - Op containing the Field definition and args
339 * region_node - Object for the containing Operation Region
340 * ` walk_state - Current method state
344 * DESCRIPTION: Create a new field in the specified operation region
346 ******************************************************************************/
349 acpi_ds_create_field(union acpi_parse_object
*op
,
350 struct acpi_namespace_node
*region_node
,
351 struct acpi_walk_state
*walk_state
)
354 union acpi_parse_object
*arg
;
355 struct acpi_create_field_info info
;
357 ACPI_FUNCTION_TRACE_PTR(ds_create_field
, op
);
359 /* First arg is the name of the parent op_region (must already exist) */
361 arg
= op
->common
.value
.arg
;
364 acpi_ns_lookup(walk_state
->scope_info
,
365 arg
->common
.value
.name
, ACPI_TYPE_REGION
,
366 ACPI_IMODE_EXECUTE
, ACPI_NS_SEARCH_PARENT
,
367 walk_state
, ®ion_node
);
368 if (ACPI_FAILURE(status
)) {
369 ACPI_ERROR_NAMESPACE(arg
->common
.value
.name
, status
);
370 return_ACPI_STATUS(status
);
374 /* Second arg is the field flags */
376 arg
= arg
->common
.next
;
377 info
.field_flags
= (u8
) arg
->common
.value
.integer
;
380 /* Each remaining arg is a Named Field */
382 info
.field_type
= ACPI_TYPE_LOCAL_REGION_FIELD
;
383 info
.region_node
= region_node
;
385 status
= acpi_ds_get_field_names(&info
, walk_state
, arg
->common
.next
);
387 return_ACPI_STATUS(status
);
390 /*******************************************************************************
392 * FUNCTION: acpi_ds_init_field_objects
394 * PARAMETERS: Op - Op containing the Field definition and args
395 * ` walk_state - Current method state
399 * DESCRIPTION: For each "Field Unit" name in the argument list that is
400 * part of the field declaration, enter the name into the
403 ******************************************************************************/
406 acpi_ds_init_field_objects(union acpi_parse_object
*op
,
407 struct acpi_walk_state
*walk_state
)
410 union acpi_parse_object
*arg
= NULL
;
411 struct acpi_namespace_node
*node
;
415 ACPI_FUNCTION_TRACE_PTR(ds_init_field_objects
, op
);
417 /* Execute flag should always be set when this function is entered */
419 if (!(walk_state
->parse_flags
& ACPI_PARSE_EXECUTE
)) {
420 if (walk_state
->parse_flags
& ACPI_PARSE_DEFERRED_OP
) {
422 /* bank_field Op is deferred, just return OK */
424 return_ACPI_STATUS(AE_OK
);
427 return_ACPI_STATUS(AE_AML_INTERNAL
);
431 * Get the field_list argument for this opcode. This is the start of the
432 * list of field elements.
434 switch (walk_state
->opcode
) {
436 arg
= acpi_ps_get_arg(op
, 2);
437 type
= ACPI_TYPE_LOCAL_REGION_FIELD
;
440 case AML_BANK_FIELD_OP
:
441 arg
= acpi_ps_get_arg(op
, 4);
442 type
= ACPI_TYPE_LOCAL_BANK_FIELD
;
445 case AML_INDEX_FIELD_OP
:
446 arg
= acpi_ps_get_arg(op
, 3);
447 type
= ACPI_TYPE_LOCAL_INDEX_FIELD
;
451 return_ACPI_STATUS(AE_BAD_PARAMETER
);
454 /* Creating new namespace node(s), should not already exist */
456 flags
= ACPI_NS_NO_UPSEARCH
| ACPI_NS_DONT_OPEN_SCOPE
|
457 ACPI_NS_ERROR_IF_FOUND
;
459 /* Mark node(s) temporary if we are executing a method */
461 if (walk_state
->method_node
) {
462 flags
|= ACPI_NS_TEMPORARY
;
466 * Walk the list of entries in the field_list
467 * Note: field_list can be of zero length. In this case, Arg will be NULL.
471 * Ignore OFFSET and ACCESSAS terms here; we are only interested in the
472 * field names in order to enter them into the namespace.
474 if (arg
->common
.aml_opcode
== AML_INT_NAMEDFIELD_OP
) {
475 status
= acpi_ns_lookup(walk_state
->scope_info
,
476 (char *)&arg
->named
.name
, type
,
477 ACPI_IMODE_LOAD_PASS1
, flags
,
479 if (ACPI_FAILURE(status
)) {
480 ACPI_ERROR_NAMESPACE((char *)&arg
->named
.name
,
482 if (status
!= AE_ALREADY_EXISTS
) {
483 return_ACPI_STATUS(status
);
486 /* Name already exists, just ignore this error */
491 arg
->common
.node
= node
;
494 /* Get the next field element in the list */
496 arg
= arg
->common
.next
;
499 return_ACPI_STATUS(AE_OK
);
502 /*******************************************************************************
504 * FUNCTION: acpi_ds_create_bank_field
506 * PARAMETERS: Op - Op containing the Field definition and args
507 * region_node - Object for the containing Operation Region
508 * walk_state - Current method state
512 * DESCRIPTION: Create a new bank field in the specified operation region
514 ******************************************************************************/
517 acpi_ds_create_bank_field(union acpi_parse_object
*op
,
518 struct acpi_namespace_node
*region_node
,
519 struct acpi_walk_state
*walk_state
)
522 union acpi_parse_object
*arg
;
523 struct acpi_create_field_info info
;
525 ACPI_FUNCTION_TRACE_PTR(ds_create_bank_field
, op
);
527 /* First arg is the name of the parent op_region (must already exist) */
529 arg
= op
->common
.value
.arg
;
532 acpi_ns_lookup(walk_state
->scope_info
,
533 arg
->common
.value
.name
, ACPI_TYPE_REGION
,
534 ACPI_IMODE_EXECUTE
, ACPI_NS_SEARCH_PARENT
,
535 walk_state
, ®ion_node
);
536 if (ACPI_FAILURE(status
)) {
537 ACPI_ERROR_NAMESPACE(arg
->common
.value
.name
, status
);
538 return_ACPI_STATUS(status
);
542 /* Second arg is the Bank Register (Field) (must already exist) */
544 arg
= arg
->common
.next
;
546 acpi_ns_lookup(walk_state
->scope_info
, arg
->common
.value
.string
,
547 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
548 ACPI_NS_SEARCH_PARENT
, walk_state
,
549 &info
.register_node
);
550 if (ACPI_FAILURE(status
)) {
551 ACPI_ERROR_NAMESPACE(arg
->common
.value
.string
, status
);
552 return_ACPI_STATUS(status
);
556 * Third arg is the bank_value
557 * This arg is a term_arg, not a constant
558 * It will be evaluated later, by acpi_ds_eval_bank_field_operands
560 arg
= arg
->common
.next
;
562 /* Fourth arg is the field flags */
564 arg
= arg
->common
.next
;
565 info
.field_flags
= (u8
) arg
->common
.value
.integer
;
567 /* Each remaining arg is a Named Field */
569 info
.field_type
= ACPI_TYPE_LOCAL_BANK_FIELD
;
570 info
.region_node
= region_node
;
573 * Use Info.data_register_node to store bank_field Op
574 * It's safe because data_register_node will never be used when create bank field
575 * We store aml_start and aml_length in the bank_field Op for late evaluation
576 * Used in acpi_ex_prep_field_value(Info)
578 * TBD: Or, should we add a field in struct acpi_create_field_info, like "void *ParentOp"?
580 info
.data_register_node
= (struct acpi_namespace_node
*)op
;
582 status
= acpi_ds_get_field_names(&info
, walk_state
, arg
->common
.next
);
583 return_ACPI_STATUS(status
);
586 /*******************************************************************************
588 * FUNCTION: acpi_ds_create_index_field
590 * PARAMETERS: Op - Op containing the Field definition and args
591 * region_node - Object for the containing Operation Region
592 * ` walk_state - Current method state
596 * DESCRIPTION: Create a new index field in the specified operation region
598 ******************************************************************************/
601 acpi_ds_create_index_field(union acpi_parse_object
*op
,
602 struct acpi_namespace_node
*region_node
,
603 struct acpi_walk_state
*walk_state
)
606 union acpi_parse_object
*arg
;
607 struct acpi_create_field_info info
;
609 ACPI_FUNCTION_TRACE_PTR(ds_create_index_field
, op
);
611 /* First arg is the name of the Index register (must already exist) */
613 arg
= op
->common
.value
.arg
;
615 acpi_ns_lookup(walk_state
->scope_info
, arg
->common
.value
.string
,
616 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
617 ACPI_NS_SEARCH_PARENT
, walk_state
,
618 &info
.register_node
);
619 if (ACPI_FAILURE(status
)) {
620 ACPI_ERROR_NAMESPACE(arg
->common
.value
.string
, status
);
621 return_ACPI_STATUS(status
);
624 /* Second arg is the data register (must already exist) */
626 arg
= arg
->common
.next
;
628 acpi_ns_lookup(walk_state
->scope_info
, arg
->common
.value
.string
,
629 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
630 ACPI_NS_SEARCH_PARENT
, walk_state
,
631 &info
.data_register_node
);
632 if (ACPI_FAILURE(status
)) {
633 ACPI_ERROR_NAMESPACE(arg
->common
.value
.string
, status
);
634 return_ACPI_STATUS(status
);
637 /* Next arg is the field flags */
639 arg
= arg
->common
.next
;
640 info
.field_flags
= (u8
) arg
->common
.value
.integer
;
642 /* Each remaining arg is a Named Field */
644 info
.field_type
= ACPI_TYPE_LOCAL_INDEX_FIELD
;
645 info
.region_node
= region_node
;
647 status
= acpi_ds_get_field_names(&info
, walk_state
, arg
->common
.next
);
649 return_ACPI_STATUS(status
);