1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: dsfield - Dispatcher field routines
6 * Copyright (C) 2000 - 2020, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
22 #define _COMPONENT ACPI_DISPATCHER
23 ACPI_MODULE_NAME("dsfield")
25 /* Local prototypes */
26 #ifdef ACPI_ASL_COMPILER
29 acpi_ds_create_external_region(acpi_status lookup_status
,
30 union acpi_parse_object
*op
,
32 struct acpi_walk_state
*walk_state
,
33 struct acpi_namespace_node
**node
);
37 acpi_ds_get_field_names(struct acpi_create_field_info
*info
,
38 struct acpi_walk_state
*walk_state
,
39 union acpi_parse_object
*arg
);
41 #ifdef ACPI_ASL_COMPILER
42 /*******************************************************************************
44 * FUNCTION: acpi_ds_create_external_region (iASL Disassembler only)
46 * PARAMETERS: lookup_status - Status from ns_lookup operation
47 * op - Op containing the Field definition and args
48 * path - Pathname of the region
49 * ` walk_state - Current method state
50 * node - Where the new region node is returned
54 * DESCRIPTION: Add region to the external list if NOT_FOUND. Create a new
57 ******************************************************************************/
60 acpi_ds_create_external_region(acpi_status lookup_status
,
61 union acpi_parse_object
*op
,
63 struct acpi_walk_state
*walk_state
,
64 struct acpi_namespace_node
**node
)
67 union acpi_operand_object
*obj_desc
;
69 if (lookup_status
!= AE_NOT_FOUND
) {
70 return (lookup_status
);
75 * operation_region not found. Generate an External for it, and
76 * insert the name into the namespace.
78 acpi_dm_add_op_to_external_list(op
, path
, ACPI_TYPE_REGION
, 0, 0);
80 status
= acpi_ns_lookup(walk_state
->scope_info
, path
, ACPI_TYPE_REGION
,
81 ACPI_IMODE_LOAD_PASS1
, ACPI_NS_SEARCH_PARENT
,
83 if (ACPI_FAILURE(status
)) {
87 /* Must create and install a region object for the new node */
89 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_REGION
);
91 return (AE_NO_MEMORY
);
94 obj_desc
->region
.node
= *node
;
95 status
= acpi_ns_attach_object(*node
, obj_desc
, ACPI_TYPE_REGION
);
100 /*******************************************************************************
102 * FUNCTION: acpi_ds_create_buffer_field
104 * PARAMETERS: op - Current parse op (create_XXField)
105 * walk_state - Current state
109 * DESCRIPTION: Execute the create_field operators:
110 * create_bit_field_op,
111 * create_byte_field_op,
112 * create_word_field_op,
113 * create_dword_field_op,
114 * create_qword_field_op,
115 * create_field_op (all of which define a field in a buffer)
117 ******************************************************************************/
120 acpi_ds_create_buffer_field(union acpi_parse_object
*op
,
121 struct acpi_walk_state
*walk_state
)
123 union acpi_parse_object
*arg
;
124 struct acpi_namespace_node
*node
;
126 union acpi_operand_object
*obj_desc
;
127 union acpi_operand_object
*second_desc
= NULL
;
130 ACPI_FUNCTION_TRACE(ds_create_buffer_field
);
133 * Get the name_string argument (name of the new buffer_field)
135 if (op
->common
.aml_opcode
== AML_CREATE_FIELD_OP
) {
137 /* For create_field, name is the 4th argument */
139 arg
= acpi_ps_get_arg(op
, 3);
141 /* For all other create_XXXField operators, name is the 3rd argument */
143 arg
= acpi_ps_get_arg(op
, 2);
147 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
150 if (walk_state
->deferred_node
) {
151 node
= walk_state
->deferred_node
;
153 /* Execute flag should always be set when this function is entered */
155 if (!(walk_state
->parse_flags
& ACPI_PARSE_EXECUTE
)) {
156 ACPI_ERROR((AE_INFO
, "Parse execute mode is not set"));
157 return_ACPI_STATUS(AE_AML_INTERNAL
);
160 /* Creating new namespace node, should not already exist */
162 flags
= ACPI_NS_NO_UPSEARCH
| ACPI_NS_DONT_OPEN_SCOPE
|
163 ACPI_NS_ERROR_IF_FOUND
;
166 * Mark node temporary if we are executing a normal control
167 * method. (Don't mark if this is a module-level code method)
169 if (walk_state
->method_node
&&
170 !(walk_state
->parse_flags
& ACPI_PARSE_MODULE_LEVEL
)) {
171 flags
|= ACPI_NS_TEMPORARY
;
174 /* Enter the name_string into the namespace */
176 status
= acpi_ns_lookup(walk_state
->scope_info
,
177 arg
->common
.value
.string
, ACPI_TYPE_ANY
,
178 ACPI_IMODE_LOAD_PASS1
, flags
,
180 if (ACPI_FAILURE(status
)) {
181 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
182 arg
->common
.value
.string
, status
);
183 return_ACPI_STATUS(status
);
188 * We could put the returned object (Node) on the object stack for later,
189 * but for now, we will put it in the "op" object that the parser uses,
190 * so we can get it again at the end of this scope.
192 op
->common
.node
= node
;
195 * If there is no object attached to the node, this node was just created
196 * and we need to create the field object. Otherwise, this was a lookup
197 * of an existing node and we don't want to create the field object again.
199 obj_desc
= acpi_ns_get_attached_object(node
);
201 return_ACPI_STATUS(AE_OK
);
205 * The Field definition is not fully parsed at this time.
206 * (We must save the address of the AML for the buffer and index operands)
209 /* Create the buffer field object */
211 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_BUFFER_FIELD
);
213 status
= AE_NO_MEMORY
;
218 * Remember location in AML stream of the field unit opcode and operands
219 * -- since the buffer and index operands must be evaluated.
221 second_desc
= obj_desc
->common
.next_object
;
222 second_desc
->extra
.aml_start
= op
->named
.data
;
223 second_desc
->extra
.aml_length
= op
->named
.length
;
224 obj_desc
->buffer_field
.node
= node
;
226 /* Attach constructed field descriptors to parent node */
228 status
= acpi_ns_attach_object(node
, obj_desc
, ACPI_TYPE_BUFFER_FIELD
);
229 if (ACPI_FAILURE(status
)) {
235 /* Remove local reference to the object */
237 acpi_ut_remove_reference(obj_desc
);
238 return_ACPI_STATUS(status
);
241 /*******************************************************************************
243 * FUNCTION: acpi_ds_get_field_names
245 * PARAMETERS: info - create_field info structure
246 * walk_state - Current method state
247 * arg - First parser arg for the field name list
251 * DESCRIPTION: Process all named fields in a field declaration. Names are
252 * entered into the namespace.
254 ******************************************************************************/
257 acpi_ds_get_field_names(struct acpi_create_field_info
*info
,
258 struct acpi_walk_state
*walk_state
,
259 union acpi_parse_object
*arg
)
263 union acpi_parse_object
*child
;
266 union acpi_operand_object
*result_desc
;
267 union acpi_operand_object
*obj_desc
;
271 ACPI_FUNCTION_TRACE_PTR(ds_get_field_names
, info
);
273 /* First field starts at bit zero */
275 info
->field_bit_position
= 0;
277 /* Process all elements in the field list (of parse nodes) */
281 * Four types of field elements are handled:
282 * 1) name - Enters a new named field into the namespace
283 * 2) offset - specifies a bit offset
284 * 3) access_as - changes the access mode/attributes
285 * 4) connection - Associate a resource template with the field
287 switch (arg
->common
.aml_opcode
) {
288 case AML_INT_RESERVEDFIELD_OP
:
290 position
= (u64
)info
->field_bit_position
+
291 (u64
)arg
->common
.value
.size
;
293 if (position
> ACPI_UINT32_MAX
) {
295 "Bit offset within field too large (> 0xFFFFFFFF)"));
296 return_ACPI_STATUS(AE_SUPPORT
);
299 info
->field_bit_position
= (u32
) position
;
302 case AML_INT_ACCESSFIELD_OP
:
303 case AML_INT_EXTACCESSFIELD_OP
:
305 * Get new access_type, access_attribute, and access_length fields
306 * -- to be used for all field units that follow, until the
307 * end-of-field or another access_as keyword is encountered.
308 * NOTE. These three bytes are encoded in the integer value
309 * of the parseop for convenience.
311 * In field_flags, preserve the flag bits other than the
315 /* access_type (byte_acc, word_acc, etc.) */
317 info
->field_flags
= (u8
)
319 field_flags
& ~(AML_FIELD_ACCESS_TYPE_MASK
)) |
320 ((u8
)((u32
)(arg
->common
.value
.integer
& 0x07))));
322 /* access_attribute (attrib_quick, attrib_byte, etc.) */
324 info
->attribute
= (u8
)
325 ((arg
->common
.value
.integer
>> 8) & 0xFF);
327 /* access_length (for serial/buffer protocols) */
329 info
->access_length
= (u8
)
330 ((arg
->common
.value
.integer
>> 16) & 0xFF);
333 case AML_INT_CONNECTION_OP
:
335 * Clear any previous connection. New connection is used for all
336 * fields that follow, similar to access_as
338 info
->resource_buffer
= NULL
;
339 info
->connection_node
= NULL
;
340 info
->pin_number_index
= 0;
343 * A Connection() is either an actual resource descriptor (buffer)
344 * or a named reference to a resource template
346 child
= arg
->common
.value
.arg
;
347 if (child
->common
.aml_opcode
== AML_INT_BYTELIST_OP
) {
348 info
->resource_buffer
= child
->named
.data
;
349 info
->resource_length
=
350 (u16
)child
->named
.value
.integer
;
352 /* Lookup the Connection() namepath, it should already exist */
354 status
= acpi_ns_lookup(walk_state
->scope_info
,
358 ACPI_NS_DONT_OPEN_SCOPE
,
360 &info
->connection_node
);
361 if (ACPI_FAILURE(status
)) {
362 ACPI_ERROR_NAMESPACE(walk_state
->
367 return_ACPI_STATUS(status
);
372 case AML_INT_NAMEDFIELD_OP
:
374 /* Lookup the name, it should already exist */
376 status
= acpi_ns_lookup(walk_state
->scope_info
,
377 (char *)&arg
->named
.name
,
380 ACPI_NS_DONT_OPEN_SCOPE
,
381 walk_state
, &info
->field_node
);
382 if (ACPI_FAILURE(status
)) {
383 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
384 (char *)&arg
->named
.name
,
386 return_ACPI_STATUS(status
);
388 arg
->common
.node
= info
->field_node
;
389 info
->field_bit_length
= arg
->common
.value
.size
;
392 * If there is no object attached to the node, this node was
393 * just created and we need to create the field object.
394 * Otherwise, this was a lookup of an existing node and we
395 * don't want to create the field object again.
397 if (!acpi_ns_get_attached_object
398 (info
->field_node
)) {
399 status
= acpi_ex_prep_field_value(info
);
400 if (ACPI_FAILURE(status
)) {
401 return_ACPI_STATUS(status
);
405 acpi_ns_get_external_pathname(info
->
408 (ae_lookup_init_file_entry
409 (name_path
, &obj_desc
))) {
410 acpi_ex_write_data_to_field
412 acpi_ns_get_attached_object
415 acpi_ut_remove_reference
418 ACPI_FREE(name_path
);
423 /* Keep track of bit position for the next field */
425 position
= (u64
)info
->field_bit_position
+
426 (u64
)arg
->common
.value
.size
;
428 if (position
> ACPI_UINT32_MAX
) {
430 "Field [%4.4s] bit offset too large (> 0xFFFFFFFF)",
434 return_ACPI_STATUS(AE_SUPPORT
);
437 info
->field_bit_position
+= info
->field_bit_length
;
438 info
->pin_number_index
++; /* Index relative to previous Connection() */
444 "Invalid opcode in field list: 0x%X",
445 arg
->common
.aml_opcode
));
446 return_ACPI_STATUS(AE_AML_BAD_OPCODE
);
449 arg
= arg
->common
.next
;
452 return_ACPI_STATUS(AE_OK
);
455 /*******************************************************************************
457 * FUNCTION: acpi_ds_create_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 field in the specified operation region
467 ******************************************************************************/
470 acpi_ds_create_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_field
, op
);
480 /* First arg is the name of the parent op_region (must already exist) */
482 arg
= op
->common
.value
.arg
;
486 acpi_ns_lookup(walk_state
->scope_info
,
487 arg
->common
.value
.name
, ACPI_TYPE_REGION
,
488 ACPI_IMODE_EXECUTE
, ACPI_NS_SEARCH_PARENT
,
489 walk_state
, ®ion_node
);
490 #ifdef ACPI_ASL_COMPILER
491 status
= acpi_ds_create_external_region(status
, arg
,
492 arg
->common
.value
.name
,
496 if (ACPI_FAILURE(status
)) {
497 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
498 arg
->common
.value
.name
, status
);
499 return_ACPI_STATUS(status
);
503 memset(&info
, 0, sizeof(struct acpi_create_field_info
));
505 /* Second arg is the field flags */
507 arg
= arg
->common
.next
;
508 info
.field_flags
= (u8
) arg
->common
.value
.integer
;
511 /* Each remaining arg is a Named Field */
513 info
.field_type
= ACPI_TYPE_LOCAL_REGION_FIELD
;
514 info
.region_node
= region_node
;
516 status
= acpi_ds_get_field_names(&info
, walk_state
, arg
->common
.next
);
517 if (info
.region_node
->object
->region
.space_id
==
518 ACPI_ADR_SPACE_PLATFORM_COMM
519 && !(region_node
->object
->field
.internal_pcc_buffer
=
520 ACPI_ALLOCATE_ZEROED(info
.region_node
->object
->region
.
522 return_ACPI_STATUS(AE_NO_MEMORY
);
524 return_ACPI_STATUS(status
);
527 /*******************************************************************************
529 * FUNCTION: acpi_ds_init_field_objects
531 * PARAMETERS: op - Op containing the Field definition and args
532 * ` walk_state - Current method state
536 * DESCRIPTION: For each "Field Unit" name in the argument list that is
537 * part of the field declaration, enter the name into the
540 ******************************************************************************/
543 acpi_ds_init_field_objects(union acpi_parse_object
*op
,
544 struct acpi_walk_state
*walk_state
)
547 union acpi_parse_object
*arg
= NULL
;
548 struct acpi_namespace_node
*node
;
552 ACPI_FUNCTION_TRACE_PTR(ds_init_field_objects
, op
);
554 /* Execute flag should always be set when this function is entered */
556 if (!(walk_state
->parse_flags
& ACPI_PARSE_EXECUTE
)) {
557 if (walk_state
->parse_flags
& ACPI_PARSE_DEFERRED_OP
) {
559 /* bank_field Op is deferred, just return OK */
561 return_ACPI_STATUS(AE_OK
);
564 ACPI_ERROR((AE_INFO
, "Parse deferred mode is not set"));
565 return_ACPI_STATUS(AE_AML_INTERNAL
);
569 * Get the field_list argument for this opcode. This is the start of the
570 * list of field elements.
572 switch (walk_state
->opcode
) {
575 arg
= acpi_ps_get_arg(op
, 2);
576 type
= ACPI_TYPE_LOCAL_REGION_FIELD
;
579 case AML_BANK_FIELD_OP
:
581 arg
= acpi_ps_get_arg(op
, 4);
582 type
= ACPI_TYPE_LOCAL_BANK_FIELD
;
585 case AML_INDEX_FIELD_OP
:
587 arg
= acpi_ps_get_arg(op
, 3);
588 type
= ACPI_TYPE_LOCAL_INDEX_FIELD
;
593 return_ACPI_STATUS(AE_BAD_PARAMETER
);
596 /* Creating new namespace node(s), should not already exist */
598 flags
= ACPI_NS_NO_UPSEARCH
| ACPI_NS_DONT_OPEN_SCOPE
|
599 ACPI_NS_ERROR_IF_FOUND
;
602 * Mark node(s) temporary if we are executing a normal control
603 * method. (Don't mark if this is a module-level code method)
605 if (walk_state
->method_node
&&
606 !(walk_state
->parse_flags
& ACPI_PARSE_MODULE_LEVEL
)) {
607 flags
|= ACPI_NS_TEMPORARY
;
610 flags
|= ACPI_NS_OVERRIDE_IF_FOUND
;
613 * Walk the list of entries in the field_list
614 * Note: field_list can be of zero length. In this case, Arg will be NULL.
618 * Ignore OFFSET/ACCESSAS/CONNECTION terms here; we are only interested
619 * in the field names in order to enter them into the namespace.
621 if (arg
->common
.aml_opcode
== AML_INT_NAMEDFIELD_OP
) {
622 status
= acpi_ns_lookup(walk_state
->scope_info
,
623 (char *)&arg
->named
.name
, type
,
624 ACPI_IMODE_LOAD_PASS1
, flags
,
626 if (ACPI_FAILURE(status
)) {
627 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
628 (char *)&arg
->named
.name
,
630 if (status
!= AE_ALREADY_EXISTS
) {
631 return_ACPI_STATUS(status
);
634 /* Name already exists, just ignore this error */
637 arg
->common
.node
= node
;
640 /* Get the next field element in the list */
642 arg
= arg
->common
.next
;
645 return_ACPI_STATUS(AE_OK
);
648 /*******************************************************************************
650 * FUNCTION: acpi_ds_create_bank_field
652 * PARAMETERS: op - Op containing the Field definition and args
653 * region_node - Object for the containing Operation Region
654 * walk_state - Current method state
658 * DESCRIPTION: Create a new bank field in the specified operation region
660 ******************************************************************************/
663 acpi_ds_create_bank_field(union acpi_parse_object
*op
,
664 struct acpi_namespace_node
*region_node
,
665 struct acpi_walk_state
*walk_state
)
668 union acpi_parse_object
*arg
;
669 struct acpi_create_field_info info
;
671 ACPI_FUNCTION_TRACE_PTR(ds_create_bank_field
, op
);
673 /* First arg is the name of the parent op_region (must already exist) */
675 arg
= op
->common
.value
.arg
;
678 acpi_ns_lookup(walk_state
->scope_info
,
679 arg
->common
.value
.name
, ACPI_TYPE_REGION
,
680 ACPI_IMODE_EXECUTE
, ACPI_NS_SEARCH_PARENT
,
681 walk_state
, ®ion_node
);
682 #ifdef ACPI_ASL_COMPILER
683 status
= acpi_ds_create_external_region(status
, arg
,
684 arg
->common
.value
.name
,
688 if (ACPI_FAILURE(status
)) {
689 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
690 arg
->common
.value
.name
, status
);
691 return_ACPI_STATUS(status
);
695 /* Second arg is the Bank Register (Field) (must already exist) */
697 arg
= arg
->common
.next
;
699 acpi_ns_lookup(walk_state
->scope_info
, arg
->common
.value
.string
,
700 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
701 ACPI_NS_SEARCH_PARENT
, walk_state
,
702 &info
.register_node
);
703 if (ACPI_FAILURE(status
)) {
704 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
705 arg
->common
.value
.string
, status
);
706 return_ACPI_STATUS(status
);
710 * Third arg is the bank_value
711 * This arg is a term_arg, not a constant
712 * It will be evaluated later, by acpi_ds_eval_bank_field_operands
714 arg
= arg
->common
.next
;
716 /* Fourth arg is the field flags */
718 arg
= arg
->common
.next
;
719 info
.field_flags
= (u8
) arg
->common
.value
.integer
;
721 /* Each remaining arg is a Named Field */
723 info
.field_type
= ACPI_TYPE_LOCAL_BANK_FIELD
;
724 info
.region_node
= region_node
;
727 * Use Info.data_register_node to store bank_field Op
728 * It's safe because data_register_node will never be used when create
729 * bank field \we store aml_start and aml_length in the bank_field Op for
730 * late evaluation. Used in acpi_ex_prep_field_value(Info)
732 * TBD: Or, should we add a field in struct acpi_create_field_info, like
735 info
.data_register_node
= (struct acpi_namespace_node
*)op
;
737 status
= acpi_ds_get_field_names(&info
, walk_state
, arg
->common
.next
);
738 return_ACPI_STATUS(status
);
741 /*******************************************************************************
743 * FUNCTION: acpi_ds_create_index_field
745 * PARAMETERS: op - Op containing the Field definition and args
746 * region_node - Object for the containing Operation Region
747 * ` walk_state - Current method state
751 * DESCRIPTION: Create a new index field in the specified operation region
753 ******************************************************************************/
756 acpi_ds_create_index_field(union acpi_parse_object
*op
,
757 struct acpi_namespace_node
*region_node
,
758 struct acpi_walk_state
*walk_state
)
761 union acpi_parse_object
*arg
;
762 struct acpi_create_field_info info
;
764 ACPI_FUNCTION_TRACE_PTR(ds_create_index_field
, op
);
766 /* First arg is the name of the Index register (must already exist) */
768 arg
= op
->common
.value
.arg
;
770 acpi_ns_lookup(walk_state
->scope_info
, arg
->common
.value
.string
,
771 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
772 ACPI_NS_SEARCH_PARENT
, walk_state
,
773 &info
.register_node
);
774 if (ACPI_FAILURE(status
)) {
775 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
776 arg
->common
.value
.string
, status
);
777 return_ACPI_STATUS(status
);
780 /* Second arg is the data register (must already exist) */
782 arg
= arg
->common
.next
;
784 acpi_ns_lookup(walk_state
->scope_info
, arg
->common
.value
.string
,
785 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
786 ACPI_NS_SEARCH_PARENT
, walk_state
,
787 &info
.data_register_node
);
788 if (ACPI_FAILURE(status
)) {
789 ACPI_ERROR_NAMESPACE(walk_state
->scope_info
,
790 arg
->common
.value
.string
, status
);
791 return_ACPI_STATUS(status
);
794 /* Next arg is the field flags */
796 arg
= arg
->common
.next
;
797 info
.field_flags
= (u8
) arg
->common
.value
.integer
;
799 /* Each remaining arg is a Named Field */
801 info
.field_type
= ACPI_TYPE_LOCAL_INDEX_FIELD
;
802 info
.region_node
= region_node
;
804 status
= acpi_ds_get_field_names(&info
, walk_state
, arg
->common
.next
);
805 return_ACPI_STATUS(status
);