1 /******************************************************************************
3 * Module Name: evgpeinit - System GPE initialization and update
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acevents.h>
155 #include <contrib/dev/acpica/include/acnamesp.h>
157 #define _COMPONENT ACPI_EVENTS
158 ACPI_MODULE_NAME ("evgpeinit")
160 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
163 * Note: History of _PRW support in ACPICA
165 * Originally (2000 - 2010), the GPE initialization code performed a walk of
166 * the entire namespace to execute the _PRW methods and detect all GPEs
167 * capable of waking the system.
169 * As of 10/2010, the _PRW method execution has been removed since it is
170 * actually unnecessary. The host OS must in fact execute all _PRW methods
171 * in order to identify the device/power-resource dependencies. We now put
172 * the onus on the host OS to identify the wake GPEs as part of this process
173 * and to inform ACPICA of these GPEs via the AcpiSetupGpeForWake interface. This
174 * not only reduces the complexity of the ACPICA initialization code, but in
175 * some cases (on systems with very large namespaces) it should reduce the
176 * kernel boot time as well.
179 /*******************************************************************************
181 * FUNCTION: AcpiEvGpeInitialize
187 * DESCRIPTION: Initialize the GPE data structures and the FADT GPE 0/1 blocks
189 ******************************************************************************/
192 AcpiEvGpeInitialize (
195 UINT32 RegisterCount0 = 0;
196 UINT32 RegisterCount1 = 0;
197 UINT32 GpeNumberMax = 0;
201 ACPI_FUNCTION_TRACE (EvGpeInitialize);
204 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
205 "Initializing General Purpose Events (GPEs):\n"));
207 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
208 if (ACPI_FAILURE (Status))
210 return_ACPI_STATUS (Status);
214 * Initialize the GPE Block(s) defined in the FADT
216 * Why the GPE register block lengths are divided by 2: From the ACPI
217 * Spec, section "General-Purpose Event Registers", we have:
219 * "Each register block contains two registers of equal length
220 * GPEx_STS and GPEx_EN (where x is 0 or 1). The length of the
221 * GPE0_STS and GPE0_EN registers is equal to half the GPE0_LEN
222 * The length of the GPE1_STS and GPE1_EN registers is equal to
223 * half the GPE1_LEN. If a generic register block is not supported
224 * then its respective block pointer and block length values in the
225 * FADT table contain zeros. The GPE0_LEN and GPE1_LEN do not need
226 * to be the same size."
230 * Determine the maximum GPE number for this machine.
232 * Note: both GPE0 and GPE1 are optional, and either can exist without
235 * If EITHER the register length OR the block address are zero, then that
236 * particular block is not supported.
238 if (AcpiGbl_FADT.Gpe0BlockLength &&
239 AcpiGbl_FADT.XGpe0Block.Address)
241 /* GPE block 0 exists (has both length and address > 0) */
243 RegisterCount0 = (UINT16) (AcpiGbl_FADT.Gpe0BlockLength / 2);
244 GpeNumberMax = (RegisterCount0 * ACPI_GPE_REGISTER_WIDTH) - 1;
246 /* Install GPE Block 0 */
248 Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
249 AcpiGbl_FADT.XGpe0Block.Address,
250 AcpiGbl_FADT.XGpe0Block.SpaceId,
252 AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[0]);
254 if (ACPI_FAILURE (Status))
256 ACPI_EXCEPTION ((AE_INFO, Status,
257 "Could not create GPE Block 0"));
261 if (AcpiGbl_FADT.Gpe1BlockLength &&
262 AcpiGbl_FADT.XGpe1Block.Address)
264 /* GPE block 1 exists (has both length and address > 0) */
266 RegisterCount1 = (UINT16) (AcpiGbl_FADT.Gpe1BlockLength / 2);
268 /* Check for GPE0/GPE1 overlap (if both banks exist) */
270 if ((RegisterCount0) &&
271 (GpeNumberMax >= AcpiGbl_FADT.Gpe1Base))
273 ACPI_ERROR ((AE_INFO,
274 "GPE0 block (GPE 0 to %u) overlaps the GPE1 block "
275 "(GPE %u to %u) - Ignoring GPE1",
276 GpeNumberMax, AcpiGbl_FADT.Gpe1Base,
277 AcpiGbl_FADT.Gpe1Base +
278 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1)));
280 /* Ignore GPE1 block by setting the register count to zero */
286 /* Install GPE Block 1 */
288 Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
289 AcpiGbl_FADT.XGpe1Block.Address,
290 AcpiGbl_FADT.XGpe1Block.SpaceId,
292 AcpiGbl_FADT.Gpe1Base,
293 AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[1]);
295 if (ACPI_FAILURE (Status))
297 ACPI_EXCEPTION ((AE_INFO, Status,
298 "Could not create GPE Block 1"));
302 * GPE0 and GPE1 do not have to be contiguous in the GPE number
303 * space. However, GPE0 always starts at GPE number zero.
305 GpeNumberMax = AcpiGbl_FADT.Gpe1Base +
306 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1);
310 /* Exit if there are no GPE registers */
312 if ((RegisterCount0 + RegisterCount1) == 0)
314 /* GPEs are not required by ACPI, this is OK */
316 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
317 "There are no GPE blocks defined in the FADT\n"));
324 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
325 return_ACPI_STATUS (AE_OK);
329 /*******************************************************************************
331 * FUNCTION: AcpiEvUpdateGpes
333 * PARAMETERS: TableOwnerId - ID of the newly-loaded ACPI table
337 * DESCRIPTION: Check for new GPE methods (_Lxx/_Exx) made available as a
338 * result of a Load() or LoadTable() operation. If new GPE
339 * methods have been installed, register the new methods.
341 ******************************************************************************/
345 ACPI_OWNER_ID TableOwnerId)
347 ACPI_GPE_XRUPT_INFO *GpeXruptInfo;
348 ACPI_GPE_BLOCK_INFO *GpeBlock;
349 ACPI_GPE_WALK_INFO WalkInfo;
350 ACPI_STATUS Status = AE_OK;
354 * Find any _Lxx/_Exx GPE methods that have just been loaded.
356 * Any GPEs that correspond to new _Lxx/_Exx methods are immediately
359 * Examine the namespace underneath each GpeDevice within the
362 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
363 if (ACPI_FAILURE (Status))
369 WalkInfo.OwnerId = TableOwnerId;
370 WalkInfo.ExecuteByOwnerId = TRUE;
372 /* Walk the interrupt level descriptor list */
374 GpeXruptInfo = AcpiGbl_GpeXruptListHead;
377 /* Walk all Gpe Blocks attached to this interrupt level */
379 GpeBlock = GpeXruptInfo->GpeBlockListHead;
382 WalkInfo.GpeBlock = GpeBlock;
383 WalkInfo.GpeDevice = GpeBlock->Node;
385 Status = AcpiNsWalkNamespace (ACPI_TYPE_METHOD,
386 WalkInfo.GpeDevice, ACPI_UINT32_MAX,
387 ACPI_NS_WALK_NO_UNLOCK, AcpiEvMatchGpeMethod,
388 NULL, &WalkInfo, NULL);
389 if (ACPI_FAILURE (Status))
391 ACPI_EXCEPTION ((AE_INFO, Status,
392 "While decoding _Lxx/_Exx methods"));
395 GpeBlock = GpeBlock->Next;
398 GpeXruptInfo = GpeXruptInfo->Next;
403 ACPI_INFO (("Enabled %u new GPEs", WalkInfo.Count));
406 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
411 /*******************************************************************************
413 * FUNCTION: AcpiEvMatchGpeMethod
415 * PARAMETERS: Callback from WalkNamespace
419 * DESCRIPTION: Called from AcpiWalkNamespace. Expects each object to be a
420 * control method under the _GPE portion of the namespace.
421 * Extract the name and GPE type from the object, saving this
422 * information for quick lookup during GPE dispatch. Allows a
423 * per-OwnerId evaluation if ExecuteByOwnerId is TRUE in the
424 * WalkInfo parameter block.
426 * The name of each GPE control method is of the form:
427 * "_Lxx" or "_Exx", where:
428 * L - means that the GPE is level triggered
429 * E - means that the GPE is edge triggered
430 * xx - is the GPE number [in HEX]
432 * If WalkInfo->ExecuteByOwnerId is TRUE, we only execute examine GPE methods
435 ******************************************************************************/
438 AcpiEvMatchGpeMethod (
439 ACPI_HANDLE ObjHandle,
444 ACPI_NAMESPACE_NODE *MethodNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
445 ACPI_GPE_WALK_INFO *WalkInfo = ACPI_CAST_PTR (ACPI_GPE_WALK_INFO, Context);
446 ACPI_GPE_EVENT_INFO *GpeEventInfo;
450 char Name[ACPI_NAME_SIZE + 1];
454 ACPI_FUNCTION_TRACE (EvMatchGpeMethod);
457 /* Check if requested OwnerId matches this OwnerId */
459 if ((WalkInfo->ExecuteByOwnerId) &&
460 (MethodNode->OwnerId != WalkInfo->OwnerId))
462 return_ACPI_STATUS (AE_OK);
466 * Match and decode the _Lxx and _Exx GPE method names
468 * 1) Extract the method name and null terminate it
470 ACPI_MOVE_32_TO_32 (Name, &MethodNode->Name.Integer);
471 Name[ACPI_NAME_SIZE] = 0;
473 /* 2) Name must begin with an underscore */
477 return_ACPI_STATUS (AE_OK); /* Ignore this method */
481 * 3) Edge/Level determination is based on the 2nd character
488 Type = ACPI_GPE_LEVEL_TRIGGERED;
493 Type = ACPI_GPE_EDGE_TRIGGERED;
498 /* Unknown method type, just ignore it */
500 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
501 "Ignoring unknown GPE method type: %s "
502 "(name not of form _Lxx or _Exx)", Name));
503 return_ACPI_STATUS (AE_OK);
506 /* 4) The last two characters of the name are the hex GPE Number */
508 Status = AcpiUtAsciiToHexByte (&Name[2], &TempGpeNumber);
509 if (ACPI_FAILURE (Status))
511 /* Conversion failed; invalid method, just ignore it */
513 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
514 "Could not extract GPE number from name: %s "
515 "(name is not of form _Lxx or _Exx)", Name));
516 return_ACPI_STATUS (AE_OK);
519 /* Ensure that we have a valid GPE number for this GPE block */
521 GpeNumber = (UINT32) TempGpeNumber;
522 GpeEventInfo = AcpiEvLowGetGpeInfo (GpeNumber, WalkInfo->GpeBlock);
526 * This GpeNumber is not valid for this GPE block, just ignore it.
527 * However, it may be valid for a different GPE block, since GPE0
528 * and GPE1 methods both appear under \_GPE.
530 return_ACPI_STATUS (AE_OK);
533 if ((ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
534 ACPI_GPE_DISPATCH_HANDLER) ||
535 (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
536 ACPI_GPE_DISPATCH_RAW_HANDLER))
538 /* If there is already a handler, ignore this GPE method */
540 return_ACPI_STATUS (AE_OK);
543 if (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
544 ACPI_GPE_DISPATCH_METHOD)
547 * If there is already a method, ignore this method. But check
548 * for a type mismatch (if both the _Lxx AND _Exx exist)
550 if (Type != (GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK))
552 ACPI_ERROR ((AE_INFO,
553 "For GPE 0x%.2X, found both _L%2.2X and _E%2.2X methods",
554 GpeNumber, GpeNumber, GpeNumber));
556 return_ACPI_STATUS (AE_OK);
559 /* Disable the GPE in case it's been enabled already. */
561 (void) AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_DISABLE);
564 * Add the GPE information from above to the GpeEventInfo block for
565 * use during dispatch of this GPE.
567 GpeEventInfo->Flags &= ~(ACPI_GPE_DISPATCH_MASK);
568 GpeEventInfo->Flags |= (UINT8) (Type | ACPI_GPE_DISPATCH_METHOD);
569 GpeEventInfo->Dispatch.MethodNode = MethodNode;
571 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
572 "Registered GPE method %s as GPE number 0x%.2X\n",
574 return_ACPI_STATUS (AE_OK);
577 #endif /* !ACPI_REDUCED_HARDWARE */