lp: move compat_ioctl handling into lp.c
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / acpi / acpica / evregion.c
blob0bc807c33a568b712cbb1ea27b4c37ca65ec772c
1 /******************************************************************************
3 * Module Name: evregion - ACPI address_space (op_region) handler dispatch
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2008, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acevents.h"
47 #include "acnamesp.h"
48 #include "acinterp.h"
50 #define _COMPONENT ACPI_EVENTS
51 ACPI_MODULE_NAME("evregion")
53 /* Local prototypes */
54 static u8
55 acpi_ev_has_default_handler(struct acpi_namespace_node *node,
56 acpi_adr_space_type space_id);
58 static acpi_status
59 acpi_ev_reg_run(acpi_handle obj_handle,
60 u32 level, void *context, void **return_value);
62 static acpi_status
63 acpi_ev_install_handler(acpi_handle obj_handle,
64 u32 level, void *context, void **return_value);
66 /* These are the address spaces that will get default handlers */
68 #define ACPI_NUM_DEFAULT_SPACES 4
70 static u8 acpi_gbl_default_address_spaces[ACPI_NUM_DEFAULT_SPACES] = {
71 ACPI_ADR_SPACE_SYSTEM_MEMORY,
72 ACPI_ADR_SPACE_SYSTEM_IO,
73 ACPI_ADR_SPACE_PCI_CONFIG,
74 ACPI_ADR_SPACE_DATA_TABLE
77 /*******************************************************************************
79 * FUNCTION: acpi_ev_install_region_handlers
81 * PARAMETERS: None
83 * RETURN: Status
85 * DESCRIPTION: Installs the core subsystem default address space handlers.
87 ******************************************************************************/
89 acpi_status acpi_ev_install_region_handlers(void)
91 acpi_status status;
92 u32 i;
94 ACPI_FUNCTION_TRACE(ev_install_region_handlers);
96 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
97 if (ACPI_FAILURE(status)) {
98 return_ACPI_STATUS(status);
102 * All address spaces (PCI Config, EC, SMBus) are scope dependent and
103 * registration must occur for a specific device.
105 * In the case of the system memory and IO address spaces there is
106 * currently no device associated with the address space. For these we
107 * use the root.
109 * We install the default PCI config space handler at the root so that
110 * this space is immediately available even though the we have not
111 * enumerated all the PCI Root Buses yet. This is to conform to the ACPI
112 * specification which states that the PCI config space must be always
113 * available -- even though we are nowhere near ready to find the PCI root
114 * buses at this point.
116 * NOTE: We ignore AE_ALREADY_EXISTS because this means that a handler
117 * has already been installed (via acpi_install_address_space_handler).
118 * Similar for AE_SAME_HANDLER.
120 for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
121 status = acpi_ev_install_space_handler(acpi_gbl_root_node,
122 acpi_gbl_default_address_spaces
123 [i],
124 ACPI_DEFAULT_HANDLER,
125 NULL, NULL);
126 switch (status) {
127 case AE_OK:
128 case AE_SAME_HANDLER:
129 case AE_ALREADY_EXISTS:
131 /* These exceptions are all OK */
133 status = AE_OK;
134 break;
136 default:
138 goto unlock_and_exit;
142 unlock_and_exit:
143 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
144 return_ACPI_STATUS(status);
147 /*******************************************************************************
149 * FUNCTION: acpi_ev_has_default_handler
151 * PARAMETERS: Node - Namespace node for the device
152 * space_id - The address space ID
154 * RETURN: TRUE if default handler is installed, FALSE otherwise
156 * DESCRIPTION: Check if the default handler is installed for the requested
157 * space ID.
159 ******************************************************************************/
161 static u8
162 acpi_ev_has_default_handler(struct acpi_namespace_node *node,
163 acpi_adr_space_type space_id)
165 union acpi_operand_object *obj_desc;
166 union acpi_operand_object *handler_obj;
168 /* Must have an existing internal object */
170 obj_desc = acpi_ns_get_attached_object(node);
171 if (obj_desc) {
172 handler_obj = obj_desc->device.handler;
174 /* Walk the linked list of handlers for this object */
176 while (handler_obj) {
177 if (handler_obj->address_space.space_id == space_id) {
178 if (handler_obj->address_space.handler_flags &
179 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED) {
180 return (TRUE);
184 handler_obj = handler_obj->address_space.next;
188 return (FALSE);
191 /*******************************************************************************
193 * FUNCTION: acpi_ev_initialize_op_regions
195 * PARAMETERS: None
197 * RETURN: Status
199 * DESCRIPTION: Execute _REG methods for all Operation Regions that have
200 * an installed default region handler.
202 ******************************************************************************/
204 acpi_status acpi_ev_initialize_op_regions(void)
206 acpi_status status;
207 u32 i;
209 ACPI_FUNCTION_TRACE(ev_initialize_op_regions);
211 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
212 if (ACPI_FAILURE(status)) {
213 return_ACPI_STATUS(status);
216 /* Run the _REG methods for op_regions in each default address space */
218 for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
220 * Make sure the installed handler is the DEFAULT handler. If not the
221 * default, the _REG methods will have already been run (when the
222 * handler was installed)
224 if (acpi_ev_has_default_handler(acpi_gbl_root_node,
225 acpi_gbl_default_address_spaces
226 [i])) {
227 status =
228 acpi_ev_execute_reg_methods(acpi_gbl_root_node,
229 acpi_gbl_default_address_spaces
230 [i]);
234 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
235 return_ACPI_STATUS(status);
238 /*******************************************************************************
240 * FUNCTION: acpi_ev_execute_reg_method
242 * PARAMETERS: region_obj - Region object
243 * Function - Passed to _REG: On (1) or Off (0)
245 * RETURN: Status
247 * DESCRIPTION: Execute _REG method for a region
249 ******************************************************************************/
251 acpi_status
252 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function)
254 struct acpi_evaluate_info *info;
255 union acpi_operand_object *args[3];
256 union acpi_operand_object *region_obj2;
257 acpi_status status;
259 ACPI_FUNCTION_TRACE(ev_execute_reg_method);
261 region_obj2 = acpi_ns_get_secondary_object(region_obj);
262 if (!region_obj2) {
263 return_ACPI_STATUS(AE_NOT_EXIST);
266 if (region_obj2->extra.method_REG == NULL) {
267 return_ACPI_STATUS(AE_OK);
270 /* Allocate and initialize the evaluation information block */
272 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
273 if (!info) {
274 return_ACPI_STATUS(AE_NO_MEMORY);
277 info->prefix_node = region_obj2->extra.method_REG;
278 info->pathname = NULL;
279 info->parameters = args;
280 info->flags = ACPI_IGNORE_RETURN_VALUE;
283 * The _REG method has two arguments:
285 * Arg0 - Integer:
286 * Operation region space ID Same value as region_obj->Region.space_id
288 * Arg1 - Integer:
289 * connection status 1 for connecting the handler, 0 for disconnecting
290 * the handler (Passed as a parameter)
292 args[0] =
293 acpi_ut_create_integer_object((u64) region_obj->region.space_id);
294 if (!args[0]) {
295 status = AE_NO_MEMORY;
296 goto cleanup1;
299 args[1] = acpi_ut_create_integer_object((u64) function);
300 if (!args[1]) {
301 status = AE_NO_MEMORY;
302 goto cleanup2;
305 args[2] = NULL; /* Terminate list */
307 /* Execute the method, no return value */
309 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
310 (ACPI_TYPE_METHOD, info->prefix_node, NULL));
312 status = acpi_ns_evaluate(info);
313 acpi_ut_remove_reference(args[1]);
315 cleanup2:
316 acpi_ut_remove_reference(args[0]);
318 cleanup1:
319 ACPI_FREE(info);
320 return_ACPI_STATUS(status);
323 /*******************************************************************************
325 * FUNCTION: acpi_ev_address_space_dispatch
327 * PARAMETERS: region_obj - Internal region object
328 * Function - Read or Write operation
329 * region_offset - Where in the region to read or write
330 * bit_width - Field width in bits (8, 16, 32, or 64)
331 * Value - Pointer to in or out value, must be
332 * full 64-bit acpi_integer
334 * RETURN: Status
336 * DESCRIPTION: Dispatch an address space or operation region access to
337 * a previously installed handler.
339 ******************************************************************************/
341 acpi_status
342 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
343 u32 function,
344 u32 region_offset,
345 u32 bit_width, acpi_integer * value)
347 acpi_status status;
348 acpi_adr_space_handler handler;
349 acpi_adr_space_setup region_setup;
350 union acpi_operand_object *handler_desc;
351 union acpi_operand_object *region_obj2;
352 void *region_context = NULL;
354 ACPI_FUNCTION_TRACE(ev_address_space_dispatch);
356 region_obj2 = acpi_ns_get_secondary_object(region_obj);
357 if (!region_obj2) {
358 return_ACPI_STATUS(AE_NOT_EXIST);
361 /* Ensure that there is a handler associated with this region */
363 handler_desc = region_obj->region.handler;
364 if (!handler_desc) {
365 ACPI_ERROR((AE_INFO,
366 "No handler for Region [%4.4s] (%p) [%s]",
367 acpi_ut_get_node_name(region_obj->region.node),
368 region_obj,
369 acpi_ut_get_region_name(region_obj->region.
370 space_id)));
372 return_ACPI_STATUS(AE_NOT_EXIST);
376 * It may be the case that the region has never been initialized.
377 * Some types of regions require special init code
379 if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
381 /* This region has not been initialized yet, do it */
383 region_setup = handler_desc->address_space.setup;
384 if (!region_setup) {
386 /* No initialization routine, exit with error */
388 ACPI_ERROR((AE_INFO,
389 "No init routine for region(%p) [%s]",
390 region_obj,
391 acpi_ut_get_region_name(region_obj->region.
392 space_id)));
393 return_ACPI_STATUS(AE_NOT_EXIST);
397 * We must exit the interpreter because the region setup will
398 * potentially execute control methods (for example, the _REG method
399 * for this region)
401 acpi_ex_exit_interpreter();
403 status = region_setup(region_obj, ACPI_REGION_ACTIVATE,
404 handler_desc->address_space.context,
405 &region_context);
407 /* Re-enter the interpreter */
409 acpi_ex_enter_interpreter();
411 /* Check for failure of the Region Setup */
413 if (ACPI_FAILURE(status)) {
414 ACPI_EXCEPTION((AE_INFO, status,
415 "During region initialization: [%s]",
416 acpi_ut_get_region_name(region_obj->
417 region.
418 space_id)));
419 return_ACPI_STATUS(status);
422 /* Region initialization may have been completed by region_setup */
424 if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
425 region_obj->region.flags |= AOPOBJ_SETUP_COMPLETE;
427 if (region_obj2->extra.region_context) {
429 /* The handler for this region was already installed */
431 ACPI_FREE(region_context);
432 } else {
434 * Save the returned context for use in all accesses to
435 * this particular region
437 region_obj2->extra.region_context =
438 region_context;
443 /* We have everything we need, we can invoke the address space handler */
445 handler = handler_desc->address_space.handler;
447 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
448 "Handler %p (@%p) Address %8.8X%8.8X [%s]\n",
449 &region_obj->region.handler->address_space, handler,
450 ACPI_FORMAT_NATIVE_UINT(region_obj->region.address +
451 region_offset),
452 acpi_ut_get_region_name(region_obj->region.
453 space_id)));
455 if (!(handler_desc->address_space.handler_flags &
456 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
458 * For handlers other than the default (supplied) handlers, we must
459 * exit the interpreter because the handler *might* block -- we don't
460 * know what it will do, so we can't hold the lock on the intepreter.
462 acpi_ex_exit_interpreter();
465 /* Call the handler */
467 status = handler(function,
468 (region_obj->region.address + region_offset),
469 bit_width, value, handler_desc->address_space.context,
470 region_obj2->extra.region_context);
472 if (ACPI_FAILURE(status)) {
473 ACPI_EXCEPTION((AE_INFO, status, "Returned by Handler for [%s]",
474 acpi_ut_get_region_name(region_obj->region.
475 space_id)));
478 if (!(handler_desc->address_space.handler_flags &
479 ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
481 * We just returned from a non-default handler, we must re-enter the
482 * interpreter
484 acpi_ex_enter_interpreter();
487 return_ACPI_STATUS(status);
490 /*******************************************************************************
492 * FUNCTION: acpi_ev_detach_region
494 * PARAMETERS: region_obj - Region Object
495 * acpi_ns_is_locked - Namespace Region Already Locked?
497 * RETURN: None
499 * DESCRIPTION: Break the association between the handler and the region
500 * this is a two way association.
502 ******************************************************************************/
504 void
505 acpi_ev_detach_region(union acpi_operand_object *region_obj,
506 u8 acpi_ns_is_locked)
508 union acpi_operand_object *handler_obj;
509 union acpi_operand_object *obj_desc;
510 union acpi_operand_object **last_obj_ptr;
511 acpi_adr_space_setup region_setup;
512 void **region_context;
513 union acpi_operand_object *region_obj2;
514 acpi_status status;
516 ACPI_FUNCTION_TRACE(ev_detach_region);
518 region_obj2 = acpi_ns_get_secondary_object(region_obj);
519 if (!region_obj2) {
520 return_VOID;
522 region_context = &region_obj2->extra.region_context;
524 /* Get the address handler from the region object */
526 handler_obj = region_obj->region.handler;
527 if (!handler_obj) {
529 /* This region has no handler, all done */
531 return_VOID;
534 /* Find this region in the handler's list */
536 obj_desc = handler_obj->address_space.region_list;
537 last_obj_ptr = &handler_obj->address_space.region_list;
539 while (obj_desc) {
541 /* Is this the correct Region? */
543 if (obj_desc == region_obj) {
544 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
545 "Removing Region %p from address handler %p\n",
546 region_obj, handler_obj));
548 /* This is it, remove it from the handler's list */
550 *last_obj_ptr = obj_desc->region.next;
551 obj_desc->region.next = NULL; /* Must clear field */
553 if (acpi_ns_is_locked) {
554 status =
555 acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
556 if (ACPI_FAILURE(status)) {
557 return_VOID;
561 /* Now stop region accesses by executing the _REG method */
563 status = acpi_ev_execute_reg_method(region_obj, 0);
564 if (ACPI_FAILURE(status)) {
565 ACPI_EXCEPTION((AE_INFO, status,
566 "from region _REG, [%s]",
567 acpi_ut_get_region_name
568 (region_obj->region.space_id)));
571 if (acpi_ns_is_locked) {
572 status =
573 acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
574 if (ACPI_FAILURE(status)) {
575 return_VOID;
580 * If the region has been activated, call the setup handler with
581 * the deactivate notification
583 if (region_obj->region.flags & AOPOBJ_SETUP_COMPLETE) {
584 region_setup = handler_obj->address_space.setup;
585 status =
586 region_setup(region_obj,
587 ACPI_REGION_DEACTIVATE,
588 handler_obj->address_space.
589 context, region_context);
591 /* Init routine may fail, Just ignore errors */
593 if (ACPI_FAILURE(status)) {
594 ACPI_EXCEPTION((AE_INFO, status,
595 "from region handler - deactivate, [%s]",
596 acpi_ut_get_region_name
597 (region_obj->region.
598 space_id)));
601 region_obj->region.flags &=
602 ~(AOPOBJ_SETUP_COMPLETE);
606 * Remove handler reference in the region
608 * NOTE: this doesn't mean that the region goes away, the region
609 * is just inaccessible as indicated to the _REG method
611 * If the region is on the handler's list, this must be the
612 * region's handler
614 region_obj->region.handler = NULL;
615 acpi_ut_remove_reference(handler_obj);
617 return_VOID;
620 /* Walk the linked list of handlers */
622 last_obj_ptr = &obj_desc->region.next;
623 obj_desc = obj_desc->region.next;
626 /* If we get here, the region was not in the handler's region list */
628 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
629 "Cannot remove region %p from address handler %p\n",
630 region_obj, handler_obj));
632 return_VOID;
635 /*******************************************************************************
637 * FUNCTION: acpi_ev_attach_region
639 * PARAMETERS: handler_obj - Handler Object
640 * region_obj - Region Object
641 * acpi_ns_is_locked - Namespace Region Already Locked?
643 * RETURN: None
645 * DESCRIPTION: Create the association between the handler and the region
646 * this is a two way association.
648 ******************************************************************************/
650 acpi_status
651 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
652 union acpi_operand_object *region_obj,
653 u8 acpi_ns_is_locked)
656 ACPI_FUNCTION_TRACE(ev_attach_region);
658 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
659 "Adding Region [%4.4s] %p to address handler %p [%s]\n",
660 acpi_ut_get_node_name(region_obj->region.node),
661 region_obj, handler_obj,
662 acpi_ut_get_region_name(region_obj->region.
663 space_id)));
665 /* Link this region to the front of the handler's list */
667 region_obj->region.next = handler_obj->address_space.region_list;
668 handler_obj->address_space.region_list = region_obj;
670 /* Install the region's handler */
672 if (region_obj->region.handler) {
673 return_ACPI_STATUS(AE_ALREADY_EXISTS);
676 region_obj->region.handler = handler_obj;
677 acpi_ut_add_reference(handler_obj);
679 return_ACPI_STATUS(AE_OK);
682 /*******************************************************************************
684 * FUNCTION: acpi_ev_install_handler
686 * PARAMETERS: walk_namespace callback
688 * DESCRIPTION: This routine installs an address handler into objects that are
689 * of type Region or Device.
691 * If the Object is a Device, and the device has a handler of
692 * the same type then the search is terminated in that branch.
694 * This is because the existing handler is closer in proximity
695 * to any more regions than the one we are trying to install.
697 ******************************************************************************/
699 static acpi_status
700 acpi_ev_install_handler(acpi_handle obj_handle,
701 u32 level, void *context, void **return_value)
703 union acpi_operand_object *handler_obj;
704 union acpi_operand_object *next_handler_obj;
705 union acpi_operand_object *obj_desc;
706 struct acpi_namespace_node *node;
707 acpi_status status;
709 ACPI_FUNCTION_NAME(ev_install_handler);
711 handler_obj = (union acpi_operand_object *)context;
713 /* Parameter validation */
715 if (!handler_obj) {
716 return (AE_OK);
719 /* Convert and validate the device handle */
721 node = acpi_ns_map_handle_to_node(obj_handle);
722 if (!node) {
723 return (AE_BAD_PARAMETER);
727 * We only care about regions and objects that are allowed to have
728 * address space handlers
730 if ((node->type != ACPI_TYPE_DEVICE) &&
731 (node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
732 return (AE_OK);
735 /* Check for an existing internal object */
737 obj_desc = acpi_ns_get_attached_object(node);
738 if (!obj_desc) {
740 /* No object, just exit */
742 return (AE_OK);
745 /* Devices are handled different than regions */
747 if (obj_desc->common.type == ACPI_TYPE_DEVICE) {
749 /* Check if this Device already has a handler for this address space */
751 next_handler_obj = obj_desc->device.handler;
752 while (next_handler_obj) {
754 /* Found a handler, is it for the same address space? */
756 if (next_handler_obj->address_space.space_id ==
757 handler_obj->address_space.space_id) {
758 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
759 "Found handler for region [%s] in device %p(%p) "
760 "handler %p\n",
761 acpi_ut_get_region_name
762 (handler_obj->address_space.
763 space_id), obj_desc,
764 next_handler_obj,
765 handler_obj));
768 * Since the object we found it on was a device, then it
769 * means that someone has already installed a handler for
770 * the branch of the namespace from this device on. Just
771 * bail out telling the walk routine to not traverse this
772 * branch. This preserves the scoping rule for handlers.
774 return (AE_CTRL_DEPTH);
777 /* Walk the linked list of handlers attached to this device */
779 next_handler_obj = next_handler_obj->address_space.next;
783 * As long as the device didn't have a handler for this space we
784 * don't care about it. We just ignore it and proceed.
786 return (AE_OK);
789 /* Object is a Region */
791 if (obj_desc->region.space_id != handler_obj->address_space.space_id) {
793 /* This region is for a different address space, just ignore it */
795 return (AE_OK);
799 * Now we have a region and it is for the handler's address space type.
801 * First disconnect region for any previous handler (if any)
803 acpi_ev_detach_region(obj_desc, FALSE);
805 /* Connect the region to the new handler */
807 status = acpi_ev_attach_region(handler_obj, obj_desc, FALSE);
808 return (status);
811 /*******************************************************************************
813 * FUNCTION: acpi_ev_install_space_handler
815 * PARAMETERS: Node - Namespace node for the device
816 * space_id - The address space ID
817 * Handler - Address of the handler
818 * Setup - Address of the setup function
819 * Context - Value passed to the handler on each access
821 * RETURN: Status
823 * DESCRIPTION: Install a handler for all op_regions of a given space_id.
824 * Assumes namespace is locked
826 ******************************************************************************/
828 acpi_status
829 acpi_ev_install_space_handler(struct acpi_namespace_node * node,
830 acpi_adr_space_type space_id,
831 acpi_adr_space_handler handler,
832 acpi_adr_space_setup setup, void *context)
834 union acpi_operand_object *obj_desc;
835 union acpi_operand_object *handler_obj;
836 acpi_status status;
837 acpi_object_type type;
838 u8 flags = 0;
840 ACPI_FUNCTION_TRACE(ev_install_space_handler);
843 * This registration is valid for only the types below and the root. This
844 * is where the default handlers get placed.
846 if ((node->type != ACPI_TYPE_DEVICE) &&
847 (node->type != ACPI_TYPE_PROCESSOR) &&
848 (node->type != ACPI_TYPE_THERMAL) && (node != acpi_gbl_root_node)) {
849 status = AE_BAD_PARAMETER;
850 goto unlock_and_exit;
853 if (handler == ACPI_DEFAULT_HANDLER) {
854 flags = ACPI_ADDR_HANDLER_DEFAULT_INSTALLED;
856 switch (space_id) {
857 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
858 handler = acpi_ex_system_memory_space_handler;
859 setup = acpi_ev_system_memory_region_setup;
860 break;
862 case ACPI_ADR_SPACE_SYSTEM_IO:
863 handler = acpi_ex_system_io_space_handler;
864 setup = acpi_ev_io_space_region_setup;
865 break;
867 case ACPI_ADR_SPACE_PCI_CONFIG:
868 handler = acpi_ex_pci_config_space_handler;
869 setup = acpi_ev_pci_config_region_setup;
870 break;
872 case ACPI_ADR_SPACE_CMOS:
873 handler = acpi_ex_cmos_space_handler;
874 setup = acpi_ev_cmos_region_setup;
875 break;
877 case ACPI_ADR_SPACE_PCI_BAR_TARGET:
878 handler = acpi_ex_pci_bar_space_handler;
879 setup = acpi_ev_pci_bar_region_setup;
880 break;
882 case ACPI_ADR_SPACE_DATA_TABLE:
883 handler = acpi_ex_data_table_space_handler;
884 setup = NULL;
885 break;
887 default:
888 status = AE_BAD_PARAMETER;
889 goto unlock_and_exit;
893 /* If the caller hasn't specified a setup routine, use the default */
895 if (!setup) {
896 setup = acpi_ev_default_region_setup;
899 /* Check for an existing internal object */
901 obj_desc = acpi_ns_get_attached_object(node);
902 if (obj_desc) {
904 * The attached device object already exists. Make sure the handler
905 * is not already installed.
907 handler_obj = obj_desc->device.handler;
909 /* Walk the handler list for this device */
911 while (handler_obj) {
913 /* Same space_id indicates a handler already installed */
915 if (handler_obj->address_space.space_id == space_id) {
916 if (handler_obj->address_space.handler ==
917 handler) {
919 * It is (relatively) OK to attempt to install the SAME
920 * handler twice. This can easily happen with the
921 * PCI_Config space.
923 status = AE_SAME_HANDLER;
924 goto unlock_and_exit;
925 } else {
926 /* A handler is already installed */
928 status = AE_ALREADY_EXISTS;
930 goto unlock_and_exit;
933 /* Walk the linked list of handlers */
935 handler_obj = handler_obj->address_space.next;
937 } else {
938 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
939 "Creating object on Device %p while installing handler\n",
940 node));
942 /* obj_desc does not exist, create one */
944 if (node->type == ACPI_TYPE_ANY) {
945 type = ACPI_TYPE_DEVICE;
946 } else {
947 type = node->type;
950 obj_desc = acpi_ut_create_internal_object(type);
951 if (!obj_desc) {
952 status = AE_NO_MEMORY;
953 goto unlock_and_exit;
956 /* Init new descriptor */
958 obj_desc->common.type = (u8) type;
960 /* Attach the new object to the Node */
962 status = acpi_ns_attach_object(node, obj_desc, type);
964 /* Remove local reference to the object */
966 acpi_ut_remove_reference(obj_desc);
968 if (ACPI_FAILURE(status)) {
969 goto unlock_and_exit;
973 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
974 "Installing address handler for region %s(%X) on Device %4.4s %p(%p)\n",
975 acpi_ut_get_region_name(space_id), space_id,
976 acpi_ut_get_node_name(node), node, obj_desc));
979 * Install the handler
981 * At this point there is no existing handler. Just allocate the object
982 * for the handler and link it into the list.
984 handler_obj =
985 acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_ADDRESS_HANDLER);
986 if (!handler_obj) {
987 status = AE_NO_MEMORY;
988 goto unlock_and_exit;
991 /* Init handler obj */
993 handler_obj->address_space.space_id = (u8) space_id;
994 handler_obj->address_space.handler_flags = flags;
995 handler_obj->address_space.region_list = NULL;
996 handler_obj->address_space.node = node;
997 handler_obj->address_space.handler = handler;
998 handler_obj->address_space.context = context;
999 handler_obj->address_space.setup = setup;
1001 /* Install at head of Device.address_space list */
1003 handler_obj->address_space.next = obj_desc->device.handler;
1006 * The Device object is the first reference on the handler_obj.
1007 * Each region that uses the handler adds a reference.
1009 obj_desc->device.handler = handler_obj;
1012 * Walk the namespace finding all of the regions this
1013 * handler will manage.
1015 * Start at the device and search the branch toward
1016 * the leaf nodes until either the leaf is encountered or
1017 * a device is detected that has an address handler of the
1018 * same type.
1020 * In either case, back up and search down the remainder
1021 * of the branch
1023 status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
1024 ACPI_NS_WALK_UNLOCK,
1025 acpi_ev_install_handler, NULL,
1026 handler_obj, NULL);
1028 unlock_and_exit:
1029 return_ACPI_STATUS(status);
1032 /*******************************************************************************
1034 * FUNCTION: acpi_ev_execute_reg_methods
1036 * PARAMETERS: Node - Namespace node for the device
1037 * space_id - The address space ID
1039 * RETURN: Status
1041 * DESCRIPTION: Run all _REG methods for the input Space ID;
1042 * Note: assumes namespace is locked, or system init time.
1044 ******************************************************************************/
1046 acpi_status
1047 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
1048 acpi_adr_space_type space_id)
1050 acpi_status status;
1052 ACPI_FUNCTION_TRACE(ev_execute_reg_methods);
1055 * Run all _REG methods for all Operation Regions for this space ID. This
1056 * is a separate walk in order to handle any interdependencies between
1057 * regions and _REG methods. (i.e. handlers must be installed for all
1058 * regions of this Space ID before we can run any _REG methods)
1060 status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
1061 ACPI_NS_WALK_UNLOCK, acpi_ev_reg_run,
1062 NULL, &space_id, NULL);
1064 return_ACPI_STATUS(status);
1067 /*******************************************************************************
1069 * FUNCTION: acpi_ev_reg_run
1071 * PARAMETERS: walk_namespace callback
1073 * DESCRIPTION: Run _REG method for region objects of the requested space_iD
1075 ******************************************************************************/
1077 static acpi_status
1078 acpi_ev_reg_run(acpi_handle obj_handle,
1079 u32 level, void *context, void **return_value)
1081 union acpi_operand_object *obj_desc;
1082 struct acpi_namespace_node *node;
1083 acpi_adr_space_type space_id;
1084 acpi_status status;
1086 space_id = *ACPI_CAST_PTR(acpi_adr_space_type, context);
1088 /* Convert and validate the device handle */
1090 node = acpi_ns_map_handle_to_node(obj_handle);
1091 if (!node) {
1092 return (AE_BAD_PARAMETER);
1096 * We only care about regions.and objects that are allowed to have address
1097 * space handlers
1099 if ((node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
1100 return (AE_OK);
1103 /* Check for an existing internal object */
1105 obj_desc = acpi_ns_get_attached_object(node);
1106 if (!obj_desc) {
1108 /* No object, just exit */
1110 return (AE_OK);
1113 /* Object is a Region */
1115 if (obj_desc->region.space_id != space_id) {
1117 /* This region is for a different address space, just ignore it */
1119 return (AE_OK);
1122 status = acpi_ev_execute_reg_method(obj_desc, 1);
1123 return (status);