include/acpi/acevents.h

   1 /******************************************************************************
   2  *
   3  * Name: acevents.h - Event subcomponent prototypes and defines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   9  * 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
  47
  48 acpi_status
  49 acpi_ev_initialize_events (
  50         void);
  51
  52 acpi_status
  53 acpi_ev_install_xrupt_handlers (
  54         void);
  55
  56
  57 /*
  58  * Evfixed - Fixed event handling
  59  */
  60
  61 acpi_status
  62 acpi_ev_fixed_event_initialize (
  63         void);
  64
  65 u32
  66 acpi_ev_fixed_event_detect (
  67         void);
  68
  69 u32
  70 acpi_ev_fixed_event_dispatch (
  71         u32                             event);
  72
  73
  74 /*
  75  * Evmisc
  76  */
  77
  78 u8
  79 acpi_ev_is_notify_object (
  80         struct acpi_namespace_node      *node);
  81
  82 acpi_status
  83 acpi_ev_acquire_global_lock(
  84         u16                             timeout);
  85
  86 acpi_status
  87 acpi_ev_release_global_lock(
  88         void);
  89
  90 acpi_status
  91 acpi_ev_init_global_lock_handler (
  92         void);
  93
  94 u32
  95 acpi_ev_get_gpe_number_index (
  96         u32                             gpe_number);
  97
  98 acpi_status
  99 acpi_ev_queue_notify_request (
 100         struct acpi_namespace_node      *node,
 101         u32                             notify_value);
 102
 103 void ACPI_SYSTEM_XFACE
 104 acpi_ev_notify_dispatch (
 105         void                            *context);
 106
 107
 108 /*
 109  * Evgpe - GPE handling and dispatch
 110  */
 111
 112 acpi_status
 113 acpi_ev_walk_gpe_list (
 114         ACPI_GPE_CALLBACK       gpe_walk_callback,
 115         u32                             flags);
 116
 117 u8
 118 acpi_ev_valid_gpe_event (
 119         struct acpi_gpe_event_info      *gpe_event_info);
 120
 121 acpi_status
 122 acpi_ev_update_gpe_enable_masks (
 123         struct acpi_gpe_event_info      *gpe_event_info,
 124         u8                              type);
 125
 126 acpi_status
 127 acpi_ev_enable_gpe (
 128         struct acpi_gpe_event_info      *gpe_event_info,
 129         u8                              write_to_hardware);
 130
 131 acpi_status
 132 acpi_ev_disable_gpe (
 133         struct acpi_gpe_event_info      *gpe_event_info);
 134
 135 struct acpi_gpe_event_info *
 136 acpi_ev_get_gpe_event_info (
 137         acpi_handle                     gpe_device,
 138         u32                             gpe_number);
 139
 140 acpi_status
 141 acpi_ev_gpe_initialize (
 142         void);
 143
 144 acpi_status
 145 acpi_ev_create_gpe_block (
 146         struct acpi_namespace_node      *gpe_device,
 147         struct acpi_generic_address     *gpe_block_address,
 148         u32                             register_count,
 149         u8                              gpe_block_base_number,
 150         u32                             interrupt_level,
 151         struct acpi_gpe_block_info      **return_gpe_block);
 152
 153 acpi_status
 154 acpi_ev_delete_gpe_block (
 155         struct acpi_gpe_block_info      *gpe_block);
 156
 157 acpi_status
 158 acpi_ev_delete_gpe_handlers (
 159         struct acpi_gpe_xrupt_info      *gpe_xrupt_info,
 160         struct acpi_gpe_block_info      *gpe_block);
 161
 162 u32
 163 acpi_ev_gpe_dispatch (
 164         struct acpi_gpe_event_info      *gpe_event_info,
 165         u32                             gpe_number);
 166
 167 u32
 168 acpi_ev_gpe_detect (
 169         struct acpi_gpe_xrupt_info      *gpe_xrupt_list);
 170
 171 acpi_status
 172 acpi_ev_set_gpe_type (
 173         struct acpi_gpe_event_info      *gpe_event_info,
 174         u8                              type);
 175
 176 acpi_status
 177 acpi_ev_check_for_wake_only_gpe (
 178         struct acpi_gpe_event_info      *gpe_event_info);
 179
 180 /*
 181  * Evregion - Address Space handling
 182  */
 183
 184 acpi_status
 185 acpi_ev_install_region_handlers (
 186         void);
 187
 188 acpi_status
 189 acpi_ev_initialize_op_regions (
 190         void);
 191
 192 acpi_status
 193 acpi_ev_address_space_dispatch (
 194         union acpi_operand_object      *region_obj,
 195         u32                             function,
 196         acpi_physical_address           address,
 197         u32                             bit_width,
 198         void                            *value);
 199
 200 acpi_status
 201 acpi_ev_install_handler (
 202         acpi_handle                     obj_handle,
 203         u32                             level,
 204         void                            *context,
 205         void                            **return_value);
 206
 207 acpi_status
 208 acpi_ev_attach_region (
 209         union acpi_operand_object       *handler_obj,
 210         union acpi_operand_object       *region_obj,
 211         u8                              acpi_ns_is_locked);
 212
 213 void
 214 acpi_ev_detach_region (
 215         union acpi_operand_object      *region_obj,
 216         u8                              acpi_ns_is_locked);
 217
 218 acpi_status
 219 acpi_ev_install_space_handler (
 220         struct acpi_namespace_node      *node,
 221         acpi_adr_space_type             space_id,
 222         acpi_adr_space_handler          handler,
 223         acpi_adr_space_setup            setup,
 224         void                            *context);
 225
 226 acpi_status
 227 acpi_ev_execute_reg_methods (
 228         struct acpi_namespace_node      *node,
 229         acpi_adr_space_type             space_id);
 230
 231 acpi_status
 232 acpi_ev_execute_reg_method (
 233         union acpi_operand_object      *region_obj,
 234         u32                             function);
 235
 236 acpi_status
 237 acpi_ev_reg_run (
 238         acpi_handle                     obj_handle,
 239         u32                             level,
 240         void                            *context,
 241         void                            **return_value);
 242
 243 /*
 244  * Evregini - Region initialization and setup
 245  */
 246
 247 acpi_status
 248 acpi_ev_system_memory_region_setup (
 249         acpi_handle                     handle,
 250         u32                             function,
 251         void                            *handler_context,
 252         void                            **region_context);
 253
 254 acpi_status
 255 acpi_ev_io_space_region_setup (
 256         acpi_handle                     handle,
 257         u32                             function,
 258         void                            *handler_context,
 259         void                            **region_context);
 260
 261 acpi_status
 262 acpi_ev_pci_config_region_setup (
 263         acpi_handle                     handle,
 264         u32                             function,
 265         void                            *handler_context,
 266         void                            **region_context);
 267
 268 acpi_status
 269 acpi_ev_cmos_region_setup (
 270         acpi_handle                     handle,
 271         u32                             function,
 272         void                            *handler_context,
 273         void                            **region_context);
 274
 275 acpi_status
 276 acpi_ev_pci_bar_region_setup (
 277         acpi_handle                     handle,
 278         u32                             function,
 279         void                            *handler_context,
 280         void                            **region_context);
 281
 282 acpi_status
 283 acpi_ev_default_region_setup (
 284         acpi_handle                     handle,
 285         u32                             function,
 286         void                            *handler_context,
 287         void                            **region_context);
 288
 289 acpi_status
 290 acpi_ev_initialize_region (
 291         union acpi_operand_object       *region_obj,
 292         u8                              acpi_ns_locked);
 293
 294
 295 /*
 296  * Evsci - SCI (System Control Interrupt) handling/dispatch
 297  */
 298
 299 u32 ACPI_SYSTEM_XFACE
 300 acpi_ev_gpe_xrupt_handler (
 301         void                            *context);
 302
 303 u32
 304 acpi_ev_install_sci_handler (
 305         void);
 306
 307 acpi_status
 308 acpi_ev_remove_sci_handler (
 309         void);
 310
 311 u32
 312 acpi_ev_initialize_sCI (
 313         u32                             program_sCI);
 314
 315 void
 316 acpi_ev_terminate (
 317         void);
 318
 319
 320 #endif  /* __ACEVENTS_H__  */