drivers/acpi/events/evxfregn.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
   4  *                         Address Spaces.
   5  *              $Revision: 24 $
   6  *
   7  *****************************************************************************/
   8
   9 /*
  10  *  Copyright (C) 2000 R. Byron Moore
  11  *
  12  *  This program is free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2 of the License, or
  15  *  (at your option) any later version.
  16  *
  17  *  This program is distributed in the hope that it will be useful,
  18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *  GNU General Public License for more details.
  21  *
  22  *  You should have received a copy of the GNU General Public License
  23  *  along with this program; if not, write to the Free Software
  24  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25  */
  26
  27
  28 #include "acpi.h"
  29 #include "achware.h"
  30 #include "acnamesp.h"
  31 #include "acevents.h"
  32 #include "amlcode.h"
  33 #include "acinterp.h"
  34
  35 #define _COMPONENT          EVENT_HANDLING
  36          MODULE_NAME         ("evxfregn")
  37
  38
  39 /******************************************************************************
  40  *
  41  * FUNCTION:    Acpi_install_address_space_handler
  42  *
  43  * PARAMETERS:  Device          - Handle for the device
  44  *              Space_id        - The address space ID
  45  *              Handler         - Address of the handler
  46  *              Setup           - Address of the setup function
  47  *              Context         - Value passed to the handler on each access
  48  *
  49  * RETURN:      Status
  50  *
  51  * DESCRIPTION: Install a handler for all Op_regions of a given Space_id.
  52  *
  53  ******************************************************************************/
  54
  55 ACPI_STATUS
  56 acpi_install_address_space_handler (
  57         ACPI_HANDLE             device,
  58         ACPI_ADDRESS_SPACE_TYPE space_id,
  59         ADDRESS_SPACE_HANDLER   handler,
  60         ADDRESS_SPACE_SETUP     setup,
  61         void                    *context)
  62 {
  63         ACPI_OPERAND_OBJECT     *obj_desc;
  64         ACPI_OPERAND_OBJECT     *handler_obj;
  65         ACPI_NAMESPACE_NODE     *node;
  66         ACPI_STATUS             status = AE_OK;
  67         OBJECT_TYPE_INTERNAL    type;
  68         u16                     flags = 0;
  69
  70
  71         /* Parameter validation */
  72
  73         if ((!device)   ||
  74                 ((!handler)  && (handler != ACPI_DEFAULT_HANDLER)) ||
  75                 (space_id > ACPI_MAX_ADDRESS_SPACE))
  76         {
  77                 return (AE_BAD_PARAMETER);
  78         }
  79
  80         acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE);
  81
  82         /* Convert and validate the device handle */
  83
  84         node = acpi_ns_convert_handle_to_entry (device);
  85         if (!node) {
  86                 status = AE_BAD_PARAMETER;
  87                 goto unlock_and_exit;
  88         }
  89
  90         /*
  91          *  This registration is valid for only the types below
  92          *  and the root.  This is where the default handlers
  93          *  get placed.
  94          */
  95
  96         if ((node->type != ACPI_TYPE_DEVICE)     &&
  97                 (node->type != ACPI_TYPE_PROCESSOR)  &&
  98                 (node->type != ACPI_TYPE_THERMAL)    &&
  99                 (node != acpi_gbl_root_node))
 100         {
 101                 status = AE_BAD_PARAMETER;
 102                 goto unlock_and_exit;
 103         }
 104
 105         if (handler == ACPI_DEFAULT_HANDLER) {
 106                 flags = ADDR_HANDLER_DEFAULT_INSTALLED;
 107
 108                 switch (space_id)
 109                 {
 110                 case ADDRESS_SPACE_SYSTEM_MEMORY:
 111                         handler = acpi_aml_system_memory_space_handler;
 112                         setup = acpi_ev_system_memory_region_setup;
 113                         break;
 114
 115                 case ADDRESS_SPACE_SYSTEM_IO:
 116                         handler = acpi_aml_system_io_space_handler;
 117                         setup = acpi_ev_io_space_region_setup;
 118                         break;
 119
 120                 case ADDRESS_SPACE_PCI_CONFIG:
 121                         handler = acpi_aml_pci_config_space_handler;
 122                         setup = acpi_ev_pci_config_region_setup;
 123                         break;
 124
 125                 default:
 126                         status = AE_NOT_EXIST;
 127                         goto unlock_and_exit;
 128                         break;
 129                 }
 130         }
 131
 132         /*
 133          *  If the caller hasn't specified a setup routine, use the default
 134          */
 135         if (!setup) {
 136                 setup = acpi_ev_default_region_setup;
 137         }
 138
 139         /*
 140          *  Check for an existing internal object
 141          */
 142
 143         obj_desc = acpi_ns_get_attached_object ((ACPI_HANDLE) node);
 144         if (obj_desc) {
 145                 /*
 146                  *  The object exists.
 147                  *  Make sure the handler is not already installed.
 148                  */
 149
 150                 /* check the address handler the user requested */
 151
 152                 handler_obj = obj_desc->device.addr_handler;
 153                 while (handler_obj) {
 154                         /*
 155                          *  We have an Address handler, see if user requested this
 156                          *  address space.
 157                          */
 158                         if(handler_obj->addr_handler.space_id == space_id) {
 159                                 status = AE_EXIST;
 160                                 goto unlock_and_exit;
 161                         }
 162
 163                         /*
 164                          *  Move through the linked list of handlers
 165                          */
 166                         handler_obj = handler_obj->addr_handler.next;
 167                 }
 168         }
 169
 170         else {
 171                 /* Obj_desc does not exist, create one */
 172
 173                 if (node->type == ACPI_TYPE_ANY) {
 174                         type = ACPI_TYPE_DEVICE;
 175                 }
 176
 177                 else {
 178                         type = node->type;
 179                 }
 180
 181                 obj_desc = acpi_cm_create_internal_object (type);
 182                 if (!obj_desc) {
 183                         status = AE_NO_MEMORY;
 184                         goto unlock_and_exit;
 185                 }
 186
 187                 /* Init new descriptor */
 188
 189                 obj_desc->common.type = (u8) type;
 190
 191                 /* Attach the new object to the Node */
 192
 193                 status = acpi_ns_attach_object (node, obj_desc, (u8) type);
 194                 if (ACPI_FAILURE (status)) {
 195                         acpi_cm_remove_reference (obj_desc);
 196                         goto unlock_and_exit;
 197                 }
 198         }
 199
 200         /*
 201          *  Now we can install the handler
 202          *
 203          *  At this point we know that there is no existing handler.
 204          *  So, we just allocate the object for the handler and link it
 205          *  into the list.
 206          */
 207         handler_obj = acpi_cm_create_internal_object (INTERNAL_TYPE_ADDRESS_HANDLER);
 208         if (!handler_obj) {
 209                 status = AE_NO_MEMORY;
 210                 goto unlock_and_exit;
 211         }
 212
 213         handler_obj->addr_handler.space_id  = (u8) space_id;
 214         handler_obj->addr_handler.hflags    = flags;
 215         handler_obj->addr_handler.next      = obj_desc->device.addr_handler;
 216         handler_obj->addr_handler.region_list = NULL;
 217         handler_obj->addr_handler.node      = node;
 218         handler_obj->addr_handler.handler   = handler;
 219         handler_obj->addr_handler.context   = context;
 220         handler_obj->addr_handler.setup     = setup;
 221
 222         /*
 223          *  Now walk the namespace finding all of the regions this
 224          *  handler will manage.
 225          *
 226          *  We start at the device and search the branch toward
 227          *  the leaf nodes until either the leaf is encountered or
 228          *  a device is detected that has an address handler of the
 229          *  same type.
 230          *
 231          *  In either case we back up and search down the remainder
 232          *  of the branch
 233          */
 234         status = acpi_ns_walk_namespace (ACPI_TYPE_ANY, device,
 235                          ACPI_UINT32_MAX, NS_WALK_UNLOCK,
 236                          acpi_ev_addr_handler_helper,
 237                          handler_obj, NULL);
 238
 239         /*
 240          *  Place this handler 1st on the list
 241          */
 242
 243         handler_obj->common.reference_count =
 244                          (u16) (handler_obj->common.reference_count +
 245                          obj_desc->common.reference_count - 1);
 246         obj_desc->device.addr_handler = handler_obj;
 247
 248
 249 unlock_and_exit:
 250         acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);
 251         return (status);
 252 }
 253
 254
 255 /******************************************************************************
 256  *
 257  * FUNCTION:    Acpi_remove_address_space_handler
 258  *
 259  * PARAMETERS:  Space_id        - The address space ID
 260  *              Handler         - Address of the handler
 261  *
 262  * RETURN:      Status
 263  *
 264  * DESCRIPTION: Install a handler for accesses on an Operation Region
 265  *
 266  ******************************************************************************/
 267
 268 ACPI_STATUS
 269 acpi_remove_address_space_handler (
 270         ACPI_HANDLE             device,
 271         ACPI_ADDRESS_SPACE_TYPE space_id,
 272         ADDRESS_SPACE_HANDLER   handler)
 273 {
 274         ACPI_OPERAND_OBJECT     *obj_desc;
 275         ACPI_OPERAND_OBJECT     *handler_obj;
 276         ACPI_OPERAND_OBJECT     *region_obj;
 277         ACPI_OPERAND_OBJECT     **last_obj_ptr;
 278         ACPI_NAMESPACE_NODE     *node;
 279         ACPI_STATUS             status = AE_OK;
 280
 281
 282         /* Parameter validation */
 283
 284         if ((!device)   ||
 285                 ((!handler)  && (handler != ACPI_DEFAULT_HANDLER)) ||
 286                 (space_id > ACPI_MAX_ADDRESS_SPACE))
 287         {
 288                 return (AE_BAD_PARAMETER);
 289         }
 290
 291         acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE);
 292
 293         /* Convert and validate the device handle */
 294
 295         node = acpi_ns_convert_handle_to_entry (device);
 296         if (!node) {
 297                 status = AE_BAD_PARAMETER;
 298                 goto unlock_and_exit;
 299         }
 300
 301
 302         /* Make sure the internal object exists */
 303
 304         obj_desc = acpi_ns_get_attached_object ((ACPI_HANDLE) node);
 305         if (!obj_desc) {
 306                 /*
 307                  *  The object DNE.
 308                  */
 309                 status = AE_NOT_EXIST;
 310                 goto unlock_and_exit;
 311         }
 312
 313         /*
 314          *  find the address handler the user requested
 315          */
 316
 317         handler_obj = obj_desc->device.addr_handler;
 318         last_obj_ptr = &obj_desc->device.addr_handler;
 319         while (handler_obj) {
 320                 /*
 321                  *  We have a handler, see if user requested this one
 322                  */
 323
 324                 if(handler_obj->addr_handler.space_id == space_id) {
 325                         /*
 326                          *  Got it, first dereference this in the Regions
 327                          */
 328                         region_obj = handler_obj->addr_handler.region_list;
 329
 330                         /* Walk the handler's region list */
 331
 332                         while (region_obj) {
 333                                 /*
 334                                  *  First disassociate the handler from the region.
 335                                  *
 336                                  *  NOTE: this doesn't mean that the region goes away
 337                                  *  The region is just inaccessible as indicated to
 338                                  *  the _REG method
 339                                  */
 340                                 acpi_ev_disassociate_region_from_handler(region_obj);
 341
 342                                 /*
 343                                  *  Walk the list, since we took the first region and it
 344                                  *  was removed from the list by the dissassociate call
 345                                  *  we just get the first item on the list again
 346                                  */
 347                                 region_obj = handler_obj->addr_handler.region_list;
 348
 349                         }
 350
 351                         /*
 352                          *  Remove this Handler object from the list
 353                          */
 354                         *last_obj_ptr = handler_obj->addr_handler.next;
 355
 356                         /*
 357                          *  Now we can delete the handler object
 358                          */
 359                         acpi_cm_remove_reference (handler_obj);
 360                         acpi_cm_remove_reference (handler_obj);
 361
 362                         goto unlock_and_exit;
 363                 }
 364
 365                 /*
 366                  *  Move through the linked list of handlers
 367                  */
 368                 last_obj_ptr = &handler_obj->addr_handler.next;
 369                 handler_obj = handler_obj->addr_handler.next;
 370         }
 371
 372
 373         /*
 374          *  The handler does not exist
 375          */
 376         status = AE_NOT_EXIST;
 377
 378
 379 unlock_and_exit:
 380         acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);
 381         return (status);
 382 }
 383
 384