1 /******************************************************************************
3 * Module Name: evgpeinit - System GPE initialization and update
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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.
44 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME("evgpeinit")
51 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
53 * Note: History of _PRW support in ACPICA
55 * Originally (2000 - 2010), the GPE initialization code performed a walk of
56 * the entire namespace to execute the _PRW methods and detect all GPEs
57 * capable of waking the system.
59 * As of 10/2010, the _PRW method execution has been removed since it is
60 * actually unnecessary. The host OS must in fact execute all _PRW methods
61 * in order to identify the device/power-resource dependencies. We now put
62 * the onus on the host OS to identify the wake GPEs as part of this process
63 * and to inform ACPICA of these GPEs via the acpi_setup_gpe_for_wake interface. This
64 * not only reduces the complexity of the ACPICA initialization code, but in
65 * some cases (on systems with very large namespaces) it should reduce the
66 * kernel boot time as well.
69 /*******************************************************************************
71 * FUNCTION: acpi_ev_gpe_initialize
77 * DESCRIPTION: Initialize the GPE data structures and the FADT GPE 0/1 blocks
79 ******************************************************************************/
80 acpi_status
acpi_ev_gpe_initialize(void)
82 u32 register_count0
= 0;
83 u32 register_count1
= 0;
84 u32 gpe_number_max
= 0;
87 ACPI_FUNCTION_TRACE(ev_gpe_initialize
);
89 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
90 "Initializing General Purpose Events (GPEs):\n"));
92 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
93 if (ACPI_FAILURE(status
)) {
94 return_ACPI_STATUS(status
);
98 * Initialize the GPE Block(s) defined in the FADT
100 * Why the GPE register block lengths are divided by 2: From the ACPI
101 * Spec, section "General-Purpose Event Registers", we have:
103 * "Each register block contains two registers of equal length
104 * GPEx_STS and GPEx_EN (where x is 0 or 1). The length of the
105 * GPE0_STS and GPE0_EN registers is equal to half the GPE0_LEN
106 * The length of the GPE1_STS and GPE1_EN registers is equal to
107 * half the GPE1_LEN. If a generic register block is not supported
108 * then its respective block pointer and block length values in the
109 * FADT table contain zeros. The GPE0_LEN and GPE1_LEN do not need
110 * to be the same size."
114 * Determine the maximum GPE number for this machine.
116 * Note: both GPE0 and GPE1 are optional, and either can exist without
119 * If EITHER the register length OR the block address are zero, then that
120 * particular block is not supported.
122 if (acpi_gbl_FADT
.gpe0_block_length
&&
123 acpi_gbl_FADT
.xgpe0_block
.address
) {
125 /* GPE block 0 exists (has both length and address > 0) */
127 register_count0
= (u16
)(acpi_gbl_FADT
.gpe0_block_length
/ 2);
129 (register_count0
* ACPI_GPE_REGISTER_WIDTH
) - 1;
131 /* Install GPE Block 0 */
133 status
= acpi_ev_create_gpe_block(acpi_gbl_fadt_gpe_device
,
134 acpi_gbl_FADT
.xgpe0_block
.
136 acpi_gbl_FADT
.xgpe0_block
.
137 space_id
, register_count0
, 0,
138 acpi_gbl_FADT
.sci_interrupt
,
139 &acpi_gbl_gpe_fadt_blocks
[0]);
141 if (ACPI_FAILURE(status
)) {
142 ACPI_EXCEPTION((AE_INFO
, status
,
143 "Could not create GPE Block 0"));
147 if (acpi_gbl_FADT
.gpe1_block_length
&&
148 acpi_gbl_FADT
.xgpe1_block
.address
) {
150 /* GPE block 1 exists (has both length and address > 0) */
152 register_count1
= (u16
)(acpi_gbl_FADT
.gpe1_block_length
/ 2);
154 /* Check for GPE0/GPE1 overlap (if both banks exist) */
156 if ((register_count0
) &&
157 (gpe_number_max
>= acpi_gbl_FADT
.gpe1_base
)) {
159 "GPE0 block (GPE 0 to %u) overlaps the GPE1 block "
160 "(GPE %u to %u) - Ignoring GPE1",
161 gpe_number_max
, acpi_gbl_FADT
.gpe1_base
,
162 acpi_gbl_FADT
.gpe1_base
+
164 ACPI_GPE_REGISTER_WIDTH
) - 1)));
166 /* Ignore GPE1 block by setting the register count to zero */
170 /* Install GPE Block 1 */
173 acpi_ev_create_gpe_block(acpi_gbl_fadt_gpe_device
,
174 acpi_gbl_FADT
.xgpe1_block
.
176 acpi_gbl_FADT
.xgpe1_block
.
177 space_id
, register_count1
,
178 acpi_gbl_FADT
.gpe1_base
,
181 &acpi_gbl_gpe_fadt_blocks
184 if (ACPI_FAILURE(status
)) {
185 ACPI_EXCEPTION((AE_INFO
, status
,
186 "Could not create GPE Block 1"));
190 * GPE0 and GPE1 do not have to be contiguous in the GPE number
191 * space. However, GPE0 always starts at GPE number zero.
193 gpe_number_max
= acpi_gbl_FADT
.gpe1_base
+
194 ((register_count1
* ACPI_GPE_REGISTER_WIDTH
) - 1);
198 /* Exit if there are no GPE registers */
200 if ((register_count0
+ register_count1
) == 0) {
202 /* GPEs are not required by ACPI, this is OK */
204 ACPI_DEBUG_PRINT((ACPI_DB_INIT
,
205 "There are no GPE blocks defined in the FADT\n"));
211 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
212 return_ACPI_STATUS(AE_OK
);
215 /*******************************************************************************
217 * FUNCTION: acpi_ev_update_gpes
219 * PARAMETERS: table_owner_id - ID of the newly-loaded ACPI table
223 * DESCRIPTION: Check for new GPE methods (_Lxx/_Exx) made available as a
224 * result of a Load() or load_table() operation. If new GPE
225 * methods have been installed, register the new methods.
227 ******************************************************************************/
229 void acpi_ev_update_gpes(acpi_owner_id table_owner_id
)
231 struct acpi_gpe_xrupt_info
*gpe_xrupt_info
;
232 struct acpi_gpe_block_info
*gpe_block
;
233 struct acpi_gpe_walk_info walk_info
;
234 acpi_status status
= AE_OK
;
237 * Find any _Lxx/_Exx GPE methods that have just been loaded.
239 * Any GPEs that correspond to new _Lxx/_Exx methods are immediately
242 * Examine the namespace underneath each gpe_device within the
245 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
246 if (ACPI_FAILURE(status
)) {
251 walk_info
.owner_id
= table_owner_id
;
252 walk_info
.execute_by_owner_id
= TRUE
;
254 /* Walk the interrupt level descriptor list */
256 gpe_xrupt_info
= acpi_gbl_gpe_xrupt_list_head
;
257 while (gpe_xrupt_info
) {
259 /* Walk all Gpe Blocks attached to this interrupt level */
261 gpe_block
= gpe_xrupt_info
->gpe_block_list_head
;
263 walk_info
.gpe_block
= gpe_block
;
264 walk_info
.gpe_device
= gpe_block
->node
;
266 status
= acpi_ns_walk_namespace(ACPI_TYPE_METHOD
,
267 walk_info
.gpe_device
,
269 ACPI_NS_WALK_NO_UNLOCK
,
270 acpi_ev_match_gpe_method
,
271 NULL
, &walk_info
, NULL
);
272 if (ACPI_FAILURE(status
)) {
273 ACPI_EXCEPTION((AE_INFO
, status
,
274 "While decoding _Lxx/_Exx methods"));
277 gpe_block
= gpe_block
->next
;
280 gpe_xrupt_info
= gpe_xrupt_info
->next
;
283 if (walk_info
.count
) {
284 ACPI_INFO(("Enabled %u new GPEs", walk_info
.count
));
287 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
291 /*******************************************************************************
293 * FUNCTION: acpi_ev_match_gpe_method
295 * PARAMETERS: Callback from walk_namespace
299 * DESCRIPTION: Called from acpi_walk_namespace. Expects each object to be a
300 * control method under the _GPE portion of the namespace.
301 * Extract the name and GPE type from the object, saving this
302 * information for quick lookup during GPE dispatch. Allows a
303 * per-owner_id evaluation if execute_by_owner_id is TRUE in the
304 * walk_info parameter block.
306 * The name of each GPE control method is of the form:
307 * "_Lxx" or "_Exx", where:
308 * L - means that the GPE is level triggered
309 * E - means that the GPE is edge triggered
310 * xx - is the GPE number [in HEX]
312 * If walk_info->execute_by_owner_id is TRUE, we only execute examine GPE methods
315 ******************************************************************************/
318 acpi_ev_match_gpe_method(acpi_handle obj_handle
,
319 u32 level
, void *context
, void **return_value
)
321 struct acpi_namespace_node
*method_node
=
322 ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
323 struct acpi_gpe_walk_info
*walk_info
=
324 ACPI_CAST_PTR(struct acpi_gpe_walk_info
, context
);
325 struct acpi_gpe_event_info
*gpe_event_info
;
329 char name
[ACPI_NAME_SIZE
+ 1];
332 ACPI_FUNCTION_TRACE(ev_match_gpe_method
);
334 /* Check if requested owner_id matches this owner_id */
336 if ((walk_info
->execute_by_owner_id
) &&
337 (method_node
->owner_id
!= walk_info
->owner_id
)) {
338 return_ACPI_STATUS(AE_OK
);
342 * Match and decode the _Lxx and _Exx GPE method names
344 * 1) Extract the method name and null terminate it
346 ACPI_MOVE_32_TO_32(name
, &method_node
->name
.integer
);
347 name
[ACPI_NAME_SIZE
] = 0;
349 /* 2) Name must begin with an underscore */
351 if (name
[0] != '_') {
352 return_ACPI_STATUS(AE_OK
); /* Ignore this method */
356 * 3) Edge/Level determination is based on the 2nd character
362 type
= ACPI_GPE_LEVEL_TRIGGERED
;
367 type
= ACPI_GPE_EDGE_TRIGGERED
;
372 /* Unknown method type, just ignore it */
374 ACPI_DEBUG_PRINT((ACPI_DB_LOAD
,
375 "Ignoring unknown GPE method type: %s "
376 "(name not of form _Lxx or _Exx)", name
));
377 return_ACPI_STATUS(AE_OK
);
380 /* 4) The last two characters of the name are the hex GPE Number */
382 status
= acpi_ut_ascii_to_hex_byte(&name
[2], &temp_gpe_number
);
383 if (ACPI_FAILURE(status
)) {
385 /* Conversion failed; invalid method, just ignore it */
387 ACPI_DEBUG_PRINT((ACPI_DB_LOAD
,
388 "Could not extract GPE number from name: %s "
389 "(name is not of form _Lxx or _Exx)", name
));
390 return_ACPI_STATUS(AE_OK
);
393 /* Ensure that we have a valid GPE number for this GPE block */
395 gpe_number
= (u32
)temp_gpe_number
;
397 acpi_ev_low_get_gpe_info(gpe_number
, walk_info
->gpe_block
);
398 if (!gpe_event_info
) {
400 * This gpe_number is not valid for this GPE block, just ignore it.
401 * However, it may be valid for a different GPE block, since GPE0
402 * and GPE1 methods both appear under \_GPE.
404 return_ACPI_STATUS(AE_OK
);
407 if ((ACPI_GPE_DISPATCH_TYPE(gpe_event_info
->flags
) ==
408 ACPI_GPE_DISPATCH_HANDLER
) ||
409 (ACPI_GPE_DISPATCH_TYPE(gpe_event_info
->flags
) ==
410 ACPI_GPE_DISPATCH_RAW_HANDLER
)) {
412 /* If there is already a handler, ignore this GPE method */
414 return_ACPI_STATUS(AE_OK
);
417 if (ACPI_GPE_DISPATCH_TYPE(gpe_event_info
->flags
) ==
418 ACPI_GPE_DISPATCH_METHOD
) {
420 * If there is already a method, ignore this method. But check
421 * for a type mismatch (if both the _Lxx AND _Exx exist)
423 if (type
!= (gpe_event_info
->flags
& ACPI_GPE_XRUPT_TYPE_MASK
)) {
425 "For GPE 0x%.2X, found both _L%2.2X and _E%2.2X methods",
426 gpe_number
, gpe_number
, gpe_number
));
428 return_ACPI_STATUS(AE_OK
);
431 /* Disable the GPE in case it's been enabled already. */
433 (void)acpi_hw_low_set_gpe(gpe_event_info
, ACPI_GPE_DISABLE
);
436 * Add the GPE information from above to the gpe_event_info block for
437 * use during dispatch of this GPE.
439 gpe_event_info
->flags
&= ~(ACPI_GPE_DISPATCH_MASK
);
440 gpe_event_info
->flags
|= (u8
)(type
| ACPI_GPE_DISPATCH_METHOD
);
441 gpe_event_info
->dispatch
.method_node
= method_node
;
443 ACPI_DEBUG_PRINT((ACPI_DB_LOAD
,
444 "Registered GPE method %s as GPE number 0x%.2X\n",
446 return_ACPI_STATUS(AE_OK
);
449 #endif /* !ACPI_REDUCED_HARDWARE */