1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: dsfield - Dispatcher field routines
6 * Copyright (C) 2000 - 2018, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
18 #define _COMPONENT ACPI_DISPATCHER
19 ACPI_MODULE_NAME("dsfield")
21 /* Local prototypes */
22 #ifdef ACPI_ASL_COMPILER
25 acpi_ds_create_external_region(acpi_status lookup_status,
26 union acpi_parse_object *op,
28 struct acpi_walk_state *walk_state,
29 struct acpi_namespace_node **node);
33 acpi_ds_get_field_names(struct acpi_create_field_info *info,
34 struct acpi_walk_state *walk_state,
35 union acpi_parse_object *arg);
37 #ifdef ACPI_ASL_COMPILER
38 /*******************************************************************************
40 * FUNCTION: acpi_ds_create_external_region (iASL Disassembler only)
42 * PARAMETERS: lookup_status - Status from ns_lookup operation
43 * op - Op containing the Field definition and args
44 * path - Pathname of the region
45 * ` walk_state - Current method state
46 * node - Where the new region node is returned
50 * DESCRIPTION: Add region to the external list if NOT_FOUND. Create a new
53 ******************************************************************************/
56 acpi_ds_create_external_region(acpi_status lookup_status,
57 union acpi_parse_object *op,
59 struct acpi_walk_state *walk_state,
60 struct acpi_namespace_node **node)
63 union acpi_operand_object *obj_desc;
65 if (lookup_status != AE_NOT_FOUND) {
66 return (lookup_status);
71 * operation_region not found. Generate an External for it, and
72 * insert the name into the namespace.
74 acpi_dm_add_op_to_external_list(op, path, ACPI_TYPE_REGION, 0, 0);
76 status = acpi_ns_lookup(walk_state->scope_info, path, ACPI_TYPE_REGION,
77 ACPI_IMODE_LOAD_PASS1, ACPI_NS_SEARCH_PARENT,
79 if (ACPI_FAILURE(status)) {
83 /* Must create and install a region object for the new node */
85 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
87 return (AE_NO_MEMORY);
90 obj_desc->region.node = *node;
91 status = acpi_ns_attach_object(*node, obj_desc, ACPI_TYPE_REGION);
96 /*******************************************************************************
98 * FUNCTION: acpi_ds_create_buffer_field
100 * PARAMETERS: op - Current parse op (create_XXField)
101 * walk_state - Current state
105 * DESCRIPTION: Execute the create_field operators:
106 * create_bit_field_op,
107 * create_byte_field_op,
108 * create_word_field_op,
109 * create_dword_field_op,
110 * create_qword_field_op,
111 * create_field_op (all of which define a field in a buffer)
113 ******************************************************************************/
116 acpi_ds_create_buffer_field(union acpi_parse_object *op,
117 struct acpi_walk_state *walk_state)
119 union acpi_parse_object *arg;
120 struct acpi_namespace_node *node;
122 union acpi_operand_object *obj_desc;
123 union acpi_operand_object *second_desc = NULL;
126 ACPI_FUNCTION_TRACE(ds_create_buffer_field);
129 * Get the name_string argument (name of the new buffer_field)
131 if (op->common.aml_opcode == AML_CREATE_FIELD_OP) {
133 /* For create_field, name is the 4th argument */
135 arg = acpi_ps_get_arg(op, 3);
137 /* For all other create_XXXField operators, name is the 3rd argument */
139 arg = acpi_ps_get_arg(op, 2);
143 return_ACPI_STATUS(AE_AML_NO_OPERAND);
146 if (walk_state->deferred_node) {
147 node = walk_state->deferred_node;
150 /* Execute flag should always be set when this function is entered */
152 if (!(walk_state->parse_flags & ACPI_PARSE_EXECUTE)) {
153 ACPI_ERROR((AE_INFO, "Parse execute mode is not set"));
154 return_ACPI_STATUS(AE_AML_INTERNAL);
157 /* Creating new namespace node, should not already exist */
159 flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE |
160 ACPI_NS_ERROR_IF_FOUND;
163 * Mark node temporary if we are executing a normal control
164 * method. (Don't mark if this is a module-level code method)
166 if (walk_state->method_node &&
167 !(walk_state->parse_flags & ACPI_PARSE_MODULE_LEVEL)) {
168 flags |= ACPI_NS_TEMPORARY;
171 /* Enter the name_string into the namespace */
173 status = acpi_ns_lookup(walk_state->scope_info,
174 arg->common.value.string, ACPI_TYPE_ANY,
175 ACPI_IMODE_LOAD_PASS1, flags,
177 if (ACPI_FAILURE(status)) {
178 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
179 arg->common.value.string, status);
180 return_ACPI_STATUS(status);
185 * We could put the returned object (Node) on the object stack for later,
186 * but for now, we will put it in the "op" object that the parser uses,
187 * so we can get it again at the end of this scope.
189 op->common.node = node;
192 * If there is no object attached to the node, this node was just created
193 * and we need to create the field object. Otherwise, this was a lookup
194 * of an existing node and we don't want to create the field object again.
196 obj_desc = acpi_ns_get_attached_object(node);
198 return_ACPI_STATUS(AE_OK);
202 * The Field definition is not fully parsed at this time.
203 * (We must save the address of the AML for the buffer and index operands)
206 /* Create the buffer field object */
208 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER_FIELD);
210 status = AE_NO_MEMORY;
215 * Remember location in AML stream of the field unit opcode and operands
216 * -- since the buffer and index operands must be evaluated.
218 second_desc = obj_desc->common.next_object;
219 second_desc->extra.aml_start = op->named.data;
220 second_desc->extra.aml_length = op->named.length;
221 obj_desc->buffer_field.node = node;
223 /* Attach constructed field descriptors to parent node */
225 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_BUFFER_FIELD);
226 if (ACPI_FAILURE(status)) {
232 /* Remove local reference to the object */
234 acpi_ut_remove_reference(obj_desc);
235 return_ACPI_STATUS(status);
238 /*******************************************************************************
240 * FUNCTION: acpi_ds_get_field_names
242 * PARAMETERS: info - create_field info structure
243 * ` walk_state - Current method state
244 * arg - First parser arg for the field name list
248 * DESCRIPTION: Process all named fields in a field declaration. Names are
249 * entered into the namespace.
251 ******************************************************************************/
254 acpi_ds_get_field_names(struct acpi_create_field_info *info,
255 struct acpi_walk_state *walk_state,
256 union acpi_parse_object *arg)
260 union acpi_parse_object *child;
262 ACPI_FUNCTION_TRACE_PTR(ds_get_field_names, info);
264 /* First field starts at bit zero */
266 info->field_bit_position = 0;
268 /* Process all elements in the field list (of parse nodes) */
272 * Four types of field elements are handled:
273 * 1) name - Enters a new named field into the namespace
274 * 2) offset - specifies a bit offset
275 * 3) access_as - changes the access mode/attributes
276 * 4) connection - Associate a resource template with the field
278 switch (arg->common.aml_opcode) {
279 case AML_INT_RESERVEDFIELD_OP:
281 position = (u64)info->field_bit_position +
282 (u64)arg->common.value.size;
284 if (position > ACPI_UINT32_MAX) {
286 "Bit offset within field too large (> 0xFFFFFFFF)"));
287 return_ACPI_STATUS(AE_SUPPORT);
290 info->field_bit_position = (u32) position;
293 case AML_INT_ACCESSFIELD_OP:
294 case AML_INT_EXTACCESSFIELD_OP:
296 * Get new access_type, access_attribute, and access_length fields
297 * -- to be used for all field units that follow, until the
298 * end-of-field or another access_as keyword is encountered.
299 * NOTE. These three bytes are encoded in the integer value
300 * of the parseop for convenience.
302 * In field_flags, preserve the flag bits other than the
306 /* access_type (byte_acc, word_acc, etc.) */
308 info->field_flags = (u8)
310 field_flags & ~(AML_FIELD_ACCESS_TYPE_MASK)) |
311 ((u8)((u32)(arg->common.value.integer & 0x07))));
313 /* access_attribute (attrib_quick, attrib_byte, etc.) */
315 info->attribute = (u8)
316 ((arg->common.value.integer >> 8) & 0xFF);
318 /* access_length (for serial/buffer protocols) */
320 info->access_length = (u8)
321 ((arg->common.value.integer >> 16) & 0xFF);
324 case AML_INT_CONNECTION_OP:
326 * Clear any previous connection. New connection is used for all
327 * fields that follow, similar to access_as
329 info->resource_buffer = NULL;
330 info->connection_node = NULL;
331 info->pin_number_index = 0;
334 * A Connection() is either an actual resource descriptor (buffer)
335 * or a named reference to a resource template
337 child = arg->common.value.arg;
338 if (child->common.aml_opcode == AML_INT_BYTELIST_OP) {
339 info->resource_buffer = child->named.data;
340 info->resource_length =
341 (u16)child->named.value.integer;
343 /* Lookup the Connection() namepath, it should already exist */
345 status = acpi_ns_lookup(walk_state->scope_info,
349 ACPI_NS_DONT_OPEN_SCOPE,
351 &info->connection_node);
352 if (ACPI_FAILURE(status)) {
353 ACPI_ERROR_NAMESPACE(walk_state->
358 return_ACPI_STATUS(status);
363 case AML_INT_NAMEDFIELD_OP:
365 /* Lookup the name, it should already exist */
367 status = acpi_ns_lookup(walk_state->scope_info,
368 (char *)&arg->named.name,
371 ACPI_NS_DONT_OPEN_SCOPE,
372 walk_state, &info->field_node);
373 if (ACPI_FAILURE(status)) {
374 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
375 (char *)&arg->named.name,
377 return_ACPI_STATUS(status);
379 arg->common.node = info->field_node;
380 info->field_bit_length = arg->common.value.size;
383 * If there is no object attached to the node, this node was
384 * just created and we need to create the field object.
385 * Otherwise, this was a lookup of an existing node and we
386 * don't want to create the field object again.
388 if (!acpi_ns_get_attached_object
389 (info->field_node)) {
390 status = acpi_ex_prep_field_value(info);
391 if (ACPI_FAILURE(status)) {
392 return_ACPI_STATUS(status);
397 /* Keep track of bit position for the next field */
399 position = (u64)info->field_bit_position +
400 (u64)arg->common.value.size;
402 if (position > ACPI_UINT32_MAX) {
404 "Field [%4.4s] bit offset too large (> 0xFFFFFFFF)",
408 return_ACPI_STATUS(AE_SUPPORT);
411 info->field_bit_position += info->field_bit_length;
412 info->pin_number_index++; /* Index relative to previous Connection() */
418 "Invalid opcode in field list: 0x%X",
419 arg->common.aml_opcode));
420 return_ACPI_STATUS(AE_AML_BAD_OPCODE);
423 arg = arg->common.next;
426 return_ACPI_STATUS(AE_OK);
429 /*******************************************************************************
431 * FUNCTION: acpi_ds_create_field
433 * PARAMETERS: op - Op containing the Field definition and args
434 * region_node - Object for the containing Operation Region
435 * ` walk_state - Current method state
439 * DESCRIPTION: Create a new field in the specified operation region
441 ******************************************************************************/
444 acpi_ds_create_field(union acpi_parse_object *op,
445 struct acpi_namespace_node *region_node,
446 struct acpi_walk_state *walk_state)
449 union acpi_parse_object *arg;
450 struct acpi_create_field_info info;
452 ACPI_FUNCTION_TRACE_PTR(ds_create_field, op);
454 /* First arg is the name of the parent op_region (must already exist) */
456 arg = op->common.value.arg;
460 acpi_ns_lookup(walk_state->scope_info,
461 arg->common.value.name, ACPI_TYPE_REGION,
462 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
463 walk_state, ®ion_node);
464 #ifdef ACPI_ASL_COMPILER
465 status = acpi_ds_create_external_region(status, arg,
466 arg->common.value.name,
470 if (ACPI_FAILURE(status)) {
471 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
472 arg->common.value.name, status);
473 return_ACPI_STATUS(status);
477 memset(&info, 0, sizeof(struct acpi_create_field_info));
479 /* Second arg is the field flags */
481 arg = arg->common.next;
482 info.field_flags = (u8) arg->common.value.integer;
485 /* Each remaining arg is a Named Field */
487 info.field_type = ACPI_TYPE_LOCAL_REGION_FIELD;
488 info.region_node = region_node;
490 status = acpi_ds_get_field_names(&info, walk_state, arg->common.next);
491 return_ACPI_STATUS(status);
494 /*******************************************************************************
496 * FUNCTION: acpi_ds_init_field_objects
498 * PARAMETERS: op - Op containing the Field definition and args
499 * ` walk_state - Current method state
503 * DESCRIPTION: For each "Field Unit" name in the argument list that is
504 * part of the field declaration, enter the name into the
507 ******************************************************************************/
510 acpi_ds_init_field_objects(union acpi_parse_object *op,
511 struct acpi_walk_state *walk_state)
514 union acpi_parse_object *arg = NULL;
515 struct acpi_namespace_node *node;
519 ACPI_FUNCTION_TRACE_PTR(ds_init_field_objects, op);
521 /* Execute flag should always be set when this function is entered */
523 if (!(walk_state->parse_flags & ACPI_PARSE_EXECUTE)) {
524 if (walk_state->parse_flags & ACPI_PARSE_DEFERRED_OP) {
526 /* bank_field Op is deferred, just return OK */
528 return_ACPI_STATUS(AE_OK);
531 ACPI_ERROR((AE_INFO, "Parse deferred mode is not set"));
532 return_ACPI_STATUS(AE_AML_INTERNAL);
536 * Get the field_list argument for this opcode. This is the start of the
537 * list of field elements.
539 switch (walk_state->opcode) {
542 arg = acpi_ps_get_arg(op, 2);
543 type = ACPI_TYPE_LOCAL_REGION_FIELD;
546 case AML_BANK_FIELD_OP:
548 arg = acpi_ps_get_arg(op, 4);
549 type = ACPI_TYPE_LOCAL_BANK_FIELD;
552 case AML_INDEX_FIELD_OP:
554 arg = acpi_ps_get_arg(op, 3);
555 type = ACPI_TYPE_LOCAL_INDEX_FIELD;
560 return_ACPI_STATUS(AE_BAD_PARAMETER);
563 /* Creating new namespace node(s), should not already exist */
565 flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE |
566 ACPI_NS_ERROR_IF_FOUND;
569 * Mark node(s) temporary if we are executing a normal control
570 * method. (Don't mark if this is a module-level code method)
572 if (walk_state->method_node &&
573 !(walk_state->parse_flags & ACPI_PARSE_MODULE_LEVEL)) {
574 flags |= ACPI_NS_TEMPORARY;
578 * Walk the list of entries in the field_list
579 * Note: field_list can be of zero length. In this case, Arg will be NULL.
583 * Ignore OFFSET/ACCESSAS/CONNECTION terms here; we are only interested
584 * in the field names in order to enter them into the namespace.
586 if (arg->common.aml_opcode == AML_INT_NAMEDFIELD_OP) {
587 status = acpi_ns_lookup(walk_state->scope_info,
588 (char *)&arg->named.name, type,
589 ACPI_IMODE_LOAD_PASS1, flags,
591 if (ACPI_FAILURE(status)) {
592 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
593 (char *)&arg->named.name,
595 if (status != AE_ALREADY_EXISTS) {
596 return_ACPI_STATUS(status);
599 /* Name already exists, just ignore this error */
604 arg->common.node = node;
607 /* Get the next field element in the list */
609 arg = arg->common.next;
612 return_ACPI_STATUS(AE_OK);
615 /*******************************************************************************
617 * FUNCTION: acpi_ds_create_bank_field
619 * PARAMETERS: op - Op containing the Field definition and args
620 * region_node - Object for the containing Operation Region
621 * walk_state - Current method state
625 * DESCRIPTION: Create a new bank field in the specified operation region
627 ******************************************************************************/
630 acpi_ds_create_bank_field(union acpi_parse_object *op,
631 struct acpi_namespace_node *region_node,
632 struct acpi_walk_state *walk_state)
635 union acpi_parse_object *arg;
636 struct acpi_create_field_info info;
638 ACPI_FUNCTION_TRACE_PTR(ds_create_bank_field, op);
640 /* First arg is the name of the parent op_region (must already exist) */
642 arg = op->common.value.arg;
645 acpi_ns_lookup(walk_state->scope_info,
646 arg->common.value.name, ACPI_TYPE_REGION,
647 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
648 walk_state, ®ion_node);
649 #ifdef ACPI_ASL_COMPILER
650 status = acpi_ds_create_external_region(status, arg,
651 arg->common.value.name,
655 if (ACPI_FAILURE(status)) {
656 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
657 arg->common.value.name, status);
658 return_ACPI_STATUS(status);
662 /* Second arg is the Bank Register (Field) (must already exist) */
664 arg = arg->common.next;
666 acpi_ns_lookup(walk_state->scope_info, arg->common.value.string,
667 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
668 ACPI_NS_SEARCH_PARENT, walk_state,
669 &info.register_node);
670 if (ACPI_FAILURE(status)) {
671 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
672 arg->common.value.string, status);
673 return_ACPI_STATUS(status);
677 * Third arg is the bank_value
678 * This arg is a term_arg, not a constant
679 * It will be evaluated later, by acpi_ds_eval_bank_field_operands
681 arg = arg->common.next;
683 /* Fourth arg is the field flags */
685 arg = arg->common.next;
686 info.field_flags = (u8) arg->common.value.integer;
688 /* Each remaining arg is a Named Field */
690 info.field_type = ACPI_TYPE_LOCAL_BANK_FIELD;
691 info.region_node = region_node;
694 * Use Info.data_register_node to store bank_field Op
695 * It's safe because data_register_node will never be used when create
696 * bank field \we store aml_start and aml_length in the bank_field Op for
697 * late evaluation. Used in acpi_ex_prep_field_value(Info)
699 * TBD: Or, should we add a field in struct acpi_create_field_info, like
702 info.data_register_node = (struct acpi_namespace_node *)op;
704 status = acpi_ds_get_field_names(&info, walk_state, arg->common.next);
705 return_ACPI_STATUS(status);
708 /*******************************************************************************
710 * FUNCTION: acpi_ds_create_index_field
712 * PARAMETERS: op - Op containing the Field definition and args
713 * region_node - Object for the containing Operation Region
714 * ` walk_state - Current method state
718 * DESCRIPTION: Create a new index field in the specified operation region
720 ******************************************************************************/
723 acpi_ds_create_index_field(union acpi_parse_object *op,
724 struct acpi_namespace_node *region_node,
725 struct acpi_walk_state *walk_state)
728 union acpi_parse_object *arg;
729 struct acpi_create_field_info info;
731 ACPI_FUNCTION_TRACE_PTR(ds_create_index_field, op);
733 /* First arg is the name of the Index register (must already exist) */
735 arg = op->common.value.arg;
737 acpi_ns_lookup(walk_state->scope_info, arg->common.value.string,
738 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
739 ACPI_NS_SEARCH_PARENT, walk_state,
740 &info.register_node);
741 if (ACPI_FAILURE(status)) {
742 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
743 arg->common.value.string, status);
744 return_ACPI_STATUS(status);
747 /* Second arg is the data register (must already exist) */
749 arg = arg->common.next;
751 acpi_ns_lookup(walk_state->scope_info, arg->common.value.string,
752 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
753 ACPI_NS_SEARCH_PARENT, walk_state,
754 &info.data_register_node);
755 if (ACPI_FAILURE(status)) {
756 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
757 arg->common.value.string, status);
758 return_ACPI_STATUS(status);
761 /* Next arg is the field flags */
763 arg = arg->common.next;
764 info.field_flags = (u8) arg->common.value.integer;
766 /* Each remaining arg is a Named Field */
768 info.field_type = ACPI_TYPE_LOCAL_INDEX_FIELD;
769 info.region_node = region_node;
771 status = acpi_ds_get_field_names(&info, walk_state, arg->common.next);
772 return_ACPI_STATUS(status);