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