blob: 197aa4f39640a24d1f82f3db9a835b776179a3ae [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/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, 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/*
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
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +010079acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040082acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
83 u8 write_to_hardware);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Len Brown4be44fc2005-08-05 00:44:28 -040085acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
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
90/*
91 * evgpeblk
92 */
Len Brown4be44fc2005-08-05 00:44:28 -040093u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
94
Bob Mooree97d6bf2008-12-30 09:45:17 +080095acpi_status
96acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
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,
Bob Mooree97d6bf2008-12-30 09:45:17 +0800100 struct acpi_gpe_block_info *gpe_block,
101 void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400102
103acpi_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
112acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
113 struct acpi_gpe_block_info *gpe_block);
114
Len Brown4be44fc2005-08-05 00:44:28 -0400115acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117u32
Len Brown4be44fc2005-08-05 00:44:28 -0400118acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
119 u32 gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Len Brown4be44fc2005-08-05 00:44:28 -0400121u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400124acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Len Brown4be44fc2005-08-05 00:44:28 -0400126acpi_status acpi_ev_gpe_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400127
128/*
129 * evregion - Address Space handling
130 */
Len Brown4be44fc2005-08-05 00:44:28 -0400131acpi_status acpi_ev_install_region_handlers(void);
132
133acpi_status acpi_ev_initialize_op_regions(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400136acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
137 u32 function,
Bob Mooref5407af2009-05-21 10:56:52 +0800138 u32 region_offset,
Bob Moore958dd242006-05-12 17:12:00 -0400139 u32 bit_width, acpi_integer * value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400142acpi_ev_attach_region(union acpi_operand_object *handler_obj,
143 union acpi_operand_object *region_obj,
144 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146void
Len Brown4be44fc2005-08-05 00:44:28 -0400147acpi_ev_detach_region(union acpi_operand_object *region_obj,
148 u8 acpi_ns_is_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400151acpi_ev_install_space_handler(struct acpi_namespace_node *node,
152 acpi_adr_space_type space_id,
153 acpi_adr_space_handler handler,
154 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400157acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
158 acpi_adr_space_type space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400161acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163/*
Robert Moore44f6c012005-04-18 22:49:35 -0400164 * evregini - Region initialization and setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400167acpi_ev_system_memory_region_setup(acpi_handle handle,
168 u32 function,
169 void *handler_context,
170 void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400173acpi_ev_io_space_region_setup(acpi_handle handle,
174 u32 function,
175 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400178acpi_ev_pci_config_region_setup(acpi_handle handle,
179 u32 function,
180 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
182acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400183acpi_ev_cmos_region_setup(acpi_handle handle,
184 u32 function,
185 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400188acpi_ev_pci_bar_region_setup(acpi_handle handle,
189 u32 function,
190 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400193acpi_ev_default_region_setup(acpi_handle handle,
194 u32 function,
195 void *handler_context, void **region_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400198acpi_ev_initialize_region(union acpi_operand_object *region_obj,
199 u8 acpi_ns_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201/*
Robert Moore44f6c012005-04-18 22:49:35 -0400202 * evsci - SCI (System Control Interrupt) handling/dispatch
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 */
Len Brown4be44fc2005-08-05 00:44:28 -0400204u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Len Brown4be44fc2005-08-05 00:44:28 -0400206u32 acpi_ev_install_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Len Brown4be44fc2005-08-05 00:44:28 -0400208acpi_status acpi_ev_remove_sci_handler(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Len Brown4be44fc2005-08-05 00:44:28 -0400210u32 acpi_ev_initialize_sCI(u32 program_sCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Len Brown4be44fc2005-08-05 00:44:28 -0400212void acpi_ev_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Len Brown4be44fc2005-08-05 00:44:28 -0400214#endif /* __ACEVENTS_H__ */