xref: /openbmc/linux/drivers/acpi/acpica/excreate.c (revision 41e4b7dc)
1 /******************************************************************************
2  *
3  * Module Name: excreate - Named object creation
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2017, 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 	/* Ensure that the target node is valid */
91 
92 	if (!target_node) {
93 		return_ACPI_STATUS(AE_NULL_OBJECT);
94 	}
95 
96 	/* Construct the alias object (a namespace node) */
97 
98 	switch (target_node->type) {
99 	case ACPI_TYPE_METHOD:
100 		/*
101 		 * Control method aliases need to be differentiated with
102 		 * a special type
103 		 */
104 		alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
105 		break;
106 
107 	default:
108 		/*
109 		 * All other object types.
110 		 *
111 		 * The new alias has the type ALIAS and points to the original
112 		 * NS node, not the object itself.
113 		 */
114 		alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
115 		alias_node->object =
116 		    ACPI_CAST_PTR(union acpi_operand_object, target_node);
117 		break;
118 	}
119 
120 	/* Since both operands are Nodes, we don't need to delete them */
121 
122 	alias_node->object =
123 	    ACPI_CAST_PTR(union acpi_operand_object, target_node);
124 	return_ACPI_STATUS(status);
125 }
126 
127 /*******************************************************************************
128  *
129  * FUNCTION:    acpi_ex_create_event
130  *
131  * PARAMETERS:  walk_state          - Current state
132  *
133  * RETURN:      Status
134  *
135  * DESCRIPTION: Create a new event object
136  *
137  ******************************************************************************/
138 
139 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
140 {
141 	acpi_status status;
142 	union acpi_operand_object *obj_desc;
143 
144 	ACPI_FUNCTION_TRACE(ex_create_event);
145 
146 	obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
147 	if (!obj_desc) {
148 		status = AE_NO_MEMORY;
149 		goto cleanup;
150 	}
151 
152 	/*
153 	 * Create the actual OS semaphore, with zero initial units -- meaning
154 	 * that the event is created in an unsignalled state
155 	 */
156 	status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
157 					  &obj_desc->event.os_semaphore);
158 	if (ACPI_FAILURE(status)) {
159 		goto cleanup;
160 	}
161 
162 	/* Attach object to the Node */
163 
164 	status = acpi_ns_attach_object((struct acpi_namespace_node *)
165 				       walk_state->operands[0], obj_desc,
166 				       ACPI_TYPE_EVENT);
167 
168 cleanup:
169 	/*
170 	 * Remove local reference to the object (on error, will cause deletion
171 	 * of both object and semaphore if present.)
172 	 */
173 	acpi_ut_remove_reference(obj_desc);
174 	return_ACPI_STATUS(status);
175 }
176 
177 /*******************************************************************************
178  *
179  * FUNCTION:    acpi_ex_create_mutex
180  *
181  * PARAMETERS:  walk_state          - Current state
182  *
183  * RETURN:      Status
184  *
185  * DESCRIPTION: Create a new mutex object
186  *
187  *              Mutex (Name[0], sync_level[1])
188  *
189  ******************************************************************************/
190 
191 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
192 {
193 	acpi_status status = AE_OK;
194 	union acpi_operand_object *obj_desc;
195 
196 	ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
197 
198 	/* Create the new mutex object */
199 
200 	obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
201 	if (!obj_desc) {
202 		status = AE_NO_MEMORY;
203 		goto cleanup;
204 	}
205 
206 	/* Create the actual OS Mutex */
207 
208 	status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex);
209 	if (ACPI_FAILURE(status)) {
210 		goto cleanup;
211 	}
212 
213 	/* Init object and attach to NS node */
214 
215 	obj_desc->mutex.sync_level = (u8)walk_state->operands[1]->integer.value;
216 	obj_desc->mutex.node =
217 	    (struct acpi_namespace_node *)walk_state->operands[0];
218 
219 	status =
220 	    acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
221 				  ACPI_TYPE_MUTEX);
222 
223 cleanup:
224 	/*
225 	 * Remove local reference to the object (on error, will cause deletion
226 	 * of both object and semaphore if present.)
227 	 */
228 	acpi_ut_remove_reference(obj_desc);
229 	return_ACPI_STATUS(status);
230 }
231 
232 /*******************************************************************************
233  *
234  * FUNCTION:    acpi_ex_create_region
235  *
236  * PARAMETERS:  aml_start           - Pointer to the region declaration AML
237  *              aml_length          - Max length of the declaration AML
238  *              space_id            - Address space ID for the region
239  *              walk_state          - Current state
240  *
241  * RETURN:      Status
242  *
243  * DESCRIPTION: Create a new operation region object
244  *
245  ******************************************************************************/
246 
247 acpi_status
248 acpi_ex_create_region(u8 * aml_start,
249 		      u32 aml_length,
250 		      u8 space_id, struct acpi_walk_state *walk_state)
251 {
252 	acpi_status status;
253 	union acpi_operand_object *obj_desc;
254 	struct acpi_namespace_node *node;
255 	union acpi_operand_object *region_obj2;
256 
257 	ACPI_FUNCTION_TRACE(ex_create_region);
258 
259 	/* Get the Namespace Node */
260 
261 	node = walk_state->op->common.node;
262 
263 	/*
264 	 * If the region object is already attached to this node,
265 	 * just return
266 	 */
267 	if (acpi_ns_get_attached_object(node)) {
268 		return_ACPI_STATUS(AE_OK);
269 	}
270 
271 	/*
272 	 * Space ID must be one of the predefined IDs, or in the user-defined
273 	 * range
274 	 */
275 	if (!acpi_is_valid_space_id(space_id)) {
276 		/*
277 		 * Print an error message, but continue. We don't want to abort
278 		 * a table load for this exception. Instead, if the region is
279 		 * actually used at runtime, abort the executing method.
280 		 */
281 		ACPI_ERROR((AE_INFO,
282 			    "Invalid/unknown Address Space ID: 0x%2.2X",
283 			    space_id));
284 	}
285 
286 	ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (0x%X)\n",
287 			  acpi_ut_get_region_name(space_id), space_id));
288 
289 	/* Create the region descriptor */
290 
291 	obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
292 	if (!obj_desc) {
293 		status = AE_NO_MEMORY;
294 		goto cleanup;
295 	}
296 
297 	/*
298 	 * Remember location in AML stream of address & length
299 	 * operands since they need to be evaluated at run time.
300 	 */
301 	region_obj2 = acpi_ns_get_secondary_object(obj_desc);
302 	region_obj2->extra.aml_start = aml_start;
303 	region_obj2->extra.aml_length = aml_length;
304 	region_obj2->extra.method_REG = NULL;
305 	if (walk_state->scope_info) {
306 		region_obj2->extra.scope_node =
307 		    walk_state->scope_info->scope.node;
308 	} else {
309 		region_obj2->extra.scope_node = node;
310 	}
311 
312 	/* Init the region from the operands */
313 
314 	obj_desc->region.space_id = space_id;
315 	obj_desc->region.address = 0;
316 	obj_desc->region.length = 0;
317 	obj_desc->region.node = node;
318 	obj_desc->region.handler = NULL;
319 	obj_desc->common.flags &=
320 	    ~(AOPOBJ_SETUP_COMPLETE | AOPOBJ_REG_CONNECTED |
321 	      AOPOBJ_OBJECT_INITIALIZED);
322 
323 	/* Install the new region object in the parent Node */
324 
325 	status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
326 
327 cleanup:
328 
329 	/* Remove local reference to the object */
330 
331 	acpi_ut_remove_reference(obj_desc);
332 	return_ACPI_STATUS(status);
333 }
334 
335 /*******************************************************************************
336  *
337  * FUNCTION:    acpi_ex_create_processor
338  *
339  * PARAMETERS:  walk_state          - Current state
340  *
341  * RETURN:      Status
342  *
343  * DESCRIPTION: Create a new processor object and populate the fields
344  *
345  *              Processor (Name[0], cpu_ID[1], pblock_addr[2], pblock_length[3])
346  *
347  ******************************************************************************/
348 
349 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
350 {
351 	union acpi_operand_object **operand = &walk_state->operands[0];
352 	union acpi_operand_object *obj_desc;
353 	acpi_status status;
354 
355 	ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
356 
357 	/* Create the processor object */
358 
359 	obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
360 	if (!obj_desc) {
361 		return_ACPI_STATUS(AE_NO_MEMORY);
362 	}
363 
364 	/* Initialize the processor object from the operands */
365 
366 	obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
367 	obj_desc->processor.length = (u8) operand[3]->integer.value;
368 	obj_desc->processor.address =
369 	    (acpi_io_address)operand[2]->integer.value;
370 
371 	/* Install the processor object in the parent Node */
372 
373 	status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
374 				       obj_desc, ACPI_TYPE_PROCESSOR);
375 
376 	/* Remove local reference to the object */
377 
378 	acpi_ut_remove_reference(obj_desc);
379 	return_ACPI_STATUS(status);
380 }
381 
382 /*******************************************************************************
383  *
384  * FUNCTION:    acpi_ex_create_power_resource
385  *
386  * PARAMETERS:  walk_state          - Current state
387  *
388  * RETURN:      Status
389  *
390  * DESCRIPTION: Create a new power_resource object and populate the fields
391  *
392  *              power_resource (Name[0], system_level[1], resource_order[2])
393  *
394  ******************************************************************************/
395 
396 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
397 {
398 	union acpi_operand_object **operand = &walk_state->operands[0];
399 	acpi_status status;
400 	union acpi_operand_object *obj_desc;
401 
402 	ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
403 
404 	/* Create the power resource object */
405 
406 	obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
407 	if (!obj_desc) {
408 		return_ACPI_STATUS(AE_NO_MEMORY);
409 	}
410 
411 	/* Initialize the power object from the operands */
412 
413 	obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
414 	obj_desc->power_resource.resource_order =
415 	    (u16) operand[2]->integer.value;
416 
417 	/* Install the  power resource object in the parent Node */
418 
419 	status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
420 				       obj_desc, ACPI_TYPE_POWER);
421 
422 	/* Remove local reference to the object */
423 
424 	acpi_ut_remove_reference(obj_desc);
425 	return_ACPI_STATUS(status);
426 }
427 #endif
428 
429 /*******************************************************************************
430  *
431  * FUNCTION:    acpi_ex_create_method
432  *
433  * PARAMETERS:  aml_start       - First byte of the method's AML
434  *              aml_length      - AML byte count for this method
435  *              walk_state      - Current state
436  *
437  * RETURN:      Status
438  *
439  * DESCRIPTION: Create a new method object
440  *
441  ******************************************************************************/
442 
443 acpi_status
444 acpi_ex_create_method(u8 * aml_start,
445 		      u32 aml_length, struct acpi_walk_state *walk_state)
446 {
447 	union acpi_operand_object **operand = &walk_state->operands[0];
448 	union acpi_operand_object *obj_desc;
449 	acpi_status status;
450 	u8 method_flags;
451 
452 	ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
453 
454 	/* Create a new method object */
455 
456 	obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
457 	if (!obj_desc) {
458 		status = AE_NO_MEMORY;
459 		goto exit;
460 	}
461 
462 	/* Save the method's AML pointer and length  */
463 
464 	obj_desc->method.aml_start = aml_start;
465 	obj_desc->method.aml_length = aml_length;
466 	obj_desc->method.node = operand[0];
467 
468 	/*
469 	 * Disassemble the method flags. Split off the arg_count, Serialized
470 	 * flag, and sync_level for efficiency.
471 	 */
472 	method_flags = (u8)operand[1]->integer.value;
473 	obj_desc->method.param_count = (u8)
474 	    (method_flags & AML_METHOD_ARG_COUNT);
475 
476 	/*
477 	 * Get the sync_level. If method is serialized, a mutex will be
478 	 * created for this method when it is parsed.
479 	 */
480 	if (method_flags & AML_METHOD_SERIALIZED) {
481 		obj_desc->method.info_flags = ACPI_METHOD_SERIALIZED;
482 
483 		/*
484 		 * ACPI 1.0: sync_level = 0
485 		 * ACPI 2.0: sync_level = sync_level in method declaration
486 		 */
487 		obj_desc->method.sync_level = (u8)
488 		    ((method_flags & AML_METHOD_SYNC_LEVEL) >> 4);
489 	}
490 
491 	/* Attach the new object to the method Node */
492 
493 	status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
494 				       obj_desc, ACPI_TYPE_METHOD);
495 
496 	/* Remove local reference to the object */
497 
498 	acpi_ut_remove_reference(obj_desc);
499 
500 exit:
501 	/* Remove a reference to the operand */
502 
503 	acpi_ut_remove_reference(operand[1]);
504 	return_ACPI_STATUS(status);
505 }
506