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