1 /****************************************************************************** 2 * 3 * Name: acevents.h - Event subcomponent prototypes and defines 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #ifndef __ACEVENTS_H__ 153 #define __ACEVENTS_H__ 154 155 156 /* 157 * evevent 158 */ 159 ACPI_STATUS 160 AcpiEvInitializeEvents ( 161 void); 162 163 ACPI_STATUS 164 AcpiEvInstallXruptHandlers ( 165 void); 166 167 UINT32 168 AcpiEvFixedEventDetect ( 169 void); 170 171 172 /* 173 * evmisc 174 */ 175 BOOLEAN 176 AcpiEvIsNotifyObject ( 177 ACPI_NAMESPACE_NODE *Node); 178 179 UINT32 180 AcpiEvGetGpeNumberIndex ( 181 UINT32 GpeNumber); 182 183 ACPI_STATUS 184 AcpiEvQueueNotifyRequest ( 185 ACPI_NAMESPACE_NODE *Node, 186 UINT32 NotifyValue); 187 188 189 /* 190 * evglock - Global Lock support 191 */ 192 ACPI_STATUS 193 AcpiEvInitGlobalLockHandler ( 194 void); 195 196 ACPI_HW_DEPENDENT_RETURN_OK ( 197 ACPI_STATUS 198 AcpiEvAcquireGlobalLock( 199 UINT16 Timeout)) 200 201 ACPI_HW_DEPENDENT_RETURN_OK ( 202 ACPI_STATUS 203 AcpiEvReleaseGlobalLock( 204 void)) 205 206 ACPI_STATUS 207 AcpiEvRemoveGlobalLockHandler ( 208 void); 209 210 211 /* 212 * evgpe - Low-level GPE support 213 */ 214 UINT32 215 AcpiEvGpeDetect ( 216 ACPI_GPE_XRUPT_INFO *GpeXruptList); 217 218 ACPI_STATUS 219 AcpiEvUpdateGpeEnableMask ( 220 ACPI_GPE_EVENT_INFO *GpeEventInfo); 221 222 ACPI_STATUS 223 AcpiEvEnableGpe ( 224 ACPI_GPE_EVENT_INFO *GpeEventInfo); 225 226 ACPI_STATUS 227 AcpiEvMaskGpe ( 228 ACPI_GPE_EVENT_INFO *GpeEventInfo, 229 BOOLEAN IsMasked); 230 231 ACPI_STATUS 232 AcpiEvAddGpeReference ( 233 ACPI_GPE_EVENT_INFO *GpeEventInfo); 234 235 ACPI_STATUS 236 AcpiEvRemoveGpeReference ( 237 ACPI_GPE_EVENT_INFO *GpeEventInfo); 238 239 ACPI_GPE_EVENT_INFO * 240 AcpiEvGetGpeEventInfo ( 241 ACPI_HANDLE GpeDevice, 242 UINT32 GpeNumber); 243 244 ACPI_GPE_EVENT_INFO * 245 AcpiEvLowGetGpeInfo ( 246 UINT32 GpeNumber, 247 ACPI_GPE_BLOCK_INFO *GpeBlock); 248 249 ACPI_STATUS 250 AcpiEvFinishGpe ( 251 ACPI_GPE_EVENT_INFO *GpeEventInfo); 252 253 254 /* 255 * evgpeblk - Upper-level GPE block support 256 */ 257 ACPI_STATUS 258 AcpiEvCreateGpeBlock ( 259 ACPI_NAMESPACE_NODE *GpeDevice, 260 UINT64 Address, 261 UINT8 SpaceId, 262 UINT32 RegisterCount, 263 UINT16 GpeBlockBaseNumber, 264 UINT32 InterruptNumber, 265 ACPI_GPE_BLOCK_INFO **ReturnGpeBlock); 266 267 ACPI_STATUS 268 AcpiEvInitializeGpeBlock ( 269 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 270 ACPI_GPE_BLOCK_INFO *GpeBlock, 271 void *Context); 272 273 ACPI_HW_DEPENDENT_RETURN_OK ( 274 ACPI_STATUS 275 AcpiEvDeleteGpeBlock ( 276 ACPI_GPE_BLOCK_INFO *GpeBlock)) 277 278 UINT32 279 AcpiEvGpeDispatch ( 280 ACPI_NAMESPACE_NODE *GpeDevice, 281 ACPI_GPE_EVENT_INFO *GpeEventInfo, 282 UINT32 GpeNumber); 283 284 285 /* 286 * evgpeinit - GPE initialization and update 287 */ 288 ACPI_STATUS 289 AcpiEvGpeInitialize ( 290 void); 291 292 ACPI_HW_DEPENDENT_RETURN_VOID ( 293 void 294 AcpiEvUpdateGpes ( 295 ACPI_OWNER_ID TableOwnerId)) 296 297 ACPI_STATUS 298 AcpiEvMatchGpeMethod ( 299 ACPI_HANDLE ObjHandle, 300 UINT32 Level, 301 void *Context, 302 void **ReturnValue); 303 304 305 /* 306 * evgpeutil - GPE utilities 307 */ 308 ACPI_STATUS 309 AcpiEvWalkGpeList ( 310 ACPI_GPE_CALLBACK GpeWalkCallback, 311 void *Context); 312 313 ACPI_STATUS 314 AcpiEvGetGpeDevice ( 315 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 316 ACPI_GPE_BLOCK_INFO *GpeBlock, 317 void *Context); 318 319 ACPI_STATUS 320 AcpiEvGetGpeXruptBlock ( 321 UINT32 InterruptNumber, 322 ACPI_GPE_XRUPT_INFO **GpeXruptBlock); 323 324 ACPI_STATUS 325 AcpiEvDeleteGpeXrupt ( 326 ACPI_GPE_XRUPT_INFO *GpeXrupt); 327 328 ACPI_STATUS 329 AcpiEvDeleteGpeHandlers ( 330 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 331 ACPI_GPE_BLOCK_INFO *GpeBlock, 332 void *Context); 333 334 335 /* 336 * evhandler - Address space handling 337 */ 338 ACPI_OPERAND_OBJECT * 339 AcpiEvFindRegionHandler ( 340 ACPI_ADR_SPACE_TYPE SpaceId, 341 ACPI_OPERAND_OBJECT *HandlerObj); 342 343 BOOLEAN 344 AcpiEvHasDefaultHandler ( 345 ACPI_NAMESPACE_NODE *Node, 346 ACPI_ADR_SPACE_TYPE SpaceId); 347 348 ACPI_STATUS 349 AcpiEvInstallRegionHandlers ( 350 void); 351 352 ACPI_STATUS 353 AcpiEvInstallSpaceHandler ( 354 ACPI_NAMESPACE_NODE *Node, 355 ACPI_ADR_SPACE_TYPE SpaceId, 356 ACPI_ADR_SPACE_HANDLER Handler, 357 ACPI_ADR_SPACE_SETUP Setup, 358 void *Context); 359 360 361 /* 362 * evregion - Operation region support 363 */ 364 ACPI_STATUS 365 AcpiEvInitializeOpRegions ( 366 void); 367 368 ACPI_STATUS 369 AcpiEvAddressSpaceDispatch ( 370 ACPI_OPERAND_OBJECT *RegionObj, 371 ACPI_OPERAND_OBJECT *FieldObj, 372 UINT32 Function, 373 UINT32 RegionOffset, 374 UINT32 BitWidth, 375 UINT64 *Value); 376 377 ACPI_STATUS 378 AcpiEvAttachRegion ( 379 ACPI_OPERAND_OBJECT *HandlerObj, 380 ACPI_OPERAND_OBJECT *RegionObj, 381 BOOLEAN AcpiNsIsLocked); 382 383 void 384 AcpiEvDetachRegion ( 385 ACPI_OPERAND_OBJECT *RegionObj, 386 BOOLEAN AcpiNsIsLocked); 387 388 void 389 AcpiEvExecuteRegMethods ( 390 ACPI_NAMESPACE_NODE *Node, 391 ACPI_ADR_SPACE_TYPE SpaceId, 392 UINT32 Function); 393 394 ACPI_STATUS 395 AcpiEvExecuteRegMethod ( 396 ACPI_OPERAND_OBJECT *RegionObj, 397 UINT32 Function); 398 399 400 /* 401 * evregini - Region initialization and setup 402 */ 403 ACPI_STATUS 404 AcpiEvSystemMemoryRegionSetup ( 405 ACPI_HANDLE Handle, 406 UINT32 Function, 407 void *HandlerContext, 408 void **RegionContext); 409 410 ACPI_STATUS 411 AcpiEvIoSpaceRegionSetup ( 412 ACPI_HANDLE Handle, 413 UINT32 Function, 414 void *HandlerContext, 415 void **RegionContext); 416 417 ACPI_STATUS 418 AcpiEvPciConfigRegionSetup ( 419 ACPI_HANDLE Handle, 420 UINT32 Function, 421 void *HandlerContext, 422 void **RegionContext); 423 424 ACPI_STATUS 425 AcpiEvCmosRegionSetup ( 426 ACPI_HANDLE Handle, 427 UINT32 Function, 428 void *HandlerContext, 429 void **RegionContext); 430 431 ACPI_STATUS 432 AcpiEvPciBarRegionSetup ( 433 ACPI_HANDLE Handle, 434 UINT32 Function, 435 void *HandlerContext, 436 void **RegionContext); 437 438 ACPI_STATUS 439 AcpiEvDefaultRegionSetup ( 440 ACPI_HANDLE Handle, 441 UINT32 Function, 442 void *HandlerContext, 443 void **RegionContext); 444 445 ACPI_STATUS 446 AcpiEvInitializeRegion ( 447 ACPI_OPERAND_OBJECT *RegionObj); 448 449 450 /* 451 * evsci - SCI (System Control Interrupt) handling/dispatch 452 */ 453 UINT32 ACPI_SYSTEM_XFACE 454 AcpiEvGpeXruptHandler ( 455 void *Context); 456 457 UINT32 458 AcpiEvSciDispatch ( 459 void); 460 461 UINT32 462 AcpiEvInstallSciHandler ( 463 void); 464 465 ACPI_STATUS 466 AcpiEvRemoveAllSciHandlers ( 467 void); 468 469 ACPI_HW_DEPENDENT_RETURN_VOID ( 470 void 471 AcpiEvTerminate ( 472 void)) 473 474 #endif /* __ACEVENTS_H__ */ 475