blob: 3e6ba99e4053a0824252de17989e79f72193021f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
Bob Moorea8357b02010-01-22 19:07:36 +08008 * Copyright (C) 2000 - 2010, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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#ifndef __ACEVENTS_H__
45#define __ACEVENTS_H__
46
Robert Moore44f6c012005-04-18 22:49:35 -040047/*
48 * evevent
49 */
Len Brown4be44fc2005-08-05 00:44:28 -040050acpi_status acpi_ev_initialize_events(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Len Brown4be44fc2005-08-05 00:44:28 -040052acpi_status acpi_ev_install_xrupt_handlers(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Bob Moore96db2552005-11-02 00:00:00 -050054acpi_status acpi_ev_install_fadt_gpes(void);
55
Len Brown4be44fc2005-08-05 00:44:28 -040056u32 acpi_ev_fixed_event_detect(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58/*
Robert Moore44f6c012005-04-18 22:49:35 -040059 * evmisc
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 */
Len Brown4be44fc2005-08-05 00:44:28 -040061u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
62
63acpi_status acpi_ev_acquire_global_lock(u16 timeout);
64
65acpi_status acpi_ev_release_global_lock(void);
66
67acpi_status acpi_ev_init_global_lock_handler(void);
68
69u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040072acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
73 u32 notify_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75/*
Robert Moore44f6c012005-04-18 22:49:35 -040076 * evgpe - GPE handling and dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078acpi_status
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +010079acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Rafael J. Wysockicbbc0de2010-02-24 00:52:08 +010081acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Len Brown4be44fc2005-08-05 00:44:28 -040083acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Len Brown4be44fc2005-08-05 00:44:28 -040085struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
86 u32 gpe_number);
Robert Moore44f6c012005-04-18 22:49:35 -040087
88/*
89 * evgpeblk
90 */
Len Brown4be44fc2005-08-05 00:44:28 -040091u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
92
Bob Mooree97d6bf2008-12-30 09:45:17 +080093acpi_status
94acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -040095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040097acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
Bob Mooree97d6bf2008-12-30 09:45:17 +080098 struct acpi_gpe_block_info *gpe_block,
99 void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400100
101acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400102acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
103 struct acpi_generic_address *gpe_block_address,
104 u32 register_count,
105 u8 gpe_block_base_number,
106 u32 interrupt_number,
107 struct acpi_gpe_block_info **return_gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Bob Moore96db2552005-11-02 00:00:00 -0500109acpi_status
110acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
111 struct acpi_gpe_block_info *gpe_block);
112
Len Brown4be44fc2005-08-05 00:44:28 -0400113acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115u32
Len Brown4be44fc2005-08-05 00:44:28 -0400116acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
117 u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Len Brown4be44fc2005-08-05 00:44:28 -0400119u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400122acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Len Brown4be44fc2005-08-05 00:44:28 -0400124acpi_status acpi_ev_gpe_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400125
126/*
127 * evregion - Address Space handling
128 */
Len Brown4be44fc2005-08-05 00:44:28 -0400129acpi_status acpi_ev_install_region_handlers(void);
130
131acpi_status acpi_ev_initialize_op_regions(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400134acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
135 u32 function,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800136 u32 region_offset, u32 bit_width, u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400139acpi_ev_attach_region(union acpi_operand_object *handler_obj,
140 union acpi_operand_object *region_obj,
141 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143void
Len Brown4be44fc2005-08-05 00:44:28 -0400144acpi_ev_detach_region(union acpi_operand_object *region_obj,
145 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400148acpi_ev_install_space_handler(struct acpi_namespace_node *node,
149 acpi_adr_space_type space_id,
150 acpi_adr_space_handler handler,
151 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400154acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
155 acpi_adr_space_type space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400158acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160/*
Robert Moore44f6c012005-04-18 22:49:35 -0400161 * evregini - Region initialization and setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400164acpi_ev_system_memory_region_setup(acpi_handle handle,
165 u32 function,
166 void *handler_context,
167 void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400170acpi_ev_io_space_region_setup(acpi_handle handle,
171 u32 function,
172 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400175acpi_ev_pci_config_region_setup(acpi_handle handle,
176 u32 function,
177 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400180acpi_ev_cmos_region_setup(acpi_handle handle,
181 u32 function,
182 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400185acpi_ev_pci_bar_region_setup(acpi_handle handle,
186 u32 function,
187 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400190acpi_ev_default_region_setup(acpi_handle handle,
191 u32 function,
192 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400195acpi_ev_initialize_region(union acpi_operand_object *region_obj,
196 u8 acpi_ns_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198/*
Robert Moore44f6c012005-04-18 22:49:35 -0400199 * evsci - SCI (System Control Interrupt) handling/dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 */
Len Brown4be44fc2005-08-05 00:44:28 -0400201u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Len Brown4be44fc2005-08-05 00:44:28 -0400203u32 acpi_ev_install_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Len Brown4be44fc2005-08-05 00:44:28 -0400205acpi_status acpi_ev_remove_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Len Brown4be44fc2005-08-05 00:44:28 -0400207u32 acpi_ev_initialize_sCI(u32 program_sCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Len Brown4be44fc2005-08-05 00:44:28 -0400209void acpi_ev_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Len Brown4be44fc2005-08-05 00:44:28 -0400211#endif /* __ACEVENTS_H__ */