1 /******************************************************************************
3 * Module Name: evgpeinit - System GPE initialization and update
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
50 #define _COMPONENT ACPI_EVENTS
51 ACPI_MODULE_NAME ("evgpeinit")
53 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
56 * Note: History of _PRW support in ACPICA
58 * Originally (2000 - 2010), the GPE initialization code performed a walk of
59 * the entire namespace to execute the _PRW methods and detect all GPEs
60 * capable of waking the system.
62 * As of 10/2010, the _PRW method execution has been removed since it is
63 * actually unnecessary. The host OS must in fact execute all _PRW methods
64 * in order to identify the device/power-resource dependencies. We now put
65 * the onus on the host OS to identify the wake GPEs as part of this process
66 * and to inform ACPICA of these GPEs via the AcpiSetupGpeForWake interface. This
67 * not only reduces the complexity of the ACPICA initialization code, but in
68 * some cases (on systems with very large namespaces) it should reduce the
69 * kernel boot time as well.
72 /*******************************************************************************
74 * FUNCTION: AcpiEvGpeInitialize
80 * DESCRIPTION: Initialize the GPE data structures and the FADT GPE 0/1 blocks
82 ******************************************************************************/
88 UINT32 RegisterCount0 = 0;
89 UINT32 RegisterCount1 = 0;
90 UINT32 GpeNumberMax = 0;
94 ACPI_FUNCTION_TRACE (EvGpeInitialize);
97 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
98 if (ACPI_FAILURE (Status))
100 return_ACPI_STATUS (Status);
104 * Initialize the GPE Block(s) defined in the FADT
106 * Why the GPE register block lengths are divided by 2: From the ACPI
107 * Spec, section "General-Purpose Event Registers", we have:
109 * "Each register block contains two registers of equal length
110 * GPEx_STS and GPEx_EN (where x is 0 or 1). The length of the
111 * GPE0_STS and GPE0_EN registers is equal to half the GPE0_LEN
112 * The length of the GPE1_STS and GPE1_EN registers is equal to
113 * half the GPE1_LEN. If a generic register block is not supported
114 * then its respective block pointer and block length values in the
115 * FADT table contain zeros. The GPE0_LEN and GPE1_LEN do not need
116 * to be the same size."
120 * Determine the maximum GPE number for this machine.
122 * Note: both GPE0 and GPE1 are optional, and either can exist without
125 * If EITHER the register length OR the block address are zero, then that
126 * particular block is not supported.
128 if (AcpiGbl_FADT.Gpe0BlockLength &&
129 AcpiGbl_FADT.XGpe0Block.Address)
131 /* GPE block 0 exists (has both length and address > 0) */
133 RegisterCount0 = (UINT16) (AcpiGbl_FADT.Gpe0BlockLength / 2);
135 GpeNumberMax = (RegisterCount0 * ACPI_GPE_REGISTER_WIDTH) - 1;
137 /* Install GPE Block 0 */
139 Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
140 &AcpiGbl_FADT.XGpe0Block, RegisterCount0, 0,
141 AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[0]);
143 if (ACPI_FAILURE (Status))
145 ACPI_EXCEPTION ((AE_INFO, Status,
146 "Could not create GPE Block 0"));
150 if (AcpiGbl_FADT.Gpe1BlockLength &&
151 AcpiGbl_FADT.XGpe1Block.Address)
153 /* GPE block 1 exists (has both length and address > 0) */
155 RegisterCount1 = (UINT16) (AcpiGbl_FADT.Gpe1BlockLength / 2);
157 /* Check for GPE0/GPE1 overlap (if both banks exist) */
159 if ((RegisterCount0) &&
160 (GpeNumberMax >= AcpiGbl_FADT.Gpe1Base))
162 ACPI_ERROR ((AE_INFO,
163 "GPE0 block (GPE 0 to %u) overlaps the GPE1 block "
164 "(GPE %u to %u) - Ignoring GPE1",
165 GpeNumberMax, AcpiGbl_FADT.Gpe1Base,
166 AcpiGbl_FADT.Gpe1Base +
167 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1)));
169 /* Ignore GPE1 block by setting the register count to zero */
175 /* Install GPE Block 1 */
177 Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
178 &AcpiGbl_FADT.XGpe1Block, RegisterCount1,
179 AcpiGbl_FADT.Gpe1Base,
180 AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[1]);
182 if (ACPI_FAILURE (Status))
184 ACPI_EXCEPTION ((AE_INFO, Status,
185 "Could not create GPE Block 1"));
189 * GPE0 and GPE1 do not have to be contiguous in the GPE number
190 * space. However, GPE0 always starts at GPE number zero.
192 GpeNumberMax = AcpiGbl_FADT.Gpe1Base +
193 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1);
197 /* Exit if there are no GPE registers */
199 if ((RegisterCount0 + RegisterCount1) == 0)
201 /* GPEs are not required by ACPI, this is OK */
203 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
204 "There are no GPE blocks defined in the FADT\n"));
209 /* Check for Max GPE number out-of-range */
211 if (GpeNumberMax > ACPI_GPE_MAX)
213 ACPI_ERROR ((AE_INFO,
214 "Maximum GPE number from FADT is too large: 0x%X",
216 Status = AE_BAD_VALUE;
221 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
222 return_ACPI_STATUS (AE_OK);
226 /*******************************************************************************
228 * FUNCTION: AcpiEvUpdateGpes
230 * PARAMETERS: TableOwnerId - ID of the newly-loaded ACPI table
234 * DESCRIPTION: Check for new GPE methods (_Lxx/_Exx) made available as a
235 * result of a Load() or LoadTable() operation. If new GPE
236 * methods have been installed, register the new methods.
238 ******************************************************************************/
242 ACPI_OWNER_ID TableOwnerId)
244 ACPI_GPE_XRUPT_INFO *GpeXruptInfo;
245 ACPI_GPE_BLOCK_INFO *GpeBlock;
246 ACPI_GPE_WALK_INFO WalkInfo;
247 ACPI_STATUS Status = AE_OK;
251 * Find any _Lxx/_Exx GPE methods that have just been loaded.
253 * Any GPEs that correspond to new _Lxx/_Exx methods are immediately
256 * Examine the namespace underneath each GpeDevice within the
259 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
260 if (ACPI_FAILURE (Status))
266 WalkInfo.OwnerId = TableOwnerId;
267 WalkInfo.ExecuteByOwnerId = TRUE;
269 /* Walk the interrupt level descriptor list */
271 GpeXruptInfo = AcpiGbl_GpeXruptListHead;
274 /* Walk all Gpe Blocks attached to this interrupt level */
276 GpeBlock = GpeXruptInfo->GpeBlockListHead;
279 WalkInfo.GpeBlock = GpeBlock;
280 WalkInfo.GpeDevice = GpeBlock->Node;
282 Status = AcpiNsWalkNamespace (ACPI_TYPE_METHOD,
283 WalkInfo.GpeDevice, ACPI_UINT32_MAX,
284 ACPI_NS_WALK_NO_UNLOCK, AcpiEvMatchGpeMethod,
285 NULL, &WalkInfo, NULL);
286 if (ACPI_FAILURE (Status))
288 ACPI_EXCEPTION ((AE_INFO, Status,
289 "While decoding _Lxx/_Exx methods"));
292 GpeBlock = GpeBlock->Next;
295 GpeXruptInfo = GpeXruptInfo->Next;
300 ACPI_INFO ((AE_INFO, "Enabled %u new GPEs", WalkInfo.Count));
303 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
308 /*******************************************************************************
310 * FUNCTION: AcpiEvMatchGpeMethod
312 * PARAMETERS: Callback from WalkNamespace
316 * DESCRIPTION: Called from AcpiWalkNamespace. Expects each object to be a
317 * control method under the _GPE portion of the namespace.
318 * Extract the name and GPE type from the object, saving this
319 * information for quick lookup during GPE dispatch. Allows a
320 * per-OwnerId evaluation if ExecuteByOwnerId is TRUE in the
321 * WalkInfo parameter block.
323 * The name of each GPE control method is of the form:
324 * "_Lxx" or "_Exx", where:
325 * L - means that the GPE is level triggered
326 * E - means that the GPE is edge triggered
327 * xx - is the GPE number [in HEX]
329 * If WalkInfo->ExecuteByOwnerId is TRUE, we only execute examine GPE methods
332 ******************************************************************************/
335 AcpiEvMatchGpeMethod (
336 ACPI_HANDLE ObjHandle,
341 ACPI_NAMESPACE_NODE *MethodNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
342 ACPI_GPE_WALK_INFO *WalkInfo = ACPI_CAST_PTR (ACPI_GPE_WALK_INFO, Context);
343 ACPI_GPE_EVENT_INFO *GpeEventInfo;
345 char Name[ACPI_NAME_SIZE + 1];
349 ACPI_FUNCTION_TRACE (EvMatchGpeMethod);
352 /* Check if requested OwnerId matches this OwnerId */
354 if ((WalkInfo->ExecuteByOwnerId) &&
355 (MethodNode->OwnerId != WalkInfo->OwnerId))
357 return_ACPI_STATUS (AE_OK);
361 * Match and decode the _Lxx and _Exx GPE method names
363 * 1) Extract the method name and null terminate it
365 ACPI_MOVE_32_TO_32 (Name, &MethodNode->Name.Integer);
366 Name[ACPI_NAME_SIZE] = 0;
368 /* 2) Name must begin with an underscore */
372 return_ACPI_STATUS (AE_OK); /* Ignore this method */
376 * 3) Edge/Level determination is based on the 2nd character
382 Type = ACPI_GPE_LEVEL_TRIGGERED;
386 Type = ACPI_GPE_EDGE_TRIGGERED;
390 /* Unknown method type, just ignore it */
392 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
393 "Ignoring unknown GPE method type: %s "
394 "(name not of form _Lxx or _Exx)", Name));
395 return_ACPI_STATUS (AE_OK);
398 /* 4) The last two characters of the name are the hex GPE Number */
400 GpeNumber = ACPI_STRTOUL (&Name[2], NULL, 16);
401 if (GpeNumber == ACPI_UINT32_MAX)
403 /* Conversion failed; invalid method, just ignore it */
405 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
406 "Could not extract GPE number from name: %s "
407 "(name is not of form _Lxx or _Exx)", Name));
408 return_ACPI_STATUS (AE_OK);
411 /* Ensure that we have a valid GPE number for this GPE block */
413 GpeEventInfo = AcpiEvLowGetGpeInfo (GpeNumber, WalkInfo->GpeBlock);
417 * This GpeNumber is not valid for this GPE block, just ignore it.
418 * However, it may be valid for a different GPE block, since GPE0
419 * and GPE1 methods both appear under \_GPE.
421 return_ACPI_STATUS (AE_OK);
424 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
425 ACPI_GPE_DISPATCH_HANDLER)
427 /* If there is already a handler, ignore this GPE method */
429 return_ACPI_STATUS (AE_OK);
432 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
433 ACPI_GPE_DISPATCH_METHOD)
436 * If there is already a method, ignore this method. But check
437 * for a type mismatch (if both the _Lxx AND _Exx exist)
439 if (Type != (GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK))
441 ACPI_ERROR ((AE_INFO,
442 "For GPE 0x%.2X, found both _L%2.2X and _E%2.2X methods",
443 GpeNumber, GpeNumber, GpeNumber));
445 return_ACPI_STATUS (AE_OK);
449 * Add the GPE information from above to the GpeEventInfo block for
450 * use during dispatch of this GPE.
452 GpeEventInfo->Flags &= ~(ACPI_GPE_DISPATCH_MASK);
453 GpeEventInfo->Flags |= (UINT8) (Type | ACPI_GPE_DISPATCH_METHOD);
454 GpeEventInfo->Dispatch.MethodNode = MethodNode;
456 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
457 "Registered GPE method %s as GPE number 0x%.2X\n",
459 return_ACPI_STATUS (AE_OK);
462 #endif /* !ACPI_REDUCED_HARDWARE */