xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exoparg3.c (revision 002f37b0cca92e4cf72857c72ac95db5a8b09615)
1 /******************************************************************************
2  *
3  * Module Name: exoparg3 - AML execution - opcodes with 3 arguments
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2013, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government. In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************/
116 
117 #define __EXOPARG3_C__
118 
119 #include "acpi.h"
120 #include "accommon.h"
121 #include "acinterp.h"
122 #include "acparser.h"
123 #include "amlcode.h"
124 
125 
126 #define _COMPONENT          ACPI_EXECUTER
127         ACPI_MODULE_NAME    ("exoparg3")
128 
129 
130 /*!
131  * Naming convention for AML interpreter execution routines.
132  *
133  * The routines that begin execution of AML opcodes are named with a common
134  * convention based upon the number of arguments, the number of target operands,
135  * and whether or not a value is returned:
136  *
137  *      AcpiExOpcode_xA_yT_zR
138  *
139  * Where:
140  *
141  * xA - ARGUMENTS:    The number of arguments (input operands) that are
142  *                    required for this opcode type (1 through 6 args).
143  * yT - TARGETS:      The number of targets (output operands) that are required
144  *                    for this opcode type (0, 1, or 2 targets).
145  * zR - RETURN VALUE: Indicates whether this opcode type returns a value
146  *                    as the function return (0 or 1).
147  *
148  * The AcpiExOpcode* functions are called via the Dispatcher component with
149  * fully resolved operands.
150 !*/
151 
152 
153 /*******************************************************************************
154  *
155  * FUNCTION:    AcpiExOpcode_3A_0T_0R
156  *
157  * PARAMETERS:  WalkState           - Current walk state
158  *
159  * RETURN:      Status
160  *
161  * DESCRIPTION: Execute Triadic operator (3 operands)
162  *
163  ******************************************************************************/
164 
165 ACPI_STATUS
166 AcpiExOpcode_3A_0T_0R (
167     ACPI_WALK_STATE         *WalkState)
168 {
169     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
170     ACPI_SIGNAL_FATAL_INFO  *Fatal;
171     ACPI_STATUS             Status = AE_OK;
172 
173 
174     ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_0T_0R,
175         AcpiPsGetOpcodeName (WalkState->Opcode));
176 
177 
178     switch (WalkState->Opcode)
179     {
180     case AML_FATAL_OP:          /* Fatal (FatalType  FatalCode  FatalArg) */
181 
182         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
183             "FatalOp: Type %X Code %X Arg %X <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n",
184             (UINT32) Operand[0]->Integer.Value,
185             (UINT32) Operand[1]->Integer.Value,
186             (UINT32) Operand[2]->Integer.Value));
187 
188         Fatal = ACPI_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO));
189         if (Fatal)
190         {
191             Fatal->Type     = (UINT32) Operand[0]->Integer.Value;
192             Fatal->Code     = (UINT32) Operand[1]->Integer.Value;
193             Fatal->Argument = (UINT32) Operand[2]->Integer.Value;
194         }
195 
196         /* Always signal the OS! */
197 
198         Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal);
199 
200         /* Might return while OS is shutting down, just continue */
201 
202         ACPI_FREE (Fatal);
203         break;
204 
205     default:
206 
207         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
208             WalkState->Opcode));
209         Status = AE_AML_BAD_OPCODE;
210         goto Cleanup;
211     }
212 
213 
214 Cleanup:
215 
216     return_ACPI_STATUS (Status);
217 }
218 
219 
220 /*******************************************************************************
221  *
222  * FUNCTION:    AcpiExOpcode_3A_1T_1R
223  *
224  * PARAMETERS:  WalkState           - Current walk state
225  *
226  * RETURN:      Status
227  *
228  * DESCRIPTION: Execute Triadic operator (3 operands)
229  *
230  ******************************************************************************/
231 
232 ACPI_STATUS
233 AcpiExOpcode_3A_1T_1R (
234     ACPI_WALK_STATE         *WalkState)
235 {
236     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
237     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
238     char                    *Buffer = NULL;
239     ACPI_STATUS             Status = AE_OK;
240     UINT64                  Index;
241     ACPI_SIZE               Length;
242 
243 
244     ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R,
245         AcpiPsGetOpcodeName (WalkState->Opcode));
246 
247 
248     switch (WalkState->Opcode)
249     {
250     case AML_MID_OP:    /* Mid (Source[0], Index[1], Length[2], Result[3]) */
251         /*
252          * Create the return object. The Source operand is guaranteed to be
253          * either a String or a Buffer, so just use its type.
254          */
255         ReturnDesc = AcpiUtCreateInternalObject (
256                         (Operand[0])->Common.Type);
257         if (!ReturnDesc)
258         {
259             Status = AE_NO_MEMORY;
260             goto Cleanup;
261         }
262 
263         /* Get the Integer values from the objects */
264 
265         Index = Operand[1]->Integer.Value;
266         Length = (ACPI_SIZE) Operand[2]->Integer.Value;
267 
268         /*
269          * If the index is beyond the length of the String/Buffer, or if the
270          * requested length is zero, return a zero-length String/Buffer
271          */
272         if (Index >= Operand[0]->String.Length)
273         {
274             Length = 0;
275         }
276 
277         /* Truncate request if larger than the actual String/Buffer */
278 
279         else if ((Index + Length) > Operand[0]->String.Length)
280         {
281             Length = (ACPI_SIZE) Operand[0]->String.Length -
282                         (ACPI_SIZE) Index;
283         }
284 
285         /* Strings always have a sub-pointer, not so for buffers */
286 
287         switch ((Operand[0])->Common.Type)
288         {
289         case ACPI_TYPE_STRING:
290 
291             /* Always allocate a new buffer for the String */
292 
293             Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1);
294             if (!Buffer)
295             {
296                 Status = AE_NO_MEMORY;
297                 goto Cleanup;
298             }
299             break;
300 
301         case ACPI_TYPE_BUFFER:
302 
303             /* If the requested length is zero, don't allocate a buffer */
304 
305             if (Length > 0)
306             {
307                 /* Allocate a new buffer for the Buffer */
308 
309                 Buffer = ACPI_ALLOCATE_ZEROED (Length);
310                 if (!Buffer)
311                 {
312                     Status = AE_NO_MEMORY;
313                     goto Cleanup;
314                 }
315             }
316             break;
317 
318         default:                        /* Should not happen */
319 
320             Status = AE_AML_OPERAND_TYPE;
321             goto Cleanup;
322         }
323 
324         if (Buffer)
325         {
326             /* We have a buffer, copy the portion requested */
327 
328             ACPI_MEMCPY (Buffer, Operand[0]->String.Pointer + Index,
329                          Length);
330         }
331 
332         /* Set the length of the new String/Buffer */
333 
334         ReturnDesc->String.Pointer = Buffer;
335         ReturnDesc->String.Length = (UINT32) Length;
336 
337         /* Mark buffer initialized */
338 
339         ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
340         break;
341 
342     default:
343 
344         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
345             WalkState->Opcode));
346         Status = AE_AML_BAD_OPCODE;
347         goto Cleanup;
348     }
349 
350     /* Store the result in the target */
351 
352     Status = AcpiExStore (ReturnDesc, Operand[3], WalkState);
353 
354 Cleanup:
355 
356     /* Delete return object on error */
357 
358     if (ACPI_FAILURE (Status) || WalkState->ResultObj)
359     {
360         AcpiUtRemoveReference (ReturnDesc);
361         WalkState->ResultObj = NULL;
362     }
363 
364     /* Set the return object and exit */
365 
366     else
367     {
368         WalkState->ResultObj = ReturnDesc;
369     }
370     return_ACPI_STATUS (Status);
371 }
372