drivers/acpi/acpica/acevents.h

   1 /******************************************************************************
   2  *
   3  * Name: acevents.h - Event subcomponent prototypes and defines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2010, Intel Corp.
   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  * evevent
  49  */
  50 acpi_status acpi_ev_initialize_events(void);
  51
  52 acpi_status acpi_ev_install_xrupt_handlers(void);
  53
  54 acpi_status acpi_ev_install_fadt_gpes(void);
  55
  56 u32 acpi_ev_fixed_event_detect(void);
  57
  58 /*
  59  * evmisc
  60  */
  61 u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
  62
  63 acpi_status acpi_ev_acquire_global_lock(u16 timeout);
  64
  65 acpi_status acpi_ev_release_global_lock(void);
  66
  67 acpi_status acpi_ev_init_global_lock_handler(void);
  68
  69 u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
  70
  71 acpi_status
  72 acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
  73                              u32 notify_value);
  74
  75 /*
  76  * evgpe - Low-level GPE support
  77  */
  78 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
  79
  80 acpi_status
  81 acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
  82
  83 acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
  84
  85 acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
  86
  87 acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
  88
  89 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
  90                                                        u32 gpe_number);
  91
  92 struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
  93                                                      struct acpi_gpe_block_info
  94                                                      *gpe_block);
  95
  96 /*
  97  * evgpeblk - Upper-level GPE block support
  98  */
  99 acpi_status
 100 acpi_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);
 106
 107 acpi_status
 108 acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 109                              struct acpi_gpe_block_info *gpe_block,
 110                              void *context);
 111
 112 acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
 113
 114 u32
 115 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
 116                      u32 gpe_number);
 117
 118 /*
 119  * evgpeinit - GPE initialization and update
 120  */
 121 acpi_status acpi_ev_gpe_initialize(void);
 122
 123 void acpi_ev_update_gpes(acpi_owner_id table_owner_id);
 124
 125 acpi_status
 126 acpi_ev_match_gpe_method(acpi_handle obj_handle,
 127                          u32 level, void *context, void **return_value);
 128
 129 acpi_status
 130 acpi_ev_match_prw_and_gpe(acpi_handle obj_handle,
 131                           u32 level, void *context, void **return_value);
 132
 133 /*
 134  * evgpeutil - GPE utilities
 135  */
 136 acpi_status
 137 acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
 138
 139 u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
 140
 141 acpi_status
 142 acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 143                        struct acpi_gpe_block_info *gpe_block, void *context);
 144
 145 struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32 interrupt_number);
 146
 147 acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
 148
 149 acpi_status
 150 acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 151                             struct acpi_gpe_block_info *gpe_block,
 152                             void *context);
 153
 154 /*
 155  * evregion - Address Space handling
 156  */
 157 acpi_status acpi_ev_install_region_handlers(void);
 158
 159 acpi_status acpi_ev_initialize_op_regions(void);
 160
 161 acpi_status
 162 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
 163                                u32 function,
 164                                u32 region_offset, u32 bit_width, u64 *value);
 165
 166 acpi_status
 167 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
 168                       union acpi_operand_object *region_obj,
 169                       u8 acpi_ns_is_locked);
 170
 171 void
 172 acpi_ev_detach_region(union acpi_operand_object *region_obj,
 173                       u8 acpi_ns_is_locked);
 174
 175 acpi_status
 176 acpi_ev_install_space_handler(struct acpi_namespace_node *node,
 177                               acpi_adr_space_type space_id,
 178                               acpi_adr_space_handler handler,
 179                               acpi_adr_space_setup setup, void *context);
 180
 181 acpi_status
 182 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
 183                             acpi_adr_space_type space_id);
 184
 185 acpi_status
 186 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
 187
 188 /*
 189  * evregini - Region initialization and setup
 190  */
 191 acpi_status
 192 acpi_ev_system_memory_region_setup(acpi_handle handle,
 193                                    u32 function,
 194                                    void *handler_context,
 195                                    void **region_context);
 196
 197 acpi_status
 198 acpi_ev_io_space_region_setup(acpi_handle handle,
 199                               u32 function,
 200                               void *handler_context, void **region_context);
 201
 202 acpi_status
 203 acpi_ev_pci_config_region_setup(acpi_handle handle,
 204                                 u32 function,
 205                                 void *handler_context, void **region_context);
 206
 207 acpi_status
 208 acpi_ev_cmos_region_setup(acpi_handle handle,
 209                           u32 function,
 210                           void *handler_context, void **region_context);
 211
 212 acpi_status
 213 acpi_ev_pci_bar_region_setup(acpi_handle handle,
 214                              u32 function,
 215                              void *handler_context, void **region_context);
 216
 217 acpi_status
 218 acpi_ev_default_region_setup(acpi_handle handle,
 219                              u32 function,
 220                              void *handler_context, void **region_context);
 221
 222 acpi_status
 223 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
 224                           u8 acpi_ns_locked);
 225
 226 /*
 227  * evsci - SCI (System Control Interrupt) handling/dispatch
 228  */
 229 u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
 230
 231 u32 acpi_ev_install_sci_handler(void);
 232
 233 acpi_status acpi_ev_remove_sci_handler(void);
 234
 235 u32 acpi_ev_initialize_sCI(u32 program_sCI);
 236
 237 void acpi_ev_terminate(void);
 238
 239 #endif                          /* __ACEVENTS_H__  */