1 /******************************************************************************
3 * Module Name: evgpeblk - GPE block creation and initialization.
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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("evgpeblk")
52 /* Local prototypes */
54 acpi_ev_install_gpe_block(struct acpi_gpe_block_info
*gpe_block
,
55 u32 interrupt_number
);
58 acpi_ev_create_gpe_info_blocks(struct acpi_gpe_block_info
*gpe_block
);
60 /*******************************************************************************
62 * FUNCTION: acpi_ev_install_gpe_block
64 * PARAMETERS: gpe_block - New GPE block
65 * interrupt_number - Xrupt to be associated with this
70 * DESCRIPTION: Install new GPE block with mutex support
72 ******************************************************************************/
75 acpi_ev_install_gpe_block(struct acpi_gpe_block_info
*gpe_block
,
78 struct acpi_gpe_block_info
*next_gpe_block
;
79 struct acpi_gpe_xrupt_info
*gpe_xrupt_block
;
83 ACPI_FUNCTION_TRACE(ev_install_gpe_block
);
85 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
86 if (ACPI_FAILURE(status
)) {
87 return_ACPI_STATUS(status
);
90 gpe_xrupt_block
= acpi_ev_get_gpe_xrupt_block(interrupt_number
);
91 if (!gpe_xrupt_block
) {
92 status
= AE_NO_MEMORY
;
96 /* Install the new block at the end of the list with lock */
98 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
99 if (gpe_xrupt_block
->gpe_block_list_head
) {
100 next_gpe_block
= gpe_xrupt_block
->gpe_block_list_head
;
101 while (next_gpe_block
->next
) {
102 next_gpe_block
= next_gpe_block
->next
;
105 next_gpe_block
->next
= gpe_block
;
106 gpe_block
->previous
= next_gpe_block
;
108 gpe_xrupt_block
->gpe_block_list_head
= gpe_block
;
111 gpe_block
->xrupt_block
= gpe_xrupt_block
;
112 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
115 status
= acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
116 return_ACPI_STATUS(status
);
119 /*******************************************************************************
121 * FUNCTION: acpi_ev_delete_gpe_block
123 * PARAMETERS: gpe_block - Existing GPE block
127 * DESCRIPTION: Remove a GPE block
129 ******************************************************************************/
131 acpi_status
acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
*gpe_block
)
134 acpi_cpu_flags flags
;
136 ACPI_FUNCTION_TRACE(ev_install_gpe_block
);
138 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
139 if (ACPI_FAILURE(status
)) {
140 return_ACPI_STATUS(status
);
143 /* Disable all GPEs in this block */
146 acpi_hw_disable_gpe_block(gpe_block
->xrupt_block
, gpe_block
, NULL
);
148 if (!gpe_block
->previous
&& !gpe_block
->next
) {
150 /* This is the last gpe_block on this interrupt */
152 status
= acpi_ev_delete_gpe_xrupt(gpe_block
->xrupt_block
);
153 if (ACPI_FAILURE(status
)) {
154 goto unlock_and_exit
;
157 /* Remove the block on this interrupt with lock */
159 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
160 if (gpe_block
->previous
) {
161 gpe_block
->previous
->next
= gpe_block
->next
;
163 gpe_block
->xrupt_block
->gpe_block_list_head
=
167 if (gpe_block
->next
) {
168 gpe_block
->next
->previous
= gpe_block
->previous
;
170 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
173 acpi_current_gpe_count
-= gpe_block
->gpe_count
;
175 /* Free the gpe_block */
177 ACPI_FREE(gpe_block
->register_info
);
178 ACPI_FREE(gpe_block
->event_info
);
179 ACPI_FREE(gpe_block
);
182 status
= acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
183 return_ACPI_STATUS(status
);
186 /*******************************************************************************
188 * FUNCTION: acpi_ev_create_gpe_info_blocks
190 * PARAMETERS: gpe_block - New GPE block
194 * DESCRIPTION: Create the register_info and event_info blocks for this GPE block
196 ******************************************************************************/
199 acpi_ev_create_gpe_info_blocks(struct acpi_gpe_block_info
*gpe_block
)
201 struct acpi_gpe_register_info
*gpe_register_info
= NULL
;
202 struct acpi_gpe_event_info
*gpe_event_info
= NULL
;
203 struct acpi_gpe_event_info
*this_event
;
204 struct acpi_gpe_register_info
*this_register
;
209 ACPI_FUNCTION_TRACE(ev_create_gpe_info_blocks
);
211 /* Allocate the GPE register information block */
213 gpe_register_info
= ACPI_ALLOCATE_ZEROED((acpi_size
) gpe_block
->
216 acpi_gpe_register_info
));
217 if (!gpe_register_info
) {
219 "Could not allocate the GpeRegisterInfo table"));
220 return_ACPI_STATUS(AE_NO_MEMORY
);
224 * Allocate the GPE event_info block. There are eight distinct GPEs
225 * per register. Initialization to zeros is sufficient.
227 gpe_event_info
= ACPI_ALLOCATE_ZEROED((acpi_size
) gpe_block
->gpe_count
*
229 acpi_gpe_event_info
));
230 if (!gpe_event_info
) {
232 "Could not allocate the GpeEventInfo table"));
233 status
= AE_NO_MEMORY
;
237 /* Save the new Info arrays in the GPE block */
239 gpe_block
->register_info
= gpe_register_info
;
240 gpe_block
->event_info
= gpe_event_info
;
243 * Initialize the GPE Register and Event structures. A goal of these
244 * tables is to hide the fact that there are two separate GPE register
245 * sets in a given GPE hardware block, the status registers occupy the
246 * first half, and the enable registers occupy the second half.
248 this_register
= gpe_register_info
;
249 this_event
= gpe_event_info
;
251 for (i
= 0; i
< gpe_block
->register_count
; i
++) {
253 /* Init the register_info for this GPE register (8 GPEs) */
255 this_register
->base_gpe_number
=
256 (u8
) (gpe_block
->block_base_number
+
257 (i
* ACPI_GPE_REGISTER_WIDTH
));
259 this_register
->status_address
.address
=
260 gpe_block
->block_address
.address
+ i
;
262 this_register
->enable_address
.address
=
263 gpe_block
->block_address
.address
+ i
+
264 gpe_block
->register_count
;
266 this_register
->status_address
.space_id
=
267 gpe_block
->block_address
.space_id
;
268 this_register
->enable_address
.space_id
=
269 gpe_block
->block_address
.space_id
;
270 this_register
->status_address
.bit_width
=
271 ACPI_GPE_REGISTER_WIDTH
;
272 this_register
->enable_address
.bit_width
=
273 ACPI_GPE_REGISTER_WIDTH
;
274 this_register
->status_address
.bit_offset
= 0;
275 this_register
->enable_address
.bit_offset
= 0;
277 /* Init the event_info for each GPE within this register */
279 for (j
= 0; j
< ACPI_GPE_REGISTER_WIDTH
; j
++) {
280 this_event
->gpe_number
=
281 (u8
) (this_register
->base_gpe_number
+ j
);
282 this_event
->register_info
= this_register
;
286 /* Disable all GPEs within this register */
288 status
= acpi_hw_write(0x00, &this_register
->enable_address
);
289 if (ACPI_FAILURE(status
)) {
293 /* Clear any pending GPE events within this register */
295 status
= acpi_hw_write(0xFF, &this_register
->status_address
);
296 if (ACPI_FAILURE(status
)) {
303 return_ACPI_STATUS(AE_OK
);
306 if (gpe_register_info
) {
307 ACPI_FREE(gpe_register_info
);
309 if (gpe_event_info
) {
310 ACPI_FREE(gpe_event_info
);
313 return_ACPI_STATUS(status
);
316 /*******************************************************************************
318 * FUNCTION: acpi_ev_create_gpe_block
320 * PARAMETERS: gpe_device - Handle to the parent GPE block
321 * gpe_block_address - Address and space_iD
322 * register_count - Number of GPE register pairs in the block
323 * gpe_block_base_number - Starting GPE number for the block
324 * interrupt_number - H/W interrupt for the block
325 * return_gpe_block - Where the new block descriptor is returned
329 * DESCRIPTION: Create and Install a block of GPE registers. All GPEs within
330 * the block are disabled at exit.
331 * Note: Assumes namespace is locked.
333 ******************************************************************************/
336 acpi_ev_create_gpe_block(struct acpi_namespace_node
*gpe_device
,
337 struct acpi_generic_address
*gpe_block_address
,
339 u8 gpe_block_base_number
,
340 u32 interrupt_number
,
341 struct acpi_gpe_block_info
**return_gpe_block
)
344 struct acpi_gpe_block_info
*gpe_block
;
345 struct acpi_gpe_walk_info walk_info
;
347 ACPI_FUNCTION_TRACE(ev_create_gpe_block
);
349 if (!register_count
) {
350 return_ACPI_STATUS(AE_OK
);
353 /* Allocate a new GPE block */
355 gpe_block
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_block_info
));
357 return_ACPI_STATUS(AE_NO_MEMORY
);
360 /* Initialize the new GPE block */
362 gpe_block
->node
= gpe_device
;
363 gpe_block
->gpe_count
= (u16
)(register_count
* ACPI_GPE_REGISTER_WIDTH
);
364 gpe_block
->initialized
= FALSE
;
365 gpe_block
->register_count
= register_count
;
366 gpe_block
->block_base_number
= gpe_block_base_number
;
368 ACPI_MEMCPY(&gpe_block
->block_address
, gpe_block_address
,
369 sizeof(struct acpi_generic_address
));
372 * Create the register_info and event_info sub-structures
373 * Note: disables and clears all GPEs in the block
375 status
= acpi_ev_create_gpe_info_blocks(gpe_block
);
376 if (ACPI_FAILURE(status
)) {
377 ACPI_FREE(gpe_block
);
378 return_ACPI_STATUS(status
);
381 /* Install the new block in the global lists */
383 status
= acpi_ev_install_gpe_block(gpe_block
, interrupt_number
);
384 if (ACPI_FAILURE(status
)) {
385 ACPI_FREE(gpe_block
);
386 return_ACPI_STATUS(status
);
389 acpi_gbl_all_gpes_initialized
= FALSE
;
391 /* Find all GPE methods (_Lxx or_Exx) for this block */
393 walk_info
.gpe_block
= gpe_block
;
394 walk_info
.gpe_device
= gpe_device
;
395 walk_info
.execute_by_owner_id
= FALSE
;
397 status
= acpi_ns_walk_namespace(ACPI_TYPE_METHOD
, gpe_device
,
398 ACPI_UINT32_MAX
, ACPI_NS_WALK_NO_UNLOCK
,
399 acpi_ev_match_gpe_method
, NULL
,
402 /* Return the new block */
404 if (return_gpe_block
) {
405 (*return_gpe_block
) = gpe_block
;
408 ACPI_DEBUG_PRINT((ACPI_DB_INIT
,
409 "GPE %02X to %02X [%4.4s] %u regs on int 0x%X\n",
410 (u32
) gpe_block
->block_base_number
,
411 (u32
) (gpe_block
->block_base_number
+
412 (gpe_block
->gpe_count
- 1)),
413 gpe_device
->name
.ascii
, gpe_block
->register_count
,
416 /* Update global count of currently available GPEs */
418 acpi_current_gpe_count
+= gpe_block
->gpe_count
;
419 return_ACPI_STATUS(AE_OK
);
422 /*******************************************************************************
424 * FUNCTION: acpi_ev_initialize_gpe_block
426 * PARAMETERS: acpi_gpe_callback
430 * DESCRIPTION: Initialize and enable a GPE block. Enable GPEs that have
431 * associated methods.
432 * Note: Assumes namespace is locked.
434 ******************************************************************************/
437 acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info
*gpe_xrupt_info
,
438 struct acpi_gpe_block_info
*gpe_block
,
442 struct acpi_gpe_event_info
*gpe_event_info
;
443 u32 gpe_enabled_count
;
448 ACPI_FUNCTION_TRACE(ev_initialize_gpe_block
);
451 * Ignore a null GPE block (e.g., if no GPE block 1 exists), and
452 * any GPE blocks that have been initialized already.
454 if (!gpe_block
|| gpe_block
->initialized
) {
455 return_ACPI_STATUS(AE_OK
);
459 * Enable all GPEs that have a corresponding method and have the
460 * ACPI_GPE_CAN_WAKE flag unset. Any other GPEs within this block
461 * must be enabled via the acpi_enable_gpe() interface.
463 gpe_enabled_count
= 0;
465 for (i
= 0; i
< gpe_block
->register_count
; i
++) {
466 for (j
= 0; j
< ACPI_GPE_REGISTER_WIDTH
; j
++) {
468 /* Get the info block for this particular GPE */
470 gpe_index
= (i
* ACPI_GPE_REGISTER_WIDTH
) + j
;
471 gpe_event_info
= &gpe_block
->event_info
[gpe_index
];
474 * Ignore GPEs that have no corresponding _Lxx/_Exx method
475 * and GPEs that are used to wake the system
477 if (((gpe_event_info
->flags
& ACPI_GPE_DISPATCH_MASK
) ==
478 ACPI_GPE_DISPATCH_NONE
)
479 || ((gpe_event_info
->flags
& ACPI_GPE_DISPATCH_MASK
)
480 == ACPI_GPE_DISPATCH_HANDLER
)
481 || (gpe_event_info
->flags
& ACPI_GPE_CAN_WAKE
)) {
485 status
= acpi_ev_add_gpe_reference(gpe_event_info
);
486 if (ACPI_FAILURE(status
)) {
487 ACPI_EXCEPTION((AE_INFO
, status
,
488 "Could not enable GPE 0x%02X",
489 gpe_index
+ gpe_block
->block_base_number
));
497 if (gpe_enabled_count
) {
498 ACPI_DEBUG_PRINT((ACPI_DB_INIT
,
499 "Enabled %u GPEs in this block\n",
503 gpe_block
->initialized
= TRUE
;
505 return_ACPI_STATUS(AE_OK
);