1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Name: acevents.h - Event subcomponent prototypes and defines 5 * 6 * Copyright (C) 2000 - 2018, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #ifndef __ACEVENTS_H__ 11 #define __ACEVENTS_H__ 12 13 /* 14 * Conditions to trigger post enabling GPE polling: 15 * It is not sufficient to trigger edge-triggered GPE with specific GPE 16 * chips, software need to poll once after enabling. 17 */ 18 #ifdef ACPI_USE_GPE_POLLING 19 #define ACPI_GPE_IS_POLLING_NEEDED(__gpe__) \ 20 ((__gpe__)->runtime_count == 1 && \ 21 (__gpe__)->flags & ACPI_GPE_INITIALIZED && \ 22 ((__gpe__)->flags & ACPI_GPE_XRUPT_TYPE_MASK) == ACPI_GPE_EDGE_TRIGGERED) 23 #else 24 #define ACPI_GPE_IS_POLLING_NEEDED(__gpe__) FALSE 25 #endif 26 27 /* 28 * evevent 29 */ 30 acpi_status acpi_ev_initialize_events(void); 31 32 acpi_status acpi_ev_install_xrupt_handlers(void); 33 34 u32 acpi_ev_fixed_event_detect(void); 35 36 /* 37 * evmisc 38 */ 39 u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node); 40 41 u32 acpi_ev_get_gpe_number_index(u32 gpe_number); 42 43 acpi_status 44 acpi_ev_queue_notify_request(struct acpi_namespace_node *node, 45 u32 notify_value); 46 47 /* 48 * evglock - Global Lock support 49 */ 50 acpi_status acpi_ev_init_global_lock_handler(void); 51 52 ACPI_HW_DEPENDENT_RETURN_OK(acpi_status 53 acpi_ev_acquire_global_lock(u16 timeout)) 54 ACPI_HW_DEPENDENT_RETURN_OK(acpi_status acpi_ev_release_global_lock(void)) 55 56 acpi_status acpi_ev_remove_global_lock_handler(void); 57 58 /* 59 * evgpe - Low-level GPE support 60 */ 61 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list); 62 63 acpi_status 64 acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info); 65 66 acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info); 67 68 acpi_status 69 acpi_ev_mask_gpe(struct acpi_gpe_event_info *gpe_event_info, u8 is_masked); 70 71 acpi_status 72 acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info); 73 74 acpi_status 75 acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info); 76 77 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device, 78 u32 gpe_number); 79 80 struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number, 81 struct acpi_gpe_block_info 82 *gpe_block); 83 84 acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info); 85 86 u32 87 acpi_ev_detect_gpe(struct acpi_namespace_node *gpe_device, 88 struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number); 89 90 /* 91 * evgpeblk - Upper-level GPE block support 92 */ 93 acpi_status 94 acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device, 95 u64 address, 96 u8 space_id, 97 u32 register_count, 98 u16 gpe_block_base_number, 99 u32 interrupt_number, 100 struct acpi_gpe_block_info **return_gpe_block); 101 102 acpi_status 103 acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info, 104 struct acpi_gpe_block_info *gpe_block, 105 void *context); 106 107 ACPI_HW_DEPENDENT_RETURN_OK(acpi_status 108 acpi_ev_delete_gpe_block(struct acpi_gpe_block_info 109 *gpe_block)) 110 111 u32 112 acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device, 113 struct acpi_gpe_event_info *gpe_event_info, 114 u32 gpe_number); 115 116 /* 117 * evgpeinit - GPE initialization and update 118 */ 119 acpi_status acpi_ev_gpe_initialize(void); 120 121 ACPI_HW_DEPENDENT_RETURN_VOID(void 122 acpi_ev_update_gpes(acpi_owner_id table_owner_id)) 123 124 acpi_status 125 acpi_ev_match_gpe_method(acpi_handle obj_handle, 126 u32 level, void *context, void **return_value); 127 128 /* 129 * evgpeutil - GPE utilities 130 */ 131 acpi_status 132 acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context); 133 134 acpi_status 135 acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info, 136 struct acpi_gpe_block_info *gpe_block, void *context); 137 138 acpi_status 139 acpi_ev_get_gpe_xrupt_block(u32 interrupt_number, 140 struct acpi_gpe_xrupt_info **gpe_xrupt_block); 141 142 acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt); 143 144 acpi_status 145 acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info, 146 struct acpi_gpe_block_info *gpe_block, 147 void *context); 148 149 /* 150 * evhandler - Address space handling 151 */ 152 union acpi_operand_object *acpi_ev_find_region_handler(acpi_adr_space_type 153 space_id, 154 union acpi_operand_object 155 *handler_obj); 156 157 u8 158 acpi_ev_has_default_handler(struct acpi_namespace_node *node, 159 acpi_adr_space_type space_id); 160 161 acpi_status acpi_ev_install_region_handlers(void); 162 163 acpi_status 164 acpi_ev_install_space_handler(struct acpi_namespace_node *node, 165 acpi_adr_space_type space_id, 166 acpi_adr_space_handler handler, 167 acpi_adr_space_setup setup, void *context); 168 169 /* 170 * evregion - Operation region support 171 */ 172 acpi_status acpi_ev_initialize_op_regions(void); 173 174 acpi_status 175 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj, 176 union acpi_operand_object *field_obj, 177 u32 function, 178 u32 region_offset, u32 bit_width, u64 *value); 179 180 acpi_status 181 acpi_ev_attach_region(union acpi_operand_object *handler_obj, 182 union acpi_operand_object *region_obj, 183 u8 acpi_ns_is_locked); 184 185 void 186 acpi_ev_detach_region(union acpi_operand_object *region_obj, 187 u8 acpi_ns_is_locked); 188 189 void 190 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node, 191 acpi_adr_space_type space_id, u32 function); 192 193 acpi_status 194 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function); 195 196 /* 197 * evregini - Region initialization and setup 198 */ 199 acpi_status 200 acpi_ev_system_memory_region_setup(acpi_handle handle, 201 u32 function, 202 void *handler_context, 203 void **region_context); 204 205 acpi_status 206 acpi_ev_io_space_region_setup(acpi_handle handle, 207 u32 function, 208 void *handler_context, void **region_context); 209 210 acpi_status 211 acpi_ev_pci_config_region_setup(acpi_handle handle, 212 u32 function, 213 void *handler_context, void **region_context); 214 215 acpi_status 216 acpi_ev_cmos_region_setup(acpi_handle handle, 217 u32 function, 218 void *handler_context, void **region_context); 219 220 acpi_status 221 acpi_ev_pci_bar_region_setup(acpi_handle handle, 222 u32 function, 223 void *handler_context, void **region_context); 224 225 acpi_status 226 acpi_ev_default_region_setup(acpi_handle handle, 227 u32 function, 228 void *handler_context, void **region_context); 229 230 acpi_status acpi_ev_initialize_region(union acpi_operand_object *region_obj); 231 232 /* 233 * evsci - SCI (System Control Interrupt) handling/dispatch 234 */ 235 u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context); 236 237 u32 acpi_ev_sci_dispatch(void); 238 239 u32 acpi_ev_install_sci_handler(void); 240 241 acpi_status acpi_ev_remove_all_sci_handlers(void); 242 243 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_ev_terminate(void)) 244 #endif /* __ACEVENTS_H__ */ 245