1 /******************************************************************************
3 * Module Name: exmisc - ACPI AML (p-code) execution - specific opcodes
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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.
53 #define _COMPONENT ACPI_EXECUTER
54 ACPI_MODULE_NAME ("exmisc")
57 /*******************************************************************************
59 * FUNCTION: AcpiExGetObjectReference
61 * PARAMETERS: ObjDesc - Create a reference to this object
62 * ReturnDesc - Where to store the reference
63 * WalkState - Current state
67 * DESCRIPTION: Obtain and return a "reference" to the target object
68 * Common code for the RefOfOp and the CondRefOfOp.
70 ******************************************************************************/
73 AcpiExGetObjectReference (
74 ACPI_OPERAND_OBJECT
*ObjDesc
,
75 ACPI_OPERAND_OBJECT
**ReturnDesc
,
76 ACPI_WALK_STATE
*WalkState
)
78 ACPI_OPERAND_OBJECT
*ReferenceObj
;
79 ACPI_OPERAND_OBJECT
*ReferencedObj
;
82 ACPI_FUNCTION_TRACE_PTR (ExGetObjectReference
, ObjDesc
);
87 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
))
89 case ACPI_DESC_TYPE_OPERAND
:
91 if (ObjDesc
->Common
.Type
!= ACPI_TYPE_LOCAL_REFERENCE
)
93 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
97 * Must be a reference to a Local or Arg
99 switch (ObjDesc
->Reference
.Class
)
101 case ACPI_REFCLASS_LOCAL
:
102 case ACPI_REFCLASS_ARG
:
103 case ACPI_REFCLASS_DEBUG
:
105 /* The referenced object is the pseudo-node for the local/arg */
107 ReferencedObj
= ObjDesc
->Reference
.Object
;
112 ACPI_ERROR ((AE_INFO
, "Unknown Reference Class 0x%2.2X",
113 ObjDesc
->Reference
.Class
));
114 return_ACPI_STATUS (AE_AML_INTERNAL
);
118 case ACPI_DESC_TYPE_NAMED
:
120 * A named reference that has already been resolved to a Node
122 ReferencedObj
= ObjDesc
;
127 ACPI_ERROR ((AE_INFO
, "Invalid descriptor type 0x%X",
128 ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
)));
129 return_ACPI_STATUS (AE_TYPE
);
133 /* Create a new reference object */
135 ReferenceObj
= AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE
);
138 return_ACPI_STATUS (AE_NO_MEMORY
);
141 ReferenceObj
->Reference
.Class
= ACPI_REFCLASS_REFOF
;
142 ReferenceObj
->Reference
.Object
= ReferencedObj
;
143 *ReturnDesc
= ReferenceObj
;
145 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
146 "Object %p Type [%s], returning Reference %p\n",
147 ObjDesc
, AcpiUtGetObjectTypeName (ObjDesc
), *ReturnDesc
));
149 return_ACPI_STATUS (AE_OK
);
153 /*******************************************************************************
155 * FUNCTION: AcpiExConcatTemplate
157 * PARAMETERS: Operand0 - First source object
158 * Operand1 - Second source object
159 * ActualReturnDesc - Where to place the return object
160 * WalkState - Current walk state
164 * DESCRIPTION: Concatenate two resource templates
166 ******************************************************************************/
169 AcpiExConcatTemplate (
170 ACPI_OPERAND_OBJECT
*Operand0
,
171 ACPI_OPERAND_OBJECT
*Operand1
,
172 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
173 ACPI_WALK_STATE
*WalkState
)
176 ACPI_OPERAND_OBJECT
*ReturnDesc
;
184 ACPI_FUNCTION_TRACE (ExConcatTemplate
);
188 * Find the EndTag descriptor in each resource template.
189 * Note1: returned pointers point TO the EndTag, not past it.
190 * Note2: zero-length buffers are allowed; treated like one EndTag
193 /* Get the length of the first resource template */
195 Status
= AcpiUtGetResourceEndTag (Operand0
, &EndTag
);
196 if (ACPI_FAILURE (Status
))
198 return_ACPI_STATUS (Status
);
201 Length0
= ACPI_PTR_DIFF (EndTag
, Operand0
->Buffer
.Pointer
);
203 /* Get the length of the second resource template */
205 Status
= AcpiUtGetResourceEndTag (Operand1
, &EndTag
);
206 if (ACPI_FAILURE (Status
))
208 return_ACPI_STATUS (Status
);
211 Length1
= ACPI_PTR_DIFF (EndTag
, Operand1
->Buffer
.Pointer
);
213 /* Combine both lengths, minimum size will be 2 for EndTag */
215 NewLength
= Length0
+ Length1
+ sizeof (AML_RESOURCE_END_TAG
);
217 /* Create a new buffer object for the result (with one EndTag) */
219 ReturnDesc
= AcpiUtCreateBufferObject (NewLength
);
222 return_ACPI_STATUS (AE_NO_MEMORY
);
226 * Copy the templates to the new buffer, 0 first, then 1 follows. One
227 * EndTag descriptor is copied from Operand1.
229 NewBuf
= ReturnDesc
->Buffer
.Pointer
;
230 ACPI_MEMCPY (NewBuf
, Operand0
->Buffer
.Pointer
, Length0
);
231 ACPI_MEMCPY (NewBuf
+ Length0
, Operand1
->Buffer
.Pointer
, Length1
);
233 /* Insert EndTag and set the checksum to zero, means "ignore checksum" */
235 NewBuf
[NewLength
- 1] = 0;
236 NewBuf
[NewLength
- 2] = ACPI_RESOURCE_NAME_END_TAG
| 1;
238 /* Return the completed resource template */
240 *ActualReturnDesc
= ReturnDesc
;
241 return_ACPI_STATUS (AE_OK
);
245 /*******************************************************************************
247 * FUNCTION: AcpiExDoConcatenate
249 * PARAMETERS: Operand0 - First source object
250 * Operand1 - Second source object
251 * ActualReturnDesc - Where to place the return object
252 * WalkState - Current walk state
256 * DESCRIPTION: Concatenate two objects OF THE SAME TYPE.
258 ******************************************************************************/
261 AcpiExDoConcatenate (
262 ACPI_OPERAND_OBJECT
*Operand0
,
263 ACPI_OPERAND_OBJECT
*Operand1
,
264 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
265 ACPI_WALK_STATE
*WalkState
)
267 ACPI_OPERAND_OBJECT
*LocalOperand1
= Operand1
;
268 ACPI_OPERAND_OBJECT
*ReturnDesc
;
273 ACPI_FUNCTION_TRACE (ExDoConcatenate
);
277 * Convert the second operand if necessary. The first operand
278 * determines the type of the second operand, (See the Data Types
279 * section of the ACPI specification.) Both object types are
280 * guaranteed to be either Integer/String/Buffer by the operand
281 * resolution mechanism.
283 switch (Operand0
->Common
.Type
)
285 case ACPI_TYPE_INTEGER
:
287 Status
= AcpiExConvertToInteger (Operand1
, &LocalOperand1
, 16);
290 case ACPI_TYPE_STRING
:
292 Status
= AcpiExConvertToString (Operand1
, &LocalOperand1
,
293 ACPI_IMPLICIT_CONVERT_HEX
);
296 case ACPI_TYPE_BUFFER
:
298 Status
= AcpiExConvertToBuffer (Operand1
, &LocalOperand1
);
303 ACPI_ERROR ((AE_INFO
, "Invalid object type: 0x%X",
304 Operand0
->Common
.Type
));
305 Status
= AE_AML_INTERNAL
;
308 if (ACPI_FAILURE (Status
))
314 * Both operands are now known to be the same object type
315 * (Both are Integer, String, or Buffer), and we can now perform the
320 * There are three cases to handle:
322 * 1) Two Integers concatenated to produce a new Buffer
323 * 2) Two Strings concatenated to produce a new String
324 * 3) Two Buffers concatenated to produce a new Buffer
326 switch (Operand0
->Common
.Type
)
328 case ACPI_TYPE_INTEGER
:
330 /* Result of two Integers is a Buffer */
331 /* Need enough buffer space for two integers */
333 ReturnDesc
= AcpiUtCreateBufferObject ((ACPI_SIZE
)
334 ACPI_MUL_2 (AcpiGbl_IntegerByteWidth
));
337 Status
= AE_NO_MEMORY
;
341 NewBuf
= (char *) ReturnDesc
->Buffer
.Pointer
;
343 /* Copy the first integer, LSB first */
345 ACPI_MEMCPY (NewBuf
, &Operand0
->Integer
.Value
,
346 AcpiGbl_IntegerByteWidth
);
348 /* Copy the second integer (LSB first) after the first */
350 ACPI_MEMCPY (NewBuf
+ AcpiGbl_IntegerByteWidth
,
351 &LocalOperand1
->Integer
.Value
,
352 AcpiGbl_IntegerByteWidth
);
355 case ACPI_TYPE_STRING
:
357 /* Result of two Strings is a String */
359 ReturnDesc
= AcpiUtCreateStringObject (
360 ((ACPI_SIZE
) Operand0
->String
.Length
+
361 LocalOperand1
->String
.Length
));
364 Status
= AE_NO_MEMORY
;
368 NewBuf
= ReturnDesc
->String
.Pointer
;
370 /* Concatenate the strings */
372 ACPI_STRCPY (NewBuf
, Operand0
->String
.Pointer
);
373 ACPI_STRCPY (NewBuf
+ Operand0
->String
.Length
,
374 LocalOperand1
->String
.Pointer
);
377 case ACPI_TYPE_BUFFER
:
379 /* Result of two Buffers is a Buffer */
381 ReturnDesc
= AcpiUtCreateBufferObject (
382 ((ACPI_SIZE
) Operand0
->Buffer
.Length
+
383 LocalOperand1
->Buffer
.Length
));
386 Status
= AE_NO_MEMORY
;
390 NewBuf
= (char *) ReturnDesc
->Buffer
.Pointer
;
392 /* Concatenate the buffers */
394 ACPI_MEMCPY (NewBuf
, Operand0
->Buffer
.Pointer
,
395 Operand0
->Buffer
.Length
);
396 ACPI_MEMCPY (NewBuf
+ Operand0
->Buffer
.Length
,
397 LocalOperand1
->Buffer
.Pointer
,
398 LocalOperand1
->Buffer
.Length
);
403 /* Invalid object type, should not happen here */
405 ACPI_ERROR ((AE_INFO
, "Invalid object type: 0x%X",
406 Operand0
->Common
.Type
));
407 Status
=AE_AML_INTERNAL
;
411 *ActualReturnDesc
= ReturnDesc
;
414 if (LocalOperand1
!= Operand1
)
416 AcpiUtRemoveReference (LocalOperand1
);
418 return_ACPI_STATUS (Status
);
422 /*******************************************************************************
424 * FUNCTION: AcpiExDoMathOp
426 * PARAMETERS: Opcode - AML opcode
427 * Integer0 - Integer operand #0
428 * Integer1 - Integer operand #1
430 * RETURN: Integer result of the operation
432 * DESCRIPTION: Execute a math AML opcode. The purpose of having all of the
433 * math functions here is to prevent a lot of pointer dereferencing
434 * to obtain the operands.
436 ******************************************************************************/
445 ACPI_FUNCTION_ENTRY ();
450 case AML_ADD_OP
: /* Add (Integer0, Integer1, Result) */
452 return (Integer0
+ Integer1
);
454 case AML_BIT_AND_OP
: /* And (Integer0, Integer1, Result) */
456 return (Integer0
& Integer1
);
458 case AML_BIT_NAND_OP
: /* NAnd (Integer0, Integer1, Result) */
460 return (~(Integer0
& Integer1
));
462 case AML_BIT_OR_OP
: /* Or (Integer0, Integer1, Result) */
464 return (Integer0
| Integer1
);
466 case AML_BIT_NOR_OP
: /* NOr (Integer0, Integer1, Result) */
468 return (~(Integer0
| Integer1
));
470 case AML_BIT_XOR_OP
: /* XOr (Integer0, Integer1, Result) */
472 return (Integer0
^ Integer1
);
474 case AML_MULTIPLY_OP
: /* Multiply (Integer0, Integer1, Result) */
476 return (Integer0
* Integer1
);
478 case AML_SHIFT_LEFT_OP
: /* ShiftLeft (Operand, ShiftCount, Result)*/
481 * We need to check if the shiftcount is larger than the integer bit
482 * width since the behavior of this is not well-defined in the C language.
484 if (Integer1
>= AcpiGbl_IntegerBitWidth
)
488 return (Integer0
<< Integer1
);
490 case AML_SHIFT_RIGHT_OP
: /* ShiftRight (Operand, ShiftCount, Result) */
493 * We need to check if the shiftcount is larger than the integer bit
494 * width since the behavior of this is not well-defined in the C language.
496 if (Integer1
>= AcpiGbl_IntegerBitWidth
)
500 return (Integer0
>> Integer1
);
502 case AML_SUBTRACT_OP
: /* Subtract (Integer0, Integer1, Result) */
504 return (Integer0
- Integer1
);
513 /*******************************************************************************
515 * FUNCTION: AcpiExDoLogicalNumericOp
517 * PARAMETERS: Opcode - AML opcode
518 * Integer0 - Integer operand #0
519 * Integer1 - Integer operand #1
520 * LogicalResult - TRUE/FALSE result of the operation
524 * DESCRIPTION: Execute a logical "Numeric" AML opcode. For these Numeric
525 * operators (LAnd and LOr), both operands must be integers.
527 * Note: cleanest machine code seems to be produced by the code
528 * below, rather than using statements of the form:
529 * Result = (Integer0 && Integer1);
531 ******************************************************************************/
534 AcpiExDoLogicalNumericOp (
538 BOOLEAN
*LogicalResult
)
540 ACPI_STATUS Status
= AE_OK
;
541 BOOLEAN LocalResult
= FALSE
;
544 ACPI_FUNCTION_TRACE (ExDoLogicalNumericOp
);
549 case AML_LAND_OP
: /* LAnd (Integer0, Integer1) */
551 if (Integer0
&& Integer1
)
557 case AML_LOR_OP
: /* LOr (Integer0, Integer1) */
559 if (Integer0
|| Integer1
)
567 Status
= AE_AML_INTERNAL
;
571 /* Return the logical result and status */
573 *LogicalResult
= LocalResult
;
574 return_ACPI_STATUS (Status
);
578 /*******************************************************************************
580 * FUNCTION: AcpiExDoLogicalOp
582 * PARAMETERS: Opcode - AML opcode
583 * Operand0 - operand #0
584 * Operand1 - operand #1
585 * LogicalResult - TRUE/FALSE result of the operation
589 * DESCRIPTION: Execute a logical AML opcode. The purpose of having all of the
590 * functions here is to prevent a lot of pointer dereferencing
591 * to obtain the operands and to simplify the generation of the
592 * logical value. For the Numeric operators (LAnd and LOr), both
593 * operands must be integers. For the other logical operators,
594 * operands can be any combination of Integer/String/Buffer. The
595 * first operand determines the type to which the second operand
598 * Note: cleanest machine code seems to be produced by the code
599 * below, rather than using statements of the form:
600 * Result = (Operand0 == Operand1);
602 ******************************************************************************/
607 ACPI_OPERAND_OBJECT
*Operand0
,
608 ACPI_OPERAND_OBJECT
*Operand1
,
609 BOOLEAN
*LogicalResult
)
611 ACPI_OPERAND_OBJECT
*LocalOperand1
= Operand1
;
616 ACPI_STATUS Status
= AE_OK
;
617 BOOLEAN LocalResult
= FALSE
;
621 ACPI_FUNCTION_TRACE (ExDoLogicalOp
);
625 * Convert the second operand if necessary. The first operand
626 * determines the type of the second operand, (See the Data Types
627 * section of the ACPI 3.0+ specification.) Both object types are
628 * guaranteed to be either Integer/String/Buffer by the operand
629 * resolution mechanism.
631 switch (Operand0
->Common
.Type
)
633 case ACPI_TYPE_INTEGER
:
635 Status
= AcpiExConvertToInteger (Operand1
, &LocalOperand1
, 16);
638 case ACPI_TYPE_STRING
:
640 Status
= AcpiExConvertToString (Operand1
, &LocalOperand1
,
641 ACPI_IMPLICIT_CONVERT_HEX
);
644 case ACPI_TYPE_BUFFER
:
646 Status
= AcpiExConvertToBuffer (Operand1
, &LocalOperand1
);
651 Status
= AE_AML_INTERNAL
;
655 if (ACPI_FAILURE (Status
))
661 * Two cases: 1) Both Integers, 2) Both Strings or Buffers
663 if (Operand0
->Common
.Type
== ACPI_TYPE_INTEGER
)
666 * 1) Both operands are of type integer
667 * Note: LocalOperand1 may have changed above
669 Integer0
= Operand0
->Integer
.Value
;
670 Integer1
= LocalOperand1
->Integer
.Value
;
674 case AML_LEQUAL_OP
: /* LEqual (Operand0, Operand1) */
676 if (Integer0
== Integer1
)
682 case AML_LGREATER_OP
: /* LGreater (Operand0, Operand1) */
684 if (Integer0
> Integer1
)
690 case AML_LLESS_OP
: /* LLess (Operand0, Operand1) */
692 if (Integer0
< Integer1
)
700 Status
= AE_AML_INTERNAL
;
707 * 2) Both operands are Strings or both are Buffers
708 * Note: Code below takes advantage of common Buffer/String
709 * object fields. LocalOperand1 may have changed above. Use
710 * memcmp to handle nulls in buffers.
712 Length0
= Operand0
->Buffer
.Length
;
713 Length1
= LocalOperand1
->Buffer
.Length
;
715 /* Lexicographic compare: compare the data bytes */
717 Compare
= ACPI_MEMCMP (Operand0
->Buffer
.Pointer
,
718 LocalOperand1
->Buffer
.Pointer
,
719 (Length0
> Length1
) ? Length1
: Length0
);
723 case AML_LEQUAL_OP
: /* LEqual (Operand0, Operand1) */
725 /* Length and all bytes must be equal */
727 if ((Length0
== Length1
) &&
730 /* Length and all bytes match ==> TRUE */
736 case AML_LGREATER_OP
: /* LGreater (Operand0, Operand1) */
741 goto Cleanup
; /* TRUE */
745 goto Cleanup
; /* FALSE */
748 /* Bytes match (to shortest length), compare lengths */
750 if (Length0
> Length1
)
756 case AML_LLESS_OP
: /* LLess (Operand0, Operand1) */
760 goto Cleanup
; /* FALSE */
765 goto Cleanup
; /* TRUE */
768 /* Bytes match (to shortest length), compare lengths */
770 if (Length0
< Length1
)
778 Status
= AE_AML_INTERNAL
;
785 /* New object was created if implicit conversion performed - delete */
787 if (LocalOperand1
!= Operand1
)
789 AcpiUtRemoveReference (LocalOperand1
);
792 /* Return the logical result and status */
794 *LogicalResult
= LocalResult
;
795 return_ACPI_STATUS (Status
);