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
73#if defined(CONFIG_X86) && defined(CONFIG_PCI)
74void acpi_lpss_init(void);
75#else
76static inline void acpi_lpss_init(void) {}
77#endif
78
79void acpi_apd_init(void);
80
81acpi_status acpi_hotplug_schedule(struct acpi_device *adev, u32 src);
82bool acpi_queue_hotplug_work(struct work_struct *work);
83void acpi_device_hotplug(struct acpi_device *adev, u32 src);
84bool acpi_scan_is_offline(struct acpi_device *adev, bool uevent);
85
86acpi_status acpi_sysfs_table_handler(u32 event, void *table, void *context);
87void acpi_scan_table_notify(void);
88
89int acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
90int acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
91int acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
92int acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
93
94#ifdef CONFIG_ARM64
95int acpi_arch_thermal_cpufreq_pctg(void);
96#else
97static 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
109extern struct list_head acpi_bus_id_list;
110
111struct acpi_device_bus_id {
112 const char *bus_id;
113 struct ida instance_ida;
114 struct list_head node;
115};
116
117void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
118 int type, void (*release)(struct device *));
119int acpi_tie_acpi_dev(struct acpi_device *adev);
120int acpi_device_add(struct acpi_device *device);
121void acpi_device_setup_files(struct acpi_device *dev);
122void acpi_device_remove_files(struct acpi_device *dev);
123extern const struct attribute_group *acpi_groups[];
124void acpi_device_add_finalize(struct acpi_device *device);
125void acpi_free_pnp_ids(struct acpi_device_pnp *pnp);
126bool acpi_device_is_enabled(const struct acpi_device *adev);
127bool acpi_device_is_present(const struct acpi_device *adev);
128bool acpi_device_is_battery(struct acpi_device *adev);
129bool acpi_device_is_first_physical_node(struct acpi_device *adev,
130 const struct device *dev);
131int acpi_bus_register_early_device(int type);
132
133/* --------------------------------------------------------------------------
134 Device Matching and Notification
135 -------------------------------------------------------------------------- */
136const struct acpi_device *acpi_companion_match(const struct device *dev);
137int __acpi_device_uevent_modalias(const struct acpi_device *adev,
138 struct kobj_uevent_env *env);
139
140/* --------------------------------------------------------------------------
141 Power Resource
142 -------------------------------------------------------------------------- */
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/* --------------------------------------------------------------------------
179 Embedded Controller
180 -------------------------------------------------------------------------- */
181
182enum 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
188struct 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
212extern 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 */
216typedef int (*acpi_ec_query_func) (void *data);
217
218#ifdef CONFIG_ACPI_EC
219
220void acpi_ec_init(void);
221void acpi_ec_ecdt_probe(void);
222void acpi_ec_dsdt_probe(void);
223void acpi_ec_block_transactions(void);
224void acpi_ec_unblock_transactions(void);
225int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
226 acpi_handle handle, acpi_ec_query_func func,
227 void *data);
228void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit);
229void acpi_ec_register_opregions(struct acpi_device *adev);
230
231#ifdef CONFIG_PM_SLEEP
232void acpi_ec_flush_work(void);
233bool acpi_ec_dispatch_gpe(void);
234#endif
235
236#else
237
238static inline void acpi_ec_init(void) {}
239static inline void acpi_ec_ecdt_probe(void) {}
240static inline void acpi_ec_dsdt_probe(void) {}
241static inline void acpi_ec_block_transactions(void) {}
242static inline void acpi_ec_unblock_transactions(void) {}
243static 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}
249static inline void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit) {}
250static inline void acpi_ec_register_opregions(struct acpi_device *adev) {}
251
252static inline void acpi_ec_flush_work(void) {}
253static 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
264extern bool acpi_s2idle_wakeup(void);
265extern int acpi_sleep_init(void);
266#else
267static inline bool acpi_s2idle_wakeup(void) { return false; }
268static inline int acpi_sleep_init(void) { return -ENXIO; }
269#endif
270
271#ifdef CONFIG_ACPI_SLEEP
272void acpi_sleep_proc_init(void);
273int suspend_nvs_alloc(void);
274void suspend_nvs_free(void);
275int suspend_nvs_save(void);
276void suspend_nvs_restore(void);
277#else
278static inline void acpi_sleep_proc_init(void) {}
279static inline int suspend_nvs_alloc(void) { return 0; }
280static inline void suspend_nvs_free(void) {}
281static inline int suspend_nvs_save(void) { return 0; }
282static inline void suspend_nvs_restore(void) {}
283#endif
284
285#ifdef CONFIG_X86
286bool force_storage_d3(void);
287#else
288static 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
299void acpi_init_properties(struct acpi_device *adev);
300void acpi_free_properties(struct acpi_device *adev);
301
302#ifdef CONFIG_X86
303void acpi_extract_apple_properties(struct acpi_device *adev);
304#else
305static inline void acpi_extract_apple_properties(struct acpi_device *adev) {}
306#endif
307
308/*--------------------------------------------------------------------------
309 Watchdog
310 -------------------------------------------------------------------------- */
311
312#ifdef CONFIG_ACPI_WATCHDOG
313void acpi_watchdog_init(void);
314#else
315static inline void acpi_watchdog_init(void) {}
316#endif
317
318#ifdef CONFIG_ACPI_LPIT
319void acpi_init_lpit(void);
320#else
321static inline void acpi_init_lpit(void) { }
322#endif
323
324/*--------------------------------------------------------------------------
325 ACPI _CRS CSI-2 and MIPI DisCo for Imaging
326 -------------------------------------------------------------------------- */
327
328void acpi_mipi_check_crs_csi2(acpi_handle handle);
329void acpi_mipi_scan_crs_csi2(void);
330void acpi_mipi_init_crs_csi2_swnodes(void);
331void acpi_mipi_crs_csi2_cleanup(void);
332#ifdef CONFIG_X86
333bool acpi_graph_ignore_port(acpi_handle handle);
334#else
335static inline bool acpi_graph_ignore_port(acpi_handle handle) { return false; }
336#endif
337
338#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
44int acpi_ioapic_remove(struct acpi_pci_root *root);
45#else
46static inline int acpi_ioapic_remove(struct acpi_pci_root *root) { return 0; }
47#endif
48#ifdef CONFIG_ACPI_DOCK
49void register_dock_dependent_device(struct acpi_device *adev,
50 acpi_handle dshandle);
51int dock_notify(struct acpi_device *adev, u32 event);
52void acpi_dock_add(struct acpi_device *adev);
53#else
54static inline void register_dock_dependent_device(struct acpi_device *adev,
55 acpi_handle dshandle) {}
56static inline int dock_notify(struct acpi_device *adev, u32 event) { return -ENODEV; }
57static inline void acpi_dock_add(struct acpi_device *adev) {}
58#endif
59#ifdef CONFIG_X86
60void acpi_cmos_rtc_init(void);
61#else
62static inline void acpi_cmos_rtc_init(void) {}
63#endif
64int acpi_rev_override_setup(char *str);
65
66extern bool acpi_force_hot_remove;
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(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);
118
119/* --------------------------------------------------------------------------
120 Device Matching and Notification
121 -------------------------------------------------------------------------- */
122struct acpi_device *acpi_companion_match(const struct device *dev);
123int __acpi_device_uevent_modalias(struct acpi_device *adev,
124 struct kobj_uevent_env *env);
125
126/* --------------------------------------------------------------------------
127 Power Resource
128 -------------------------------------------------------------------------- */
129int acpi_power_init(void);
130void acpi_power_resources_list_free(struct list_head *list);
131int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
132 struct list_head *list);
133int acpi_add_power_resource(acpi_handle handle);
134void acpi_power_add_remove_device(struct acpi_device *adev, bool add);
135int acpi_power_wakeup_list_init(struct list_head *list, int *system_level);
136int acpi_device_sleep_wake(struct acpi_device *dev,
137 int enable, int sleep_state, int dev_state);
138int acpi_power_get_inferred_state(struct acpi_device *device, int *state);
139int acpi_power_on_resources(struct acpi_device *device, int state);
140int acpi_power_transition(struct acpi_device *device, int state);
141
142int acpi_wakeup_device_init(void);
143
144#ifdef CONFIG_ARCH_MIGHT_HAVE_ACPI_PDC
145void acpi_early_processor_set_pdc(void);
146#else
147static inline void acpi_early_processor_set_pdc(void) {}
148#endif
149
150#ifdef CONFIG_X86
151void acpi_early_processor_osc(void);
152#else
153static inline void acpi_early_processor_osc(void) {}
154#endif
155
156/* --------------------------------------------------------------------------
157 Embedded Controller
158 -------------------------------------------------------------------------- */
159struct acpi_ec {
160 acpi_handle handle;
161 unsigned long gpe;
162 unsigned long command_addr;
163 unsigned long data_addr;
164 bool global_lock;
165 unsigned long flags;
166 unsigned long reference_count;
167 struct mutex mutex;
168 wait_queue_head_t wait;
169 struct list_head list;
170 struct transaction *curr;
171 spinlock_t lock;
172 struct work_struct work;
173 unsigned long timestamp;
174 unsigned long nr_pending_queries;
175 bool saved_busy_polling;
176 unsigned int saved_polling_guard;
177};
178
179extern struct acpi_ec *first_ec;
180
181/* If we find an EC via the ECDT, we need to keep a ptr to its context */
182/* External interfaces use first EC only, so remember */
183typedef int (*acpi_ec_query_func) (void *data);
184
185int acpi_ec_init(void);
186int acpi_ec_ecdt_probe(void);
187int acpi_ec_dsdt_probe(void);
188int acpi_ec_ecdt_start(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
197/*--------------------------------------------------------------------------
198 Suspend/Resume
199 -------------------------------------------------------------------------- */
200#ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
201extern int acpi_sleep_init(void);
202#else
203static inline int acpi_sleep_init(void) { return -ENXIO; }
204#endif
205
206#ifdef CONFIG_ACPI_SLEEP
207void acpi_sleep_proc_init(void);
208int suspend_nvs_alloc(void);
209void suspend_nvs_free(void);
210int suspend_nvs_save(void);
211void suspend_nvs_restore(void);
212#else
213static inline void acpi_sleep_proc_init(void) {}
214static inline int suspend_nvs_alloc(void) { return 0; }
215static inline void suspend_nvs_free(void) {}
216static inline int suspend_nvs_save(void) { return 0; }
217static inline void suspend_nvs_restore(void) {}
218#endif
219
220/*--------------------------------------------------------------------------
221 Device properties
222 -------------------------------------------------------------------------- */
223#define ACPI_DT_NAMESPACE_HID "PRP0001"
224
225void acpi_init_properties(struct acpi_device *adev);
226void acpi_free_properties(struct acpi_device *adev);
227
228/*--------------------------------------------------------------------------
229 Watchdog
230 -------------------------------------------------------------------------- */
231
232#ifdef CONFIG_ACPI_WATCHDOG
233void acpi_watchdog_init(void);
234#else
235static inline void acpi_watchdog_init(void) {}
236#endif
237
238#endif /* _ACPI_INTERNAL_H_ */