0bba148a2c61fc084d52a58df1b1498b20ef6034
[linux-3.10.git] / 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                                 u8 type);
81
82 acpi_status
83 acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
84                    u8 write_to_hardware);
85
86 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
87
88 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
89                                                        u32 gpe_number);
90
91 /*
92  * evgpeblk
93  */
94 u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
95
96 acpi_status
97 acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
98
99 acpi_status
100 acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
101                             struct acpi_gpe_block_info *gpe_block,
102                             void *context);
103
104 acpi_status
105 acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
106                          struct acpi_generic_address *gpe_block_address,
107                          u32 register_count,
108                          u8 gpe_block_base_number,
109                          u32 interrupt_number,
110                          struct acpi_gpe_block_info **return_gpe_block);
111
112 acpi_status
113 acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
114                              struct acpi_gpe_block_info *gpe_block);
115
116 acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
117
118 u32
119 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
120                      u32 gpe_number);
121
122 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
123
124 acpi_status
125 acpi_ev_set_gpe_type(struct acpi_gpe_event_info *gpe_event_info, u8 type);
126
127 acpi_status
128 acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);
129
130 acpi_status acpi_ev_gpe_initialize(void);
131
132 /*
133  * evregion - Address Space handling
134  */
135 acpi_status acpi_ev_install_region_handlers(void);
136
137 acpi_status acpi_ev_initialize_op_regions(void);
138
139 acpi_status
140 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
141                                u32 function,
142                                u32 region_offset,
143                                u32 bit_width, acpi_integer * value);
144
145 acpi_status
146 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
147                       union acpi_operand_object *region_obj,
148                       u8 acpi_ns_is_locked);
149
150 void
151 acpi_ev_detach_region(union acpi_operand_object *region_obj,
152                       u8 acpi_ns_is_locked);
153
154 acpi_status
155 acpi_ev_install_space_handler(struct acpi_namespace_node *node,
156                               acpi_adr_space_type space_id,
157                               acpi_adr_space_handler handler,
158                               acpi_adr_space_setup setup, void *context);
159
160 acpi_status
161 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
162                             acpi_adr_space_type space_id);
163
164 acpi_status
165 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
166
167 /*
168  * evregini - Region initialization and setup
169  */
170 acpi_status
171 acpi_ev_system_memory_region_setup(acpi_handle handle,
172                                    u32 function,
173                                    void *handler_context,
174                                    void **region_context);
175
176 acpi_status
177 acpi_ev_io_space_region_setup(acpi_handle handle,
178                               u32 function,
179                               void *handler_context, void **region_context);
180
181 acpi_status
182 acpi_ev_pci_config_region_setup(acpi_handle handle,
183                                 u32 function,
184                                 void *handler_context, void **region_context);
185
186 acpi_status
187 acpi_ev_cmos_region_setup(acpi_handle handle,
188                           u32 function,
189                           void *handler_context, void **region_context);
190
191 acpi_status
192 acpi_ev_pci_bar_region_setup(acpi_handle handle,
193                              u32 function,
194                              void *handler_context, void **region_context);
195
196 acpi_status
197 acpi_ev_default_region_setup(acpi_handle handle,
198                              u32 function,
199                              void *handler_context, void **region_context);
200
201 acpi_status
202 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
203                           u8 acpi_ns_locked);
204
205 /*
206  * evsci - SCI (System Control Interrupt) handling/dispatch
207  */
208 u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
209
210 u32 acpi_ev_install_sci_handler(void);
211
212 acpi_status acpi_ev_remove_sci_handler(void);
213
214 u32 acpi_ev_initialize_sCI(u32 program_sCI);
215
216 void acpi_ev_terminate(void);
217
218 #endif                          /* __ACEVENTS_H__  */