[ACPI]
[reactos.git] / reactos / drivers / bus / acpi / acpica / executer / excreate.c
1 /******************************************************************************
2 *
3 * Module Name: excreate - Named object creation
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2011, 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 __EXCREATE_C__
118
119 #include "acpi.h"
120 #include "accommon.h"
121 #include "acinterp.h"
122 #include "amlcode.h"
123 #include "acnamesp.h"
124
125
126 #define _COMPONENT ACPI_EXECUTER
127 ACPI_MODULE_NAME ("excreate")
128
129
130 #ifndef ACPI_NO_METHOD_EXECUTION
131 /*******************************************************************************
132 *
133 * FUNCTION: AcpiExCreateAlias
134 *
135 * PARAMETERS: WalkState - Current state, contains operands
136 *
137 * RETURN: Status
138 *
139 * DESCRIPTION: Create a new named alias
140 *
141 ******************************************************************************/
142
143 ACPI_STATUS
144 AcpiExCreateAlias (
145 ACPI_WALK_STATE *WalkState)
146 {
147 ACPI_NAMESPACE_NODE *TargetNode;
148 ACPI_NAMESPACE_NODE *AliasNode;
149 ACPI_STATUS Status = AE_OK;
150
151
152 ACPI_FUNCTION_TRACE (ExCreateAlias);
153
154
155 /* Get the source/alias operands (both namespace nodes) */
156
157 AliasNode = (ACPI_NAMESPACE_NODE *) WalkState->Operands[0];
158 TargetNode = (ACPI_NAMESPACE_NODE *) WalkState->Operands[1];
159
160 if ((TargetNode->Type == ACPI_TYPE_LOCAL_ALIAS) ||
161 (TargetNode->Type == ACPI_TYPE_LOCAL_METHOD_ALIAS))
162 {
163 /*
164 * Dereference an existing alias so that we don't create a chain
165 * of aliases. With this code, we guarantee that an alias is
166 * always exactly one level of indirection away from the
167 * actual aliased name.
168 */
169 TargetNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, TargetNode->Object);
170 }
171
172 /*
173 * For objects that can never change (i.e., the NS node will
174 * permanently point to the same object), we can simply attach
175 * the object to the new NS node. For other objects (such as
176 * Integers, buffers, etc.), we have to point the Alias node
177 * to the original Node.
178 */
179 switch (TargetNode->Type)
180 {
181
182 /* For these types, the sub-object can change dynamically via a Store */
183
184 case ACPI_TYPE_INTEGER:
185 case ACPI_TYPE_STRING:
186 case ACPI_TYPE_BUFFER:
187 case ACPI_TYPE_PACKAGE:
188 case ACPI_TYPE_BUFFER_FIELD:
189
190 /*
191 * These types open a new scope, so we need the NS node in order to access
192 * any children.
193 */
194 case ACPI_TYPE_DEVICE:
195 case ACPI_TYPE_POWER:
196 case ACPI_TYPE_PROCESSOR:
197 case ACPI_TYPE_THERMAL:
198 case ACPI_TYPE_LOCAL_SCOPE:
199
200 /*
201 * The new alias has the type ALIAS and points to the original
202 * NS node, not the object itself.
203 */
204 AliasNode->Type = ACPI_TYPE_LOCAL_ALIAS;
205 AliasNode->Object = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, TargetNode);
206 break;
207
208 case ACPI_TYPE_METHOD:
209
210 /*
211 * Control method aliases need to be differentiated
212 */
213 AliasNode->Type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
214 AliasNode->Object = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, TargetNode);
215 break;
216
217 default:
218
219 /* Attach the original source object to the new Alias Node */
220
221 /*
222 * The new alias assumes the type of the target, and it points
223 * to the same object. The reference count of the object has an
224 * additional reference to prevent deletion out from under either the
225 * target node or the alias Node
226 */
227 Status = AcpiNsAttachObject (AliasNode,
228 AcpiNsGetAttachedObject (TargetNode), TargetNode->Type);
229 break;
230 }
231
232 /* Since both operands are Nodes, we don't need to delete them */
233
234 return_ACPI_STATUS (Status);
235 }
236
237
238 /*******************************************************************************
239 *
240 * FUNCTION: AcpiExCreateEvent
241 *
242 * PARAMETERS: WalkState - Current state
243 *
244 * RETURN: Status
245 *
246 * DESCRIPTION: Create a new event object
247 *
248 ******************************************************************************/
249
250 ACPI_STATUS
251 AcpiExCreateEvent (
252 ACPI_WALK_STATE *WalkState)
253 {
254 ACPI_STATUS Status;
255 ACPI_OPERAND_OBJECT *ObjDesc;
256
257
258 ACPI_FUNCTION_TRACE (ExCreateEvent);
259
260
261 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_EVENT);
262 if (!ObjDesc)
263 {
264 Status = AE_NO_MEMORY;
265 goto Cleanup;
266 }
267
268 /*
269 * Create the actual OS semaphore, with zero initial units -- meaning
270 * that the event is created in an unsignalled state
271 */
272 Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0,
273 &ObjDesc->Event.OsSemaphore);
274 if (ACPI_FAILURE (Status))
275 {
276 goto Cleanup;
277 }
278
279 /* Attach object to the Node */
280
281 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) WalkState->Operands[0],
282 ObjDesc, ACPI_TYPE_EVENT);
283
284 Cleanup:
285 /*
286 * Remove local reference to the object (on error, will cause deletion
287 * of both object and semaphore if present.)
288 */
289 AcpiUtRemoveReference (ObjDesc);
290 return_ACPI_STATUS (Status);
291 }
292
293
294 /*******************************************************************************
295 *
296 * FUNCTION: AcpiExCreateMutex
297 *
298 * PARAMETERS: WalkState - Current state
299 *
300 * RETURN: Status
301 *
302 * DESCRIPTION: Create a new mutex object
303 *
304 * Mutex (Name[0], SyncLevel[1])
305 *
306 ******************************************************************************/
307
308 ACPI_STATUS
309 AcpiExCreateMutex (
310 ACPI_WALK_STATE *WalkState)
311 {
312 ACPI_STATUS Status = AE_OK;
313 ACPI_OPERAND_OBJECT *ObjDesc;
314
315
316 ACPI_FUNCTION_TRACE_PTR (ExCreateMutex, ACPI_WALK_OPERANDS);
317
318
319 /* Create the new mutex object */
320
321 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
322 if (!ObjDesc)
323 {
324 Status = AE_NO_MEMORY;
325 goto Cleanup;
326 }
327
328 /* Create the actual OS Mutex */
329
330 Status = AcpiOsCreateMutex (&ObjDesc->Mutex.OsMutex);
331 if (ACPI_FAILURE (Status))
332 {
333 goto Cleanup;
334 }
335
336 /* Init object and attach to NS node */
337
338 ObjDesc->Mutex.SyncLevel = (UINT8) WalkState->Operands[1]->Integer.Value;
339 ObjDesc->Mutex.Node = (ACPI_NAMESPACE_NODE *) WalkState->Operands[0];
340
341 Status = AcpiNsAttachObject (ObjDesc->Mutex.Node, ObjDesc, ACPI_TYPE_MUTEX);
342
343
344 Cleanup:
345 /*
346 * Remove local reference to the object (on error, will cause deletion
347 * of both object and semaphore if present.)
348 */
349 AcpiUtRemoveReference (ObjDesc);
350 return_ACPI_STATUS (Status);
351 }
352
353
354 /*******************************************************************************
355 *
356 * FUNCTION: AcpiExCreateRegion
357 *
358 * PARAMETERS: AmlStart - Pointer to the region declaration AML
359 * AmlLength - Max length of the declaration AML
360 * RegionSpace - SpaceID for the region
361 * WalkState - Current state
362 *
363 * RETURN: Status
364 *
365 * DESCRIPTION: Create a new operation region object
366 *
367 ******************************************************************************/
368
369 ACPI_STATUS
370 AcpiExCreateRegion (
371 UINT8 *AmlStart,
372 UINT32 AmlLength,
373 UINT8 RegionSpace,
374 ACPI_WALK_STATE *WalkState)
375 {
376 ACPI_STATUS Status;
377 ACPI_OPERAND_OBJECT *ObjDesc;
378 ACPI_NAMESPACE_NODE *Node;
379 ACPI_OPERAND_OBJECT *RegionObj2;
380
381
382 ACPI_FUNCTION_TRACE (ExCreateRegion);
383
384
385 /* Get the Namespace Node */
386
387 Node = WalkState->Op->Common.Node;
388
389 /*
390 * If the region object is already attached to this node,
391 * just return
392 */
393 if (AcpiNsGetAttachedObject (Node))
394 {
395 return_ACPI_STATUS (AE_OK);
396 }
397
398 /*
399 * Space ID must be one of the predefined IDs, or in the user-defined
400 * range
401 */
402 if ((RegionSpace >= ACPI_NUM_PREDEFINED_REGIONS) &&
403 (RegionSpace < ACPI_USER_REGION_BEGIN) &&
404 (RegionSpace != ACPI_ADR_SPACE_DATA_TABLE))
405 {
406 ACPI_ERROR ((AE_INFO, "Invalid AddressSpace type 0x%X", RegionSpace));
407 return_ACPI_STATUS (AE_AML_INVALID_SPACE_ID);
408 }
409
410 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "Region Type - %s (0x%X)\n",
411 AcpiUtGetRegionName (RegionSpace), RegionSpace));
412
413 /* Create the region descriptor */
414
415 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_REGION);
416 if (!ObjDesc)
417 {
418 Status = AE_NO_MEMORY;
419 goto Cleanup;
420 }
421
422 /*
423 * Remember location in AML stream of address & length
424 * operands since they need to be evaluated at run time.
425 */
426 RegionObj2 = ObjDesc->Common.NextObject;
427 RegionObj2->Extra.AmlStart = AmlStart;
428 RegionObj2->Extra.AmlLength = AmlLength;
429
430 /* Init the region from the operands */
431
432 ObjDesc->Region.SpaceId = RegionSpace;
433 ObjDesc->Region.Address = 0;
434 ObjDesc->Region.Length = 0;
435 ObjDesc->Region.Node = Node;
436
437 /* Install the new region object in the parent Node */
438
439 Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_REGION);
440
441
442 Cleanup:
443
444 /* Remove local reference to the object */
445
446 AcpiUtRemoveReference (ObjDesc);
447 return_ACPI_STATUS (Status);
448 }
449
450
451 /*******************************************************************************
452 *
453 * FUNCTION: AcpiExCreateProcessor
454 *
455 * PARAMETERS: WalkState - Current state
456 *
457 * RETURN: Status
458 *
459 * DESCRIPTION: Create a new processor object and populate the fields
460 *
461 * Processor (Name[0], CpuID[1], PblockAddr[2], PblockLength[3])
462 *
463 ******************************************************************************/
464
465 ACPI_STATUS
466 AcpiExCreateProcessor (
467 ACPI_WALK_STATE *WalkState)
468 {
469 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
470 ACPI_OPERAND_OBJECT *ObjDesc;
471 ACPI_STATUS Status;
472
473
474 ACPI_FUNCTION_TRACE_PTR (ExCreateProcessor, WalkState);
475
476
477 /* Create the processor object */
478
479 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_PROCESSOR);
480 if (!ObjDesc)
481 {
482 return_ACPI_STATUS (AE_NO_MEMORY);
483 }
484
485 /* Initialize the processor object from the operands */
486
487 ObjDesc->Processor.ProcId = (UINT8) Operand[1]->Integer.Value;
488 ObjDesc->Processor.Length = (UINT8) Operand[3]->Integer.Value;
489 ObjDesc->Processor.Address = (ACPI_IO_ADDRESS) Operand[2]->Integer.Value;
490
491 /* Install the processor object in the parent Node */
492
493 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
494 ObjDesc, ACPI_TYPE_PROCESSOR);
495
496 /* Remove local reference to the object */
497
498 AcpiUtRemoveReference (ObjDesc);
499 return_ACPI_STATUS (Status);
500 }
501
502
503 /*******************************************************************************
504 *
505 * FUNCTION: AcpiExCreatePowerResource
506 *
507 * PARAMETERS: WalkState - Current state
508 *
509 * RETURN: Status
510 *
511 * DESCRIPTION: Create a new PowerResource object and populate the fields
512 *
513 * PowerResource (Name[0], SystemLevel[1], ResourceOrder[2])
514 *
515 ******************************************************************************/
516
517 ACPI_STATUS
518 AcpiExCreatePowerResource (
519 ACPI_WALK_STATE *WalkState)
520 {
521 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
522 ACPI_STATUS Status;
523 ACPI_OPERAND_OBJECT *ObjDesc;
524
525
526 ACPI_FUNCTION_TRACE_PTR (ExCreatePowerResource, WalkState);
527
528
529 /* Create the power resource object */
530
531 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_POWER);
532 if (!ObjDesc)
533 {
534 return_ACPI_STATUS (AE_NO_MEMORY);
535 }
536
537 /* Initialize the power object from the operands */
538
539 ObjDesc->PowerResource.SystemLevel = (UINT8) Operand[1]->Integer.Value;
540 ObjDesc->PowerResource.ResourceOrder = (UINT16) Operand[2]->Integer.Value;
541
542 /* Install the power resource object in the parent Node */
543
544 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
545 ObjDesc, ACPI_TYPE_POWER);
546
547 /* Remove local reference to the object */
548
549 AcpiUtRemoveReference (ObjDesc);
550 return_ACPI_STATUS (Status);
551 }
552 #endif
553
554
555 /*******************************************************************************
556 *
557 * FUNCTION: AcpiExCreateMethod
558 *
559 * PARAMETERS: AmlStart - First byte of the method's AML
560 * AmlLength - AML byte count for this method
561 * WalkState - Current state
562 *
563 * RETURN: Status
564 *
565 * DESCRIPTION: Create a new method object
566 *
567 ******************************************************************************/
568
569 ACPI_STATUS
570 AcpiExCreateMethod (
571 UINT8 *AmlStart,
572 UINT32 AmlLength,
573 ACPI_WALK_STATE *WalkState)
574 {
575 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
576 ACPI_OPERAND_OBJECT *ObjDesc;
577 ACPI_STATUS Status;
578 UINT8 MethodFlags;
579
580
581 ACPI_FUNCTION_TRACE_PTR (ExCreateMethod, WalkState);
582
583
584 /* Create a new method object */
585
586 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
587 if (!ObjDesc)
588 {
589 Status = AE_NO_MEMORY;
590 goto Exit;
591 }
592
593 /* Save the method's AML pointer and length */
594
595 ObjDesc->Method.AmlStart = AmlStart;
596 ObjDesc->Method.AmlLength = AmlLength;
597
598 /*
599 * Disassemble the method flags. Split off the ArgCount, Serialized
600 * flag, and SyncLevel for efficiency.
601 */
602 MethodFlags = (UINT8) Operand[1]->Integer.Value;
603 ObjDesc->Method.ParamCount = (UINT8) (MethodFlags & AML_METHOD_ARG_COUNT);
604
605 /*
606 * Get the SyncLevel. If method is serialized, a mutex will be
607 * created for this method when it is parsed.
608 */
609 if (MethodFlags & AML_METHOD_SERIALIZED)
610 {
611 ObjDesc->Method.InfoFlags = ACPI_METHOD_SERIALIZED;
612
613 /*
614 * ACPI 1.0: SyncLevel = 0
615 * ACPI 2.0: SyncLevel = SyncLevel in method declaration
616 */
617 ObjDesc->Method.SyncLevel = (UINT8)
618 ((MethodFlags & AML_METHOD_SYNC_LEVEL) >> 4);
619 }
620
621 /* Attach the new object to the method Node */
622
623 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
624 ObjDesc, ACPI_TYPE_METHOD);
625
626 /* Remove local reference to the object */
627
628 AcpiUtRemoveReference (ObjDesc);
629
630 Exit:
631 /* Remove a reference to the operand */
632
633 AcpiUtRemoveReference (Operand[1]);
634 return_ACPI_STATUS (Status);
635 }
636
637