blob: 70e0b28801aa0bffc0ceafb7d1defa576eda9111 [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
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
61acpi_status acpi_ev_acquire_global_lock(u16 timeout);
62
63acpi_status acpi_ev_release_global_lock(void);
64
65acpi_status acpi_ev_init_global_lock_handler(void);
66
67u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040070acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
71 u32 notify_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73/*
Bob Moore3fe50202010-04-27 11:41:19 +080074 * evgpe - Low-level GPE support
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 */
Bob Moore3fe50202010-04-27 11:41:19 +080076u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078acpi_status
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080079acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +080081acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
82
Lin Ming3a378982010-12-13 13:36:15 +080083acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +020084
Lin Ming3a378982010-12-13 13:36:15 +080085acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +020086
Len Brown4be44fc2005-08-05 00:44:28 -040087struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
88 u32 gpe_number);
Robert Moore44f6c012005-04-18 22:49:35 -040089
Lin Ming0f849d22010-04-06 14:52:37 +080090struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
91 struct acpi_gpe_block_info
92 *gpe_block);
93
Lin Mingbba63a22010-12-13 13:39:17 +080094acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
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,
Lin Ming3a378982010-12-13 13:36:15 +0800110 void *context);
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
Lin Ming8b6cd8a2010-12-13 13:38:46 +0800115acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
116 struct acpi_gpe_event_info *gpe_event_info,
Len Brown4be44fc2005-08-05 00:44:28 -0400117 u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Bob Moore3fe50202010-04-27 11:41:19 +0800119/*
120 * evgpeinit - GPE initialization and update
121 */
Len Brown4be44fc2005-08-05 00:44:28 -0400122acpi_status acpi_ev_gpe_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400123
Bob Moore3fe50202010-04-27 11:41:19 +0800124void acpi_ev_update_gpes(acpi_owner_id table_owner_id);
125
126acpi_status
127acpi_ev_match_gpe_method(acpi_handle obj_handle,
128 u32 level, void *context, void **return_value);
129
Bob Moore3fe50202010-04-27 11:41:19 +0800130/*
131 * evgpeutil - GPE utilities
132 */
133acpi_status
134acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
135
136u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
137
Lin Ming3cfd53d2010-12-13 13:36:02 +0800138acpi_status
139acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
140 struct acpi_gpe_block_info *gpe_block, void *context);
141
Bob Moore3fe50202010-04-27 11:41:19 +0800142struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32 interrupt_number);
143
144acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
145
146acpi_status
147acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
148 struct acpi_gpe_block_info *gpe_block,
149 void *context);
150
Robert Moore44f6c012005-04-18 22:49:35 -0400151/*
152 * evregion - Address Space handling
153 */
Len Brown4be44fc2005-08-05 00:44:28 -0400154acpi_status acpi_ev_install_region_handlers(void);
155
156acpi_status acpi_ev_initialize_op_regions(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400159acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
160 u32 function,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800161 u32 region_offset, u32 bit_width, u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400164acpi_ev_attach_region(union acpi_operand_object *handler_obj,
165 union acpi_operand_object *region_obj,
166 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168void
Len Brown4be44fc2005-08-05 00:44:28 -0400169acpi_ev_detach_region(union acpi_operand_object *region_obj,
170 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400173acpi_ev_install_space_handler(struct acpi_namespace_node *node,
174 acpi_adr_space_type space_id,
175 acpi_adr_space_handler handler,
176 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400179acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
180 acpi_adr_space_type space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
182acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400183acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185/*
Robert Moore44f6c012005-04-18 22:49:35 -0400186 * evregini - Region initialization and setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400189acpi_ev_system_memory_region_setup(acpi_handle handle,
190 u32 function,
191 void *handler_context,
192 void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400195acpi_ev_io_space_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_pci_config_region_setup(acpi_handle handle,
201 u32 function,
202 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400205acpi_ev_cmos_region_setup(acpi_handle handle,
206 u32 function,
207 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400210acpi_ev_pci_bar_region_setup(acpi_handle handle,
211 u32 function,
212 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_ev_default_region_setup(acpi_handle handle,
216 u32 function,
217 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400220acpi_ev_initialize_region(union acpi_operand_object *region_obj,
221 u8 acpi_ns_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223/*
Robert Moore44f6c012005-04-18 22:49:35 -0400224 * evsci - SCI (System Control Interrupt) handling/dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 */
Len Brown4be44fc2005-08-05 00:44:28 -0400226u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Len Brown4be44fc2005-08-05 00:44:28 -0400228u32 acpi_ev_install_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Len Brown4be44fc2005-08-05 00:44:28 -0400230acpi_status acpi_ev_remove_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Len Brown4be44fc2005-08-05 00:44:28 -0400232u32 acpi_ev_initialize_sCI(u32 program_sCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Len Brown4be44fc2005-08-05 00:44:28 -0400234void acpi_ev_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Len Brown4be44fc2005-08-05 00:44:28 -0400236#endif /* __ACEVENTS_H__ */