mirror of
https://github.com/acpica/acpica/
synced 2025-01-27 03:42:04 +03:00
260 lines
9.1 KiB
C
260 lines
9.1 KiB
C
|
|
/******************************************************************************
|
|
*
|
|
* Name: events.h - Event subcomponent prototypes and defines
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/******************************************************************************
|
|
*
|
|
* 1. Copyright Notice
|
|
*
|
|
* Some or all of this work - Copyright (c) 1999, Intel Corp. All rights
|
|
* reserved.
|
|
*
|
|
* 2. License
|
|
*
|
|
* 2.1. Intel grants, free of charge, to any person ("Licensee") obtaining a
|
|
* copy of the source code appearing in this file ("Covered Code") a license
|
|
* under Intel's copyrights in the base code distributed originally by Intel
|
|
* ("Original Intel Code") to copy, make derivatives, distribute, use and
|
|
* display any portion of the Covered Code in any form; and
|
|
*
|
|
* 2.2. Intel grants Licensee a non-exclusive and non-transferable patent
|
|
* license (without the right to sublicense), under only those claims of Intel
|
|
* patents that are infringed by the Original Intel Code, to make, use, sell,
|
|
* offer to sell, and import the Covered Code and derivative works thereof
|
|
* solely to the minimum extent necessary to exercise the above copyright
|
|
* license, and in no event shall the patent license extend to any additions to
|
|
* or modifications of the Original Intel Code. No other license or right is
|
|
* granted directly or by implication, estoppel or otherwise;
|
|
*
|
|
* the above copyright and patent license is granted only if the following
|
|
* conditions are met:
|
|
*
|
|
* 3. Conditions
|
|
*
|
|
* 3.1. Redistribution of source code of any substantial portion of the Covered
|
|
* Code or modification must include the above Copyright Notice, the above
|
|
* License, this list of Conditions, and the following Disclaimer and Export
|
|
* Compliance provision. In addition, Licensee must cause all Covered Code to
|
|
* which Licensee contributes to contain a file documenting the changes
|
|
* Licensee made to create that Covered Code and the date of any change.
|
|
* Licensee must include in that file the documentation of any changes made by
|
|
* any predecessor Licensee. Licensee must include a prominent statement that
|
|
* the modification is derived, directly or indirectly, from Original Intel
|
|
* Code.
|
|
*
|
|
* 3.2. Redistribution in binary form of any substantial portion of the Covered
|
|
* Code or modification must reproduce the above Copyright Notice, and the
|
|
* following Disclaimer and Export Compliance provision in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* 3.3. Intel retains all right, title, and interest in and to the Original
|
|
* Intel Code.
|
|
*
|
|
* 3.4. Neither the name Intel nor any other trademark owned or controlled by
|
|
* Intel shall be used in advertising or otherwise to promote the sale, use or
|
|
* other dealings in products derived from or relating to the Covered Code
|
|
* without prior written authorization from Intel.
|
|
*
|
|
* 4. Disclaimer and Export Compliance
|
|
*
|
|
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
|
|
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
|
|
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
|
|
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
|
|
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
|
|
* PARTICULAR PURPOSE.
|
|
*
|
|
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
|
|
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
|
|
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
|
|
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
|
|
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
|
|
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
|
|
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
|
|
* LIMITED REMEDY.
|
|
*
|
|
* 4.3. Licensee shall not export, either directly or indirectly, any of this
|
|
* software or system incorporating such software without first obtaining any
|
|
* required license or other approval from the U. S. Department of Commerce or
|
|
* any other agency or department of the United States Government. In the
|
|
* event Licensee exports any such software from the United States or re-
|
|
* exports any such software from a foreign destination, Licensee shall ensure
|
|
* that the distribution and export/re-export of the software is in compliance
|
|
* with all laws, regulations, orders, or other restrictions of the U.S. Export
|
|
* Administration Regulations. Licensee agrees that neither it nor any of its
|
|
* subsidiaries will export/re-export any technical data, process, software, or
|
|
* service, directly or indirectly, to any country for which the United States
|
|
* government or any agency thereof requires an export license, other
|
|
* governmental approval, or letter of assurance, without first obtaining such
|
|
* license, approval or letter.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
|
|
#ifndef __EVENTS_H__
|
|
#define __EVENTS_H__
|
|
|
|
|
|
/* Globals for event handling */
|
|
|
|
extern INT32 EdgeLevelSave;
|
|
extern INT32 IrqEnableSave; /* original SCI config */
|
|
extern INT32 OriginalMode; /* stores the original ACPI/legacy mode */
|
|
|
|
|
|
|
|
/* Interrupt handler return values */
|
|
|
|
#define INTERRUPT_HANDLED 0x01
|
|
#define INTERRUPT_NOT_HANDLED 0x02
|
|
#define INTERRUPT_ERROR 0x03
|
|
|
|
/* InstallSCIHandlerXferToACPI() Flags bitmask options */
|
|
|
|
#define ACPI_TABLES_REQUIRED 0x01
|
|
#define HW_OVERRIDE_SUPPORTED 0x02
|
|
#define PROGRAM_SCI_LEVEL_SENSITIVITY 0x04
|
|
#define DISABLE_KNOWN_EVENTS 0x08
|
|
#define LOAD_ACPI_NAMESPACE 0x10
|
|
|
|
|
|
/* iErrorMask mask bits */
|
|
|
|
#define NO_ACPI_TABLES_MASK 0x01
|
|
#define NO_ACPI_TRANSITION_MASK 0x02
|
|
#define SCI_LEVEL_INT_MASK 0x04
|
|
#define NO_SCI_HANDLER_MASK 0x08
|
|
#define NO_LEGACY_TRANSITION_MASK 0x10
|
|
#define UNABLE_TO_LOAD_NAMESPACE 0x20
|
|
#define SCI_DISABLED 0x40
|
|
|
|
#define SAVE_NOT_VALID -1
|
|
|
|
/* identifier strings for fixed events */
|
|
|
|
#define TMR_FIXED_EVENT "TMR_FIXED_EVENT"
|
|
#define NOT_USED_EVENT "UNHANDLED_SCI"
|
|
#define GBL_FIXED_EVENT "GBL_FIXED_EVENT"
|
|
#define PWR_BTN_FIXED_EVENT "PWR_BTN_FIXED_EVENT"
|
|
#define SLP_BTN_FIXED_EVENT "SLP_BTN_FIXED_EVENT"
|
|
#define RTC_FIXED_EVENT "RTC_FIXED_EVENT"
|
|
|
|
/* event index for types of events */
|
|
|
|
enum
|
|
{
|
|
TMR_EVENT,
|
|
NOT_USED,
|
|
/*
|
|
* There's no bus master event so index 1 is used for IRQ's that are not
|
|
* handled by the SCI handler
|
|
*/
|
|
GBL_EVENT,
|
|
PWR_BTN_EVENT,
|
|
SLP_BTN_EVENT,
|
|
RTC_EVENT,
|
|
GENERAL_EVENT
|
|
};
|
|
|
|
|
|
/* Opcodes for event enable/disable functions */
|
|
|
|
#define DISABLE 0
|
|
#define ENABLE 1
|
|
#define STATUS 0
|
|
|
|
/*
|
|
* Use the macros below + the function AcpiClearStatusBit for
|
|
* accessing and manipulating status/enable bits for various events.
|
|
*
|
|
* IMPORTANT: SCI handler must be installed or the enable bit will not be
|
|
* modified.
|
|
*/
|
|
#define ENABLE_EVENT(name) AcpiEnableDisableEvent(name, ENABLE)
|
|
#define DISABLE_EVENT(name) AcpiEnableDisableEvent(name, DISABLE)
|
|
#define ENABLE_GEN_EVENT(name,offset) AcpiEnableDisableEvent(name, ENABLE, offset)
|
|
#define DISABLE_GEN_EVENT(name,offset) AcpiEnableDisableEvent(name, DISABLE, offset)
|
|
|
|
#define READ_ENABLE_BIT(name,buf) AcpiReadStatusEnableBit(name, ENABLE, buf)
|
|
#define READ_STATUS_BIT(name,buf) AcpiReadStatusEnableBit(name, STATUS, buf)
|
|
#define READ_GEN_ENABLE_BIT(name,buf,offset) AcpiReadStatusEnableBit(name, ENABLE, buf, offset)
|
|
#define READ_GEN_STATUS_BIT(name,buf,offset) AcpiReadStatusEnableBit(name, STATUS, buf, offset)
|
|
|
|
|
|
/*
|
|
* elements correspond to counts for
|
|
* TMR, GBL, PWR_BTN, SLP_BTN, and RTC
|
|
* respectively. These counts are modified
|
|
* by the ACPI interrupt handler...
|
|
*/
|
|
|
|
extern volatile UINT32 EventCount[];
|
|
|
|
|
|
/* Prototypes */
|
|
|
|
INT32
|
|
AcpiClearStatusBit (
|
|
char * EventName, ...);
|
|
|
|
INT32
|
|
AcpiEnableDisableEvent (
|
|
char * EventName,
|
|
INT32 Action, ...);
|
|
|
|
INT32
|
|
AcpiReadStatusEnableBit (
|
|
char * EventName,
|
|
INT32 StatusOrEnable,
|
|
BOOLEAN * OutBit, ...);
|
|
|
|
UINT32
|
|
InstallSciHandler (
|
|
void);
|
|
|
|
void
|
|
UninstallSciHandler (
|
|
void);
|
|
|
|
UINT32
|
|
SciCount (
|
|
char * EventName);
|
|
|
|
INT32
|
|
InitializeSCI (
|
|
INT32 ProgramSCI);
|
|
|
|
INT32
|
|
VerifyAcpiTablesPresent (
|
|
char * TestName);
|
|
|
|
INT32
|
|
InstallSCIHandlerXferToACPI (
|
|
char * TestName,
|
|
INT32 Flags);
|
|
|
|
INT32
|
|
UninstallSCIHandlerXferToLegacy (
|
|
void);
|
|
|
|
UINT32
|
|
InstallInterruptHandler (
|
|
UINT32 InterruptNumber,
|
|
INT32 (* Isr)(void),
|
|
UINT32 *ExceptPtr);
|
|
|
|
INT32
|
|
RemoveInterruptHandler (UINT32 Handle);
|
|
|
|
void
|
|
RestoreAcpiState (
|
|
void);
|
|
|
|
|
|
|
|
#endif /* __EVENTS_H__ */
|