drivers/acpi/events/evxfregn.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
   4  *                         Address Spaces.
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2006, R. Byron Moore
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions, and the following disclaimer,
  17  *    without modification.
  18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  19  *    substantially similar to the "NO WARRANTY" disclaimer below
  20  *    ("Disclaimer") and any redistribution must be conditioned upon
  21  *    including a substantially similar Disclaimer requirement for further
  22  *    binary redistribution.
  23  * 3. Neither the names of the above-listed copyright holders nor the names
  24  *    of any contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * Alternatively, this software may be distributed under the terms of the
  28  * GNU General Public License ("GPL") version 2 as published by the Free
  29  * Software Foundation.
  30  *
  31  * NO WARRANTY
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42  * POSSIBILITY OF SUCH DAMAGES.
  43  */
  44
  45 #include <linux/module.h>
  46
  47 #include <acpi/acpi.h>
  48 #include <acpi/acnamesp.h>
  49 #include <acpi/acevents.h>
  50
  51 #define _COMPONENT          ACPI_EVENTS
  52 ACPI_MODULE_NAME("evxfregn")
  53
  54 /*******************************************************************************
  55  *
  56  * FUNCTION:    acpi_install_address_space_handler
  57  *
  58  * PARAMETERS:  Device          - Handle for the device
  59  *              space_id        - The address space ID
  60  *              Handler         - Address of the handler
  61  *              Setup           - Address of the setup function
  62  *              Context         - Value passed to the handler on each access
  63  *
  64  * RETURN:      Status
  65  *
  66  * DESCRIPTION: Install a handler for all op_regions of a given space_id.
  67  *
  68  ******************************************************************************/
  69 acpi_status
  70 acpi_install_address_space_handler(acpi_handle device,
  71                                    acpi_adr_space_type space_id,
  72                                    acpi_adr_space_handler handler,
  73                                    acpi_adr_space_setup setup, void *context)
  74 {
  75         struct acpi_namespace_node *node;
  76         acpi_status status;
  77
  78         ACPI_FUNCTION_TRACE("acpi_install_address_space_handler");
  79
  80         /* Parameter validation */
  81
  82         if (!device) {
  83                 return_ACPI_STATUS(AE_BAD_PARAMETER);
  84         }
  85
  86         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  87         if (ACPI_FAILURE(status)) {
  88                 return_ACPI_STATUS(status);
  89         }
  90
  91         /* Convert and validate the device handle */
  92
  93         node = acpi_ns_map_handle_to_node(device);
  94         if (!node) {
  95                 status = AE_BAD_PARAMETER;
  96                 goto unlock_and_exit;
  97         }
  98
  99         /* Install the handler for all Regions for this Space ID */
 100
 101         status =
 102             acpi_ev_install_space_handler(node, space_id, handler, setup,
 103                                           context);
 104         if (ACPI_FAILURE(status)) {
 105                 goto unlock_and_exit;
 106         }
 107
 108         /* Run all _REG methods for this address space */
 109
 110         status = acpi_ev_execute_reg_methods(node, space_id);
 111
 112       unlock_and_exit:
 113         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 114         return_ACPI_STATUS(status);
 115 }
 116
 117 EXPORT_SYMBOL(acpi_install_address_space_handler);
 118
 119 /*******************************************************************************
 120  *
 121  * FUNCTION:    acpi_remove_address_space_handler
 122  *
 123  * PARAMETERS:  Device          - Handle for the device
 124  *              space_id        - The address space ID
 125  *              Handler         - Address of the handler
 126  *
 127  * RETURN:      Status
 128  *
 129  * DESCRIPTION: Remove a previously installed handler.
 130  *
 131  ******************************************************************************/
 132
 133 acpi_status
 134 acpi_remove_address_space_handler(acpi_handle device,
 135                                   acpi_adr_space_type space_id,
 136                                   acpi_adr_space_handler handler)
 137 {
 138         union acpi_operand_object *obj_desc;
 139         union acpi_operand_object *handler_obj;
 140         union acpi_operand_object *region_obj;
 141         union acpi_operand_object **last_obj_ptr;
 142         struct acpi_namespace_node *node;
 143         acpi_status status;
 144
 145         ACPI_FUNCTION_TRACE("acpi_remove_address_space_handler");
 146
 147         /* Parameter validation */
 148
 149         if (!device) {
 150                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 151         }
 152
 153         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 154         if (ACPI_FAILURE(status)) {
 155                 return_ACPI_STATUS(status);
 156         }
 157
 158         /* Convert and validate the device handle */
 159
 160         node = acpi_ns_map_handle_to_node(device);
 161         if (!node) {
 162                 status = AE_BAD_PARAMETER;
 163                 goto unlock_and_exit;
 164         }
 165
 166         /* Make sure the internal object exists */
 167
 168         obj_desc = acpi_ns_get_attached_object(node);
 169         if (!obj_desc) {
 170                 status = AE_NOT_EXIST;
 171                 goto unlock_and_exit;
 172         }
 173
 174         /* Find the address handler the user requested */
 175
 176         handler_obj = obj_desc->device.handler;
 177         last_obj_ptr = &obj_desc->device.handler;
 178         while (handler_obj) {
 179                 /* We have a handler, see if user requested this one */
 180
 181                 if (handler_obj->address_space.space_id == space_id) {
 182                         /* Matched space_id, first dereference this in the Regions */
 183
 184                         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 185                                           "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
 186                                           handler_obj, handler,
 187                                           acpi_ut_get_region_name(space_id),
 188                                           node, obj_desc));
 189
 190                         region_obj = handler_obj->address_space.region_list;
 191
 192                         /* Walk the handler's region list */
 193
 194                         while (region_obj) {
 195                                 /*
 196                                  * First disassociate the handler from the region.
 197                                  *
 198                                  * NOTE: this doesn't mean that the region goes away
 199                                  * The region is just inaccessible as indicated to
 200                                  * the _REG method
 201                                  */
 202                                 acpi_ev_detach_region(region_obj, TRUE);
 203
 204                                 /*
 205                                  * Walk the list: Just grab the head because the
 206                                  * detach_region removed the previous head.
 207                                  */
 208                                 region_obj =
 209                                     handler_obj->address_space.region_list;
 210
 211                         }
 212
 213                         /* Remove this Handler object from the list */
 214
 215                         *last_obj_ptr = handler_obj->address_space.next;
 216
 217                         /* Now we can delete the handler object */
 218
 219                         acpi_ut_remove_reference(handler_obj);
 220                         goto unlock_and_exit;
 221                 }
 222
 223                 /* Walk the linked list of handlers */
 224
 225                 last_obj_ptr = &handler_obj->address_space.next;
 226                 handler_obj = handler_obj->address_space.next;
 227         }
 228
 229         /* The handler does not exist */
 230
 231         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 232                           "Unable to remove address handler %p for %s(%X), dev_node %p, obj %p\n",
 233                           handler, acpi_ut_get_region_name(space_id), space_id,
 234                           node, obj_desc));
 235
 236         status = AE_NOT_EXIST;
 237
 238       unlock_and_exit:
 239         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 240         return_ACPI_STATUS(status);
 241 }
 242
 243 EXPORT_SYMBOL(acpi_remove_address_space_handler);