1 /******************************************************************************
3 * Module Name: evregion - Operation Region support
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
50 #define _COMPONENT ACPI_EVENTS
51 ACPI_MODULE_NAME("evregion")
53 extern u8 acpi_gbl_default_address_spaces[];
55 /* Local prototypes */
58 acpi_ev_orphan_ec_reg_method(struct acpi_namespace_node *ec_device_node);
61 acpi_ev_reg_run(acpi_handle obj_handle,
62 u32 level, void *context, void **return_value);
64 /*******************************************************************************
66 * FUNCTION: acpi_ev_initialize_op_regions
72 * DESCRIPTION: Execute _REG methods for all Operation Regions that have
73 * an installed default region handler.
75 ******************************************************************************/
77 acpi_status acpi_ev_initialize_op_regions(void)
82 ACPI_FUNCTION_TRACE(ev_initialize_op_regions);
84 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
85 if (ACPI_FAILURE(status)) {
86 return_ACPI_STATUS(status);
89 /* Run the _REG methods for op_regions in each default address space */
91 for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
93 * Make sure the installed handler is the DEFAULT handler. If not the
94 * default, the _REG methods will have already been run (when the
95 * handler was installed)
97 if (acpi_ev_has_default_handler(acpi_gbl_root_node,
98 acpi_gbl_default_address_spaces
101 acpi_ev_execute_reg_methods(acpi_gbl_root_node,
102 acpi_gbl_default_address_spaces
107 acpi_gbl_reg_methods_executed = TRUE;
109 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
110 return_ACPI_STATUS(status);
113 /*******************************************************************************
115 * FUNCTION: acpi_ev_address_space_dispatch
117 * PARAMETERS: region_obj - Internal region object
118 * field_obj - Corresponding field. Can be NULL.
119 * function - Read or Write operation
120 * region_offset - Where in the region to read or write
121 * bit_width - Field width in bits (8, 16, 32, or 64)
122 * value - Pointer to in or out value, must be
123 * a full 64-bit integer
127 * DESCRIPTION: Dispatch an address space or operation region access to
128 * a previously installed handler.
130 ******************************************************************************/
133 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
134 union acpi_operand_object *field_obj,
136 u32 region_offset, u32 bit_width, u64 *value)
139 acpi_adr_space_handler handler;
140 acpi_adr_space_setup region_setup;
141 union acpi_operand_object *handler_desc;
142 union acpi_operand_object *region_obj2;
143 void *region_context = NULL;
144 struct acpi_connection_info *context;
146 ACPI_FUNCTION_TRACE(ev_address_space_dispatch);
148 region_obj2 = acpi_ns_get_secondary_object(region_obj);
150 return_ACPI_STATUS(AE_NOT_EXIST);
153 /* Ensure that there is a handler associated with this region */
155 handler_desc = region_obj->region.handler;
158 "No handler for Region [%4.4s] (%p) [%s]",
159 acpi_ut_get_node_name(region_obj->region.node),
161 acpi_ut_get_region_name(region_obj->region.
164 return_ACPI_STATUS(AE_NOT_EXIST);
167 context = handler_desc->address_space.context;
170 * It may be the case that the region has never been initialized.
171 * Some types of regions require special init code
173 if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
175 /* This region has not been initialized yet, do it */
177 region_setup = handler_desc->address_space.setup;
180 /* No initialization routine, exit with error */
183 "No init routine for region(%p) [%s]",
185 acpi_ut_get_region_name(region_obj->region.
187 return_ACPI_STATUS(AE_NOT_EXIST);
191 * We must exit the interpreter because the region setup will
192 * potentially execute control methods (for example, the _REG method
195 acpi_ex_exit_interpreter();
197 status = region_setup(region_obj, ACPI_REGION_ACTIVATE,
198 context, ®ion_context);
200 /* Re-enter the interpreter */
202 acpi_ex_enter_interpreter();
204 /* Check for failure of the Region Setup */
206 if (ACPI_FAILURE(status)) {
207 ACPI_EXCEPTION((AE_INFO, status,
208 "During region initialization: [%s]",
209 acpi_ut_get_region_name(region_obj->
212 return_ACPI_STATUS(status);
215 /* Region initialization may have been completed by region_setup */
217 if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
218 region_obj->region.flags |= AOPOBJ_SETUP_COMPLETE;
221 * Save the returned context for use in all accesses to
222 * the handler for this particular region
224 if (!(region_obj2->extra.region_context)) {
225 region_obj2->extra.region_context =
231 /* We have everything we need, we can invoke the address space handler */
233 handler = handler_desc->address_space.handler;
235 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
236 "Handler %p (@%p) Address %8.8X%8.8X [%s]\n",
237 ®ion_obj->region.handler->address_space, handler,
238 ACPI_FORMAT_NATIVE_UINT(region_obj->region.address +
240 acpi_ut_get_region_name(region_obj->region.
244 * Special handling for generic_serial_bus and general_purpose_io:
245 * There are three extra parameters that must be passed to the
246 * handler via the context:
247 * 1) Connection buffer, a resource template from Connection() op.
248 * 2) Length of the above buffer.
249 * 3) Actual access length from the access_as() op.
251 if (((region_obj->region.space_id == ACPI_ADR_SPACE_GSBUS) ||
252 (region_obj->region.space_id == ACPI_ADR_SPACE_GPIO)) &&
253 context && field_obj) {
255 /* Get the Connection (resource_template) buffer */
257 context->connection = field_obj->field.resource_buffer;
258 context->length = field_obj->field.resource_length;
259 context->access_length = field_obj->field.access_length;
262 if (!(handler_desc->address_space.handler_flags &
263 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
265 * For handlers other than the default (supplied) handlers, we must
266 * exit the interpreter because the handler *might* block -- we don't
267 * know what it will do, so we can't hold the lock on the intepreter.
269 acpi_ex_exit_interpreter();
272 /* Call the handler */
274 status = handler(function,
275 (region_obj->region.address + region_offset),
276 bit_width, value, context,
277 region_obj2->extra.region_context);
279 if (ACPI_FAILURE(status)) {
280 ACPI_EXCEPTION((AE_INFO, status, "Returned by Handler for [%s]",
281 acpi_ut_get_region_name(region_obj->region.
285 if (!(handler_desc->address_space.handler_flags &
286 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
288 * We just returned from a non-default handler, we must re-enter the
291 acpi_ex_enter_interpreter();
294 return_ACPI_STATUS(status);
297 /*******************************************************************************
299 * FUNCTION: acpi_ev_detach_region
301 * PARAMETERS: region_obj - Region Object
302 * acpi_ns_is_locked - Namespace Region Already Locked?
306 * DESCRIPTION: Break the association between the handler and the region
307 * this is a two way association.
309 ******************************************************************************/
312 acpi_ev_detach_region(union acpi_operand_object *region_obj,
313 u8 acpi_ns_is_locked)
315 union acpi_operand_object *handler_obj;
316 union acpi_operand_object *obj_desc;
317 union acpi_operand_object *start_desc;
318 union acpi_operand_object **last_obj_ptr;
319 acpi_adr_space_setup region_setup;
320 void **region_context;
321 union acpi_operand_object *region_obj2;
324 ACPI_FUNCTION_TRACE(ev_detach_region);
326 region_obj2 = acpi_ns_get_secondary_object(region_obj);
330 region_context = ®ion_obj2->extra.region_context;
332 /* Get the address handler from the region object */
334 handler_obj = region_obj->region.handler;
337 /* This region has no handler, all done */
342 /* Find this region in the handler's list */
344 obj_desc = handler_obj->address_space.region_list;
345 start_desc = obj_desc;
346 last_obj_ptr = &handler_obj->address_space.region_list;
350 /* Is this the correct Region? */
352 if (obj_desc == region_obj) {
353 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
354 "Removing Region %p from address handler %p\n",
355 region_obj, handler_obj));
357 /* This is it, remove it from the handler's list */
359 *last_obj_ptr = obj_desc->region.next;
360 obj_desc->region.next = NULL; /* Must clear field */
362 if (acpi_ns_is_locked) {
364 acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
365 if (ACPI_FAILURE(status)) {
370 /* Now stop region accesses by executing the _REG method */
373 acpi_ev_execute_reg_method(region_obj,
374 ACPI_REG_DISCONNECT);
375 if (ACPI_FAILURE(status)) {
376 ACPI_EXCEPTION((AE_INFO, status,
377 "from region _REG, [%s]",
378 acpi_ut_get_region_name
379 (region_obj->region.space_id)));
382 if (acpi_ns_is_locked) {
384 acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
385 if (ACPI_FAILURE(status)) {
391 * If the region has been activated, call the setup handler with
392 * the deactivate notification
394 if (region_obj->region.flags & AOPOBJ_SETUP_COMPLETE) {
395 region_setup = handler_obj->address_space.setup;
397 region_setup(region_obj,
398 ACPI_REGION_DEACTIVATE,
399 handler_obj->address_space.
400 context, region_context);
403 * region_context should have been released by the deactivate
404 * operation. We don't need access to it anymore here.
406 if (region_context) {
407 *region_context = NULL;
410 /* Init routine may fail, Just ignore errors */
412 if (ACPI_FAILURE(status)) {
413 ACPI_EXCEPTION((AE_INFO, status,
414 "from region handler - deactivate, [%s]",
415 acpi_ut_get_region_name
420 region_obj->region.flags &=
421 ~(AOPOBJ_SETUP_COMPLETE);
425 * Remove handler reference in the region
427 * NOTE: this doesn't mean that the region goes away, the region
428 * is just inaccessible as indicated to the _REG method
430 * If the region is on the handler's list, this must be the
433 region_obj->region.handler = NULL;
434 acpi_ut_remove_reference(handler_obj);
439 /* Walk the linked list of handlers */
441 last_obj_ptr = &obj_desc->region.next;
442 obj_desc = obj_desc->region.next;
444 /* Prevent infinite loop if list is corrupted */
446 if (obj_desc == start_desc) {
448 "Circular handler list in region object %p",
454 /* If we get here, the region was not in the handler's region list */
456 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
457 "Cannot remove region %p from address handler %p\n",
458 region_obj, handler_obj));
463 /*******************************************************************************
465 * FUNCTION: acpi_ev_attach_region
467 * PARAMETERS: handler_obj - Handler Object
468 * region_obj - Region Object
469 * acpi_ns_is_locked - Namespace Region Already Locked?
473 * DESCRIPTION: Create the association between the handler and the region
474 * this is a two way association.
476 ******************************************************************************/
479 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
480 union acpi_operand_object *region_obj,
481 u8 acpi_ns_is_locked)
484 ACPI_FUNCTION_TRACE(ev_attach_region);
486 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
487 "Adding Region [%4.4s] %p to address handler %p [%s]\n",
488 acpi_ut_get_node_name(region_obj->region.node),
489 region_obj, handler_obj,
490 acpi_ut_get_region_name(region_obj->region.
493 /* Link this region to the front of the handler's list */
495 region_obj->region.next = handler_obj->address_space.region_list;
496 handler_obj->address_space.region_list = region_obj;
498 /* Install the region's handler */
500 if (region_obj->region.handler) {
501 return_ACPI_STATUS(AE_ALREADY_EXISTS);
504 region_obj->region.handler = handler_obj;
505 acpi_ut_add_reference(handler_obj);
507 return_ACPI_STATUS(AE_OK);
510 /*******************************************************************************
512 * FUNCTION: acpi_ev_execute_reg_method
514 * PARAMETERS: region_obj - Region object
515 * function - Passed to _REG: On (1) or Off (0)
519 * DESCRIPTION: Execute _REG method for a region
521 ******************************************************************************/
524 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function)
526 struct acpi_evaluate_info *info;
527 union acpi_operand_object *args[3];
528 union acpi_operand_object *region_obj2;
531 ACPI_FUNCTION_TRACE(ev_execute_reg_method);
533 region_obj2 = acpi_ns_get_secondary_object(region_obj);
535 return_ACPI_STATUS(AE_NOT_EXIST);
538 if (region_obj2->extra.method_REG == NULL) {
539 return_ACPI_STATUS(AE_OK);
542 /* Allocate and initialize the evaluation information block */
544 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
546 return_ACPI_STATUS(AE_NO_MEMORY);
549 info->prefix_node = region_obj2->extra.method_REG;
550 info->relative_pathname = NULL;
551 info->parameters = args;
552 info->flags = ACPI_IGNORE_RETURN_VALUE;
555 * The _REG method has two arguments:
558 * Operation region space ID Same value as region_obj->Region.space_id
561 * connection status 1 for connecting the handler, 0 for disconnecting
562 * the handler (Passed as a parameter)
565 acpi_ut_create_integer_object((u64)region_obj->region.space_id);
567 status = AE_NO_MEMORY;
571 args[1] = acpi_ut_create_integer_object((u64)function);
573 status = AE_NO_MEMORY;
577 args[2] = NULL; /* Terminate list */
579 /* Execute the method, no return value */
581 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
582 (ACPI_TYPE_METHOD, info->prefix_node, NULL));
584 status = acpi_ns_evaluate(info);
585 acpi_ut_remove_reference(args[1]);
588 acpi_ut_remove_reference(args[0]);
592 return_ACPI_STATUS(status);
595 /*******************************************************************************
597 * FUNCTION: acpi_ev_execute_reg_methods
599 * PARAMETERS: node - Namespace node for the device
600 * space_id - The address space ID
604 * DESCRIPTION: Run all _REG methods for the input Space ID;
605 * Note: assumes namespace is locked, or system init time.
607 ******************************************************************************/
610 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
611 acpi_adr_space_type space_id)
615 ACPI_FUNCTION_TRACE(ev_execute_reg_methods);
618 * Run all _REG methods for all Operation Regions for this space ID. This
619 * is a separate walk in order to handle any interdependencies between
620 * regions and _REG methods. (i.e. handlers must be installed for all
621 * regions of this Space ID before we can run any _REG methods)
623 status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
624 ACPI_NS_WALK_UNLOCK, acpi_ev_reg_run,
625 NULL, &space_id, NULL);
627 /* Special case for EC: handle "orphan" _REG methods with no region */
629 if (space_id == ACPI_ADR_SPACE_EC) {
630 acpi_ev_orphan_ec_reg_method(node);
633 return_ACPI_STATUS(status);
636 /*******************************************************************************
638 * FUNCTION: acpi_ev_reg_run
640 * PARAMETERS: walk_namespace callback
642 * DESCRIPTION: Run _REG method for region objects of the requested spaceID
644 ******************************************************************************/
647 acpi_ev_reg_run(acpi_handle obj_handle,
648 u32 level, void *context, void **return_value)
650 union acpi_operand_object *obj_desc;
651 struct acpi_namespace_node *node;
652 acpi_adr_space_type space_id;
655 space_id = *ACPI_CAST_PTR(acpi_adr_space_type, context);
657 /* Convert and validate the device handle */
659 node = acpi_ns_validate_handle(obj_handle);
661 return (AE_BAD_PARAMETER);
665 * We only care about regions.and objects that are allowed to have address
668 if ((node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
672 /* Check for an existing internal object */
674 obj_desc = acpi_ns_get_attached_object(node);
677 /* No object, just exit */
682 /* Object is a Region */
684 if (obj_desc->region.space_id != space_id) {
686 /* This region is for a different address space, just ignore it */
691 status = acpi_ev_execute_reg_method(obj_desc, ACPI_REG_CONNECT);
695 /*******************************************************************************
697 * FUNCTION: acpi_ev_orphan_ec_reg_method
699 * PARAMETERS: ec_device_node - Namespace node for an EC device
703 * DESCRIPTION: Execute an "orphan" _REG method that appears under the EC
704 * device. This is a _REG method that has no corresponding region
705 * within the EC device scope. The orphan _REG method appears to
706 * have been enabled by the description of the ECDT in the ACPI
707 * specification: "The availability of the region space can be
708 * detected by providing a _REG method object underneath the
709 * Embedded Controller device."
711 * To quickly access the EC device, we use the ec_device_node used
712 * during EC handler installation. Otherwise, we would need to
713 * perform a time consuming namespace walk, executing _HID
714 * methods to find the EC device.
716 * MUTEX: Assumes the namespace is locked
718 ******************************************************************************/
721 acpi_ev_orphan_ec_reg_method(struct acpi_namespace_node *ec_device_node)
723 acpi_handle reg_method;
724 struct acpi_namespace_node *next_node;
726 struct acpi_object_list args;
727 union acpi_object objects[2];
729 ACPI_FUNCTION_TRACE(ev_orphan_ec_reg_method);
731 if (!ec_device_node) {
735 /* Namespace is currently locked, must release */
737 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
739 /* Get a handle to a _REG method immediately under the EC device */
741 status = acpi_get_handle(ec_device_node, METHOD_NAME__REG, ®_method);
742 if (ACPI_FAILURE(status)) {
743 goto exit; /* There is no _REG method present */
747 * Execute the _REG method only if there is no Operation Region in
748 * this scope with the Embedded Controller space ID. Otherwise, it
749 * will already have been executed. Note, this allows for Regions
750 * with other space IDs to be present; but the code below will then
751 * execute the _REG method with the embedded_control space_ID argument.
753 next_node = acpi_ns_get_next_node(ec_device_node, NULL);
755 if ((next_node->type == ACPI_TYPE_REGION) &&
756 (next_node->object) &&
757 (next_node->object->region.space_id == ACPI_ADR_SPACE_EC)) {
758 goto exit; /* Do not execute the _REG */
761 next_node = acpi_ns_get_next_node(ec_device_node, next_node);
764 /* Evaluate the _REG(embedded_control,Connect) method */
767 args.pointer = objects;
768 objects[0].type = ACPI_TYPE_INTEGER;
769 objects[0].integer.value = ACPI_ADR_SPACE_EC;
770 objects[1].type = ACPI_TYPE_INTEGER;
771 objects[1].integer.value = ACPI_REG_CONNECT;
773 status = acpi_evaluate_object(reg_method, NULL, &args, NULL);
776 /* We ignore all errors from above, don't care */
778 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);