blob: c0a43b38c6a3a138c6445b76d6b88e482ec68636 [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 Moore77848132012-01-12 13:27:23 +08008 * Copyright (C) 2000 - 2012, 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
Len Brown4be44fc2005-08-05 00:44:28 -040054u32 acpi_ev_fixed_event_detect(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/*
Robert Moore44f6c012005-04-18 22:49:35 -040057 * evmisc
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 */
Len Brown4be44fc2005-08-05 00:44:28 -040059u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
60
Len Brown4be44fc2005-08-05 00:44:28 -040061u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040064acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
65 u32 notify_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67/*
Bob Moore0f6896f2011-04-13 11:33:17 +080068 * evglock - Global Lock support
69 */
70acpi_status acpi_ev_init_global_lock_handler(void);
71
Bob Moore33620c52012-02-14 18:14:27 +080072ACPI_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);
Bob Moore0f6896f2011-04-13 11:33:17 +080076
77/*
Bob Moore3fe50202010-04-27 11:41:19 +080078 * evgpe - Low-level GPE support
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 */
Bob Moore3fe50202010-04-27 11:41:19 +080080u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082acpi_status
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080083acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +080085acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
86
Lin Ming3a378982010-12-13 13:36:15 +080087acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +020088
Lin Ming3a378982010-12-13 13:36:15 +080089acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +020090
Len Brown4be44fc2005-08-05 00:44:28 -040091struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
92 u32 gpe_number);
Robert Moore44f6c012005-04-18 22:49:35 -040093
Lin Ming0f849d22010-04-06 14:52:37 +080094struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
95 struct acpi_gpe_block_info
96 *gpe_block);
97
Lin Mingbba63a22010-12-13 13:39:17 +080098acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
99
Robert Moore44f6c012005-04-18 22:49:35 -0400100/*
Bob Moore3fe50202010-04-27 11:41:19 +0800101 * evgpeblk - Upper-level GPE block support
Robert Moore44f6c012005-04-18 22:49:35 -0400102 */
Robert Moore44f6c012005-04-18 22:49:35 -0400103acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400104acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Bob Moore96db2552005-11-02 00:00:00 -0500111acpi_status
Rafael J. Wysockia2100802010-09-16 00:30:43 +0200112acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
113 struct acpi_gpe_block_info *gpe_block,
Lin Ming3a378982010-12-13 13:36:15 +0800114 void *context);
Bob Moore96db2552005-11-02 00:00:00 -0500115
Bob Moore33620c52012-02-14 18:14:27 +0800116ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
117 acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
118 *gpe_block))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120u32
Lin Ming8b6cd8a2010-12-13 13:38:46 +0800121acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
122 struct acpi_gpe_event_info *gpe_event_info,
Len Brown4be44fc2005-08-05 00:44:28 -0400123 u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Bob Moore3fe50202010-04-27 11:41:19 +0800125/*
126 * evgpeinit - GPE initialization and update
127 */
Len Brown4be44fc2005-08-05 00:44:28 -0400128acpi_status acpi_ev_gpe_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400129
Bob Moore33620c52012-02-14 18:14:27 +0800130ACPI_HW_DEPENDENT_RETURN_VOID(void
131 acpi_ev_update_gpes(acpi_owner_id table_owner_id))
Bob Moore3fe50202010-04-27 11:41:19 +0800132
Bob Moore33620c52012-02-14 18:14:27 +0800133 acpi_status
Bob Moore3fe50202010-04-27 11:41:19 +0800134acpi_ev_match_gpe_method(acpi_handle obj_handle,
135 u32 level, void *context, void **return_value);
136
Bob Moore3fe50202010-04-27 11:41:19 +0800137/*
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
Lin Ming3cfd53d2010-12-13 13:36:02 +0800145acpi_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
Bob Moore3fe50202010-04-27 11:41:19 +0800149struct 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
Robert Moore44f6c012005-04-18 22:49:35 -0400158/*
159 * evregion - Address Space handling
160 */
Len Brown4be44fc2005-08-05 00:44:28 -0400161acpi_status acpi_ev_install_region_handlers(void);
162
163acpi_status acpi_ev_initialize_op_regions(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400166acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
Bob Moore9ce81782011-11-16 13:39:07 +0800167 union acpi_operand_object *field_obj,
Len Brown4be44fc2005-08-05 00:44:28 -0400168 u32 function,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800169 u32 region_offset, u32 bit_width, u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400172acpi_ev_attach_region(union acpi_operand_object *handler_obj,
173 union acpi_operand_object *region_obj,
174 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176void
Len Brown4be44fc2005-08-05 00:44:28 -0400177acpi_ev_detach_region(union acpi_operand_object *region_obj,
178 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400181acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400187acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
188 acpi_adr_space_type space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400191acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193/*
Robert Moore44f6c012005-04-18 22:49:35 -0400194 * evregini - Region initialization and setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400197acpi_ev_system_memory_region_setup(acpi_handle handle,
198 u32 function,
199 void *handler_context,
200 void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400203acpi_ev_io_space_region_setup(acpi_handle handle,
204 u32 function,
205 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400208acpi_ev_pci_config_region_setup(acpi_handle handle,
209 u32 function,
210 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400213acpi_ev_cmos_region_setup(acpi_handle handle,
214 u32 function,
215 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400218acpi_ev_pci_bar_region_setup(acpi_handle handle,
219 u32 function,
220 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400223acpi_ev_default_region_setup(acpi_handle handle,
224 u32 function,
225 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400228acpi_ev_initialize_region(union acpi_operand_object *region_obj,
229 u8 acpi_ns_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231/*
Robert Moore44f6c012005-04-18 22:49:35 -0400232 * evsci - SCI (System Control Interrupt) handling/dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 */
Len Brown4be44fc2005-08-05 00:44:28 -0400234u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Len Brown4be44fc2005-08-05 00:44:28 -0400236u32 acpi_ev_install_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Len Brown4be44fc2005-08-05 00:44:28 -0400238acpi_status acpi_ev_remove_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Bob Mooreba494be2012-07-12 09:40:10 +0800240u32 acpi_ev_initialize_SCI(u32 program_SCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Bob Moore33620c52012-02-14 18:14:27 +0800242ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_ev_terminate(void))
Len Brown4be44fc2005-08-05 00:44:28 -0400243#endif /* __ACEVENTS_H__ */