1 /******************************************************************************
3 * Module Name: dsfield - Dispatcher field routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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>
45 #include <acpi/amlcode.h>
46 #include <acpi/acdispat.h>
47 #include <acpi/acinterp.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acparser.h>
51 #define _COMPONENT ACPI_DISPATCHER
52 ACPI_MODULE_NAME("dsfield")
54 /* Local prototypes */
56 acpi_ds_get_field_names(struct acpi_create_field_info *info,
57 struct acpi_walk_state *walk_state,
58 union acpi_parse_object *arg);
60 /*******************************************************************************
62 * FUNCTION: acpi_ds_create_buffer_field
64 * PARAMETERS: Op - Current parse op (create_xXField)
65 * walk_state - Current state
69 * DESCRIPTION: Execute the create_field operators:
70 * create_bit_field_op,
71 * create_byte_field_op,
72 * create_word_field_op,
73 * create_dword_field_op,
74 * create_qword_field_op,
75 * create_field_op (all of which define a field in a buffer)
77 ******************************************************************************/
80 acpi_ds_create_buffer_field(union acpi_parse_object *op,
81 struct acpi_walk_state *walk_state)
83 union acpi_parse_object *arg;
84 struct acpi_namespace_node *node;
86 union acpi_operand_object *obj_desc;
87 union acpi_operand_object *second_desc = NULL;
90 ACPI_FUNCTION_TRACE("ds_create_buffer_field");
92 /* Get the name_string argument */
94 if (op->common.aml_opcode == AML_CREATE_FIELD_OP) {
95 arg = acpi_ps_get_arg(op, 3);
97 /* Create Bit/Byte/Word/Dword field */
99 arg = acpi_ps_get_arg(op, 2);
103 return_ACPI_STATUS(AE_AML_NO_OPERAND);
106 if (walk_state->deferred_node) {
107 node = walk_state->deferred_node;
111 * During the load phase, we want to enter the name of the field into
112 * the namespace. During the execute phase (when we evaluate the size
113 * operand), we want to lookup the name
115 if (walk_state->parse_flags & ACPI_PARSE_EXECUTE) {
116 flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE;
118 flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE |
119 ACPI_NS_ERROR_IF_FOUND;
123 * Enter the name_string into the namespace
126 acpi_ns_lookup(walk_state->scope_info,
127 arg->common.value.string, ACPI_TYPE_ANY,
128 ACPI_IMODE_LOAD_PASS1, flags, walk_state,
130 if (ACPI_FAILURE(status)) {
131 ACPI_REPORT_NSERROR(arg->common.value.string, status);
132 return_ACPI_STATUS(status);
136 /* We could put the returned object (Node) on the object stack for later,
137 * but for now, we will put it in the "op" object that the parser uses,
138 * so we can get it again at the end of this scope
140 op->common.node = node;
143 * If there is no object attached to the node, this node was just created
144 * and we need to create the field object. Otherwise, this was a lookup
145 * of an existing node and we don't want to create the field object again.
147 obj_desc = acpi_ns_get_attached_object(node);
149 return_ACPI_STATUS(AE_OK);
153 * The Field definition is not fully parsed at this time.
154 * (We must save the address of the AML for the buffer and index operands)
157 /* Create the buffer field object */
159 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER_FIELD);
161 status = AE_NO_MEMORY;
166 * Remember location in AML stream of the field unit
167 * opcode and operands -- since the buffer and index
168 * operands must be evaluated.
170 second_desc = obj_desc->common.next_object;
171 second_desc->extra.aml_start = op->named.data;
172 second_desc->extra.aml_length = op->named.length;
173 obj_desc->buffer_field.node = node;
175 /* Attach constructed field descriptors to parent node */
177 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_BUFFER_FIELD);
178 if (ACPI_FAILURE(status)) {
184 /* Remove local reference to the object */
186 acpi_ut_remove_reference(obj_desc);
187 return_ACPI_STATUS(status);
190 /*******************************************************************************
192 * FUNCTION: acpi_ds_get_field_names
194 * PARAMETERS: Info - create_field info structure
195 * ` walk_state - Current method state
196 * Arg - First parser arg for the field name list
200 * DESCRIPTION: Process all named fields in a field declaration. Names are
201 * entered into the namespace.
203 ******************************************************************************/
206 acpi_ds_get_field_names(struct acpi_create_field_info *info,
207 struct acpi_walk_state *walk_state,
208 union acpi_parse_object *arg)
211 acpi_integer position;
213 ACPI_FUNCTION_TRACE_PTR("ds_get_field_names", info);
215 /* First field starts at bit zero */
217 info->field_bit_position = 0;
219 /* Process all elements in the field list (of parse nodes) */
223 * Three types of field elements are handled:
224 * 1) Offset - specifies a bit offset
225 * 2) access_as - changes the access mode
226 * 3) Name - Enters a new named field into the namespace
228 switch (arg->common.aml_opcode) {
229 case AML_INT_RESERVEDFIELD_OP:
231 position = (acpi_integer) info->field_bit_position
232 + (acpi_integer) arg->common.value.size;
234 if (position > ACPI_UINT32_MAX) {
235 ACPI_REPORT_ERROR(("Bit offset within field too large (> 0xFFFFFFFF)\n"));
236 return_ACPI_STATUS(AE_SUPPORT);
239 info->field_bit_position = (u32) position;
242 case AML_INT_ACCESSFIELD_OP:
245 * Get a new access_type and access_attribute -- to be used for all
246 * field units that follow, until field end or another access_as
249 * In field_flags, preserve the flag bits other than the
252 info->field_flags = (u8)
254 field_flags & ~(AML_FIELD_ACCESS_TYPE_MASK)) |
255 ((u8) ((u32) arg->common.value.integer >> 8)));
257 info->attribute = (u8) (arg->common.value.integer);
260 case AML_INT_NAMEDFIELD_OP:
262 /* Lookup the name */
264 status = acpi_ns_lookup(walk_state->scope_info,
265 (char *)&arg->named.name,
268 ACPI_NS_DONT_OPEN_SCOPE,
269 walk_state, &info->field_node);
270 if (ACPI_FAILURE(status)) {
271 ACPI_REPORT_NSERROR((char *)&arg->named.name,
273 if (status != AE_ALREADY_EXISTS) {
274 return_ACPI_STATUS(status);
277 /* Already exists, ignore error */
279 arg->common.node = info->field_node;
280 info->field_bit_length = arg->common.value.size;
282 /* Create and initialize an object for the new Field Node */
284 status = acpi_ex_prep_field_value(info);
285 if (ACPI_FAILURE(status)) {
286 return_ACPI_STATUS(status);
290 /* Keep track of bit position for the next field */
292 position = (acpi_integer) info->field_bit_position
293 + (acpi_integer) arg->common.value.size;
295 if (position > ACPI_UINT32_MAX) {
296 ACPI_REPORT_ERROR(("Field [%4.4s] bit offset too large (> 0xFFFFFFFF)\n", ACPI_CAST_PTR(char, &info->field_node->name)));
297 return_ACPI_STATUS(AE_SUPPORT);
300 info->field_bit_position += info->field_bit_length;
305 ACPI_REPORT_ERROR(("Invalid opcode in field list: %X\n",
306 arg->common.aml_opcode));
307 return_ACPI_STATUS(AE_AML_BAD_OPCODE);
310 arg = arg->common.next;
313 return_ACPI_STATUS(AE_OK);
316 /*******************************************************************************
318 * FUNCTION: acpi_ds_create_field
320 * PARAMETERS: Op - Op containing the Field definition and args
321 * region_node - Object for the containing Operation Region
322 * ` walk_state - Current method state
326 * DESCRIPTION: Create a new field in the specified operation region
328 ******************************************************************************/
331 acpi_ds_create_field(union acpi_parse_object *op,
332 struct acpi_namespace_node *region_node,
333 struct acpi_walk_state *walk_state)
336 union acpi_parse_object *arg;
337 struct acpi_create_field_info info;
339 ACPI_FUNCTION_TRACE_PTR("ds_create_field", op);
341 /* First arg is the name of the parent op_region (must already exist) */
343 arg = op->common.value.arg;
346 acpi_ns_lookup(walk_state->scope_info,
347 arg->common.value.name, ACPI_TYPE_REGION,
348 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
349 walk_state, ®ion_node);
350 if (ACPI_FAILURE(status)) {
351 ACPI_REPORT_NSERROR(arg->common.value.name, status);
352 return_ACPI_STATUS(status);
356 /* Second arg is the field flags */
358 arg = arg->common.next;
359 info.field_flags = (u8) arg->common.value.integer;
362 /* Each remaining arg is a Named Field */
364 info.field_type = ACPI_TYPE_LOCAL_REGION_FIELD;
365 info.region_node = region_node;
367 status = acpi_ds_get_field_names(&info, walk_state, arg->common.next);
369 return_ACPI_STATUS(status);
372 /*******************************************************************************
374 * FUNCTION: acpi_ds_init_field_objects
376 * PARAMETERS: Op - Op containing the Field definition and args
377 * ` walk_state - Current method state
381 * DESCRIPTION: For each "Field Unit" name in the argument list that is
382 * part of the field declaration, enter the name into the
385 ******************************************************************************/
388 acpi_ds_init_field_objects(union acpi_parse_object *op,
389 struct acpi_walk_state *walk_state)
392 union acpi_parse_object *arg = NULL;
393 struct acpi_namespace_node *node;
396 ACPI_FUNCTION_TRACE_PTR("ds_init_field_objects", op);
398 switch (walk_state->opcode) {
400 arg = acpi_ps_get_arg(op, 2);
401 type = ACPI_TYPE_LOCAL_REGION_FIELD;
404 case AML_BANK_FIELD_OP:
405 arg = acpi_ps_get_arg(op, 4);
406 type = ACPI_TYPE_LOCAL_BANK_FIELD;
409 case AML_INDEX_FIELD_OP:
410 arg = acpi_ps_get_arg(op, 3);
411 type = ACPI_TYPE_LOCAL_INDEX_FIELD;
415 return_ACPI_STATUS(AE_BAD_PARAMETER);
419 * Walk the list of entries in the field_list
422 /* Ignore OFFSET and ACCESSAS terms here */
424 if (arg->common.aml_opcode == AML_INT_NAMEDFIELD_OP) {
425 status = acpi_ns_lookup(walk_state->scope_info,
426 (char *)&arg->named.name,
427 type, ACPI_IMODE_LOAD_PASS1,
428 ACPI_NS_NO_UPSEARCH |
429 ACPI_NS_DONT_OPEN_SCOPE |
430 ACPI_NS_ERROR_IF_FOUND,
432 if (ACPI_FAILURE(status)) {
433 ACPI_REPORT_NSERROR((char *)&arg->named.name,
435 if (status != AE_ALREADY_EXISTS) {
436 return_ACPI_STATUS(status);
439 /* Name already exists, just ignore this error */
444 arg->common.node = node;
447 /* Move to next field in the list */
449 arg = arg->common.next;
452 return_ACPI_STATUS(AE_OK);
455 /*******************************************************************************
457 * FUNCTION: acpi_ds_create_bank_field
459 * PARAMETERS: Op - Op containing the Field definition and args
460 * region_node - Object for the containing Operation Region
461 * ` walk_state - Current method state
465 * DESCRIPTION: Create a new bank field in the specified operation region
467 ******************************************************************************/
470 acpi_ds_create_bank_field(union acpi_parse_object *op,
471 struct acpi_namespace_node *region_node,
472 struct acpi_walk_state *walk_state)
475 union acpi_parse_object *arg;
476 struct acpi_create_field_info info;
478 ACPI_FUNCTION_TRACE_PTR("ds_create_bank_field", op);
480 /* First arg is the name of the parent op_region (must already exist) */
482 arg = op->common.value.arg;
485 acpi_ns_lookup(walk_state->scope_info,
486 arg->common.value.name, ACPI_TYPE_REGION,
487 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
488 walk_state, ®ion_node);
489 if (ACPI_FAILURE(status)) {
490 ACPI_REPORT_NSERROR(arg->common.value.name, status);
491 return_ACPI_STATUS(status);
495 /* Second arg is the Bank Register (Field) (must already exist) */
497 arg = arg->common.next;
499 acpi_ns_lookup(walk_state->scope_info, arg->common.value.string,
500 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
501 ACPI_NS_SEARCH_PARENT, walk_state,
502 &info.register_node);
503 if (ACPI_FAILURE(status)) {
504 ACPI_REPORT_NSERROR(arg->common.value.string, status);
505 return_ACPI_STATUS(status);
508 /* Third arg is the bank_value */
510 arg = arg->common.next;
511 info.bank_value = (u32) arg->common.value.integer;
513 /* Fourth arg is the field flags */
515 arg = arg->common.next;
516 info.field_flags = (u8) arg->common.value.integer;
518 /* Each remaining arg is a Named Field */
520 info.field_type = ACPI_TYPE_LOCAL_BANK_FIELD;
521 info.region_node = region_node;
523 status = acpi_ds_get_field_names(&info, walk_state, arg->common.next);
525 return_ACPI_STATUS(status);
528 /*******************************************************************************
530 * FUNCTION: acpi_ds_create_index_field
532 * PARAMETERS: Op - Op containing the Field definition and args
533 * region_node - Object for the containing Operation Region
534 * ` walk_state - Current method state
538 * DESCRIPTION: Create a new index field in the specified operation region
540 ******************************************************************************/
543 acpi_ds_create_index_field(union acpi_parse_object *op,
544 struct acpi_namespace_node *region_node,
545 struct acpi_walk_state *walk_state)
548 union acpi_parse_object *arg;
549 struct acpi_create_field_info info;
551 ACPI_FUNCTION_TRACE_PTR("ds_create_index_field", op);
553 /* First arg is the name of the Index register (must already exist) */
555 arg = op->common.value.arg;
557 acpi_ns_lookup(walk_state->scope_info, arg->common.value.string,
558 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
559 ACPI_NS_SEARCH_PARENT, walk_state,
560 &info.register_node);
561 if (ACPI_FAILURE(status)) {
562 ACPI_REPORT_NSERROR(arg->common.value.string, status);
563 return_ACPI_STATUS(status);
566 /* Second arg is the data register (must already exist) */
568 arg = arg->common.next;
570 acpi_ns_lookup(walk_state->scope_info, arg->common.value.string,
571 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
572 ACPI_NS_SEARCH_PARENT, walk_state,
573 &info.data_register_node);
574 if (ACPI_FAILURE(status)) {
575 ACPI_REPORT_NSERROR(arg->common.value.string, status);
576 return_ACPI_STATUS(status);
579 /* Next arg is the field flags */
581 arg = arg->common.next;
582 info.field_flags = (u8) arg->common.value.integer;
584 /* Each remaining arg is a Named Field */
586 info.field_type = ACPI_TYPE_LOCAL_INDEX_FIELD;
587 info.region_node = region_node;
589 status = acpi_ds_get_field_names(&info, walk_state, arg->common.next);
591 return_ACPI_STATUS(status);