drivers/acpi/hardware/hwgpe.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: hwgpe - Low level GPE enable/disable/clear functions
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2007, 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 <acpi/acpi.h>
  46 #include <acpi/acevents.h>
  47
  48 #define _COMPONENT          ACPI_HARDWARE
  49 ACPI_MODULE_NAME("hwgpe")
  50
  51 /* Local prototypes */
  52 static acpi_status
  53 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
  54                                 struct acpi_gpe_block_info *gpe_block);
  55
  56 /******************************************************************************
  57  *
  58  * FUNCTION:    acpi_hw_write_gpe_enable_reg
  59  *
  60  * PARAMETERS:  gpe_event_info      - Info block for the GPE to be enabled
  61  *
  62  * RETURN:      Status
  63  *
  64  * DESCRIPTION: Write a GPE enable register.  Note: The bit for this GPE must
  65  *              already be cleared or set in the parent register
  66  *              enable_for_run mask.
  67  *
  68  ******************************************************************************/
  69
  70 acpi_status
  71 acpi_hw_write_gpe_enable_reg(struct acpi_gpe_event_info *gpe_event_info)
  72 {
  73         struct acpi_gpe_register_info *gpe_register_info;
  74         acpi_status status;
  75
  76         ACPI_FUNCTION_ENTRY();
  77
  78         /* Get the info block for the entire GPE register */
  79
  80         gpe_register_info = gpe_event_info->register_info;
  81         if (!gpe_register_info) {
  82                 return (AE_NOT_EXIST);
  83         }
  84
  85         /* Write the entire GPE (runtime) enable register */
  86
  87         status = acpi_hw_low_level_write(8, gpe_register_info->enable_for_run,
  88                                          &gpe_register_info->enable_address);
  89
  90         return (status);
  91 }
  92
  93 /******************************************************************************
  94  *
  95  * FUNCTION:    acpi_hw_clear_gpe
  96  *
  97  * PARAMETERS:  gpe_event_info      - Info block for the GPE to be cleared
  98  *
  99  * RETURN:      Status
 100  *
 101  * DESCRIPTION: Clear the status bit for a single GPE.
 102  *
 103  ******************************************************************************/
 104
 105 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info * gpe_event_info)
 106 {
 107         acpi_status status;
 108         u8 register_bit;
 109
 110         ACPI_FUNCTION_ENTRY();
 111
 112         register_bit = (u8)
 113             (1 <<
 114              (gpe_event_info->gpe_number -
 115               gpe_event_info->register_info->base_gpe_number));
 116
 117         /*
 118          * Write a one to the appropriate bit in the status register to
 119          * clear this GPE.
 120          */
 121         status = acpi_hw_low_level_write(8, register_bit,
 122                                          &gpe_event_info->register_info->
 123                                          status_address);
 124
 125         return (status);
 126 }
 127
 128 /******************************************************************************
 129  *
 130  * FUNCTION:    acpi_hw_get_gpe_status
 131  *
 132  * PARAMETERS:  gpe_event_info      - Info block for the GPE to queried
 133  *              event_status        - Where the GPE status is returned
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: Return the status of a single GPE.
 138  *
 139  ******************************************************************************/
 140
 141 #ifdef ACPI_FUTURE_USAGE
 142 acpi_status
 143 acpi_hw_get_gpe_status(struct acpi_gpe_event_info * gpe_event_info,
 144                        acpi_event_status * event_status)
 145 {
 146         u32 in_byte;
 147         u8 register_bit;
 148         struct acpi_gpe_register_info *gpe_register_info;
 149         acpi_status status;
 150         acpi_event_status local_event_status = 0;
 151
 152         ACPI_FUNCTION_ENTRY();
 153
 154         if (!event_status) {
 155                 return (AE_BAD_PARAMETER);
 156         }
 157
 158         /* Get the info block for the entire GPE register */
 159
 160         gpe_register_info = gpe_event_info->register_info;
 161
 162         /* Get the register bitmask for this GPE */
 163
 164         register_bit = (u8)
 165             (1 <<
 166              (gpe_event_info->gpe_number -
 167               gpe_event_info->register_info->base_gpe_number));
 168
 169         /* GPE currently enabled? (enabled for runtime?) */
 170
 171         if (register_bit & gpe_register_info->enable_for_run) {
 172                 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
 173         }
 174
 175         /* GPE enabled for wake? */
 176
 177         if (register_bit & gpe_register_info->enable_for_wake) {
 178                 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
 179         }
 180
 181         /* GPE currently active (status bit == 1)? */
 182
 183         status =
 184             acpi_hw_low_level_read(8, &in_byte,
 185                                    &gpe_register_info->status_address);
 186         if (ACPI_FAILURE(status)) {
 187                 goto unlock_and_exit;
 188         }
 189
 190         if (register_bit & in_byte) {
 191                 local_event_status |= ACPI_EVENT_FLAG_SET;
 192         }
 193
 194         /* Set return value */
 195
 196         (*event_status) = local_event_status;
 197
 198       unlock_and_exit:
 199         return (status);
 200 }
 201 #endif                          /*  ACPI_FUTURE_USAGE  */
 202
 203 /******************************************************************************
 204  *
 205  * FUNCTION:    acpi_hw_disable_gpe_block
 206  *
 207  * PARAMETERS:  gpe_xrupt_info      - GPE Interrupt info
 208  *              gpe_block           - Gpe Block info
 209  *
 210  * RETURN:      Status
 211  *
 212  * DESCRIPTION: Disable all GPEs within a single GPE block
 213  *
 214  ******************************************************************************/
 215
 216 acpi_status
 217 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info * gpe_xrupt_info,
 218                           struct acpi_gpe_block_info * gpe_block)
 219 {
 220         u32 i;
 221         acpi_status status;
 222
 223         /* Examine each GPE Register within the block */
 224
 225         for (i = 0; i < gpe_block->register_count; i++) {
 226
 227                 /* Disable all GPEs in this register */
 228
 229                 status = acpi_hw_low_level_write(8, 0x00,
 230                                                  &gpe_block->register_info[i].
 231                                                  enable_address);
 232                 if (ACPI_FAILURE(status)) {
 233                         return (status);
 234                 }
 235         }
 236
 237         return (AE_OK);
 238 }
 239
 240 /******************************************************************************
 241  *
 242  * FUNCTION:    acpi_hw_clear_gpe_block
 243  *
 244  * PARAMETERS:  gpe_xrupt_info      - GPE Interrupt info
 245  *              gpe_block           - Gpe Block info
 246  *
 247  * RETURN:      Status
 248  *
 249  * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
 250  *
 251  ******************************************************************************/
 252
 253 acpi_status
 254 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info * gpe_xrupt_info,
 255                         struct acpi_gpe_block_info * gpe_block)
 256 {
 257         u32 i;
 258         acpi_status status;
 259
 260         /* Examine each GPE Register within the block */
 261
 262         for (i = 0; i < gpe_block->register_count; i++) {
 263
 264                 /* Clear status on all GPEs in this register */
 265
 266                 status = acpi_hw_low_level_write(8, 0xFF,
 267                                                  &gpe_block->register_info[i].
 268                                                  status_address);
 269                 if (ACPI_FAILURE(status)) {
 270                         return (status);
 271                 }
 272         }
 273
 274         return (AE_OK);
 275 }
 276
 277 /******************************************************************************
 278  *
 279  * FUNCTION:    acpi_hw_enable_runtime_gpe_block
 280  *
 281  * PARAMETERS:  gpe_xrupt_info      - GPE Interrupt info
 282  *              gpe_block           - Gpe Block info
 283  *
 284  * RETURN:      Status
 285  *
 286  * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
 287  *              combination wake/run GPEs.
 288  *
 289  ******************************************************************************/
 290
 291 acpi_status
 292 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info * gpe_xrupt_info,
 293                                  struct acpi_gpe_block_info * gpe_block)
 294 {
 295         u32 i;
 296         acpi_status status;
 297
 298         /* NOTE: assumes that all GPEs are currently disabled */
 299
 300         /* Examine each GPE Register within the block */
 301
 302         for (i = 0; i < gpe_block->register_count; i++) {
 303                 if (!gpe_block->register_info[i].enable_for_run) {
 304                         continue;
 305                 }
 306
 307                 /* Enable all "runtime" GPEs in this register */
 308
 309                 status =
 310                     acpi_hw_low_level_write(8,
 311                                             gpe_block->register_info[i].
 312                                             enable_for_run,
 313                                             &gpe_block->register_info[i].
 314                                             enable_address);
 315                 if (ACPI_FAILURE(status)) {
 316                         return (status);
 317                 }
 318         }
 319
 320         return (AE_OK);
 321 }
 322
 323 /******************************************************************************
 324  *
 325  * FUNCTION:    acpi_hw_enable_wakeup_gpe_block
 326  *
 327  * PARAMETERS:  gpe_xrupt_info      - GPE Interrupt info
 328  *              gpe_block           - Gpe Block info
 329  *
 330  * RETURN:      Status
 331  *
 332  * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
 333  *              combination wake/run GPEs.
 334  *
 335  ******************************************************************************/
 336
 337 static acpi_status
 338 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 339                                 struct acpi_gpe_block_info *gpe_block)
 340 {
 341         u32 i;
 342         acpi_status status;
 343
 344         /* Examine each GPE Register within the block */
 345
 346         for (i = 0; i < gpe_block->register_count; i++) {
 347                 if (!gpe_block->register_info[i].enable_for_wake) {
 348                         continue;
 349                 }
 350
 351                 /* Enable all "wake" GPEs in this register */
 352
 353                 status = acpi_hw_low_level_write(8,
 354                                                  gpe_block->register_info[i].
 355                                                  enable_for_wake,
 356                                                  &gpe_block->register_info[i].
 357                                                  enable_address);
 358                 if (ACPI_FAILURE(status)) {
 359                         return (status);
 360                 }
 361         }
 362
 363         return (AE_OK);
 364 }
 365
 366 /******************************************************************************
 367  *
 368  * FUNCTION:    acpi_hw_disable_all_gpes
 369  *
 370  * PARAMETERS:  None
 371  *
 372  * RETURN:      Status
 373  *
 374  * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
 375  *
 376  ******************************************************************************/
 377
 378 acpi_status acpi_hw_disable_all_gpes(void)
 379 {
 380         acpi_status status;
 381
 382         ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
 383
 384         status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block);
 385         status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block);
 386         return_ACPI_STATUS(status);
 387 }
 388
 389 /******************************************************************************
 390  *
 391  * FUNCTION:    acpi_hw_enable_all_runtime_gpes
 392  *
 393  * PARAMETERS:  None
 394  *
 395  * RETURN:      Status
 396  *
 397  * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
 398  *
 399  ******************************************************************************/
 400
 401 acpi_status acpi_hw_enable_all_runtime_gpes(void)
 402 {
 403         acpi_status status;
 404
 405         ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
 406
 407         status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block);
 408         return_ACPI_STATUS(status);
 409 }
 410
 411 /******************************************************************************
 412  *
 413  * FUNCTION:    acpi_hw_enable_all_wakeup_gpes
 414  *
 415  * PARAMETERS:  None
 416  *
 417  * RETURN:      Status
 418  *
 419  * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
 420  *
 421  ******************************************************************************/
 422
 423 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
 424 {
 425         acpi_status status;
 426
 427         ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
 428
 429         status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block);
 430         return_ACPI_STATUS(status);
 431 }