sys/contrib/dev/acpica/evxfevnt.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
   4  *              $Revision: 62 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial prton of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/evxfevnt.c,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 117
 118
 119 #define __EVXFEVNT_C__
 120
 121 #include "acpi.h"
 122 #include "acevents.h"
 123
 124 #define _COMPONENT          ACPI_EVENTS
 125         ACPI_MODULE_NAME    ("evxfevnt")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiEnable
 131  *
 132  * PARAMETERS:  None
 133  *
 134  * RETURN:      Status
 135  *
 136  * DESCRIPTION: Transfers the system into ACPI mode.
 137  *
 138  ******************************************************************************/
 139
 140 ACPI_STATUS
 141 AcpiEnable (void)
 142 {
 143     ACPI_STATUS             Status = AE_OK;
 144
 145
 146     ACPI_FUNCTION_TRACE ("AcpiEnable");
 147
 148
 149     /* Make sure we have the FADT*/
 150
 151     if (!AcpiGbl_FADT)
 152     {
 153         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "No FADT information present!\n"));
 154         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 155     }
 156
 157     if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
 158     {
 159         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in ACPI mode\n"));
 160     }
 161     else
 162     {
 163         /* Transition to ACPI mode */
 164
 165         Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
 166         if (ACPI_FAILURE (Status))
 167         {
 168             ACPI_REPORT_ERROR (("Could not transition to ACPI mode.\n"));
 169             return_ACPI_STATUS (Status);
 170         }
 171
 172         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Transition to ACPI mode successful\n"));
 173     }
 174
 175     return_ACPI_STATUS (Status);
 176 }
 177
 178
 179 /*******************************************************************************
 180  *
 181  * FUNCTION:    AcpiDisable
 182  *
 183  * PARAMETERS:  None
 184  *
 185  * RETURN:      Status
 186  *
 187  * DESCRIPTION: Transfers the system into LEGACY mode.
 188  *
 189  ******************************************************************************/
 190
 191 ACPI_STATUS
 192 AcpiDisable (void)
 193 {
 194     ACPI_STATUS             Status = AE_OK;
 195
 196
 197     ACPI_FUNCTION_TRACE ("AcpiDisable");
 198
 199     if (!AcpiGbl_FADT)
 200     {
 201         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "No FADT information present!\n"));
 202         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 203     }
 204
 205     if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
 206     {
 207         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in legacy (non-ACPI) mode\n"));
 208     }
 209     else
 210     {
 211         /* Transition to LEGACY mode */
 212
 213         Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
 214
 215         if (ACPI_FAILURE (Status))
 216         {
 217             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not exit ACPI mode to legacy mode"));
 218             return_ACPI_STATUS (Status);
 219         }
 220
 221         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI mode disabled\n"));
 222     }
 223
 224     return_ACPI_STATUS (Status);
 225 }
 226
 227
 228 /*******************************************************************************
 229  *
 230  * FUNCTION:    AcpiEnableEvent
 231  *
 232  * PARAMETERS:  Event           - The fixed event or GPE to be enabled
 233  *              Type            - The type of event
 234  *              Flags           - Just enable, or also wake enable?
 235  *
 236  * RETURN:      Status
 237  *
 238  * DESCRIPTION: Enable an ACPI event (fixed and general purpose)
 239  *
 240  ******************************************************************************/
 241
 242 ACPI_STATUS
 243 AcpiEnableEvent (
 244     UINT32                  Event,
 245     UINT32                  Type,
 246     UINT32                  Flags)
 247 {
 248     ACPI_STATUS             Status = AE_OK;
 249     UINT32                  Value;
 250     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 251
 252
 253     ACPI_FUNCTION_TRACE ("AcpiEnableEvent");
 254
 255
 256     /* The Type must be either Fixed Event or GPE */
 257
 258     switch (Type)
 259     {
 260     case ACPI_EVENT_FIXED:
 261
 262         /* Decode the Fixed Event */
 263
 264         if (Event > ACPI_EVENT_MAX)
 265         {
 266             return_ACPI_STATUS (AE_BAD_PARAMETER);
 267         }
 268
 269         /*
 270          * Enable the requested fixed event (by writing a one to the
 271          * enable register bit)
 272          */
 273         Status = AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 274                     1, ACPI_MTX_LOCK);
 275         if (ACPI_FAILURE (Status))
 276         {
 277             return_ACPI_STATUS (Status);
 278         }
 279
 280         /* Make sure that the hardware responded */
 281
 282         Status = AcpiGetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 283                         &Value, ACPI_MTX_LOCK);
 284         if (ACPI_FAILURE (Status))
 285         {
 286             return_ACPI_STATUS (Status);
 287         }
 288
 289         if (Value != 1)
 290         {
 291             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 292                 "Could not enable %s event\n", AcpiUtGetEventName (Event)));
 293             return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
 294         }
 295         break;
 296
 297
 298     case ACPI_EVENT_GPE:
 299
 300         /* Ensure that we have a valid GPE number */
 301
 302         GpeEventInfo = AcpiEvGetGpeEventInfo (Event);
 303         if (!GpeEventInfo)
 304         {
 305             return_ACPI_STATUS (AE_BAD_PARAMETER);
 306         }
 307
 308         /* Enable the requested GPE number */
 309
 310         Status = AcpiHwEnableGpe (GpeEventInfo);
 311         if (ACPI_FAILURE (Status))
 312         {
 313             return_ACPI_STATUS (Status);
 314         }
 315
 316         if (Flags & ACPI_EVENT_WAKE_ENABLE)
 317         {
 318             AcpiHwEnableGpeForWakeup (GpeEventInfo);
 319         }
 320         break;
 321
 322
 323     default:
 324
 325         Status = AE_BAD_PARAMETER;
 326     }
 327
 328     return_ACPI_STATUS (Status);
 329 }
 330
 331
 332 /*******************************************************************************
 333  *
 334  * FUNCTION:    AcpiDisableEvent
 335  *
 336  * PARAMETERS:  Event           - The fixed event or GPE to be enabled
 337  *              Type            - The type of event, fixed or general purpose
 338  *              Flags           - Wake disable vs. non-wake disable
 339  *
 340  * RETURN:      Status
 341  *
 342  * DESCRIPTION: Disable an ACPI event (fixed and general purpose)
 343  *
 344  ******************************************************************************/
 345
 346 ACPI_STATUS
 347 AcpiDisableEvent (
 348     UINT32                  Event,
 349     UINT32                  Type,
 350     UINT32                  Flags)
 351 {
 352     ACPI_STATUS             Status = AE_OK;
 353     UINT32                  Value;
 354     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 355
 356
 357     ACPI_FUNCTION_TRACE ("AcpiDisableEvent");
 358
 359
 360     /* The Type must be either Fixed Event or GPE */
 361
 362     switch (Type)
 363     {
 364     case ACPI_EVENT_FIXED:
 365
 366         /* Decode the Fixed Event */
 367
 368         if (Event > ACPI_EVENT_MAX)
 369         {
 370             return_ACPI_STATUS (AE_BAD_PARAMETER);
 371         }
 372
 373         /*
 374          * Disable the requested fixed event (by writing a zero to the
 375          * enable register bit)
 376          */
 377         Status = AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 378                     0, ACPI_MTX_LOCK);
 379         if (ACPI_FAILURE (Status))
 380         {
 381             return_ACPI_STATUS (Status);
 382         }
 383
 384         Status = AcpiGetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 385                     &Value, ACPI_MTX_LOCK);
 386         if (ACPI_FAILURE (Status))
 387         {
 388             return_ACPI_STATUS (Status);
 389         }
 390
 391         if (Value != 0)
 392         {
 393             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 394                 "Could not disable %s events\n", AcpiUtGetEventName (Event)));
 395             return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
 396         }
 397         break;
 398
 399
 400     case ACPI_EVENT_GPE:
 401
 402         /* Ensure that we have a valid GPE number */
 403
 404         GpeEventInfo = AcpiEvGetGpeEventInfo (Event);
 405         if (!GpeEventInfo)
 406         {
 407             return_ACPI_STATUS (AE_BAD_PARAMETER);
 408         }
 409
 410         /*
 411          * Only disable the requested GPE number for wake if specified.
 412          * Otherwise, turn it totally off
 413          */
 414
 415         if (Flags & ACPI_EVENT_WAKE_DISABLE)
 416         {
 417             AcpiHwDisableGpeForWakeup (GpeEventInfo);
 418         }
 419         else
 420         {
 421             Status = AcpiHwDisableGpe (GpeEventInfo);
 422         }
 423         break;
 424
 425
 426     default:
 427         Status = AE_BAD_PARAMETER;
 428     }
 429
 430     return_ACPI_STATUS (Status);
 431 }
 432
 433
 434 /*******************************************************************************
 435  *
 436  * FUNCTION:    AcpiClearEvent
 437  *
 438  * PARAMETERS:  Event           - The fixed event or GPE to be cleared
 439  *              Type            - The type of event
 440  *
 441  * RETURN:      Status
 442  *
 443  * DESCRIPTION: Clear an ACPI event (fixed and general purpose)
 444  *
 445  ******************************************************************************/
 446
 447 ACPI_STATUS
 448 AcpiClearEvent (
 449     UINT32                  Event,
 450     UINT32                  Type)
 451 {
 452     ACPI_STATUS             Status = AE_OK;
 453     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 454
 455
 456     ACPI_FUNCTION_TRACE ("AcpiClearEvent");
 457
 458
 459     /* The Type must be either Fixed Event or GPE */
 460
 461     switch (Type)
 462     {
 463     case ACPI_EVENT_FIXED:
 464
 465         /* Decode the Fixed Event */
 466
 467         if (Event > ACPI_EVENT_MAX)
 468         {
 469             return_ACPI_STATUS (AE_BAD_PARAMETER);
 470         }
 471
 472         /*
 473          * Clear the requested fixed event (By writing a one to the
 474          * status register bit)
 475          */
 476         Status = AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
 477                 1, ACPI_MTX_LOCK);
 478         break;
 479
 480
 481     case ACPI_EVENT_GPE:
 482
 483         /* Ensure that we have a valid GPE number */
 484
 485         GpeEventInfo = AcpiEvGetGpeEventInfo (Event);
 486         if (!GpeEventInfo)
 487         {
 488             return_ACPI_STATUS (AE_BAD_PARAMETER);
 489         }
 490
 491         Status = AcpiHwClearGpe (GpeEventInfo);
 492         break;
 493
 494
 495     default:
 496
 497         Status = AE_BAD_PARAMETER;
 498     }
 499
 500     return_ACPI_STATUS (Status);
 501 }
 502
 503
 504 /*******************************************************************************
 505  *
 506  * FUNCTION:    AcpiGetEventStatus
 507  *
 508  * PARAMETERS:  Event           - The fixed event or GPE
 509  *              Type            - The type of event
 510  *              Status          - Where the current status of the event will
 511  *                                be returned
 512  *
 513  * RETURN:      Status
 514  *
 515  * DESCRIPTION: Obtains and returns the current status of the event
 516  *
 517  ******************************************************************************/
 518
 519
 520 ACPI_STATUS
 521 AcpiGetEventStatus (
 522     UINT32                  Event,
 523     UINT32                  Type,
 524     ACPI_EVENT_STATUS       *EventStatus)
 525 {
 526     ACPI_STATUS             Status = AE_OK;
 527     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 528
 529
 530     ACPI_FUNCTION_TRACE ("AcpiGetEventStatus");
 531
 532
 533     if (!EventStatus)
 534     {
 535         return_ACPI_STATUS (AE_BAD_PARAMETER);
 536     }
 537
 538
 539     /* The Type must be either Fixed Event or GPE */
 540
 541     switch (Type)
 542     {
 543     case ACPI_EVENT_FIXED:
 544
 545         /* Decode the Fixed Event */
 546
 547         if (Event > ACPI_EVENT_MAX)
 548         {
 549             return_ACPI_STATUS (AE_BAD_PARAMETER);
 550         }
 551
 552         /* Get the status of the requested fixed event */
 553
 554         Status = AcpiGetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
 555                         EventStatus, ACPI_MTX_LOCK);
 556         break;
 557
 558
 559     case ACPI_EVENT_GPE:
 560
 561         /* Ensure that we have a valid GPE number */
 562
 563         GpeEventInfo = AcpiEvGetGpeEventInfo (Event);
 564         if (!GpeEventInfo)
 565         {
 566             return_ACPI_STATUS (AE_BAD_PARAMETER);
 567         }
 568
 569         /* Obtain status on the requested GPE number */
 570
 571         Status = AcpiHwGetGpeStatus (Event, EventStatus);
 572         break;
 573
 574
 575     default:
 576         Status = AE_BAD_PARAMETER;
 577     }
 578
 579     return_ACPI_STATUS (Status);
 580 }
 581
 582