1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: dsopcode - Dispatcher support for regions and fields
6 * Copyright (C) 2000 - 2018, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
20 #define _COMPONENT ACPI_DISPATCHER
21 ACPI_MODULE_NAME("dsopcode")
23 /* Local prototypes */
25 acpi_ds_init_buffer_field(u16 aml_opcode
,
26 union acpi_operand_object
*obj_desc
,
27 union acpi_operand_object
*buffer_desc
,
28 union acpi_operand_object
*offset_desc
,
29 union acpi_operand_object
*length_desc
,
30 union acpi_operand_object
*result_desc
);
32 /*******************************************************************************
34 * FUNCTION: acpi_ds_initialize_region
36 * PARAMETERS: obj_handle - Region namespace node
40 * DESCRIPTION: Front end to ev_initialize_region
42 ******************************************************************************/
44 acpi_status
acpi_ds_initialize_region(acpi_handle obj_handle
)
46 union acpi_operand_object
*obj_desc
;
49 obj_desc
= acpi_ns_get_attached_object(obj_handle
);
51 /* Namespace is NOT locked */
53 status
= acpi_ev_initialize_region(obj_desc
);
57 /*******************************************************************************
59 * FUNCTION: acpi_ds_init_buffer_field
61 * PARAMETERS: aml_opcode - create_xxx_field
62 * obj_desc - buffer_field object
63 * buffer_desc - Host Buffer
64 * offset_desc - Offset into buffer
65 * length_desc - Length of field (CREATE_FIELD_OP only)
66 * result_desc - Where to store the result
70 * DESCRIPTION: Perform actual initialization of a buffer field
72 ******************************************************************************/
75 acpi_ds_init_buffer_field(u16 aml_opcode
,
76 union acpi_operand_object
*obj_desc
,
77 union acpi_operand_object
*buffer_desc
,
78 union acpi_operand_object
*offset_desc
,
79 union acpi_operand_object
*length_desc
,
80 union acpi_operand_object
*result_desc
)
88 ACPI_FUNCTION_TRACE_PTR(ds_init_buffer_field
, obj_desc
);
90 /* Host object must be a Buffer */
92 if (buffer_desc
->common
.type
!= ACPI_TYPE_BUFFER
) {
94 "Target of Create Field is not a Buffer object - %s",
95 acpi_ut_get_object_type_name(buffer_desc
)));
97 status
= AE_AML_OPERAND_TYPE
;
102 * The last parameter to all of these opcodes (result_desc) started
103 * out as a name_string, and should therefore now be a NS node
104 * after resolution in acpi_ex_resolve_operands().
106 if (ACPI_GET_DESCRIPTOR_TYPE(result_desc
) != ACPI_DESC_TYPE_NAMED
) {
108 "(%s) destination not a NS Node [%s]",
109 acpi_ps_get_opcode_name(aml_opcode
),
110 acpi_ut_get_descriptor_name(result_desc
)));
112 status
= AE_AML_OPERAND_TYPE
;
116 offset
= (u32
) offset_desc
->integer
.value
;
119 * Setup the Bit offsets and counts, according to the opcode
121 switch (aml_opcode
) {
122 case AML_CREATE_FIELD_OP
:
124 /* Offset is in bits, count is in bits */
126 field_flags
= AML_FIELD_ACCESS_BYTE
;
128 bit_count
= (u32
) length_desc
->integer
.value
;
130 /* Must have a valid (>0) bit count */
132 if (bit_count
== 0) {
134 "Attempt to CreateField of length zero"));
135 status
= AE_AML_OPERAND_VALUE
;
140 case AML_CREATE_BIT_FIELD_OP
:
142 /* Offset is in bits, Field is one bit */
146 field_flags
= AML_FIELD_ACCESS_BYTE
;
149 case AML_CREATE_BYTE_FIELD_OP
:
151 /* Offset is in bytes, field is one byte */
153 bit_offset
= 8 * offset
;
155 field_flags
= AML_FIELD_ACCESS_BYTE
;
158 case AML_CREATE_WORD_FIELD_OP
:
160 /* Offset is in bytes, field is one word */
162 bit_offset
= 8 * offset
;
164 field_flags
= AML_FIELD_ACCESS_WORD
;
167 case AML_CREATE_DWORD_FIELD_OP
:
169 /* Offset is in bytes, field is one dword */
171 bit_offset
= 8 * offset
;
173 field_flags
= AML_FIELD_ACCESS_DWORD
;
176 case AML_CREATE_QWORD_FIELD_OP
:
178 /* Offset is in bytes, field is one qword */
180 bit_offset
= 8 * offset
;
182 field_flags
= AML_FIELD_ACCESS_QWORD
;
188 "Unknown field creation opcode 0x%02X",
190 status
= AE_AML_BAD_OPCODE
;
194 /* Entire field must fit within the current length of the buffer */
196 if ((bit_offset
+ bit_count
) > (8 * (u32
)buffer_desc
->buffer
.length
)) {
198 "Field [%4.4s] at bit offset/length %u/%u "
199 "exceeds size of target Buffer (%u bits)",
200 acpi_ut_get_node_name(result_desc
), bit_offset
,
201 bit_count
, 8 * (u32
)buffer_desc
->buffer
.length
));
202 status
= AE_AML_BUFFER_LIMIT
;
207 * Initialize areas of the field object that are common to all fields
208 * For field_flags, use LOCK_RULE = 0 (NO_LOCK),
209 * UPDATE_RULE = 0 (UPDATE_PRESERVE)
212 acpi_ex_prep_common_field_object(obj_desc
, field_flags
, 0,
213 bit_offset
, bit_count
);
214 if (ACPI_FAILURE(status
)) {
218 obj_desc
->buffer_field
.buffer_obj
= buffer_desc
;
220 /* Reference count for buffer_desc inherits obj_desc count */
222 buffer_desc
->common
.reference_count
= (u16
)
223 (buffer_desc
->common
.reference_count
+
224 obj_desc
->common
.reference_count
);
228 /* Always delete the operands */
230 acpi_ut_remove_reference(offset_desc
);
231 acpi_ut_remove_reference(buffer_desc
);
233 if (aml_opcode
== AML_CREATE_FIELD_OP
) {
234 acpi_ut_remove_reference(length_desc
);
237 /* On failure, delete the result descriptor */
239 if (ACPI_FAILURE(status
)) {
240 acpi_ut_remove_reference(result_desc
); /* Result descriptor */
242 /* Now the address and length are valid for this buffer_field */
244 obj_desc
->buffer_field
.flags
|= AOPOBJ_DATA_VALID
;
247 return_ACPI_STATUS(status
);
250 /*******************************************************************************
252 * FUNCTION: acpi_ds_eval_buffer_field_operands
254 * PARAMETERS: walk_state - Current walk
255 * op - A valid buffer_field Op object
259 * DESCRIPTION: Get buffer_field Buffer and Index
260 * Called from acpi_ds_exec_end_op during buffer_field parse tree walk
262 ******************************************************************************/
265 acpi_ds_eval_buffer_field_operands(struct acpi_walk_state
*walk_state
,
266 union acpi_parse_object
*op
)
269 union acpi_operand_object
*obj_desc
;
270 struct acpi_namespace_node
*node
;
271 union acpi_parse_object
*next_op
;
273 ACPI_FUNCTION_TRACE_PTR(ds_eval_buffer_field_operands
, op
);
276 * This is where we evaluate the address and length fields of the
277 * create_xxx_field declaration
279 node
= op
->common
.node
;
281 /* next_op points to the op that holds the Buffer */
283 next_op
= op
->common
.value
.arg
;
285 /* Evaluate/create the address and length operands */
287 status
= acpi_ds_create_operands(walk_state
, next_op
);
288 if (ACPI_FAILURE(status
)) {
289 return_ACPI_STATUS(status
);
292 obj_desc
= acpi_ns_get_attached_object(node
);
294 return_ACPI_STATUS(AE_NOT_EXIST
);
297 /* Resolve the operands */
300 acpi_ex_resolve_operands(op
->common
.aml_opcode
, ACPI_WALK_OPERANDS
,
302 if (ACPI_FAILURE(status
)) {
303 ACPI_ERROR((AE_INFO
, "(%s) bad operand(s), status 0x%X",
304 acpi_ps_get_opcode_name(op
->common
.aml_opcode
),
307 return_ACPI_STATUS(status
);
310 /* Initialize the Buffer Field */
312 if (op
->common
.aml_opcode
== AML_CREATE_FIELD_OP
) {
314 /* NOTE: Slightly different operands for this opcode */
317 acpi_ds_init_buffer_field(op
->common
.aml_opcode
, obj_desc
,
318 walk_state
->operands
[0],
319 walk_state
->operands
[1],
320 walk_state
->operands
[2],
321 walk_state
->operands
[3]);
323 /* All other, create_xxx_field opcodes */
326 acpi_ds_init_buffer_field(op
->common
.aml_opcode
, obj_desc
,
327 walk_state
->operands
[0],
328 walk_state
->operands
[1], NULL
,
329 walk_state
->operands
[2]);
332 return_ACPI_STATUS(status
);
335 /*******************************************************************************
337 * FUNCTION: acpi_ds_eval_region_operands
339 * PARAMETERS: walk_state - Current walk
340 * op - A valid region Op object
344 * DESCRIPTION: Get region address and length
345 * Called from acpi_ds_exec_end_op during op_region parse tree walk
347 ******************************************************************************/
350 acpi_ds_eval_region_operands(struct acpi_walk_state
*walk_state
,
351 union acpi_parse_object
*op
)
354 union acpi_operand_object
*obj_desc
;
355 union acpi_operand_object
*operand_desc
;
356 struct acpi_namespace_node
*node
;
357 union acpi_parse_object
*next_op
;
359 ACPI_FUNCTION_TRACE_PTR(ds_eval_region_operands
, op
);
362 * This is where we evaluate the address and length fields of the
363 * op_region declaration
365 node
= op
->common
.node
;
367 /* next_op points to the op that holds the space_ID */
369 next_op
= op
->common
.value
.arg
;
371 /* next_op points to address op */
373 next_op
= next_op
->common
.next
;
375 /* Evaluate/create the address and length operands */
377 status
= acpi_ds_create_operands(walk_state
, next_op
);
378 if (ACPI_FAILURE(status
)) {
379 return_ACPI_STATUS(status
);
382 /* Resolve the length and address operands to numbers */
385 acpi_ex_resolve_operands(op
->common
.aml_opcode
, ACPI_WALK_OPERANDS
,
387 if (ACPI_FAILURE(status
)) {
388 return_ACPI_STATUS(status
);
391 obj_desc
= acpi_ns_get_attached_object(node
);
393 return_ACPI_STATUS(AE_NOT_EXIST
);
397 * Get the length operand and save it
400 operand_desc
= walk_state
->operands
[walk_state
->num_operands
- 1];
402 obj_desc
->region
.length
= (u32
) operand_desc
->integer
.value
;
403 acpi_ut_remove_reference(operand_desc
);
406 * Get the address and save it
407 * (at top of stack - 1)
409 operand_desc
= walk_state
->operands
[walk_state
->num_operands
- 2];
411 obj_desc
->region
.address
= (acpi_physical_address
)
412 operand_desc
->integer
.value
;
413 acpi_ut_remove_reference(operand_desc
);
415 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "RgnObj %p Addr %8.8X%8.8X Len %X\n",
417 ACPI_FORMAT_UINT64(obj_desc
->region
.address
),
418 obj_desc
->region
.length
));
420 /* Now the address and length are valid for this opregion */
422 obj_desc
->region
.flags
|= AOPOBJ_DATA_VALID
;
423 return_ACPI_STATUS(status
);
426 /*******************************************************************************
428 * FUNCTION: acpi_ds_eval_table_region_operands
430 * PARAMETERS: walk_state - Current walk
431 * op - A valid region Op object
435 * DESCRIPTION: Get region address and length.
436 * Called from acpi_ds_exec_end_op during data_table_region parse
439 ******************************************************************************/
442 acpi_ds_eval_table_region_operands(struct acpi_walk_state
*walk_state
,
443 union acpi_parse_object
*op
)
446 union acpi_operand_object
*obj_desc
;
447 union acpi_operand_object
**operand
;
448 struct acpi_namespace_node
*node
;
449 union acpi_parse_object
*next_op
;
450 struct acpi_table_header
*table
;
453 ACPI_FUNCTION_TRACE_PTR(ds_eval_table_region_operands
, op
);
456 * This is where we evaluate the Signature string, oem_id string,
457 * and oem_table_id string of the Data Table Region declaration
459 node
= op
->common
.node
;
461 /* next_op points to Signature string op */
463 next_op
= op
->common
.value
.arg
;
466 * Evaluate/create the Signature string, oem_id string,
467 * and oem_table_id string operands
469 status
= acpi_ds_create_operands(walk_state
, next_op
);
470 if (ACPI_FAILURE(status
)) {
471 return_ACPI_STATUS(status
);
474 operand
= &walk_state
->operands
[0];
477 * Resolve the Signature string, oem_id string,
478 * and oem_table_id string operands
481 acpi_ex_resolve_operands(op
->common
.aml_opcode
, ACPI_WALK_OPERANDS
,
483 if (ACPI_FAILURE(status
)) {
487 /* Find the ACPI table */
489 status
= acpi_tb_find_table(operand
[0]->string
.pointer
,
490 operand
[1]->string
.pointer
,
491 operand
[2]->string
.pointer
, &table_index
);
492 if (ACPI_FAILURE(status
)) {
493 if (status
== AE_NOT_FOUND
) {
495 "ACPI Table [%4.4s] OEM:(%s, %s) not found in RSDT/XSDT",
496 operand
[0]->string
.pointer
,
497 operand
[1]->string
.pointer
,
498 operand
[2]->string
.pointer
));
503 status
= acpi_get_table_by_index(table_index
, &table
);
504 if (ACPI_FAILURE(status
)) {
508 obj_desc
= acpi_ns_get_attached_object(node
);
510 status
= AE_NOT_EXIST
;
514 obj_desc
->region
.address
= ACPI_PTR_TO_PHYSADDR(table
);
515 obj_desc
->region
.length
= table
->length
;
517 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "RgnObj %p Addr %8.8X%8.8X Len %X\n",
519 ACPI_FORMAT_UINT64(obj_desc
->region
.address
),
520 obj_desc
->region
.length
));
522 /* Now the address and length are valid for this opregion */
524 obj_desc
->region
.flags
|= AOPOBJ_DATA_VALID
;
527 acpi_ut_remove_reference(operand
[0]);
528 acpi_ut_remove_reference(operand
[1]);
529 acpi_ut_remove_reference(operand
[2]);
531 return_ACPI_STATUS(status
);
534 /*******************************************************************************
536 * FUNCTION: acpi_ds_eval_data_object_operands
538 * PARAMETERS: walk_state - Current walk
539 * op - A valid data_object Op object
540 * obj_desc - data_object
544 * DESCRIPTION: Get the operands and complete the following data object types:
547 ******************************************************************************/
550 acpi_ds_eval_data_object_operands(struct acpi_walk_state
*walk_state
,
551 union acpi_parse_object
*op
,
552 union acpi_operand_object
*obj_desc
)
555 union acpi_operand_object
*arg_desc
;
558 ACPI_FUNCTION_TRACE(ds_eval_data_object_operands
);
560 /* The first operand (for all of these data objects) is the length */
563 * Set proper index into operand stack for acpi_ds_obj_stack_push
564 * invoked inside acpi_ds_create_operand.
566 walk_state
->operand_index
= walk_state
->num_operands
;
568 /* Ignore if child is not valid */
570 if (!op
->common
.value
.arg
) {
572 "Missing child while evaluating opcode %4.4X, Op %p",
573 op
->common
.aml_opcode
, op
));
574 return_ACPI_STATUS(AE_OK
);
577 status
= acpi_ds_create_operand(walk_state
, op
->common
.value
.arg
, 1);
578 if (ACPI_FAILURE(status
)) {
579 return_ACPI_STATUS(status
);
582 status
= acpi_ex_resolve_operands(walk_state
->opcode
,
584 operands
[walk_state
->num_operands
-
586 if (ACPI_FAILURE(status
)) {
587 return_ACPI_STATUS(status
);
590 /* Extract length operand */
592 arg_desc
= walk_state
->operands
[walk_state
->num_operands
- 1];
593 length
= (u32
) arg_desc
->integer
.value
;
595 /* Cleanup for length operand */
597 status
= acpi_ds_obj_stack_pop(1, walk_state
);
598 if (ACPI_FAILURE(status
)) {
599 return_ACPI_STATUS(status
);
602 acpi_ut_remove_reference(arg_desc
);
605 * Create the actual data object
607 switch (op
->common
.aml_opcode
) {
611 acpi_ds_build_internal_buffer_obj(walk_state
, op
, length
,
616 case AML_VARIABLE_PACKAGE_OP
:
619 acpi_ds_build_internal_package_obj(walk_state
, op
, length
,
625 return_ACPI_STATUS(AE_AML_BAD_OPCODE
);
628 if (ACPI_SUCCESS(status
)) {
630 * Return the object in the walk_state, unless the parent is a package -
631 * in this case, the return object will be stored in the parse tree
634 if ((!op
->common
.parent
) ||
635 ((op
->common
.parent
->common
.aml_opcode
!= AML_PACKAGE_OP
) &&
636 (op
->common
.parent
->common
.aml_opcode
!=
637 AML_VARIABLE_PACKAGE_OP
)
638 && (op
->common
.parent
->common
.aml_opcode
!=
640 walk_state
->result_obj
= obj_desc
;
644 return_ACPI_STATUS(status
);
647 /*******************************************************************************
649 * FUNCTION: acpi_ds_eval_bank_field_operands
651 * PARAMETERS: walk_state - Current walk
652 * op - A valid bank_field Op object
656 * DESCRIPTION: Get bank_field bank_value
657 * Called from acpi_ds_exec_end_op during bank_field parse tree walk
659 ******************************************************************************/
662 acpi_ds_eval_bank_field_operands(struct acpi_walk_state
*walk_state
,
663 union acpi_parse_object
*op
)
666 union acpi_operand_object
*obj_desc
;
667 union acpi_operand_object
*operand_desc
;
668 struct acpi_namespace_node
*node
;
669 union acpi_parse_object
*next_op
;
670 union acpi_parse_object
*arg
;
672 ACPI_FUNCTION_TRACE_PTR(ds_eval_bank_field_operands
, op
);
675 * This is where we evaluate the bank_value field of the
676 * bank_field declaration
679 /* next_op points to the op that holds the Region */
681 next_op
= op
->common
.value
.arg
;
683 /* next_op points to the op that holds the Bank Register */
685 next_op
= next_op
->common
.next
;
687 /* next_op points to the op that holds the Bank Value */
689 next_op
= next_op
->common
.next
;
692 * Set proper index into operand stack for acpi_ds_obj_stack_push
693 * invoked inside acpi_ds_create_operand.
695 * We use walk_state->Operands[0] to store the evaluated bank_value
697 walk_state
->operand_index
= 0;
699 status
= acpi_ds_create_operand(walk_state
, next_op
, 0);
700 if (ACPI_FAILURE(status
)) {
701 return_ACPI_STATUS(status
);
704 status
= acpi_ex_resolve_to_value(&walk_state
->operands
[0], walk_state
);
705 if (ACPI_FAILURE(status
)) {
706 return_ACPI_STATUS(status
);
709 ACPI_DUMP_OPERANDS(ACPI_WALK_OPERANDS
,
710 acpi_ps_get_opcode_name(op
->common
.aml_opcode
), 1);
712 * Get the bank_value operand and save it
715 operand_desc
= walk_state
->operands
[0];
717 /* Arg points to the start Bank Field */
719 arg
= acpi_ps_get_arg(op
, 4);
722 /* Ignore OFFSET and ACCESSAS terms here */
724 if (arg
->common
.aml_opcode
== AML_INT_NAMEDFIELD_OP
) {
725 node
= arg
->common
.node
;
727 obj_desc
= acpi_ns_get_attached_object(node
);
729 return_ACPI_STATUS(AE_NOT_EXIST
);
732 obj_desc
->bank_field
.value
=
733 (u32
) operand_desc
->integer
.value
;
736 /* Move to next field in the list */
738 arg
= arg
->common
.next
;
741 acpi_ut_remove_reference(operand_desc
);
742 return_ACPI_STATUS(status
);