ACPI: Use GPE reference counting to support shared GPEs
[safe/jmp/linux-2.6] / drivers / acpi / acpica / acevents.h
1 /******************************************************************************
2  *
3  * Name: acevents.h - Event subcomponent prototypes and defines
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2008, 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 #ifndef __ACEVENTS_H__
45 #define __ACEVENTS_H__
46
47 /*
48  * evevent
49  */
50 acpi_status acpi_ev_initialize_events(void);
51
52 acpi_status acpi_ev_install_xrupt_handlers(void);
53
54 acpi_status acpi_ev_install_fadt_gpes(void);
55
56 u32 acpi_ev_fixed_event_detect(void);
57
58 /*
59  * evmisc
60  */
61 u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
62
63 acpi_status acpi_ev_acquire_global_lock(u16 timeout);
64
65 acpi_status acpi_ev_release_global_lock(void);
66
67 acpi_status acpi_ev_init_global_lock_handler(void);
68
69 u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
70
71 acpi_status
72 acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
73                              u32 notify_value);
74
75 /*
76  * evgpe - GPE handling and dispatch
77  */
78 acpi_status
79 acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info);
80
81 acpi_status
82 acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
83                    u8 write_to_hardware);
84
85 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
86
87 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
88                                                        u32 gpe_number);
89
90 /*
91  * evgpeblk
92  */
93 u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
94
95 acpi_status
96 acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
97
98 acpi_status
99 acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
100                             struct acpi_gpe_block_info *gpe_block,
101                             void *context);
102
103 acpi_status
104 acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
105                          struct acpi_generic_address *gpe_block_address,
106                          u32 register_count,
107                          u8 gpe_block_base_number,
108                          u32 interrupt_number,
109                          struct acpi_gpe_block_info **return_gpe_block);
110
111 acpi_status
112 acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
113                              struct acpi_gpe_block_info *gpe_block);
114
115 acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
116
117 u32
118 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
119                      u32 gpe_number);
120
121 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
122
123 acpi_status
124 acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);
125
126 acpi_status acpi_ev_gpe_initialize(void);
127
128 /*
129  * evregion - Address Space handling
130  */
131 acpi_status acpi_ev_install_region_handlers(void);
132
133 acpi_status acpi_ev_initialize_op_regions(void);
134
135 acpi_status
136 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
137                                u32 function,
138                                u32 region_offset,
139                                u32 bit_width, acpi_integer * value);
140
141 acpi_status
142 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
143                       union acpi_operand_object *region_obj,
144                       u8 acpi_ns_is_locked);
145
146 void
147 acpi_ev_detach_region(union acpi_operand_object *region_obj,
148                       u8 acpi_ns_is_locked);
149
150 acpi_status
151 acpi_ev_install_space_handler(struct acpi_namespace_node *node,
152                               acpi_adr_space_type space_id,
153                               acpi_adr_space_handler handler,
154                               acpi_adr_space_setup setup, void *context);
155
156 acpi_status
157 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
158                             acpi_adr_space_type space_id);
159
160 acpi_status
161 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
162
163 /*
164  * evregini - Region initialization and setup
165  */
166 acpi_status
167 acpi_ev_system_memory_region_setup(acpi_handle handle,
168                                    u32 function,
169                                    void *handler_context,
170                                    void **region_context);
171
172 acpi_status
173 acpi_ev_io_space_region_setup(acpi_handle handle,
174                               u32 function,
175                               void *handler_context, void **region_context);
176
177 acpi_status
178 acpi_ev_pci_config_region_setup(acpi_handle handle,
179                                 u32 function,
180                                 void *handler_context, void **region_context);
181
182 acpi_status
183 acpi_ev_cmos_region_setup(acpi_handle handle,
184                           u32 function,
185                           void *handler_context, void **region_context);
186
187 acpi_status
188 acpi_ev_pci_bar_region_setup(acpi_handle handle,
189                              u32 function,
190                              void *handler_context, void **region_context);
191
192 acpi_status
193 acpi_ev_default_region_setup(acpi_handle handle,
194                              u32 function,
195                              void *handler_context, void **region_context);
196
197 acpi_status
198 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
199                           u8 acpi_ns_locked);
200
201 /*
202  * evsci - SCI (System Control Interrupt) handling/dispatch
203  */
204 u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
205
206 u32 acpi_ev_install_sci_handler(void);
207
208 acpi_status acpi_ev_remove_sci_handler(void);
209
210 u32 acpi_ev_initialize_sCI(u32 program_sCI);
211
212 void acpi_ev_terminate(void);
213
214 #endif                          /* __ACEVENTS_H__  */