blob: a6f99cc37a19947ece8c6ebb322687320e6d2853 [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/*
Bob Moore3fe50202010-04-27 11:41:19 +080076 * evgpe - Low-level GPE support
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 */
Bob Moore3fe50202010-04-27 11:41:19 +080078u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080acpi_status
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080081acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +080083acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
84
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +020085acpi_status acpi_raw_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
86
87acpi_status acpi_raw_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
88
Len Brown4be44fc2005-08-05 00:44:28 -040089struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
90 u32 gpe_number);
Robert Moore44f6c012005-04-18 22:49:35 -040091
Lin Ming0f849d22010-04-06 14:52:37 +080092struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
93 struct acpi_gpe_block_info
94 *gpe_block);
95
Robert Moore44f6c012005-04-18 22:49:35 -040096/*
Bob Moore3fe50202010-04-27 11:41:19 +080097 * evgpeblk - Upper-level GPE block support
Robert Moore44f6c012005-04-18 22:49:35 -040098 */
Robert Moore44f6c012005-04-18 22:49:35 -040099acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400100acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
101 struct acpi_generic_address *gpe_block_address,
102 u32 register_count,
103 u8 gpe_block_base_number,
104 u32 interrupt_number,
105 struct acpi_gpe_block_info **return_gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Bob Moore96db2552005-11-02 00:00:00 -0500107acpi_status
Rafael J. Wysockia2100802010-09-16 00:30:43 +0200108acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
109 struct acpi_gpe_block_info *gpe_block,
110 void *ignored);
Bob Moore96db2552005-11-02 00:00:00 -0500111
Len Brown4be44fc2005-08-05 00:44:28 -0400112acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114u32
Len Brown4be44fc2005-08-05 00:44:28 -0400115acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
116 u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Bob Moore3fe50202010-04-27 11:41:19 +0800118/*
119 * evgpeinit - GPE initialization and update
120 */
Len Brown4be44fc2005-08-05 00:44:28 -0400121acpi_status acpi_ev_gpe_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400122
Bob Moore3fe50202010-04-27 11:41:19 +0800123void acpi_ev_update_gpes(acpi_owner_id table_owner_id);
124
125acpi_status
126acpi_ev_match_gpe_method(acpi_handle obj_handle,
127 u32 level, void *context, void **return_value);
128
129acpi_status
130acpi_ev_match_prw_and_gpe(acpi_handle obj_handle,
131 u32 level, void *context, void **return_value);
132
133/*
134 * evgpeutil - GPE utilities
135 */
136acpi_status
137acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
138
139u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
140
141struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32 interrupt_number);
142
143acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
144
145acpi_status
146acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
147 struct acpi_gpe_block_info *gpe_block,
148 void *context);
149
Robert Moore44f6c012005-04-18 22:49:35 -0400150/*
151 * evregion - Address Space handling
152 */
Len Brown4be44fc2005-08-05 00:44:28 -0400153acpi_status acpi_ev_install_region_handlers(void);
154
155acpi_status acpi_ev_initialize_op_regions(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400158acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
159 u32 function,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800160 u32 region_offset, u32 bit_width, u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400163acpi_ev_attach_region(union acpi_operand_object *handler_obj,
164 union acpi_operand_object *region_obj,
165 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167void
Len Brown4be44fc2005-08-05 00:44:28 -0400168acpi_ev_detach_region(union acpi_operand_object *region_obj,
169 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400172acpi_ev_install_space_handler(struct acpi_namespace_node *node,
173 acpi_adr_space_type space_id,
174 acpi_adr_space_handler handler,
175 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400178acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
179 acpi_adr_space_type space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400182acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184/*
Robert Moore44f6c012005-04-18 22:49:35 -0400185 * evregini - Region initialization and setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400188acpi_ev_system_memory_region_setup(acpi_handle handle,
189 u32 function,
190 void *handler_context,
191 void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400194acpi_ev_io_space_region_setup(acpi_handle handle,
195 u32 function,
196 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400199acpi_ev_pci_config_region_setup(acpi_handle handle,
200 u32 function,
201 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400204acpi_ev_cmos_region_setup(acpi_handle handle,
205 u32 function,
206 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400209acpi_ev_pci_bar_region_setup(acpi_handle handle,
210 u32 function,
211 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400214acpi_ev_default_region_setup(acpi_handle handle,
215 u32 function,
216 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400219acpi_ev_initialize_region(union acpi_operand_object *region_obj,
220 u8 acpi_ns_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222/*
Robert Moore44f6c012005-04-18 22:49:35 -0400223 * evsci - SCI (System Control Interrupt) handling/dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 */
Len Brown4be44fc2005-08-05 00:44:28 -0400225u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Len Brown4be44fc2005-08-05 00:44:28 -0400227u32 acpi_ev_install_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Len Brown4be44fc2005-08-05 00:44:28 -0400229acpi_status acpi_ev_remove_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Len Brown4be44fc2005-08-05 00:44:28 -0400231u32 acpi_ev_initialize_sCI(u32 program_sCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Len Brown4be44fc2005-08-05 00:44:28 -0400233void acpi_ev_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Len Brown4be44fc2005-08-05 00:44:28 -0400235#endif /* __ACEVENTS_H__ */