blob: f2717be4fe0dc46c81d554df326168d07e857db0 [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 Moore4a90c7e2006-01-13 16:22:00 -05008 * Copyright (C) 2000 - 2006, R. Byron Moore
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/*
Robert Moore44f6c012005-04-18 22:49:35 -040076 * evgpe - GPE handling and dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040079acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info,
80 u8 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040083acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
84 u8 write_to_hardware);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Len Brown4be44fc2005-08-05 00:44:28 -040086acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Len Brown4be44fc2005-08-05 00:44:28 -040088struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
89 u32 gpe_number);
Robert Moore44f6c012005-04-18 22:49:35 -040090
91/*
92 * evgpeblk
93 */
Len Brown4be44fc2005-08-05 00:44:28 -040094u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
95
96acpi_status acpi_ev_walk_gpe_list(ACPI_GPE_CALLBACK gpe_walk_callback);
Robert Moore44f6c012005-04-18 22:49:35 -040097
Linus Torvalds1da177e2005-04-16 15:20:36 -070098acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040099acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
100 struct acpi_gpe_block_info *gpe_block);
Robert Moore44f6c012005-04-18 22:49:35 -0400101
102acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400103acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
104 struct acpi_generic_address *gpe_block_address,
105 u32 register_count,
106 u8 gpe_block_base_number,
107 u32 interrupt_number,
108 struct acpi_gpe_block_info **return_gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Bob Moore96db2552005-11-02 00:00:00 -0500110acpi_status
111acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
112 struct acpi_gpe_block_info *gpe_block);
113
Len Brown4be44fc2005-08-05 00:44:28 -0400114acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116u32
Len Brown4be44fc2005-08-05 00:44:28 -0400117acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
118 u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Len Brown4be44fc2005-08-05 00:44:28 -0400120u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400123acpi_ev_set_gpe_type(struct acpi_gpe_event_info *gpe_event_info, u8 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400126acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Len Brown4be44fc2005-08-05 00:44:28 -0400128acpi_status acpi_ev_gpe_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400129
130/*
131 * evregion - Address Space handling
132 */
Len Brown4be44fc2005-08-05 00:44:28 -0400133acpi_status acpi_ev_install_region_handlers(void);
134
135acpi_status acpi_ev_initialize_op_regions(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400138acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
139 u32 function,
140 acpi_physical_address address,
141 u32 bit_width, void *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400144acpi_ev_attach_region(union acpi_operand_object *handler_obj,
145 union acpi_operand_object *region_obj,
146 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148void
Len Brown4be44fc2005-08-05 00:44:28 -0400149acpi_ev_detach_region(union acpi_operand_object *region_obj,
150 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400153acpi_ev_install_space_handler(struct acpi_namespace_node *node,
154 acpi_adr_space_type space_id,
155 acpi_adr_space_handler handler,
156 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400159acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
160 acpi_adr_space_type space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400163acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165/*
Robert Moore44f6c012005-04-18 22:49:35 -0400166 * evregini - Region initialization and setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400169acpi_ev_system_memory_region_setup(acpi_handle handle,
170 u32 function,
171 void *handler_context,
172 void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400175acpi_ev_io_space_region_setup(acpi_handle handle,
176 u32 function,
177 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400180acpi_ev_pci_config_region_setup(acpi_handle handle,
181 u32 function,
182 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400185acpi_ev_cmos_region_setup(acpi_handle handle,
186 u32 function,
187 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400190acpi_ev_pci_bar_region_setup(acpi_handle handle,
191 u32 function,
192 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400195acpi_ev_default_region_setup(acpi_handle handle,
196 u32 function,
197 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400200acpi_ev_initialize_region(union acpi_operand_object *region_obj,
201 u8 acpi_ns_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203/*
Robert Moore44f6c012005-04-18 22:49:35 -0400204 * evsci - SCI (System Control Interrupt) handling/dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 */
Len Brown4be44fc2005-08-05 00:44:28 -0400206u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Len Brown4be44fc2005-08-05 00:44:28 -0400208u32 acpi_ev_install_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Len Brown4be44fc2005-08-05 00:44:28 -0400210acpi_status acpi_ev_remove_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Len Brown4be44fc2005-08-05 00:44:28 -0400212u32 acpi_ev_initialize_sCI(u32 program_sCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Len Brown4be44fc2005-08-05 00:44:28 -0400214void acpi_ev_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Len Brown4be44fc2005-08-05 00:44:28 -0400216#endif /* __ACEVENTS_H__ */