1 /****************************************************************************** 2 * 3 * Name: acevents.h - Event subcomponent prototypes and defines 4 * $Revision: 1.105 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2006, 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 portion 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 117 #ifndef __ACEVENTS_H__ 118 #define __ACEVENTS_H__ 119 120 121 /* 122 * evevent 123 */ 124 ACPI_STATUS 125 AcpiEvInitializeEvents ( 126 void); 127 128 ACPI_STATUS 129 AcpiEvInstallXruptHandlers ( 130 void); 131 132 ACPI_STATUS 133 AcpiEvInstallFadtGpes ( 134 void); 135 136 UINT32 137 AcpiEvFixedEventDetect ( 138 void); 139 140 141 /* 142 * evmisc 143 */ 144 BOOLEAN 145 AcpiEvIsNotifyObject ( 146 ACPI_NAMESPACE_NODE *Node); 147 148 ACPI_STATUS 149 AcpiEvAcquireGlobalLock( 150 UINT16 Timeout); 151 152 ACPI_STATUS 153 AcpiEvReleaseGlobalLock( 154 void); 155 156 ACPI_STATUS 157 AcpiEvInitGlobalLockHandler ( 158 void); 159 160 UINT32 161 AcpiEvGetGpeNumberIndex ( 162 UINT32 GpeNumber); 163 164 ACPI_STATUS 165 AcpiEvQueueNotifyRequest ( 166 ACPI_NAMESPACE_NODE *Node, 167 UINT32 NotifyValue); 168 169 170 /* 171 * evgpe - GPE handling and dispatch 172 */ 173 ACPI_STATUS 174 AcpiEvUpdateGpeEnableMasks ( 175 ACPI_GPE_EVENT_INFO *GpeEventInfo, 176 UINT8 Type); 177 178 ACPI_STATUS 179 AcpiEvEnableGpe ( 180 ACPI_GPE_EVENT_INFO *GpeEventInfo, 181 BOOLEAN WriteToHardware); 182 183 ACPI_STATUS 184 AcpiEvDisableGpe ( 185 ACPI_GPE_EVENT_INFO *GpeEventInfo); 186 187 ACPI_GPE_EVENT_INFO * 188 AcpiEvGetGpeEventInfo ( 189 ACPI_HANDLE GpeDevice, 190 UINT32 GpeNumber); 191 192 193 /* 194 * evgpeblk 195 */ 196 BOOLEAN 197 AcpiEvValidGpeEvent ( 198 ACPI_GPE_EVENT_INFO *GpeEventInfo); 199 200 ACPI_STATUS 201 AcpiEvWalkGpeList ( 202 ACPI_GPE_CALLBACK GpeWalkCallback); 203 204 ACPI_STATUS 205 AcpiEvDeleteGpeHandlers ( 206 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 207 ACPI_GPE_BLOCK_INFO *GpeBlock); 208 209 ACPI_STATUS 210 AcpiEvCreateGpeBlock ( 211 ACPI_NAMESPACE_NODE *GpeDevice, 212 ACPI_GENERIC_ADDRESS *GpeBlockAddress, 213 UINT32 RegisterCount, 214 UINT8 GpeBlockBaseNumber, 215 UINT32 InterruptNumber, 216 ACPI_GPE_BLOCK_INFO **ReturnGpeBlock); 217 218 ACPI_STATUS 219 AcpiEvInitializeGpeBlock ( 220 ACPI_NAMESPACE_NODE *GpeDevice, 221 ACPI_GPE_BLOCK_INFO *GpeBlock); 222 223 ACPI_STATUS 224 AcpiEvDeleteGpeBlock ( 225 ACPI_GPE_BLOCK_INFO *GpeBlock); 226 227 UINT32 228 AcpiEvGpeDispatch ( 229 ACPI_GPE_EVENT_INFO *GpeEventInfo, 230 UINT32 GpeNumber); 231 232 UINT32 233 AcpiEvGpeDetect ( 234 ACPI_GPE_XRUPT_INFO *GpeXruptList); 235 236 ACPI_STATUS 237 AcpiEvSetGpeType ( 238 ACPI_GPE_EVENT_INFO *GpeEventInfo, 239 UINT8 Type); 240 241 ACPI_STATUS 242 AcpiEvCheckForWakeOnlyGpe ( 243 ACPI_GPE_EVENT_INFO *GpeEventInfo); 244 245 ACPI_STATUS 246 AcpiEvGpeInitialize ( 247 void); 248 249 250 /* 251 * evregion - Address Space handling 252 */ 253 ACPI_STATUS 254 AcpiEvInstallRegionHandlers ( 255 void); 256 257 ACPI_STATUS 258 AcpiEvInitializeOpRegions ( 259 void); 260 261 ACPI_STATUS 262 AcpiEvAddressSpaceDispatch ( 263 ACPI_OPERAND_OBJECT *RegionObj, 264 UINT32 Function, 265 ACPI_PHYSICAL_ADDRESS Address, 266 UINT32 BitWidth, 267 void *Value); 268 269 ACPI_STATUS 270 AcpiEvAttachRegion ( 271 ACPI_OPERAND_OBJECT *HandlerObj, 272 ACPI_OPERAND_OBJECT *RegionObj, 273 BOOLEAN AcpiNsIsLocked); 274 275 void 276 AcpiEvDetachRegion ( 277 ACPI_OPERAND_OBJECT *RegionObj, 278 BOOLEAN AcpiNsIsLocked); 279 280 ACPI_STATUS 281 AcpiEvInstallSpaceHandler ( 282 ACPI_NAMESPACE_NODE *Node, 283 ACPI_ADR_SPACE_TYPE SpaceId, 284 ACPI_ADR_SPACE_HANDLER Handler, 285 ACPI_ADR_SPACE_SETUP Setup, 286 void *Context); 287 288 ACPI_STATUS 289 AcpiEvExecuteRegMethods ( 290 ACPI_NAMESPACE_NODE *Node, 291 ACPI_ADR_SPACE_TYPE SpaceId); 292 293 ACPI_STATUS 294 AcpiEvExecuteRegMethod ( 295 ACPI_OPERAND_OBJECT *RegionObj, 296 UINT32 Function); 297 298 299 /* 300 * evregini - Region initialization and setup 301 */ 302 ACPI_STATUS 303 AcpiEvSystemMemoryRegionSetup ( 304 ACPI_HANDLE Handle, 305 UINT32 Function, 306 void *HandlerContext, 307 void **RegionContext); 308 309 ACPI_STATUS 310 AcpiEvIoSpaceRegionSetup ( 311 ACPI_HANDLE Handle, 312 UINT32 Function, 313 void *HandlerContext, 314 void **RegionContext); 315 316 ACPI_STATUS 317 AcpiEvPciConfigRegionSetup ( 318 ACPI_HANDLE Handle, 319 UINT32 Function, 320 void *HandlerContext, 321 void **RegionContext); 322 323 ACPI_STATUS 324 AcpiEvCmosRegionSetup ( 325 ACPI_HANDLE Handle, 326 UINT32 Function, 327 void *HandlerContext, 328 void **RegionContext); 329 330 ACPI_STATUS 331 AcpiEvPciBarRegionSetup ( 332 ACPI_HANDLE Handle, 333 UINT32 Function, 334 void *HandlerContext, 335 void **RegionContext); 336 337 ACPI_STATUS 338 AcpiEvDefaultRegionSetup ( 339 ACPI_HANDLE Handle, 340 UINT32 Function, 341 void *HandlerContext, 342 void **RegionContext); 343 344 ACPI_STATUS 345 AcpiEvInitializeRegion ( 346 ACPI_OPERAND_OBJECT *RegionObj, 347 BOOLEAN AcpiNsLocked); 348 349 350 /* 351 * evsci - SCI (System Control Interrupt) handling/dispatch 352 */ 353 UINT32 ACPI_SYSTEM_XFACE 354 AcpiEvGpeXruptHandler ( 355 void *Context); 356 357 UINT32 358 AcpiEvInstallSciHandler ( 359 void); 360 361 ACPI_STATUS 362 AcpiEvRemoveSciHandler ( 363 void); 364 365 UINT32 366 AcpiEvInitializeSCI ( 367 UINT32 ProgramSCI); 368 369 void 370 AcpiEvTerminate ( 371 void); 372 373 374 #endif /* __ACEVENTS_H__ */ 375