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
  73 #if defined(CONFIG_X86) && defined(CONFIG_PCI)
  74 void acpi_lpss_init(void);
  75 #else
  76 static inline void acpi_lpss_init(void) {}
  77 #endif
  78
  79 void acpi_apd_init(void);
  80
  81 acpi_status acpi_hotplug_schedule(struct acpi_device *adev, u32 src);
  82 bool acpi_queue_hotplug_work(struct work_struct *work);
  83 void acpi_device_hotplug(struct acpi_device *adev, u32 src);
  84 bool acpi_scan_is_offline(struct acpi_device *adev, bool uevent);
  85
  86 acpi_status acpi_sysfs_table_handler(u32 event, void *table, void *context);
  87 void acpi_scan_table_notify(void);
  88
  89 int acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
  90 int acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
  91 int acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
  92 int acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
  93
  94 #ifdef CONFIG_ARM64
  95 int acpi_arch_thermal_cpufreq_pctg(void);
  96 #else
  97 static inline int acpi_arch_thermal_cpufreq_pctg(void)
  98 {
  99         return 0;
 100 }
 101 #endif
 102
 103 /* --------------------------------------------------------------------------
 104                      Device Node Initialization / Removal
 105    -------------------------------------------------------------------------- */
 106 #define ACPI_STA_DEFAULT (ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED | \
 107                           ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING)
 108
 109 extern struct list_head acpi_bus_id_list;
 110
 111 struct acpi_device_bus_id {
 112         const char *bus_id;
 113         struct ida instance_ida;
 114         struct list_head node;
 115 };
 116
 117 void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
 118                              int type, void (*release)(struct device *));
 119 int acpi_tie_acpi_dev(struct acpi_device *adev);
 120 int acpi_device_add(struct acpi_device *device);
 121 void acpi_device_setup_files(struct acpi_device *dev);
 122 void acpi_device_remove_files(struct acpi_device *dev);
 123 extern const struct attribute_group *acpi_groups[];
 124 void acpi_device_add_finalize(struct acpi_device *device);
 125 void acpi_free_pnp_ids(struct acpi_device_pnp *pnp);
 126 bool acpi_device_is_enabled(const struct acpi_device *adev);
 127 bool acpi_device_is_present(const struct acpi_device *adev);
 128 bool acpi_device_is_battery(struct acpi_device *adev);
 129 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
 130                                         const struct device *dev);
 131 int acpi_bus_register_early_device(int type);
 132
 133 /* --------------------------------------------------------------------------
 134                      Device Matching and Notification
 135    -------------------------------------------------------------------------- */
 136 const struct acpi_device *acpi_companion_match(const struct device *dev);
 137 int __acpi_device_uevent_modalias(const struct acpi_device *adev,
 138                                   struct kobj_uevent_env *env);
 139
 140 /* --------------------------------------------------------------------------
 141                                   Power Resource
 142    -------------------------------------------------------------------------- */
 143 void acpi_power_resources_list_free(struct list_head *list);
 144 int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
 145                                  struct list_head *list);
 146 struct acpi_device *acpi_add_power_resource(acpi_handle handle);
 147 void acpi_power_add_remove_device(struct acpi_device *adev, bool add);
 148 int acpi_power_wakeup_list_init(struct list_head *list, int *system_level);
 149 int acpi_device_sleep_wake(struct acpi_device *dev,
 150                            int enable, int sleep_state, int dev_state);
 151 int acpi_power_get_inferred_state(struct acpi_device *device, int *state);
 152 int acpi_power_on_resources(struct acpi_device *device, int state);
 153 int acpi_power_transition(struct acpi_device *device, int state);
 154 void acpi_turn_off_unused_power_resources(void);
 155
 156 /* --------------------------------------------------------------------------
 157                               Device Power Management
 158    -------------------------------------------------------------------------- */
 159 int acpi_device_get_power(struct acpi_device *device, int *state);
 160 int acpi_wakeup_device_init(void);
 161
 162 /* --------------------------------------------------------------------------
 163                                   Processor
 164    -------------------------------------------------------------------------- */
 165 #ifdef CONFIG_ARCH_MIGHT_HAVE_ACPI_PDC
 166 void acpi_early_processor_control_setup(void);
 167 void acpi_early_processor_set_pdc(void);
 168 #ifdef CONFIG_X86
 169 void acpi_proc_quirk_mwait_check(void);
 170 #else
 171 static inline void acpi_proc_quirk_mwait_check(void) {}
 172 #endif
 173 bool processor_physically_present(acpi_handle handle);
 174 #else
 175 static inline void acpi_early_processor_control_setup(void) {}
 176 #endif
 177
 178 /* --------------------------------------------------------------------------
 179                                   Embedded Controller
 180    -------------------------------------------------------------------------- */
 181
 182 enum acpi_ec_event_state {
 183         EC_EVENT_READY = 0,     /* Event work can be submitted */
 184         EC_EVENT_IN_PROGRESS,   /* Event work is pending or being processed */
 185         EC_EVENT_COMPLETE,      /* Event work processing has completed */
 186 };
 187
 188 struct acpi_ec {
 189         acpi_handle handle;
 190         int gpe;
 191         int irq;
 192         unsigned long command_addr;
 193         unsigned long data_addr;
 194         bool global_lock;
 195         unsigned long flags;
 196         unsigned long reference_count;
 197         struct mutex mutex;
 198         wait_queue_head_t wait;
 199         struct list_head list;
 200         struct transaction *curr;
 201         spinlock_t lock;
 202         struct work_struct work;
 203         unsigned long timestamp;
 204         enum acpi_ec_event_state event_state;
 205         unsigned int events_to_process;
 206         unsigned int events_in_progress;
 207         unsigned int queries_in_progress;
 208         bool busy_polling;
 209         unsigned int polling_guard;
 210 };
 211
 212 extern struct acpi_ec *first_ec;
 213
 214 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
 215 /* External interfaces use first EC only, so remember */
 216 typedef int (*acpi_ec_query_func) (void *data);
 217
 218 #ifdef CONFIG_ACPI_EC
 219
 220 void acpi_ec_init(void);
 221 void acpi_ec_ecdt_probe(void);
 222 void acpi_ec_dsdt_probe(void);
 223 void acpi_ec_block_transactions(void);
 224 void acpi_ec_unblock_transactions(void);
 225 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
 226                               acpi_handle handle, acpi_ec_query_func func,
 227                               void *data);
 228 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit);
 229 void acpi_ec_register_opregions(struct acpi_device *adev);
 230
 231 #ifdef CONFIG_PM_SLEEP
 232 void acpi_ec_flush_work(void);
 233 bool acpi_ec_dispatch_gpe(void);
 234 #endif
 235
 236 #else
 237
 238 static inline void acpi_ec_init(void) {}
 239 static inline void acpi_ec_ecdt_probe(void) {}
 240 static inline void acpi_ec_dsdt_probe(void) {}
 241 static inline void acpi_ec_block_transactions(void) {}
 242 static inline void acpi_ec_unblock_transactions(void) {}
 243 static inline int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
 244                               acpi_handle handle, acpi_ec_query_func func,
 245                               void *data)
 246 {
 247         return -ENXIO;
 248 }
 249 static inline void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit) {}
 250 static inline void acpi_ec_register_opregions(struct acpi_device *adev) {}
 251
 252 static inline void acpi_ec_flush_work(void) {}
 253 static inline bool acpi_ec_dispatch_gpe(void)
 254 {
 255         return false;
 256 }
 257
 258 #endif
 259
 260 /*--------------------------------------------------------------------------
 261                                   Suspend/Resume
 262   -------------------------------------------------------------------------- */
 263 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
 264 extern bool acpi_s2idle_wakeup(void);
 265 extern int acpi_sleep_init(void);
 266 #else
 267 static inline bool acpi_s2idle_wakeup(void) { return false; }
 268 static inline int acpi_sleep_init(void) { return -ENXIO; }
 269 #endif
 270
 271 #ifdef CONFIG_ACPI_SLEEP
 272 void acpi_sleep_proc_init(void);
 273 int suspend_nvs_alloc(void);
 274 void suspend_nvs_free(void);
 275 int suspend_nvs_save(void);
 276 void suspend_nvs_restore(void);
 277 #else
 278 static inline void acpi_sleep_proc_init(void) {}
 279 static inline int suspend_nvs_alloc(void) { return 0; }
 280 static inline void suspend_nvs_free(void) {}
 281 static inline int suspend_nvs_save(void) { return 0; }
 282 static inline void suspend_nvs_restore(void) {}
 283 #endif
 284
 285 #ifdef CONFIG_X86
 286 bool force_storage_d3(void);
 287 #else
 288 static inline bool force_storage_d3(void)
 289 {
 290         return false;
 291 }
 292 #endif
 293
 294 /*--------------------------------------------------------------------------
 295                                 Device properties
 296   -------------------------------------------------------------------------- */
 297 #define ACPI_DT_NAMESPACE_HID   "PRP0001"
 298
 299 void acpi_init_properties(struct acpi_device *adev);
 300 void acpi_free_properties(struct acpi_device *adev);
 301
 302 #ifdef CONFIG_X86
 303 void acpi_extract_apple_properties(struct acpi_device *adev);
 304 #else
 305 static inline void acpi_extract_apple_properties(struct acpi_device *adev) {}
 306 #endif
 307
 308 /*--------------------------------------------------------------------------
 309                                 Watchdog
 310   -------------------------------------------------------------------------- */
 311
 312 #ifdef CONFIG_ACPI_WATCHDOG
 313 void acpi_watchdog_init(void);
 314 #else
 315 static inline void acpi_watchdog_init(void) {}
 316 #endif
 317
 318 #ifdef CONFIG_ACPI_LPIT
 319 void acpi_init_lpit(void);
 320 #else
 321 static inline void acpi_init_lpit(void) { }
 322 #endif
 323
 324 /*--------------------------------------------------------------------------
 325                 ACPI _CRS CSI-2 and MIPI DisCo for Imaging
 326   -------------------------------------------------------------------------- */
 327
 328 void acpi_mipi_check_crs_csi2(acpi_handle handle);
 329 void acpi_mipi_scan_crs_csi2(void);
 330 void acpi_mipi_init_crs_csi2_swnodes(void);
 331 void acpi_mipi_crs_csi2_cleanup(void);
 332 #ifdef CONFIG_X86
 333 bool acpi_graph_ignore_port(acpi_handle handle);
 334 #else
 335 static inline bool acpi_graph_ignore_port(acpi_handle handle) { return false; }
 336 #endif
 337
 338 #endif /* _ACPI_INTERNAL_H_ */