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