Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc-2.6
[linux-2.6.git] / drivers / acpi / acpica / excreate.c
1 /******************************************************************************
2  *
3  * Module Name: excreate - Named object creation
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2010, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acinterp.h"
47 #include "amlcode.h"
48 #include "acnamesp.h"
49
50 #define _COMPONENT          ACPI_EXECUTER
51 ACPI_MODULE_NAME("excreate")
52 #ifndef ACPI_NO_METHOD_EXECUTION
53 /*******************************************************************************
54  *
55  * FUNCTION:    acpi_ex_create_alias
56  *
57  * PARAMETERS:  walk_state           - Current state, contains operands
58  *
59  * RETURN:      Status
60  *
61  * DESCRIPTION: Create a new named alias
62  *
63  ******************************************************************************/
64 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state)
65 {
66         struct acpi_namespace_node *target_node;
67         struct acpi_namespace_node *alias_node;
68         acpi_status status = AE_OK;
69
70         ACPI_FUNCTION_TRACE(ex_create_alias);
71
72         /* Get the source/alias operands (both namespace nodes) */
73
74         alias_node = (struct acpi_namespace_node *)walk_state->operands[0];
75         target_node = (struct acpi_namespace_node *)walk_state->operands[1];
76
77         if ((target_node->type == ACPI_TYPE_LOCAL_ALIAS) ||
78             (target_node->type == ACPI_TYPE_LOCAL_METHOD_ALIAS)) {
79                 /*
80                  * Dereference an existing alias so that we don't create a chain
81                  * of aliases.  With this code, we guarantee that an alias is
82                  * always exactly one level of indirection away from the
83                  * actual aliased name.
84                  */
85                 target_node =
86                     ACPI_CAST_PTR(struct acpi_namespace_node,
87                                   target_node->object);
88         }
89
90         /*
91          * For objects that can never change (i.e., the NS node will
92          * permanently point to the same object), we can simply attach
93          * the object to the new NS node.  For other objects (such as
94          * Integers, buffers, etc.), we have to point the Alias node
95          * to the original Node.
96          */
97         switch (target_node->type) {
98
99                 /* For these types, the sub-object can change dynamically via a Store */
100
101         case ACPI_TYPE_INTEGER:
102         case ACPI_TYPE_STRING:
103         case ACPI_TYPE_BUFFER:
104         case ACPI_TYPE_PACKAGE:
105         case ACPI_TYPE_BUFFER_FIELD:
106
107                 /*
108                  * These types open a new scope, so we need the NS node in order to access
109                  * any children.
110                  */
111         case ACPI_TYPE_DEVICE:
112         case ACPI_TYPE_POWER:
113         case ACPI_TYPE_PROCESSOR:
114         case ACPI_TYPE_THERMAL:
115         case ACPI_TYPE_LOCAL_SCOPE:
116
117                 /*
118                  * The new alias has the type ALIAS and points to the original
119                  * NS node, not the object itself.
120                  */
121                 alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
122                 alias_node->object =
123                     ACPI_CAST_PTR(union acpi_operand_object, target_node);
124                 break;
125
126         case ACPI_TYPE_METHOD:
127
128                 /*
129                  * Control method aliases need to be differentiated
130                  */
131                 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
132                 alias_node->object =
133                     ACPI_CAST_PTR(union acpi_operand_object, target_node);
134                 break;
135
136         default:
137
138                 /* Attach the original source object to the new Alias Node */
139
140                 /*
141                  * The new alias assumes the type of the target, and it points
142                  * to the same object.  The reference count of the object has an
143                  * additional reference to prevent deletion out from under either the
144                  * target node or the alias Node
145                  */
146                 status = acpi_ns_attach_object(alias_node,
147                                                acpi_ns_get_attached_object
148                                                (target_node),
149                                                target_node->type);
150                 break;
151         }
152
153         /* Since both operands are Nodes, we don't need to delete them */
154
155         return_ACPI_STATUS(status);
156 }
157
158 /*******************************************************************************
159  *
160  * FUNCTION:    acpi_ex_create_event
161  *
162  * PARAMETERS:  walk_state          - Current state
163  *
164  * RETURN:      Status
165  *
166  * DESCRIPTION: Create a new event object
167  *
168  ******************************************************************************/
169
170 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
171 {
172         acpi_status status;
173         union acpi_operand_object *obj_desc;
174
175         ACPI_FUNCTION_TRACE(ex_create_event);
176
177         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
178         if (!obj_desc) {
179                 status = AE_NO_MEMORY;
180                 goto cleanup;
181         }
182
183         /*
184          * Create the actual OS semaphore, with zero initial units -- meaning
185          * that the event is created in an unsignalled state
186          */
187         status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
188                                           &obj_desc->event.os_semaphore);
189         if (ACPI_FAILURE(status)) {
190                 goto cleanup;
191         }
192
193         /* Attach object to the Node */
194
195         status =
196             acpi_ns_attach_object((struct acpi_namespace_node *)walk_state->
197                                   operands[0], obj_desc, ACPI_TYPE_EVENT);
198
199       cleanup:
200         /*
201          * Remove local reference to the object (on error, will cause deletion
202          * of both object and semaphore if present.)
203          */
204         acpi_ut_remove_reference(obj_desc);
205         return_ACPI_STATUS(status);
206 }
207
208 /*******************************************************************************
209  *
210  * FUNCTION:    acpi_ex_create_mutex
211  *
212  * PARAMETERS:  walk_state          - Current state
213  *
214  * RETURN:      Status
215  *
216  * DESCRIPTION: Create a new mutex object
217  *
218  *              Mutex (Name[0], sync_level[1])
219  *
220  ******************************************************************************/
221
222 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
223 {
224         acpi_status status = AE_OK;
225         union acpi_operand_object *obj_desc;
226
227         ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
228
229         /* Create the new mutex object */
230
231         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
232         if (!obj_desc) {
233                 status = AE_NO_MEMORY;
234                 goto cleanup;
235         }
236
237         /* Create the actual OS Mutex */
238
239         status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex);
240         if (ACPI_FAILURE(status)) {
241                 goto cleanup;
242         }
243
244         /* Init object and attach to NS node */
245
246         obj_desc->mutex.sync_level =
247             (u8) walk_state->operands[1]->integer.value;
248         obj_desc->mutex.node =
249             (struct acpi_namespace_node *)walk_state->operands[0];
250
251         status =
252             acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
253                                   ACPI_TYPE_MUTEX);
254
255       cleanup:
256         /*
257          * Remove local reference to the object (on error, will cause deletion
258          * of both object and semaphore if present.)
259          */
260         acpi_ut_remove_reference(obj_desc);
261         return_ACPI_STATUS(status);
262 }
263
264 /*******************************************************************************
265  *
266  * FUNCTION:    acpi_ex_create_region
267  *
268  * PARAMETERS:  aml_start           - Pointer to the region declaration AML
269  *              aml_length          - Max length of the declaration AML
270  *              region_space        - space_iD for the region
271  *              walk_state          - Current state
272  *
273  * RETURN:      Status
274  *
275  * DESCRIPTION: Create a new operation region object
276  *
277  ******************************************************************************/
278
279 acpi_status
280 acpi_ex_create_region(u8 * aml_start,
281                       u32 aml_length,
282                       u8 region_space, struct acpi_walk_state *walk_state)
283 {
284         acpi_status status;
285         union acpi_operand_object *obj_desc;
286         struct acpi_namespace_node *node;
287         union acpi_operand_object *region_obj2;
288
289         ACPI_FUNCTION_TRACE(ex_create_region);
290
291         /* Get the Namespace Node */
292
293         node = walk_state->op->common.node;
294
295         /*
296          * If the region object is already attached to this node,
297          * just return
298          */
299         if (acpi_ns_get_attached_object(node)) {
300                 return_ACPI_STATUS(AE_OK);
301         }
302
303         /*
304          * Space ID must be one of the predefined IDs, or in the user-defined
305          * range
306          */
307         if ((region_space >= ACPI_NUM_PREDEFINED_REGIONS) &&
308             (region_space < ACPI_USER_REGION_BEGIN)) {
309                 ACPI_ERROR((AE_INFO, "Invalid AddressSpace type %X",
310                             region_space));
311                 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
312         }
313
314         ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (%X)\n",
315                           acpi_ut_get_region_name(region_space), region_space));
316
317         /* Create the region descriptor */
318
319         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
320         if (!obj_desc) {
321                 status = AE_NO_MEMORY;
322                 goto cleanup;
323         }
324
325         /*
326          * Remember location in AML stream of address & length
327          * operands since they need to be evaluated at run time.
328          */
329         region_obj2 = obj_desc->common.next_object;
330         region_obj2->extra.aml_start = aml_start;
331         region_obj2->extra.aml_length = aml_length;
332
333         /* Init the region from the operands */
334
335         obj_desc->region.space_id = region_space;
336         obj_desc->region.address = 0;
337         obj_desc->region.length = 0;
338         obj_desc->region.node = node;
339
340         /* Install the new region object in the parent Node */
341
342         status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
343
344       cleanup:
345
346         /* Remove local reference to the object */
347
348         acpi_ut_remove_reference(obj_desc);
349         return_ACPI_STATUS(status);
350 }
351
352 /*******************************************************************************
353  *
354  * FUNCTION:    acpi_ex_create_processor
355  *
356  * PARAMETERS:  walk_state          - Current state
357  *
358  * RETURN:      Status
359  *
360  * DESCRIPTION: Create a new processor object and populate the fields
361  *
362  *              Processor (Name[0], cpu_iD[1], pblock_addr[2], pblock_length[3])
363  *
364  ******************************************************************************/
365
366 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
367 {
368         union acpi_operand_object **operand = &walk_state->operands[0];
369         union acpi_operand_object *obj_desc;
370         acpi_status status;
371
372         ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
373
374         /* Create the processor object */
375
376         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
377         if (!obj_desc) {
378                 return_ACPI_STATUS(AE_NO_MEMORY);
379         }
380
381         /* Initialize the processor object from the operands */
382
383         obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
384         obj_desc->processor.length = (u8) operand[3]->integer.value;
385         obj_desc->processor.address =
386             (acpi_io_address) operand[2]->integer.value;
387
388         /* Install the processor object in the parent Node */
389
390         status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
391                                        obj_desc, ACPI_TYPE_PROCESSOR);
392
393         /* Remove local reference to the object */
394
395         acpi_ut_remove_reference(obj_desc);
396         return_ACPI_STATUS(status);
397 }
398
399 /*******************************************************************************
400  *
401  * FUNCTION:    acpi_ex_create_power_resource
402  *
403  * PARAMETERS:  walk_state          - Current state
404  *
405  * RETURN:      Status
406  *
407  * DESCRIPTION: Create a new power_resource object and populate the fields
408  *
409  *              power_resource (Name[0], system_level[1], resource_order[2])
410  *
411  ******************************************************************************/
412
413 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
414 {
415         union acpi_operand_object **operand = &walk_state->operands[0];
416         acpi_status status;
417         union acpi_operand_object *obj_desc;
418
419         ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
420
421         /* Create the power resource object */
422
423         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
424         if (!obj_desc) {
425                 return_ACPI_STATUS(AE_NO_MEMORY);
426         }
427
428         /* Initialize the power object from the operands */
429
430         obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
431         obj_desc->power_resource.resource_order =
432             (u16) operand[2]->integer.value;
433
434         /* Install the  power resource object in the parent Node */
435
436         status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
437                                        obj_desc, ACPI_TYPE_POWER);
438
439         /* Remove local reference to the object */
440
441         acpi_ut_remove_reference(obj_desc);
442         return_ACPI_STATUS(status);
443 }
444 #endif
445
446 /*******************************************************************************
447  *
448  * FUNCTION:    acpi_ex_create_method
449  *
450  * PARAMETERS:  aml_start       - First byte of the method's AML
451  *              aml_length      - AML byte count for this method
452  *              walk_state      - Current state
453  *
454  * RETURN:      Status
455  *
456  * DESCRIPTION: Create a new method object
457  *
458  ******************************************************************************/
459
460 acpi_status
461 acpi_ex_create_method(u8 * aml_start,
462                       u32 aml_length, struct acpi_walk_state *walk_state)
463 {
464         union acpi_operand_object **operand = &walk_state->operands[0];
465         union acpi_operand_object *obj_desc;
466         acpi_status status;
467         u8 method_flags;
468
469         ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
470
471         /* Create a new method object */
472
473         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
474         if (!obj_desc) {
475                 status = AE_NO_MEMORY;
476                 goto exit;
477         }
478
479         /* Save the method's AML pointer and length  */
480
481         obj_desc->method.aml_start = aml_start;
482         obj_desc->method.aml_length = aml_length;
483
484         /*
485          * Disassemble the method flags. Split off the Arg Count
486          * for efficiency
487          */
488         method_flags = (u8) operand[1]->integer.value;
489
490         obj_desc->method.method_flags =
491             (u8) (method_flags & ~AML_METHOD_ARG_COUNT);
492         obj_desc->method.param_count =
493             (u8) (method_flags & AML_METHOD_ARG_COUNT);
494
495         /*
496          * Get the sync_level. If method is serialized, a mutex will be
497          * created for this method when it is parsed.
498          */
499         if (method_flags & AML_METHOD_SERIALIZED) {
500                 /*
501                  * ACPI 1.0: sync_level = 0
502                  * ACPI 2.0: sync_level = sync_level in method declaration
503                  */
504                 obj_desc->method.sync_level = (u8)
505                     ((method_flags & AML_METHOD_SYNC_LEVEL) >> 4);
506         }
507
508         /* Attach the new object to the method Node */
509
510         status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
511                                        obj_desc, ACPI_TYPE_METHOD);
512
513         /* Remove local reference to the object */
514
515         acpi_ut_remove_reference(obj_desc);
516
517       exit:
518         /* Remove a reference to the operand */
519
520         acpi_ut_remove_reference(operand[1]);
521         return_ACPI_STATUS(status);
522 }