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