Loading...
1/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, 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 */
50acpi_status acpi_ev_initialize_events(void);
51
52acpi_status acpi_ev_install_xrupt_handlers(void);
53
54u32 acpi_ev_fixed_event_detect(void);
55
56/*
57 * evmisc
58 */
59u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
60
61u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
62
63acpi_status
64acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
65 u32 notify_value);
66
67/*
68 * evglock - Global Lock support
69 */
70acpi_status acpi_ev_init_global_lock_handler(void);
71
72acpi_status acpi_ev_acquire_global_lock(u16 timeout);
73
74acpi_status acpi_ev_release_global_lock(void);
75
76acpi_status acpi_ev_remove_global_lock_handler(void);
77
78/*
79 * evgpe - Low-level GPE support
80 */
81u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
82
83acpi_status
84acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
85
86acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
87
88acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
89
90acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
91
92struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
93 u32 gpe_number);
94
95struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
96 struct acpi_gpe_block_info
97 *gpe_block);
98
99acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
100
101/*
102 * evgpeblk - Upper-level GPE block support
103 */
104acpi_status
105acpi_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
112acpi_status
113acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
114 struct acpi_gpe_block_info *gpe_block,
115 void *context);
116
117acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
118
119u32
120acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
121 struct acpi_gpe_event_info *gpe_event_info,
122 u32 gpe_number);
123
124/*
125 * evgpeinit - GPE initialization and update
126 */
127acpi_status acpi_ev_gpe_initialize(void);
128
129void acpi_ev_update_gpes(acpi_owner_id table_owner_id);
130
131acpi_status
132acpi_ev_match_gpe_method(acpi_handle obj_handle,
133 u32 level, void *context, void **return_value);
134
135/*
136 * evgpeutil - GPE utilities
137 */
138acpi_status
139acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
140
141u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
142
143acpi_status
144acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
145 struct acpi_gpe_block_info *gpe_block, void *context);
146
147struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32 interrupt_number);
148
149acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
150
151acpi_status
152acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
153 struct acpi_gpe_block_info *gpe_block,
154 void *context);
155
156/*
157 * evregion - Address Space handling
158 */
159acpi_status acpi_ev_install_region_handlers(void);
160
161acpi_status acpi_ev_initialize_op_regions(void);
162
163acpi_status
164acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
165 u32 function,
166 u32 region_offset, u32 bit_width, u64 *value);
167
168acpi_status
169acpi_ev_attach_region(union acpi_operand_object *handler_obj,
170 union acpi_operand_object *region_obj,
171 u8 acpi_ns_is_locked);
172
173void
174acpi_ev_detach_region(union acpi_operand_object *region_obj,
175 u8 acpi_ns_is_locked);
176
177acpi_status
178acpi_ev_install_space_handler(struct acpi_namespace_node *node,
179 acpi_adr_space_type space_id,
180 acpi_adr_space_handler handler,
181 acpi_adr_space_setup setup, void *context);
182
183acpi_status
184acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
185 acpi_adr_space_type space_id);
186
187acpi_status
188acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
189
190/*
191 * evregini - Region initialization and setup
192 */
193acpi_status
194acpi_ev_system_memory_region_setup(acpi_handle handle,
195 u32 function,
196 void *handler_context,
197 void **region_context);
198
199acpi_status
200acpi_ev_io_space_region_setup(acpi_handle handle,
201 u32 function,
202 void *handler_context, void **region_context);
203
204acpi_status
205acpi_ev_pci_config_region_setup(acpi_handle handle,
206 u32 function,
207 void *handler_context, void **region_context);
208
209acpi_status
210acpi_ev_cmos_region_setup(acpi_handle handle,
211 u32 function,
212 void *handler_context, void **region_context);
213
214acpi_status
215acpi_ev_pci_bar_region_setup(acpi_handle handle,
216 u32 function,
217 void *handler_context, void **region_context);
218
219acpi_status
220acpi_ev_default_region_setup(acpi_handle handle,
221 u32 function,
222 void *handler_context, void **region_context);
223
224acpi_status
225acpi_ev_initialize_region(union acpi_operand_object *region_obj,
226 u8 acpi_ns_locked);
227
228/*
229 * evsci - SCI (System Control Interrupt) handling/dispatch
230 */
231u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
232
233u32 acpi_ev_install_sci_handler(void);
234
235acpi_status acpi_ev_remove_sci_handler(void);
236
237u32 acpi_ev_initialize_sCI(u32 program_sCI);
238
239void acpi_ev_terminate(void);
240
241#endif /* __ACEVENTS_H__ */
1/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, 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 */
50acpi_status acpi_ev_initialize_events(void);
51
52acpi_status acpi_ev_install_xrupt_handlers(void);
53
54u32 acpi_ev_fixed_event_detect(void);
55
56/*
57 * evmisc
58 */
59u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
60
61u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
62
63acpi_status
64acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
65 u32 notify_value);
66
67/*
68 * evglock - Global Lock support
69 */
70acpi_status acpi_ev_init_global_lock_handler(void);
71
72ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
73 acpi_ev_acquire_global_lock(u16 timeout))
74 ACPI_HW_DEPENDENT_RETURN_OK(acpi_status acpi_ev_release_global_lock(void))
75 acpi_status acpi_ev_remove_global_lock_handler(void);
76
77/*
78 * evgpe - Low-level GPE support
79 */
80u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
81
82acpi_status
83acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
84
85acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
86
87acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
88
89acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
90
91struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
92 u32 gpe_number);
93
94struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
95 struct acpi_gpe_block_info
96 *gpe_block);
97
98acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
99
100/*
101 * evgpeblk - Upper-level GPE block support
102 */
103acpi_status
104acpi_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
111acpi_status
112acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
113 struct acpi_gpe_block_info *gpe_block,
114 void *context);
115
116ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
117 acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
118 *gpe_block))
119
120u32
121acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
122 struct acpi_gpe_event_info *gpe_event_info,
123 u32 gpe_number);
124
125/*
126 * evgpeinit - GPE initialization and update
127 */
128acpi_status acpi_ev_gpe_initialize(void);
129
130ACPI_HW_DEPENDENT_RETURN_VOID(void
131 acpi_ev_update_gpes(acpi_owner_id table_owner_id))
132
133 acpi_status
134acpi_ev_match_gpe_method(acpi_handle obj_handle,
135 u32 level, void *context, void **return_value);
136
137/*
138 * evgpeutil - GPE utilities
139 */
140acpi_status
141acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
142
143u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
144
145acpi_status
146acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
147 struct acpi_gpe_block_info *gpe_block, void *context);
148
149struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32 interrupt_number);
150
151acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
152
153acpi_status
154acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
155 struct acpi_gpe_block_info *gpe_block,
156 void *context);
157
158/*
159 * evregion - Address Space handling
160 */
161acpi_status acpi_ev_install_region_handlers(void);
162
163acpi_status acpi_ev_initialize_op_regions(void);
164
165acpi_status
166acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
167 union acpi_operand_object *field_obj,
168 u32 function,
169 u32 region_offset, u32 bit_width, u64 *value);
170
171acpi_status
172acpi_ev_attach_region(union acpi_operand_object *handler_obj,
173 union acpi_operand_object *region_obj,
174 u8 acpi_ns_is_locked);
175
176void
177acpi_ev_detach_region(union acpi_operand_object *region_obj,
178 u8 acpi_ns_is_locked);
179
180acpi_status
181acpi_ev_install_space_handler(struct acpi_namespace_node *node,
182 acpi_adr_space_type space_id,
183 acpi_adr_space_handler handler,
184 acpi_adr_space_setup setup, void *context);
185
186acpi_status
187acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
188 acpi_adr_space_type space_id);
189
190acpi_status
191acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
192
193/*
194 * evregini - Region initialization and setup
195 */
196acpi_status
197acpi_ev_system_memory_region_setup(acpi_handle handle,
198 u32 function,
199 void *handler_context,
200 void **region_context);
201
202acpi_status
203acpi_ev_io_space_region_setup(acpi_handle handle,
204 u32 function,
205 void *handler_context, void **region_context);
206
207acpi_status
208acpi_ev_pci_config_region_setup(acpi_handle handle,
209 u32 function,
210 void *handler_context, void **region_context);
211
212acpi_status
213acpi_ev_cmos_region_setup(acpi_handle handle,
214 u32 function,
215 void *handler_context, void **region_context);
216
217acpi_status
218acpi_ev_pci_bar_region_setup(acpi_handle handle,
219 u32 function,
220 void *handler_context, void **region_context);
221
222acpi_status
223acpi_ev_default_region_setup(acpi_handle handle,
224 u32 function,
225 void *handler_context, void **region_context);
226
227acpi_status
228acpi_ev_initialize_region(union acpi_operand_object *region_obj,
229 u8 acpi_ns_locked);
230
231/*
232 * evsci - SCI (System Control Interrupt) handling/dispatch
233 */
234u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
235
236u32 acpi_ev_install_sci_handler(void);
237
238acpi_status acpi_ev_remove_sci_handler(void);
239
240u32 acpi_ev_initialize_sCI(u32 program_sCI);
241
242ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_ev_terminate(void))
243#endif /* __ACEVENTS_H__ */