LXR |
|
|
|
|||
File indexing completed on 2025-05-11 08:23:41
0001 /****************************************************************************** 0002 * 0003 * Name: acevents.h - Event subcomponent prototypes and defines 0004 * 0005 *****************************************************************************/ 0006 0007 /****************************************************************************** 0008 * 0009 * 1. Copyright Notice 0010 * 0011 * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp. 0012 * All rights reserved. 0013 * 0014 * 2. License 0015 * 0016 * 2.1. This is your license from Intel Corp. under its intellectual property 0017 * rights. You may have additional license terms from the party that provided 0018 * you this software, covering your right to use that party's intellectual 0019 * property rights. 0020 * 0021 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 0022 * copy of the source code appearing in this file ("Covered Code") an 0023 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 0024 * base code distributed originally by Intel ("Original Intel Code") to copy, 0025 * make derivatives, distribute, use and display any portion of the Covered 0026 * Code in any form, with the right to sublicense such rights; and 0027 * 0028 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 0029 * license (with the right to sublicense), under only those claims of Intel 0030 * patents that are infringed by the Original Intel Code, to make, use, sell, 0031 * offer to sell, and import the Covered Code and derivative works thereof 0032 * solely to the minimum extent necessary to exercise the above copyright 0033 * license, and in no event shall the patent license extend to any additions 0034 * to or modifications of the Original Intel Code. No other license or right 0035 * is granted directly or by implication, estoppel or otherwise; 0036 * 0037 * The above copyright and patent license is granted only if the following 0038 * conditions are met: 0039 * 0040 * 3. Conditions 0041 * 0042 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 0043 * Redistribution of source code of any substantial portion of the Covered 0044 * Code or modification with rights to further distribute source must include 0045 * the above Copyright Notice, the above License, this list of Conditions, 0046 * and the following Disclaimer and Export Compliance provision. In addition, 0047 * Licensee must cause all Covered Code to which Licensee contributes to 0048 * contain a file documenting the changes Licensee made to create that Covered 0049 * Code and the date of any change. Licensee must include in that file the 0050 * documentation of any changes made by any predecessor Licensee. Licensee 0051 * must include a prominent statement that the modification is derived, 0052 * directly or indirectly, from Original Intel Code. 0053 * 0054 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 0055 * Redistribution of source code of any substantial portion of the Covered 0056 * Code or modification without rights to further distribute source must 0057 * include the following Disclaimer and Export Compliance provision in the 0058 * documentation and/or other materials provided with distribution. In 0059 * addition, Licensee may not authorize further sublicense of source of any 0060 * portion of the Covered Code, and must include terms to the effect that the 0061 * license from Licensee to its licensee is limited to the intellectual 0062 * property embodied in the software Licensee provides to its licensee, and 0063 * not to intellectual property embodied in modifications its licensee may 0064 * make. 0065 * 0066 * 3.3. Redistribution of Executable. Redistribution in executable form of any 0067 * substantial portion of the Covered Code or modification must reproduce the 0068 * above Copyright Notice, and the following Disclaimer and Export Compliance 0069 * provision in the documentation and/or other materials provided with the 0070 * distribution. 0071 * 0072 * 3.4. Intel retains all right, title, and interest in and to the Original 0073 * Intel Code. 0074 * 0075 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 0076 * Intel shall be used in advertising or otherwise to promote the sale, use or 0077 * other dealings in products derived from or relating to the Covered Code 0078 * without prior written authorization from Intel. 0079 * 0080 * 4. Disclaimer and Export Compliance 0081 * 0082 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 0083 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 0084 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 0085 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 0086 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 0087 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 0088 * PARTICULAR PURPOSE. 0089 * 0090 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 0091 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 0092 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 0093 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 0094 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 0095 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 0096 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 0097 * LIMITED REMEDY. 0098 * 0099 * 4.3. Licensee shall not export, either directly or indirectly, any of this 0100 * software or system incorporating such software without first obtaining any 0101 * required license or other approval from the U. S. Department of Commerce or 0102 * any other agency or department of the United States Government. In the 0103 * event Licensee exports any such software from the United States or 0104 * re-exports any such software from a foreign destination, Licensee shall 0105 * ensure that the distribution and export/re-export of the software is in 0106 * compliance with all laws, regulations, orders, or other restrictions of the 0107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 0108 * any of its subsidiaries will export/re-export any technical data, process, 0109 * software, or service, directly or indirectly, to any country for which the 0110 * United States government or any agency thereof requires an export license, 0111 * other governmental approval, or letter of assurance, without first obtaining 0112 * such license, approval or letter. 0113 * 0114 ***************************************************************************** 0115 * 0116 * Alternatively, you may choose to be licensed under the terms of the 0117 * following license: 0118 * 0119 * Redistribution and use in source and binary forms, with or without 0120 * modification, are permitted provided that the following conditions 0121 * are met: 0122 * 1. Redistributions of source code must retain the above copyright 0123 * notice, this list of conditions, and the following disclaimer, 0124 * without modification. 0125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 0126 * substantially similar to the "NO WARRANTY" disclaimer below 0127 * ("Disclaimer") and any redistribution must be conditioned upon 0128 * including a substantially similar Disclaimer requirement for further 0129 * binary redistribution. 0130 * 3. Neither the names of the above-listed copyright holders nor the names 0131 * of any contributors may be used to endorse or promote products derived 0132 * from this software without specific prior written permission. 0133 * 0134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 0135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 0136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 0137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 0138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 0139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 0140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 0141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 0142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 0143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 0144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 0145 * 0146 * Alternatively, you may choose to be licensed under the terms of the 0147 * GNU General Public License ("GPL") version 2 as published by the Free 0148 * Software Foundation. 0149 * 0150 *****************************************************************************/ 0151 0152 #ifndef __ACEVENTS_H__ 0153 #define __ACEVENTS_H__ 0154 0155 0156 /* 0157 * Conditions to trigger post enabling GPE polling: 0158 * It is not sufficient to trigger edge-triggered GPE with specific GPE 0159 * chips, software need to poll once after enabling. 0160 */ 0161 #ifdef ACPI_USE_GPE_POLLING 0162 #define ACPI_GPE_IS_POLLING_NEEDED(__gpe__) \ 0163 ((__gpe__)->RuntimeCount == 1 && \ 0164 (__gpe__)->Flags & ACPI_GPE_INITIALIZED && \ 0165 ((__gpe__)->Flags & ACPI_GPE_XRUPT_TYPE_MASK) == ACPI_GPE_EDGE_TRIGGERED) 0166 #else 0167 #define ACPI_GPE_IS_POLLING_NEEDED(__gpe__) FALSE 0168 #endif 0169 0170 0171 /* 0172 * evevent 0173 */ 0174 ACPI_STATUS 0175 AcpiEvInitializeEvents ( 0176 void); 0177 0178 ACPI_STATUS 0179 AcpiEvInstallXruptHandlers ( 0180 void); 0181 0182 UINT32 0183 AcpiEvFixedEventDetect ( 0184 void); 0185 0186 0187 /* 0188 * evmisc 0189 */ 0190 BOOLEAN 0191 AcpiEvIsNotifyObject ( 0192 ACPI_NAMESPACE_NODE *Node); 0193 0194 UINT32 0195 AcpiEvGetGpeNumberIndex ( 0196 UINT32 GpeNumber); 0197 0198 ACPI_STATUS 0199 AcpiEvQueueNotifyRequest ( 0200 ACPI_NAMESPACE_NODE *Node, 0201 UINT32 NotifyValue); 0202 0203 0204 /* 0205 * evglock - Global Lock support 0206 */ 0207 ACPI_STATUS 0208 AcpiEvInitGlobalLockHandler ( 0209 void); 0210 0211 ACPI_HW_DEPENDENT_RETURN_OK ( 0212 ACPI_STATUS 0213 AcpiEvAcquireGlobalLock( 0214 UINT16 Timeout)) 0215 0216 ACPI_HW_DEPENDENT_RETURN_OK ( 0217 ACPI_STATUS 0218 AcpiEvReleaseGlobalLock( 0219 void)) 0220 0221 ACPI_STATUS 0222 AcpiEvRemoveGlobalLockHandler ( 0223 void); 0224 0225 0226 /* 0227 * evgpe - Low-level GPE support 0228 */ 0229 UINT32 0230 AcpiEvGpeDetect ( 0231 ACPI_GPE_XRUPT_INFO *GpeXruptList); 0232 0233 ACPI_STATUS 0234 AcpiEvUpdateGpeEnableMask ( 0235 ACPI_GPE_EVENT_INFO *GpeEventInfo); 0236 0237 ACPI_STATUS 0238 AcpiEvEnableGpe ( 0239 ACPI_GPE_EVENT_INFO *GpeEventInfo); 0240 0241 ACPI_STATUS 0242 AcpiEvMaskGpe ( 0243 ACPI_GPE_EVENT_INFO *GpeEventInfo, 0244 BOOLEAN IsMasked); 0245 0246 ACPI_STATUS 0247 AcpiEvAddGpeReference ( 0248 ACPI_GPE_EVENT_INFO *GpeEventInfo, 0249 BOOLEAN ClearOnEnable); 0250 0251 ACPI_STATUS 0252 AcpiEvRemoveGpeReference ( 0253 ACPI_GPE_EVENT_INFO *GpeEventInfo); 0254 0255 ACPI_GPE_EVENT_INFO * 0256 AcpiEvGetGpeEventInfo ( 0257 ACPI_HANDLE GpeDevice, 0258 UINT32 GpeNumber); 0259 0260 ACPI_GPE_EVENT_INFO * 0261 AcpiEvLowGetGpeInfo ( 0262 UINT32 GpeNumber, 0263 ACPI_GPE_BLOCK_INFO *GpeBlock); 0264 0265 ACPI_STATUS 0266 AcpiEvFinishGpe ( 0267 ACPI_GPE_EVENT_INFO *GpeEventInfo); 0268 0269 UINT32 0270 AcpiEvDetectGpe ( 0271 ACPI_NAMESPACE_NODE *GpeDevice, 0272 ACPI_GPE_EVENT_INFO *GpeEventInfo, 0273 UINT32 GpeNumber); 0274 0275 0276 /* 0277 * evgpeblk - Upper-level GPE block support 0278 */ 0279 ACPI_STATUS 0280 AcpiEvCreateGpeBlock ( 0281 ACPI_NAMESPACE_NODE *GpeDevice, 0282 UINT64 Address, 0283 UINT8 SpaceId, 0284 UINT32 RegisterCount, 0285 UINT16 GpeBlockBaseNumber, 0286 UINT32 InterruptNumber, 0287 ACPI_GPE_BLOCK_INFO **ReturnGpeBlock); 0288 0289 ACPI_STATUS 0290 AcpiEvInitializeGpeBlock ( 0291 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 0292 ACPI_GPE_BLOCK_INFO *GpeBlock, 0293 void *Context); 0294 0295 ACPI_HW_DEPENDENT_RETURN_OK ( 0296 ACPI_STATUS 0297 AcpiEvDeleteGpeBlock ( 0298 ACPI_GPE_BLOCK_INFO *GpeBlock)) 0299 0300 UINT32 0301 AcpiEvGpeDispatch ( 0302 ACPI_NAMESPACE_NODE *GpeDevice, 0303 ACPI_GPE_EVENT_INFO *GpeEventInfo, 0304 UINT32 GpeNumber); 0305 0306 0307 /* 0308 * evgpeinit - GPE initialization and update 0309 */ 0310 ACPI_STATUS 0311 AcpiEvGpeInitialize ( 0312 void); 0313 0314 ACPI_HW_DEPENDENT_RETURN_VOID ( 0315 void 0316 AcpiEvUpdateGpes ( 0317 ACPI_OWNER_ID TableOwnerId)) 0318 0319 ACPI_STATUS 0320 AcpiEvMatchGpeMethod ( 0321 ACPI_HANDLE ObjHandle, 0322 UINT32 Level, 0323 void *Context, 0324 void **ReturnValue); 0325 0326 0327 /* 0328 * evgpeutil - GPE utilities 0329 */ 0330 ACPI_STATUS 0331 AcpiEvWalkGpeList ( 0332 ACPI_GPE_CALLBACK GpeWalkCallback, 0333 void *Context); 0334 0335 ACPI_STATUS 0336 AcpiEvGetGpeDevice ( 0337 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 0338 ACPI_GPE_BLOCK_INFO *GpeBlock, 0339 void *Context); 0340 0341 ACPI_STATUS 0342 AcpiEvGetGpeXruptBlock ( 0343 UINT32 InterruptNumber, 0344 ACPI_GPE_XRUPT_INFO **GpeXruptBlock); 0345 0346 ACPI_STATUS 0347 AcpiEvDeleteGpeXrupt ( 0348 ACPI_GPE_XRUPT_INFO *GpeXrupt); 0349 0350 ACPI_STATUS 0351 AcpiEvDeleteGpeHandlers ( 0352 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 0353 ACPI_GPE_BLOCK_INFO *GpeBlock, 0354 void *Context); 0355 0356 0357 /* 0358 * evhandler - Address space handling 0359 */ 0360 ACPI_OPERAND_OBJECT * 0361 AcpiEvFindRegionHandler ( 0362 ACPI_ADR_SPACE_TYPE SpaceId, 0363 ACPI_OPERAND_OBJECT *HandlerObj); 0364 0365 BOOLEAN 0366 AcpiEvHasDefaultHandler ( 0367 ACPI_NAMESPACE_NODE *Node, 0368 ACPI_ADR_SPACE_TYPE SpaceId); 0369 0370 ACPI_STATUS 0371 AcpiEvInstallRegionHandlers ( 0372 void); 0373 0374 ACPI_STATUS 0375 AcpiEvInstallSpaceHandler ( 0376 ACPI_NAMESPACE_NODE *Node, 0377 ACPI_ADR_SPACE_TYPE SpaceId, 0378 ACPI_ADR_SPACE_HANDLER Handler, 0379 ACPI_ADR_SPACE_SETUP Setup, 0380 void *Context); 0381 0382 0383 /* 0384 * evregion - Operation region support 0385 */ 0386 ACPI_STATUS 0387 AcpiEvInitializeOpRegions ( 0388 void); 0389 0390 ACPI_STATUS 0391 AcpiEvAddressSpaceDispatch ( 0392 ACPI_OPERAND_OBJECT *RegionObj, 0393 ACPI_OPERAND_OBJECT *FieldObj, 0394 UINT32 Function, 0395 UINT32 RegionOffset, 0396 UINT32 BitWidth, 0397 UINT64 *Value); 0398 0399 ACPI_STATUS 0400 AcpiEvAttachRegion ( 0401 ACPI_OPERAND_OBJECT *HandlerObj, 0402 ACPI_OPERAND_OBJECT *RegionObj, 0403 BOOLEAN AcpiNsIsLocked); 0404 0405 void 0406 AcpiEvDetachRegion ( 0407 ACPI_OPERAND_OBJECT *RegionObj, 0408 BOOLEAN AcpiNsIsLocked); 0409 0410 void 0411 AcpiEvExecuteRegMethods ( 0412 ACPI_NAMESPACE_NODE *Node, 0413 ACPI_ADR_SPACE_TYPE SpaceId, 0414 UINT32 Function); 0415 0416 ACPI_STATUS 0417 AcpiEvExecuteRegMethod ( 0418 ACPI_OPERAND_OBJECT *RegionObj, 0419 UINT32 Function); 0420 0421 0422 /* 0423 * evregini - Region initialization and setup 0424 */ 0425 ACPI_STATUS 0426 AcpiEvSystemMemoryRegionSetup ( 0427 ACPI_HANDLE Handle, 0428 UINT32 Function, 0429 void *HandlerContext, 0430 void **RegionContext); 0431 0432 ACPI_STATUS 0433 AcpiEvIoSpaceRegionSetup ( 0434 ACPI_HANDLE Handle, 0435 UINT32 Function, 0436 void *HandlerContext, 0437 void **RegionContext); 0438 0439 ACPI_STATUS 0440 AcpiEvPciConfigRegionSetup ( 0441 ACPI_HANDLE Handle, 0442 UINT32 Function, 0443 void *HandlerContext, 0444 void **RegionContext); 0445 0446 ACPI_STATUS 0447 AcpiEvCmosRegionSetup ( 0448 ACPI_HANDLE Handle, 0449 UINT32 Function, 0450 void *HandlerContext, 0451 void **RegionContext); 0452 0453 ACPI_STATUS 0454 AcpiEvPciBarRegionSetup ( 0455 ACPI_HANDLE Handle, 0456 UINT32 Function, 0457 void *HandlerContext, 0458 void **RegionContext); 0459 0460 ACPI_STATUS 0461 AcpiEvDataTableRegionSetup ( 0462 ACPI_HANDLE Handle, 0463 UINT32 Function, 0464 void *HandlerContext, 0465 void **RegionContext); 0466 0467 ACPI_STATUS 0468 AcpiEvDefaultRegionSetup ( 0469 ACPI_HANDLE Handle, 0470 UINT32 Function, 0471 void *HandlerContext, 0472 void **RegionContext); 0473 0474 ACPI_STATUS 0475 AcpiEvInitializeRegion ( 0476 ACPI_OPERAND_OBJECT *RegionObj); 0477 0478 BOOLEAN 0479 AcpiEvIsPciRootBridge ( 0480 ACPI_NAMESPACE_NODE *Node); 0481 0482 0483 /* 0484 * evsci - SCI (System Control Interrupt) handling/dispatch 0485 */ 0486 UINT32 ACPI_SYSTEM_XFACE 0487 AcpiEvGpeXruptHandler ( 0488 void *Context); 0489 0490 UINT32 0491 AcpiEvSciDispatch ( 0492 void); 0493 0494 UINT32 0495 AcpiEvInstallSciHandler ( 0496 void); 0497 0498 ACPI_STATUS 0499 AcpiEvRemoveAllSciHandlers ( 0500 void); 0501 0502 ACPI_HW_DEPENDENT_RETURN_VOID ( 0503 void 0504 AcpiEvTerminate ( 0505 void)) 0506 0507 #endif /* __ACEVENTS_H__ */
| [ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
|
This page was automatically generated by the 2.3.7 LXR engine. The LXR team |
|