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