drivers/acpi/acpica/acevents.h

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