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