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 - 2005, 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  *
  57  * FUNCTION:    acpi_install_address_space_handler
  58  *
  59  * PARAMETERS:  Device          - Handle for the device
  60  *              space_id        - The address space ID
  61  *              Handler         - Address of the handler
  62  *              Setup           - Address of the setup function
  63  *              Context         - Value passed to the handler on each access
  64  *
  65  * RETURN:      Status
  66  *
  67  * DESCRIPTION: Install a handler for all op_regions of a given space_id.
  68  *
  69  ******************************************************************************/
  70
  71 acpi_status
  72 acpi_install_address_space_handler (
  73         acpi_handle                     device,
  74         acpi_adr_space_type             space_id,
  75         acpi_adr_space_handler          handler,
  76         acpi_adr_space_setup            setup,
  77         void                            *context)
  78 {
  79         struct acpi_namespace_node      *node;
  80         acpi_status                     status;
  81
  82
  83         ACPI_FUNCTION_TRACE ("acpi_install_address_space_handler");
  84
  85
  86         /* Parameter validation */
  87
  88         if (!device) {
  89                 return_ACPI_STATUS (AE_BAD_PARAMETER);
  90         }
  91
  92         status = acpi_ut_acquire_mutex (ACPI_MTX_NAMESPACE);
  93         if (ACPI_FAILURE (status)) {
  94                 return_ACPI_STATUS (status);
  95         }
  96
  97         /* Convert and validate the device handle */
  98
  99         node = acpi_ns_map_handle_to_node (device);
 100         if (!node) {
 101                 status = AE_BAD_PARAMETER;
 102                 goto unlock_and_exit;
 103         }
 104
 105         /* Install the handler for all Regions for this Space ID */
 106
 107         status = acpi_ev_install_space_handler (node, space_id, handler, setup, context);
 108         if (ACPI_FAILURE (status)) {
 109                 goto unlock_and_exit;
 110         }
 111
 112         /* Run all _REG methods for this address space */
 113
 114         status = acpi_ev_execute_reg_methods (node, space_id);
 115
 116 unlock_and_exit:
 117         (void) acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);
 118         return_ACPI_STATUS (status);
 119 }
 120 EXPORT_SYMBOL(acpi_install_address_space_handler);
 121
 122
 123 /*******************************************************************************
 124  *
 125  * FUNCTION:    acpi_remove_address_space_handler
 126  *
 127  * PARAMETERS:  Device          - Handle for the device
 128  *              space_id        - The address space ID
 129  *              Handler         - Address of the handler
 130  *
 131  * RETURN:      Status
 132  *
 133  * DESCRIPTION: Remove a previously installed handler.
 134  *
 135  ******************************************************************************/
 136
 137 acpi_status
 138 acpi_remove_address_space_handler (
 139         acpi_handle                     device,
 140         acpi_adr_space_type             space_id,
 141         acpi_adr_space_handler          handler)
 142 {
 143         union acpi_operand_object       *obj_desc;
 144         union acpi_operand_object       *handler_obj;
 145         union acpi_operand_object       *region_obj;
 146         union acpi_operand_object       **last_obj_ptr;
 147         struct acpi_namespace_node      *node;
 148         acpi_status                     status;
 149
 150
 151         ACPI_FUNCTION_TRACE ("acpi_remove_address_space_handler");
 152
 153
 154         /* Parameter validation */
 155
 156         if (!device) {
 157                 return_ACPI_STATUS (AE_BAD_PARAMETER);
 158         }
 159
 160         status = acpi_ut_acquire_mutex (ACPI_MTX_NAMESPACE);
 161         if (ACPI_FAILURE (status)) {
 162                 return_ACPI_STATUS (status);
 163         }
 164
 165         /* Convert and validate the device handle */
 166
 167         node = acpi_ns_map_handle_to_node (device);
 168         if (!node) {
 169                 status = AE_BAD_PARAMETER;
 170                 goto unlock_and_exit;
 171         }
 172
 173         /* Make sure the internal object exists */
 174
 175         obj_desc = acpi_ns_get_attached_object (node);
 176         if (!obj_desc) {
 177                 status = AE_NOT_EXIST;
 178                 goto unlock_and_exit;
 179         }
 180
 181         /* Find the address handler the user requested */
 182
 183         handler_obj = obj_desc->device.handler;
 184         last_obj_ptr = &obj_desc->device.handler;
 185         while (handler_obj) {
 186                 /* We have a handler, see if user requested this one */
 187
 188                 if (handler_obj->address_space.space_id == space_id) {
 189                         /* Matched space_id, first dereference this in the Regions */
 190
 191                         ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 192                                 "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
 193                                 handler_obj, handler, acpi_ut_get_region_name (space_id),
 194                                 node, obj_desc));
 195
 196                         region_obj = handler_obj->address_space.region_list;
 197
 198                         /* Walk the handler's region list */
 199
 200                         while (region_obj) {
 201                                 /*
 202                                  * First disassociate the handler from the region.
 203                                  *
 204                                  * NOTE: this doesn't mean that the region goes away
 205                                  * The region is just inaccessible as indicated to
 206                                  * the _REG method
 207                                  */
 208                                 acpi_ev_detach_region (region_obj, TRUE);
 209
 210                                 /*
 211                                  * Walk the list: Just grab the head because the
 212                                  * detach_region removed the previous head.
 213                                  */
 214                                 region_obj = handler_obj->address_space.region_list;
 215
 216                         }
 217
 218                         /* Remove this Handler object from the list */
 219
 220                         *last_obj_ptr = handler_obj->address_space.next;
 221
 222                         /* Now we can delete the handler object */
 223
 224                         acpi_ut_remove_reference (handler_obj);
 225                         goto unlock_and_exit;
 226                 }
 227
 228                 /* Walk the linked list of handlers */
 229
 230                 last_obj_ptr = &handler_obj->address_space.next;
 231                 handler_obj = handler_obj->address_space.next;
 232         }
 233
 234         /* The handler does not exist */
 235
 236         ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 237                 "Unable to remove address handler %p for %s(%X), dev_node %p, obj %p\n",
 238                 handler, acpi_ut_get_region_name (space_id), space_id, node, obj_desc));
 239
 240         status = AE_NOT_EXIST;
 241
 242 unlock_and_exit:
 243         (void) acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);
 244         return_ACPI_STATUS (status);
 245 }
 246 EXPORT_SYMBOL(acpi_remove_address_space_handler);
 247