xref: /openbmc/linux/drivers/acpi/acpica/evgpeinit.c (revision b34e08d5)
1 /******************************************************************************
2  *
3  * Module Name: evgpeinit - System GPE initialization and update
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43 
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acevents.h"
47 #include "acnamesp.h"
48 
49 #define _COMPONENT          ACPI_EVENTS
50 ACPI_MODULE_NAME("evgpeinit")
51 #if (!ACPI_REDUCED_HARDWARE)	/* Entire module */
52 /*
53  * Note: History of _PRW support in ACPICA
54  *
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.
58  *
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.
67  */
68 
69 /*******************************************************************************
70  *
71  * FUNCTION:    acpi_ev_gpe_initialize
72  *
73  * PARAMETERS:  None
74  *
75  * RETURN:      Status
76  *
77  * DESCRIPTION: Initialize the GPE data structures and the FADT GPE 0/1 blocks
78  *
79  ******************************************************************************/
80 acpi_status acpi_ev_gpe_initialize(void)
81 {
82 	u32 register_count0 = 0;
83 	u32 register_count1 = 0;
84 	u32 gpe_number_max = 0;
85 	acpi_status status;
86 
87 	ACPI_FUNCTION_TRACE(ev_gpe_initialize);
88 
89 	ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
90 			      "Initializing General Purpose Events (GPEs):\n"));
91 
92 	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
93 	if (ACPI_FAILURE(status)) {
94 		return_ACPI_STATUS(status);
95 	}
96 
97 	/*
98 	 * Initialize the GPE Block(s) defined in the FADT
99 	 *
100 	 * Why the GPE register block lengths are divided by 2:  From the ACPI
101 	 * Spec, section "General-Purpose Event Registers", we have:
102 	 *
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."
111 	 */
112 
113 	/*
114 	 * Determine the maximum GPE number for this machine.
115 	 *
116 	 * Note: both GPE0 and GPE1 are optional, and either can exist without
117 	 * the other.
118 	 *
119 	 * If EITHER the register length OR the block address are zero, then that
120 	 * particular block is not supported.
121 	 */
122 	if (acpi_gbl_FADT.gpe0_block_length &&
123 	    acpi_gbl_FADT.xgpe0_block.address) {
124 
125 		/* GPE block 0 exists (has both length and address > 0) */
126 
127 		register_count0 = (u16)(acpi_gbl_FADT.gpe0_block_length / 2);
128 		gpe_number_max =
129 		    (register_count0 * ACPI_GPE_REGISTER_WIDTH) - 1;
130 
131 		/* Install GPE Block 0 */
132 
133 		status = acpi_ev_create_gpe_block(acpi_gbl_fadt_gpe_device,
134 						  &acpi_gbl_FADT.xgpe0_block,
135 						  register_count0, 0,
136 						  acpi_gbl_FADT.sci_interrupt,
137 						  &acpi_gbl_gpe_fadt_blocks[0]);
138 
139 		if (ACPI_FAILURE(status)) {
140 			ACPI_EXCEPTION((AE_INFO, status,
141 					"Could not create GPE Block 0"));
142 		}
143 	}
144 
145 	if (acpi_gbl_FADT.gpe1_block_length &&
146 	    acpi_gbl_FADT.xgpe1_block.address) {
147 
148 		/* GPE block 1 exists (has both length and address > 0) */
149 
150 		register_count1 = (u16)(acpi_gbl_FADT.gpe1_block_length / 2);
151 
152 		/* Check for GPE0/GPE1 overlap (if both banks exist) */
153 
154 		if ((register_count0) &&
155 		    (gpe_number_max >= acpi_gbl_FADT.gpe1_base)) {
156 			ACPI_ERROR((AE_INFO,
157 				    "GPE0 block (GPE 0 to %u) overlaps the GPE1 block "
158 				    "(GPE %u to %u) - Ignoring GPE1",
159 				    gpe_number_max, acpi_gbl_FADT.gpe1_base,
160 				    acpi_gbl_FADT.gpe1_base +
161 				    ((register_count1 *
162 				      ACPI_GPE_REGISTER_WIDTH) - 1)));
163 
164 			/* Ignore GPE1 block by setting the register count to zero */
165 
166 			register_count1 = 0;
167 		} else {
168 			/* Install GPE Block 1 */
169 
170 			status =
171 			    acpi_ev_create_gpe_block(acpi_gbl_fadt_gpe_device,
172 						     &acpi_gbl_FADT.xgpe1_block,
173 						     register_count1,
174 						     acpi_gbl_FADT.gpe1_base,
175 						     acpi_gbl_FADT.
176 						     sci_interrupt,
177 						     &acpi_gbl_gpe_fadt_blocks
178 						     [1]);
179 
180 			if (ACPI_FAILURE(status)) {
181 				ACPI_EXCEPTION((AE_INFO, status,
182 						"Could not create GPE Block 1"));
183 			}
184 
185 			/*
186 			 * GPE0 and GPE1 do not have to be contiguous in the GPE number
187 			 * space. However, GPE0 always starts at GPE number zero.
188 			 */
189 			gpe_number_max = acpi_gbl_FADT.gpe1_base +
190 			    ((register_count1 * ACPI_GPE_REGISTER_WIDTH) - 1);
191 		}
192 	}
193 
194 	/* Exit if there are no GPE registers */
195 
196 	if ((register_count0 + register_count1) == 0) {
197 
198 		/* GPEs are not required by ACPI, this is OK */
199 
200 		ACPI_DEBUG_PRINT((ACPI_DB_INIT,
201 				  "There are no GPE blocks defined in the FADT\n"));
202 		status = AE_OK;
203 		goto cleanup;
204 	}
205 
206 cleanup:
207 	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
208 	return_ACPI_STATUS(AE_OK);
209 }
210 
211 /*******************************************************************************
212  *
213  * FUNCTION:    acpi_ev_update_gpes
214  *
215  * PARAMETERS:  table_owner_id      - ID of the newly-loaded ACPI table
216  *
217  * RETURN:      None
218  *
219  * DESCRIPTION: Check for new GPE methods (_Lxx/_Exx) made available as a
220  *              result of a Load() or load_table() operation. If new GPE
221  *              methods have been installed, register the new methods.
222  *
223  ******************************************************************************/
224 
225 void acpi_ev_update_gpes(acpi_owner_id table_owner_id)
226 {
227 	struct acpi_gpe_xrupt_info *gpe_xrupt_info;
228 	struct acpi_gpe_block_info *gpe_block;
229 	struct acpi_gpe_walk_info walk_info;
230 	acpi_status status = AE_OK;
231 
232 	/*
233 	 * Find any _Lxx/_Exx GPE methods that have just been loaded.
234 	 *
235 	 * Any GPEs that correspond to new _Lxx/_Exx methods are immediately
236 	 * enabled.
237 	 *
238 	 * Examine the namespace underneath each gpe_device within the
239 	 * gpe_block lists.
240 	 */
241 	status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
242 	if (ACPI_FAILURE(status)) {
243 		return;
244 	}
245 
246 	walk_info.count = 0;
247 	walk_info.owner_id = table_owner_id;
248 	walk_info.execute_by_owner_id = TRUE;
249 
250 	/* Walk the interrupt level descriptor list */
251 
252 	gpe_xrupt_info = acpi_gbl_gpe_xrupt_list_head;
253 	while (gpe_xrupt_info) {
254 
255 		/* Walk all Gpe Blocks attached to this interrupt level */
256 
257 		gpe_block = gpe_xrupt_info->gpe_block_list_head;
258 		while (gpe_block) {
259 			walk_info.gpe_block = gpe_block;
260 			walk_info.gpe_device = gpe_block->node;
261 
262 			status = acpi_ns_walk_namespace(ACPI_TYPE_METHOD,
263 							walk_info.gpe_device,
264 							ACPI_UINT32_MAX,
265 							ACPI_NS_WALK_NO_UNLOCK,
266 							acpi_ev_match_gpe_method,
267 							NULL, &walk_info, NULL);
268 			if (ACPI_FAILURE(status)) {
269 				ACPI_EXCEPTION((AE_INFO, status,
270 						"While decoding _Lxx/_Exx methods"));
271 			}
272 
273 			gpe_block = gpe_block->next;
274 		}
275 
276 		gpe_xrupt_info = gpe_xrupt_info->next;
277 	}
278 
279 	if (walk_info.count) {
280 		ACPI_INFO((AE_INFO, "Enabled %u new GPEs", walk_info.count));
281 	}
282 
283 	(void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
284 	return;
285 }
286 
287 /*******************************************************************************
288  *
289  * FUNCTION:    acpi_ev_match_gpe_method
290  *
291  * PARAMETERS:  Callback from walk_namespace
292  *
293  * RETURN:      Status
294  *
295  * DESCRIPTION: Called from acpi_walk_namespace. Expects each object to be a
296  *              control method under the _GPE portion of the namespace.
297  *              Extract the name and GPE type from the object, saving this
298  *              information for quick lookup during GPE dispatch. Allows a
299  *              per-owner_id evaluation if execute_by_owner_id is TRUE in the
300  *              walk_info parameter block.
301  *
302  *              The name of each GPE control method is of the form:
303  *              "_Lxx" or "_Exx", where:
304  *                  L      - means that the GPE is level triggered
305  *                  E      - means that the GPE is edge triggered
306  *                  xx     - is the GPE number [in HEX]
307  *
308  * If walk_info->execute_by_owner_id is TRUE, we only execute examine GPE methods
309  * with that owner.
310  *
311  ******************************************************************************/
312 
313 acpi_status
314 acpi_ev_match_gpe_method(acpi_handle obj_handle,
315 			 u32 level, void *context, void **return_value)
316 {
317 	struct acpi_namespace_node *method_node =
318 	    ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
319 	struct acpi_gpe_walk_info *walk_info =
320 	    ACPI_CAST_PTR(struct acpi_gpe_walk_info, context);
321 	struct acpi_gpe_event_info *gpe_event_info;
322 	u32 gpe_number;
323 	char name[ACPI_NAME_SIZE + 1];
324 	u8 type;
325 
326 	ACPI_FUNCTION_TRACE(ev_match_gpe_method);
327 
328 	/* Check if requested owner_id matches this owner_id */
329 
330 	if ((walk_info->execute_by_owner_id) &&
331 	    (method_node->owner_id != walk_info->owner_id)) {
332 		return_ACPI_STATUS(AE_OK);
333 	}
334 
335 	/*
336 	 * Match and decode the _Lxx and _Exx GPE method names
337 	 *
338 	 * 1) Extract the method name and null terminate it
339 	 */
340 	ACPI_MOVE_32_TO_32(name, &method_node->name.integer);
341 	name[ACPI_NAME_SIZE] = 0;
342 
343 	/* 2) Name must begin with an underscore */
344 
345 	if (name[0] != '_') {
346 		return_ACPI_STATUS(AE_OK);	/* Ignore this method */
347 	}
348 
349 	/*
350 	 * 3) Edge/Level determination is based on the 2nd character
351 	 *    of the method name
352 	 */
353 	switch (name[1]) {
354 	case 'L':
355 
356 		type = ACPI_GPE_LEVEL_TRIGGERED;
357 		break;
358 
359 	case 'E':
360 
361 		type = ACPI_GPE_EDGE_TRIGGERED;
362 		break;
363 
364 	default:
365 
366 		/* Unknown method type, just ignore it */
367 
368 		ACPI_DEBUG_PRINT((ACPI_DB_LOAD,
369 				  "Ignoring unknown GPE method type: %s "
370 				  "(name not of form _Lxx or _Exx)", name));
371 		return_ACPI_STATUS(AE_OK);
372 	}
373 
374 	/* 4) The last two characters of the name are the hex GPE Number */
375 
376 	gpe_number = ACPI_STRTOUL(&name[2], NULL, 16);
377 	if (gpe_number == ACPI_UINT32_MAX) {
378 
379 		/* Conversion failed; invalid method, just ignore it */
380 
381 		ACPI_DEBUG_PRINT((ACPI_DB_LOAD,
382 				  "Could not extract GPE number from name: %s "
383 				  "(name is not of form _Lxx or _Exx)", name));
384 		return_ACPI_STATUS(AE_OK);
385 	}
386 
387 	/* Ensure that we have a valid GPE number for this GPE block */
388 
389 	gpe_event_info =
390 	    acpi_ev_low_get_gpe_info(gpe_number, walk_info->gpe_block);
391 	if (!gpe_event_info) {
392 		/*
393 		 * This gpe_number is not valid for this GPE block, just ignore it.
394 		 * However, it may be valid for a different GPE block, since GPE0
395 		 * and GPE1 methods both appear under \_GPE.
396 		 */
397 		return_ACPI_STATUS(AE_OK);
398 	}
399 
400 	if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
401 	    ACPI_GPE_DISPATCH_HANDLER) {
402 
403 		/* If there is already a handler, ignore this GPE method */
404 
405 		return_ACPI_STATUS(AE_OK);
406 	}
407 
408 	if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
409 	    ACPI_GPE_DISPATCH_METHOD) {
410 		/*
411 		 * If there is already a method, ignore this method. But check
412 		 * for a type mismatch (if both the _Lxx AND _Exx exist)
413 		 */
414 		if (type != (gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK)) {
415 			ACPI_ERROR((AE_INFO,
416 				    "For GPE 0x%.2X, found both _L%2.2X and _E%2.2X methods",
417 				    gpe_number, gpe_number, gpe_number));
418 		}
419 		return_ACPI_STATUS(AE_OK);
420 	}
421 
422 	/* Disable the GPE in case it's been enabled already. */
423 	(void)acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_DISABLE);
424 
425 	/*
426 	 * Add the GPE information from above to the gpe_event_info block for
427 	 * use during dispatch of this GPE.
428 	 */
429 	gpe_event_info->flags &= ~(ACPI_GPE_DISPATCH_MASK);
430 	gpe_event_info->flags |= (u8)(type | ACPI_GPE_DISPATCH_METHOD);
431 	gpe_event_info->dispatch.method_node = method_node;
432 
433 	ACPI_DEBUG_PRINT((ACPI_DB_LOAD,
434 			  "Registered GPE method %s as GPE number 0x%.2X\n",
435 			  name, gpe_number));
436 	return_ACPI_STATUS(AE_OK);
437 }
438 
439 #endif				/* !ACPI_REDUCED_HARDWARE */
440