LXR linux/drivers/acpi/acpica/acevents.h

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