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_mask_gpe(struct acpi_gpe_event_info *gpe_event_info, u8 is_masked);
  89
  90acpi_status
  91acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
  92
  93acpi_status
  94acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
  95
  96struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
  97                                                       u32 gpe_number);
  98
  99struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
 100                                                     struct acpi_gpe_block_info
 101                                                     *gpe_block);
 102
 103acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
 104
 105/*
 106 * evgpeblk - Upper-level GPE block support
 107 */
 108acpi_status
 109acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
 110                         struct acpi_generic_address *gpe_block_address,
 111                         u32 register_count,
 112                         u8 gpe_block_base_number,
 113                         u32 interrupt_number,
 114                         struct acpi_gpe_block_info **return_gpe_block);
 115
 116acpi_status
 117acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 118                             struct acpi_gpe_block_info *gpe_block,
 119                             void *context);
 120
 121ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
 122                            acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
 123                                                     *gpe_block))
 124
 125u32
 126acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
 127                     struct acpi_gpe_event_info *gpe_event_info,
 128                     u32 gpe_number);
 129
 130/*
 131 * evgpeinit - GPE initialization and update
 132 */
 133acpi_status acpi_ev_gpe_initialize(void);
 134
 135ACPI_HW_DEPENDENT_RETURN_VOID(void
 136                              acpi_ev_update_gpes(acpi_owner_id table_owner_id))
 137
 138 acpi_status
 139acpi_ev_match_gpe_method(acpi_handle obj_handle,
 140                         u32 level, void *context, void **return_value);
 141
 142/*
 143 * evgpeutil - GPE utilities
 144 */
 145acpi_status
 146acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
 147
 148u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
 149
 150acpi_status
 151acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 152                       struct acpi_gpe_block_info *gpe_block, void *context);
 153
 154struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32 interrupt_number);
 155
 156acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
 157
 158acpi_status
 159acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 160                            struct acpi_gpe_block_info *gpe_block,
 161                            void *context);
 162
 163/*
 164 * evhandler - Address space handling
 165 */
 166u8
 167acpi_ev_has_default_handler(struct acpi_namespace_node *node,
 168                            acpi_adr_space_type space_id);
 169
 170acpi_status acpi_ev_install_region_handlers(void);
 171
 172acpi_status
 173acpi_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);
 177
 178/*
 179 * evregion - Operation region support
 180 */
 181acpi_status acpi_ev_initialize_op_regions(void);
 182
 183acpi_status
 184acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
 185                               union acpi_operand_object *field_obj,
 186                               u32 function,
 187                               u32 region_offset, u32 bit_width, u64 *value);
 188
 189acpi_status
 190acpi_ev_attach_region(union acpi_operand_object *handler_obj,
 191                      union acpi_operand_object *region_obj,
 192                      u8 acpi_ns_is_locked);
 193
 194void
 195acpi_ev_detach_region(union acpi_operand_object *region_obj,
 196                      u8 acpi_ns_is_locked);
 197
 198acpi_status
 199acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
 200                            acpi_adr_space_type space_id);
 201
 202acpi_status
 203acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
 204
 205/*
 206 * evregini - Region initialization and setup
 207 */
 208acpi_status
 209acpi_ev_system_memory_region_setup(acpi_handle handle,
 210                                   u32 function,
 211                                   void *handler_context,
 212                                   void **region_context);
 213
 214acpi_status
 215acpi_ev_io_space_region_setup(acpi_handle handle,
 216                              u32 function,
 217                              void *handler_context, void **region_context);
 218
 219acpi_status
 220acpi_ev_pci_config_region_setup(acpi_handle handle,
 221                                u32 function,
 222                                void *handler_context, void **region_context);
 223
 224acpi_status
 225acpi_ev_cmos_region_setup(acpi_handle handle,
 226                          u32 function,
 227                          void *handler_context, void **region_context);
 228
 229acpi_status
 230acpi_ev_pci_bar_region_setup(acpi_handle handle,
 231                             u32 function,
 232                             void *handler_context, void **region_context);
 233
 234acpi_status
 235acpi_ev_default_region_setup(acpi_handle handle,
 236                             u32 function,
 237                             void *handler_context, void **region_context);
 238
 239acpi_status
 240acpi_ev_initialize_region(union acpi_operand_object *region_obj,
 241                          u8 acpi_ns_locked);
 242
 243/*
 244 * evsci - SCI (System Control Interrupt) handling/dispatch
 245 */
 246u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
 247
 248u32 acpi_ev_install_sci_handler(void);
 249
 250acpi_status acpi_ev_remove_sci_handler(void);
 251
 252u32 acpi_ev_initialize_SCI(u32 program_SCI);
 253
 254ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_ev_terminate(void))
 255#endif                          /* __ACEVENTS_H__  */
 256