1 /******************************************************************************
3 * Module Name: evgpeinit - System GPE initialization and update
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
98 "Initializing General Purpose Events (GPEs):\n"));
100 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
101 if (ACPI_FAILURE (Status))
103 return_ACPI_STATUS (Status);
107 * Initialize the GPE Block(s) defined in the FADT
109 * Why the GPE register block lengths are divided by 2: From the ACPI
110 * Spec, section "General-Purpose Event Registers", we have:
112 * "Each register block contains two registers of equal length
113 * GPEx_STS and GPEx_EN (where x is 0 or 1). The length of the
114 * GPE0_STS and GPE0_EN registers is equal to half the GPE0_LEN
115 * The length of the GPE1_STS and GPE1_EN registers is equal to
116 * half the GPE1_LEN. If a generic register block is not supported
117 * then its respective block pointer and block length values in the
118 * FADT table contain zeros. The GPE0_LEN and GPE1_LEN do not need
119 * to be the same size."
123 * Determine the maximum GPE number for this machine.
125 * Note: both GPE0 and GPE1 are optional, and either can exist without
128 * If EITHER the register length OR the block address are zero, then that
129 * particular block is not supported.
131 if (AcpiGbl_FADT.Gpe0BlockLength &&
132 AcpiGbl_FADT.XGpe0Block.Address)
134 /* GPE block 0 exists (has both length and address > 0) */
136 RegisterCount0 = (UINT16) (AcpiGbl_FADT.Gpe0BlockLength / 2);
137 GpeNumberMax = (RegisterCount0 * ACPI_GPE_REGISTER_WIDTH) - 1;
139 /* Install GPE Block 0 */
141 Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
142 AcpiGbl_FADT.XGpe0Block.Address,
143 AcpiGbl_FADT.XGpe0Block.SpaceId,
145 AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[0]);
147 if (ACPI_FAILURE (Status))
149 ACPI_EXCEPTION ((AE_INFO, Status,
150 "Could not create GPE Block 0"));
154 if (AcpiGbl_FADT.Gpe1BlockLength &&
155 AcpiGbl_FADT.XGpe1Block.Address)
157 /* GPE block 1 exists (has both length and address > 0) */
159 RegisterCount1 = (UINT16) (AcpiGbl_FADT.Gpe1BlockLength / 2);
161 /* Check for GPE0/GPE1 overlap (if both banks exist) */
163 if ((RegisterCount0) &&
164 (GpeNumberMax >= AcpiGbl_FADT.Gpe1Base))
166 ACPI_ERROR ((AE_INFO,
167 "GPE0 block (GPE 0 to %u) overlaps the GPE1 block "
168 "(GPE %u to %u) - Ignoring GPE1",
169 GpeNumberMax, AcpiGbl_FADT.Gpe1Base,
170 AcpiGbl_FADT.Gpe1Base +
171 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1)));
173 /* Ignore GPE1 block by setting the register count to zero */
179 /* Install GPE Block 1 */
181 Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
182 AcpiGbl_FADT.XGpe1Block.Address,
183 AcpiGbl_FADT.XGpe1Block.SpaceId,
185 AcpiGbl_FADT.Gpe1Base,
186 AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[1]);
188 if (ACPI_FAILURE (Status))
190 ACPI_EXCEPTION ((AE_INFO, Status,
191 "Could not create GPE Block 1"));
195 * GPE0 and GPE1 do not have to be contiguous in the GPE number
196 * space. However, GPE0 always starts at GPE number zero.
198 GpeNumberMax = AcpiGbl_FADT.Gpe1Base +
199 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1);
203 /* Exit if there are no GPE registers */
205 if ((RegisterCount0 + RegisterCount1) == 0)
207 /* GPEs are not required by ACPI, this is OK */
209 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
210 "There are no GPE blocks defined in the FADT\n"));
217 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
218 return_ACPI_STATUS (AE_OK);
222 /*******************************************************************************
224 * FUNCTION: AcpiEvUpdateGpes
226 * PARAMETERS: TableOwnerId - ID of the newly-loaded ACPI table
230 * DESCRIPTION: Check for new GPE methods (_Lxx/_Exx) made available as a
231 * result of a Load() or LoadTable() operation. If new GPE
232 * methods have been installed, register the new methods.
234 ******************************************************************************/
238 ACPI_OWNER_ID TableOwnerId)
240 ACPI_GPE_XRUPT_INFO *GpeXruptInfo;
241 ACPI_GPE_BLOCK_INFO *GpeBlock;
242 ACPI_GPE_WALK_INFO WalkInfo;
243 ACPI_STATUS Status = AE_OK;
247 * Find any _Lxx/_Exx GPE methods that have just been loaded.
249 * Any GPEs that correspond to new _Lxx/_Exx methods are immediately
252 * Examine the namespace underneath each GpeDevice within the
255 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
256 if (ACPI_FAILURE (Status))
262 WalkInfo.OwnerId = TableOwnerId;
263 WalkInfo.ExecuteByOwnerId = TRUE;
265 /* Walk the interrupt level descriptor list */
267 GpeXruptInfo = AcpiGbl_GpeXruptListHead;
270 /* Walk all Gpe Blocks attached to this interrupt level */
272 GpeBlock = GpeXruptInfo->GpeBlockListHead;
275 WalkInfo.GpeBlock = GpeBlock;
276 WalkInfo.GpeDevice = GpeBlock->Node;
278 Status = AcpiNsWalkNamespace (ACPI_TYPE_METHOD,
279 WalkInfo.GpeDevice, ACPI_UINT32_MAX,
280 ACPI_NS_WALK_NO_UNLOCK, AcpiEvMatchGpeMethod,
281 NULL, &WalkInfo, NULL);
282 if (ACPI_FAILURE (Status))
284 ACPI_EXCEPTION ((AE_INFO, Status,
285 "While decoding _Lxx/_Exx methods"));
288 GpeBlock = GpeBlock->Next;
291 GpeXruptInfo = GpeXruptInfo->Next;
296 ACPI_INFO ((AE_INFO, "Enabled %u new GPEs", WalkInfo.Count));
299 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
304 /*******************************************************************************
306 * FUNCTION: AcpiEvMatchGpeMethod
308 * PARAMETERS: Callback from WalkNamespace
312 * DESCRIPTION: Called from AcpiWalkNamespace. Expects each object to be a
313 * control method under the _GPE portion of the namespace.
314 * Extract the name and GPE type from the object, saving this
315 * information for quick lookup during GPE dispatch. Allows a
316 * per-OwnerId evaluation if ExecuteByOwnerId is TRUE in the
317 * WalkInfo parameter block.
319 * The name of each GPE control method is of the form:
320 * "_Lxx" or "_Exx", where:
321 * L - means that the GPE is level triggered
322 * E - means that the GPE is edge triggered
323 * xx - is the GPE number [in HEX]
325 * If WalkInfo->ExecuteByOwnerId is TRUE, we only execute examine GPE methods
328 ******************************************************************************/
331 AcpiEvMatchGpeMethod (
332 ACPI_HANDLE ObjHandle,
337 ACPI_NAMESPACE_NODE *MethodNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
338 ACPI_GPE_WALK_INFO *WalkInfo = ACPI_CAST_PTR (ACPI_GPE_WALK_INFO, Context);
339 ACPI_GPE_EVENT_INFO *GpeEventInfo;
341 char Name[ACPI_NAME_SIZE + 1];
345 ACPI_FUNCTION_TRACE (EvMatchGpeMethod);
348 /* Check if requested OwnerId matches this OwnerId */
350 if ((WalkInfo->ExecuteByOwnerId) &&
351 (MethodNode->OwnerId != WalkInfo->OwnerId))
353 return_ACPI_STATUS (AE_OK);
357 * Match and decode the _Lxx and _Exx GPE method names
359 * 1) Extract the method name and null terminate it
361 ACPI_MOVE_32_TO_32 (Name, &MethodNode->Name.Integer);
362 Name[ACPI_NAME_SIZE] = 0;
364 /* 2) Name must begin with an underscore */
368 return_ACPI_STATUS (AE_OK); /* Ignore this method */
372 * 3) Edge/Level determination is based on the 2nd character
379 Type = ACPI_GPE_LEVEL_TRIGGERED;
384 Type = ACPI_GPE_EDGE_TRIGGERED;
389 /* Unknown method type, just ignore it */
391 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
392 "Ignoring unknown GPE method type: %s "
393 "(name not of form _Lxx or _Exx)", Name));
394 return_ACPI_STATUS (AE_OK);
397 /* 4) The last two characters of the name are the hex GPE Number */
399 GpeNumber = ACPI_STRTOUL (&Name[2], NULL, 16);
400 if (GpeNumber == ACPI_UINT32_MAX)
402 /* Conversion failed; invalid method, just ignore it */
404 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
405 "Could not extract GPE number from name: %s "
406 "(name is not of form _Lxx or _Exx)", Name));
407 return_ACPI_STATUS (AE_OK);
410 /* Ensure that we have a valid GPE number for this GPE block */
412 GpeEventInfo = AcpiEvLowGetGpeInfo (GpeNumber, WalkInfo->GpeBlock);
416 * This GpeNumber is not valid for this GPE block, just ignore it.
417 * However, it may be valid for a different GPE block, since GPE0
418 * and GPE1 methods both appear under \_GPE.
420 return_ACPI_STATUS (AE_OK);
423 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
424 ACPI_GPE_DISPATCH_HANDLER)
426 /* If there is already a handler, ignore this GPE method */
428 return_ACPI_STATUS (AE_OK);
431 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
432 ACPI_GPE_DISPATCH_METHOD)
435 * If there is already a method, ignore this method. But check
436 * for a type mismatch (if both the _Lxx AND _Exx exist)
438 if (Type != (GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK))
440 ACPI_ERROR ((AE_INFO,
441 "For GPE 0x%.2X, found both _L%2.2X and _E%2.2X methods",
442 GpeNumber, GpeNumber, GpeNumber));
444 return_ACPI_STATUS (AE_OK);
448 * Add the GPE information from above to the GpeEventInfo block for
449 * use during dispatch of this GPE.
451 GpeEventInfo->Flags &= ~(ACPI_GPE_DISPATCH_MASK);
452 GpeEventInfo->Flags |= (UINT8) (Type | ACPI_GPE_DISPATCH_METHOD);
453 GpeEventInfo->Dispatch.MethodNode = MethodNode;
455 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
456 "Registered GPE method %s as GPE number 0x%.2X\n",
458 return_ACPI_STATUS (AE_OK);
461 #endif /* !ACPI_REDUCED_HARDWARE */