drivers/acpi/internal.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * acpi/internal.h
   4  * For use by Linux/ACPI infrastructure, not drivers
   5  *
   6  * Copyright (c) 2009, Intel Corporation.
   7  */
   8
   9 #ifndef _ACPI_INTERNAL_H_
  10 #define _ACPI_INTERNAL_H_
  11
  12 #include <linux/idr.h>
  13
  14 extern struct acpi_device *acpi_root;
  15
  16 int early_acpi_osi_init(void);
  17 int acpi_osi_init(void);
  18 acpi_status acpi_os_initialize1(void);
  19 void acpi_scan_init(void);
  20 #ifdef CONFIG_PCI
  21 void acpi_pci_root_init(void);
  22 void acpi_pci_link_init(void);
  23 #else
  24 static inline void acpi_pci_root_init(void) {}
  25 static inline void acpi_pci_link_init(void) {}
  26 #endif
  27 void acpi_processor_init(void);
  28 void acpi_platform_init(void);
  29 void acpi_pnp_init(void);
  30 void acpi_int340x_thermal_init(void);
  31 int acpi_sysfs_init(void);
  32 void acpi_gpe_apply_masked_gpes(void);
  33 void acpi_container_init(void);
  34 void acpi_memory_hotplug_init(void);
  35 #ifdef  CONFIG_ACPI_HOTPLUG_IOAPIC
  36 void pci_ioapic_remove(struct acpi_pci_root *root);
  37 int acpi_ioapic_remove(struct acpi_pci_root *root);
  38 #else
  39 static inline void pci_ioapic_remove(struct acpi_pci_root *root) { return; }
  40 static inline int acpi_ioapic_remove(struct acpi_pci_root *root) { return 0; }
  41 #endif
  42 #ifdef CONFIG_ACPI_DOCK
  43 void register_dock_dependent_device(struct acpi_device *adev,
  44                                     acpi_handle dshandle);
  45 int dock_notify(struct acpi_device *adev, u32 event);
  46 void acpi_dock_add(struct acpi_device *adev);
  47 #else
  48 static inline void register_dock_dependent_device(struct acpi_device *adev,
  49                                                   acpi_handle dshandle) {}
  50 static inline int dock_notify(struct acpi_device *adev, u32 event) { return -ENODEV; }
  51 static inline void acpi_dock_add(struct acpi_device *adev) {}
  52 #endif
  53 #ifdef CONFIG_X86
  54 void acpi_cmos_rtc_init(void);
  55 #else
  56 static inline void acpi_cmos_rtc_init(void) {}
  57 #endif
  58 int acpi_rev_override_setup(char *str);
  59
  60 void acpi_sysfs_add_hotplug_profile(struct acpi_hotplug_profile *hotplug,
  61                                     const char *name);
  62 int acpi_scan_add_handler_with_hotplug(struct acpi_scan_handler *handler,
  63                                        const char *hotplug_profile_name);
  64 void acpi_scan_hotplug_enabled(struct acpi_hotplug_profile *hotplug, bool val);
  65
  66 #ifdef CONFIG_DEBUG_FS
  67 extern struct dentry *acpi_debugfs_dir;
  68 void acpi_debugfs_init(void);
  69 #else
  70 static inline void acpi_debugfs_init(void) { return; }
  71 #endif
  72 #ifdef CONFIG_PCI
  73 void acpi_lpss_init(void);
  74 #else
  75 static inline void acpi_lpss_init(void) {}
  76 #endif
  77
  78 void acpi_apd_init(void);
  79
  80 acpi_status acpi_hotplug_schedule(struct acpi_device *adev, u32 src);
  81 bool acpi_queue_hotplug_work(struct work_struct *work);
  82 void acpi_device_hotplug(struct acpi_device *adev, u32 src);
  83 bool acpi_scan_is_offline(struct acpi_device *adev, bool uevent);
  84
  85 acpi_status acpi_sysfs_table_handler(u32 event, void *table, void *context);
  86 void acpi_scan_table_notify(void);
  87
  88 int acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
  89 int acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
  90 int acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
  91 int acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
  92
  93 #ifdef CONFIG_ARM64
  94 int acpi_arch_thermal_cpufreq_pctg(void);
  95 #else
  96 static inline int acpi_arch_thermal_cpufreq_pctg(void)
  97 {
  98         return 0;
  99 }
 100 #endif
 101
 102 /* --------------------------------------------------------------------------
 103                      Device Node Initialization / Removal
 104    -------------------------------------------------------------------------- */
 105 #define ACPI_STA_DEFAULT (ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED | \
 106                           ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING)
 107
 108 extern struct list_head acpi_bus_id_list;
 109
 110 struct acpi_device_bus_id {
 111         const char *bus_id;
 112         struct ida instance_ida;
 113         struct list_head node;
 114 };
 115
 116 void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
 117                              int type, void (*release)(struct device *));
 118 int acpi_tie_acpi_dev(struct acpi_device *adev);
 119 int acpi_device_add(struct acpi_device *device);
 120 int acpi_device_setup_files(struct acpi_device *dev);
 121 void acpi_device_remove_files(struct acpi_device *dev);
 122 void acpi_device_add_finalize(struct acpi_device *device);
 123 void acpi_free_pnp_ids(struct acpi_device_pnp *pnp);
 124 bool acpi_device_is_present(const struct acpi_device *adev);
 125 bool acpi_device_is_battery(struct acpi_device *adev);
 126 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
 127                                         const struct device *dev);
 128 int acpi_bus_register_early_device(int type);
 129
 130 /* --------------------------------------------------------------------------
 131                      Device Matching and Notification
 132    -------------------------------------------------------------------------- */
 133 const struct acpi_device *acpi_companion_match(const struct device *dev);
 134 int __acpi_device_uevent_modalias(const struct acpi_device *adev,
 135                                   struct kobj_uevent_env *env);
 136
 137 /* --------------------------------------------------------------------------
 138                                   Power Resource
 139    -------------------------------------------------------------------------- */
 140 void acpi_power_resources_list_free(struct list_head *list);
 141 int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
 142                                  struct list_head *list);
 143 struct acpi_device *acpi_add_power_resource(acpi_handle handle);
 144 void acpi_power_add_remove_device(struct acpi_device *adev, bool add);
 145 int acpi_power_wakeup_list_init(struct list_head *list, int *system_level);
 146 int acpi_device_sleep_wake(struct acpi_device *dev,
 147                            int enable, int sleep_state, int dev_state);
 148 int acpi_power_get_inferred_state(struct acpi_device *device, int *state);
 149 int acpi_power_on_resources(struct acpi_device *device, int state);
 150 int acpi_power_transition(struct acpi_device *device, int state);
 151 void acpi_turn_off_unused_power_resources(void);
 152
 153 /* --------------------------------------------------------------------------
 154                               Device Power Management
 155    -------------------------------------------------------------------------- */
 156 int acpi_device_get_power(struct acpi_device *device, int *state);
 157 int acpi_wakeup_device_init(void);
 158
 159 /* --------------------------------------------------------------------------
 160                                   Processor
 161    -------------------------------------------------------------------------- */
 162 #ifdef CONFIG_ARCH_MIGHT_HAVE_ACPI_PDC
 163 void acpi_early_processor_control_setup(void);
 164 void acpi_early_processor_set_pdc(void);
 165 #ifdef CONFIG_X86
 166 void acpi_proc_quirk_mwait_check(void);
 167 #else
 168 static inline void acpi_proc_quirk_mwait_check(void) {}
 169 #endif
 170 bool processor_physically_present(acpi_handle handle);
 171 #else
 172 static inline void acpi_early_processor_control_setup(void) {}
 173 #endif
 174
 175 /* --------------------------------------------------------------------------
 176                                   Embedded Controller
 177    -------------------------------------------------------------------------- */
 178
 179 enum acpi_ec_event_state {
 180         EC_EVENT_READY = 0,     /* Event work can be submitted */
 181         EC_EVENT_IN_PROGRESS,   /* Event work is pending or being processed */
 182         EC_EVENT_COMPLETE,      /* Event work processing has completed */
 183 };
 184
 185 struct acpi_ec {
 186         acpi_handle handle;
 187         acpi_handle address_space_handler_holder;
 188         int gpe;
 189         int irq;
 190         unsigned long command_addr;
 191         unsigned long data_addr;
 192         bool global_lock;
 193         unsigned long flags;
 194         unsigned long reference_count;
 195         struct mutex mutex;
 196         wait_queue_head_t wait;
 197         struct list_head list;
 198         struct transaction *curr;
 199         spinlock_t lock;
 200         struct work_struct work;
 201         unsigned long timestamp;
 202         enum acpi_ec_event_state event_state;
 203         unsigned int events_to_process;
 204         unsigned int events_in_progress;
 205         unsigned int queries_in_progress;
 206         bool busy_polling;
 207         unsigned int polling_guard;
 208 };
 209
 210 extern struct acpi_ec *first_ec;
 211
 212 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
 213 /* External interfaces use first EC only, so remember */
 214 typedef int (*acpi_ec_query_func) (void *data);
 215
 216 void acpi_ec_init(void);
 217 void acpi_ec_ecdt_probe(void);
 218 void acpi_ec_dsdt_probe(void);
 219 void acpi_ec_block_transactions(void);
 220 void acpi_ec_unblock_transactions(void);
 221 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
 222                               acpi_handle handle, acpi_ec_query_func func,
 223                               void *data);
 224 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit);
 225
 226 #ifdef CONFIG_PM_SLEEP
 227 void acpi_ec_flush_work(void);
 228 bool acpi_ec_dispatch_gpe(void);
 229 #endif
 230
 231
 232 /*--------------------------------------------------------------------------
 233                                   Suspend/Resume
 234   -------------------------------------------------------------------------- */
 235 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
 236 extern bool acpi_s2idle_wakeup(void);
 237 extern int acpi_sleep_init(void);
 238 #else
 239 static inline bool acpi_s2idle_wakeup(void) { return false; }
 240 static inline int acpi_sleep_init(void) { return -ENXIO; }
 241 #endif
 242
 243 #ifdef CONFIG_ACPI_SLEEP
 244 void acpi_sleep_proc_init(void);
 245 int suspend_nvs_alloc(void);
 246 void suspend_nvs_free(void);
 247 int suspend_nvs_save(void);
 248 void suspend_nvs_restore(void);
 249 #else
 250 static inline void acpi_sleep_proc_init(void) {}
 251 static inline int suspend_nvs_alloc(void) { return 0; }
 252 static inline void suspend_nvs_free(void) {}
 253 static inline int suspend_nvs_save(void) { return 0; }
 254 static inline void suspend_nvs_restore(void) {}
 255 #endif
 256
 257 #ifdef CONFIG_X86
 258 bool force_storage_d3(void);
 259 #else
 260 static inline bool force_storage_d3(void)
 261 {
 262         return false;
 263 }
 264 #endif
 265
 266 /*--------------------------------------------------------------------------
 267                                 Device properties
 268   -------------------------------------------------------------------------- */
 269 #define ACPI_DT_NAMESPACE_HID   "PRP0001"
 270
 271 void acpi_init_properties(struct acpi_device *adev);
 272 void acpi_free_properties(struct acpi_device *adev);
 273
 274 #ifdef CONFIG_X86
 275 void acpi_extract_apple_properties(struct acpi_device *adev);
 276 #else
 277 static inline void acpi_extract_apple_properties(struct acpi_device *adev) {}
 278 #endif
 279
 280 /*--------------------------------------------------------------------------
 281                                 Watchdog
 282   -------------------------------------------------------------------------- */
 283
 284 #ifdef CONFIG_ACPI_WATCHDOG
 285 void acpi_watchdog_init(void);
 286 #else
 287 static inline void acpi_watchdog_init(void) {}
 288 #endif
 289
 290 #ifdef CONFIG_ACPI_LPIT
 291 void acpi_init_lpit(void);
 292 #else
 293 static inline void acpi_init_lpit(void) { }
 294 #endif
 295
 296 /*--------------------------------------------------------------------------
 297                 ACPI _CRS CSI-2 and MIPI DisCo for Imaging
 298   -------------------------------------------------------------------------- */
 299
 300 void acpi_mipi_check_crs_csi2(acpi_handle handle);
 301 void acpi_mipi_scan_crs_csi2(void);
 302 void acpi_mipi_init_crs_csi2_swnodes(void);
 303 void acpi_mipi_crs_csi2_cleanup(void);
 304
 305 #endif /* _ACPI_INTERNAL_H_ */