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 - 2012, 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
165ACPI_STATUS
166AcpiExOpcode_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
206    default:
207
208        ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
209            WalkState->Opcode));
210        Status = AE_AML_BAD_OPCODE;
211        goto Cleanup;
212    }
213
214
215Cleanup:
216
217    return_ACPI_STATUS (Status);
218}
219
220
221/*******************************************************************************
222 *
223 * FUNCTION:    AcpiExOpcode_3A_1T_1R
224 *
225 * PARAMETERS:  WalkState           - Current walk state
226 *
227 * RETURN:      Status
228 *
229 * DESCRIPTION: Execute Triadic operator (3 operands)
230 *
231 ******************************************************************************/
232
233ACPI_STATUS
234AcpiExOpcode_3A_1T_1R (
235    ACPI_WALK_STATE         *WalkState)
236{
237    ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
238    ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
239    char                    *Buffer = NULL;
240    ACPI_STATUS             Status = AE_OK;
241    UINT64                  Index;
242    ACPI_SIZE               Length;
243
244
245    ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R,
246        AcpiPsGetOpcodeName (WalkState->Opcode));
247
248
249    switch (WalkState->Opcode)
250    {
251    case AML_MID_OP:    /* Mid (Source[0], Index[1], Length[2], Result[3]) */
252
253        /*
254         * Create the return object. The Source operand is guaranteed to be
255         * either a String or a Buffer, so just use its type.
256         */
257        ReturnDesc = AcpiUtCreateInternalObject (
258                        (Operand[0])->Common.Type);
259        if (!ReturnDesc)
260        {
261            Status = AE_NO_MEMORY;
262            goto Cleanup;
263        }
264
265        /* Get the Integer values from the objects */
266
267        Index = Operand[1]->Integer.Value;
268        Length = (ACPI_SIZE) Operand[2]->Integer.Value;
269
270        /*
271         * If the index is beyond the length of the String/Buffer, or if the
272         * requested length is zero, return a zero-length String/Buffer
273         */
274        if (Index >= Operand[0]->String.Length)
275        {
276            Length = 0;
277        }
278
279        /* Truncate request if larger than the actual String/Buffer */
280
281        else if ((Index + Length) > Operand[0]->String.Length)
282        {
283            Length = (ACPI_SIZE) Operand[0]->String.Length -
284                        (ACPI_SIZE) Index;
285        }
286
287        /* Strings always have a sub-pointer, not so for buffers */
288
289        switch ((Operand[0])->Common.Type)
290        {
291        case ACPI_TYPE_STRING:
292
293            /* Always allocate a new buffer for the String */
294
295            Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1);
296            if (!Buffer)
297            {
298                Status = AE_NO_MEMORY;
299                goto Cleanup;
300            }
301            break;
302
303        case ACPI_TYPE_BUFFER:
304
305            /* If the requested length is zero, don't allocate a buffer */
306
307            if (Length > 0)
308            {
309                /* Allocate a new buffer for the Buffer */
310
311                Buffer = ACPI_ALLOCATE_ZEROED (Length);
312                if (!Buffer)
313                {
314                    Status = AE_NO_MEMORY;
315                    goto Cleanup;
316                }
317            }
318            break;
319
320        default:                        /* Should not happen */
321
322            Status = AE_AML_OPERAND_TYPE;
323            goto Cleanup;
324        }
325
326        if (Buffer)
327        {
328            /* We have a buffer, copy the portion requested */
329
330            ACPI_MEMCPY (Buffer, Operand[0]->String.Pointer + Index,
331                         Length);
332        }
333
334        /* Set the length of the new String/Buffer */
335
336        ReturnDesc->String.Pointer = Buffer;
337        ReturnDesc->String.Length = (UINT32) Length;
338
339        /* Mark buffer initialized */
340
341        ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
342        break;
343
344
345    default:
346
347        ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
348            WalkState->Opcode));
349        Status = AE_AML_BAD_OPCODE;
350        goto Cleanup;
351    }
352
353    /* Store the result in the target */
354
355    Status = AcpiExStore (ReturnDesc, Operand[3], WalkState);
356
357Cleanup:
358
359    /* Delete return object on error */
360
361    if (ACPI_FAILURE (Status) || WalkState->ResultObj)
362    {
363        AcpiUtRemoveReference (ReturnDesc);
364        WalkState->ResultObj = NULL;
365    }
366
367    /* Set the return object and exit */
368
369    else
370    {
371        WalkState->ResultObj = ReturnDesc;
372    }
373    return_ACPI_STATUS (Status);
374}
375