xref: /openbmc/linux/drivers/acpi/internal.h (revision bfb41e46) 
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 extern struct acpi_device *acpi_root;
15 
16 int early_acpi_osi_init(void);
17 int acpi_osi_init(void);
18 acpi_status acpi_os_initialize1(void);
19 void 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_notify(void);
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 struct acpi_device_bus_id {
102 	const char *bus_id;
103 	struct ida instance_ida;
104 	struct list_head node;
105 };
106 
107 void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
108 			     int type, void (*release)(struct device *));
109 int acpi_tie_acpi_dev(struct acpi_device *adev);
110 int acpi_device_add(struct acpi_device *device);
111 int acpi_device_setup_files(struct acpi_device *dev);
112 void acpi_device_remove_files(struct acpi_device *dev);
113 void acpi_device_add_finalize(struct acpi_device *device);
114 void acpi_free_pnp_ids(struct acpi_device_pnp *pnp);
115 bool acpi_device_is_present(const struct acpi_device *adev);
116 bool acpi_device_is_battery(struct acpi_device *adev);
117 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
118 					const struct device *dev);
119 int acpi_bus_register_early_device(int type);
120 
121 /* --------------------------------------------------------------------------
122                      Device Matching and Notification
123    -------------------------------------------------------------------------- */
124 const struct acpi_device *acpi_companion_match(const struct device *dev);
125 int __acpi_device_uevent_modalias(const struct acpi_device *adev,
126 				  struct kobj_uevent_env *env);
127 
128 /* --------------------------------------------------------------------------
129                                   Power Resource
130    -------------------------------------------------------------------------- */
131 int acpi_power_init(void);
132 void acpi_power_resources_list_free(struct list_head *list);
133 int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
134 				 struct list_head *list);
135 struct acpi_device *acpi_add_power_resource(acpi_handle handle);
136 void acpi_power_add_remove_device(struct acpi_device *adev, bool add);
137 int acpi_power_wakeup_list_init(struct list_head *list, int *system_level);
138 int acpi_device_sleep_wake(struct acpi_device *dev,
139 			   int enable, int sleep_state, int dev_state);
140 int acpi_power_get_inferred_state(struct acpi_device *device, int *state);
141 int acpi_power_on_resources(struct acpi_device *device, int state);
142 int acpi_power_transition(struct acpi_device *device, int state);
143 void acpi_turn_off_unused_power_resources(void);
144 
145 /* --------------------------------------------------------------------------
146                               Device Power Management
147    -------------------------------------------------------------------------- */
148 int acpi_device_get_power(struct acpi_device *device, int *state);
149 int acpi_wakeup_device_init(void);
150 
151 /* --------------------------------------------------------------------------
152                                   Processor
153    -------------------------------------------------------------------------- */
154 #ifdef CONFIG_ARCH_MIGHT_HAVE_ACPI_PDC
155 void acpi_early_processor_set_pdc(void);
156 #else
157 static inline void acpi_early_processor_set_pdc(void) {}
158 #endif
159 
160 #ifdef CONFIG_X86
161 void acpi_early_processor_osc(void);
162 #else
163 static inline void acpi_early_processor_osc(void) {}
164 #endif
165 
166 /* --------------------------------------------------------------------------
167                                   Embedded Controller
168    -------------------------------------------------------------------------- */
169 
170 enum acpi_ec_event_state {
171 	EC_EVENT_READY = 0,	/* Event work can be submitted */
172 	EC_EVENT_IN_PROGRESS,	/* Event work is pending or being processed */
173 	EC_EVENT_COMPLETE,	/* Event work processing has completed */
174 };
175 
176 struct acpi_ec {
177 	acpi_handle handle;
178 	acpi_handle address_space_handler_holder;
179 	int gpe;
180 	int irq;
181 	unsigned long command_addr;
182 	unsigned long data_addr;
183 	bool global_lock;
184 	unsigned long flags;
185 	unsigned long reference_count;
186 	struct mutex mutex;
187 	wait_queue_head_t wait;
188 	struct list_head list;
189 	struct transaction *curr;
190 	spinlock_t lock;
191 	struct work_struct work;
192 	unsigned long timestamp;
193 	enum acpi_ec_event_state event_state;
194 	unsigned int events_to_process;
195 	unsigned int events_in_progress;
196 	unsigned int queries_in_progress;
197 	bool busy_polling;
198 	unsigned int polling_guard;
199 };
200 
201 extern struct acpi_ec *first_ec;
202 
203 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
204 /* External interfaces use first EC only, so remember */
205 typedef int (*acpi_ec_query_func) (void *data);
206 
207 void acpi_ec_init(void);
208 void acpi_ec_ecdt_probe(void);
209 void acpi_ec_dsdt_probe(void);
210 void acpi_ec_block_transactions(void);
211 void acpi_ec_unblock_transactions(void);
212 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
213 			      acpi_handle handle, acpi_ec_query_func func,
214 			      void *data);
215 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit);
216 
217 #ifdef CONFIG_PM_SLEEP
218 void acpi_ec_flush_work(void);
219 bool acpi_ec_dispatch_gpe(void);
220 #endif
221 
222 
223 /*--------------------------------------------------------------------------
224                                   Suspend/Resume
225   -------------------------------------------------------------------------- */
226 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
227 extern bool acpi_s2idle_wakeup(void);
228 extern int acpi_sleep_init(void);
229 #else
230 static inline bool acpi_s2idle_wakeup(void) { return false; }
231 static inline int acpi_sleep_init(void) { return -ENXIO; }
232 #endif
233 
234 #ifdef CONFIG_ACPI_SLEEP
235 void acpi_sleep_proc_init(void);
236 int suspend_nvs_alloc(void);
237 void suspend_nvs_free(void);
238 int suspend_nvs_save(void);
239 void suspend_nvs_restore(void);
240 #else
241 static inline void acpi_sleep_proc_init(void) {}
242 static inline int suspend_nvs_alloc(void) { return 0; }
243 static inline void suspend_nvs_free(void) {}
244 static inline int suspend_nvs_save(void) { return 0; }
245 static inline void suspend_nvs_restore(void) {}
246 #endif
247 
248 #ifdef CONFIG_X86
249 bool force_storage_d3(void);
250 #else
251 static inline bool force_storage_d3(void)
252 {
253 	return false;
254 }
255 #endif
256 
257 /*--------------------------------------------------------------------------
258 				Device properties
259   -------------------------------------------------------------------------- */
260 #define ACPI_DT_NAMESPACE_HID	"PRP0001"
261 
262 void acpi_init_properties(struct acpi_device *adev);
263 void acpi_free_properties(struct acpi_device *adev);
264 
265 #ifdef CONFIG_X86
266 void acpi_extract_apple_properties(struct acpi_device *adev);
267 #else
268 static inline void acpi_extract_apple_properties(struct acpi_device *adev) {}
269 #endif
270 
271 /*--------------------------------------------------------------------------
272 				Watchdog
273   -------------------------------------------------------------------------- */
274 
275 #ifdef CONFIG_ACPI_WATCHDOG
276 void acpi_watchdog_init(void);
277 #else
278 static inline void acpi_watchdog_init(void) {}
279 #endif
280 
281 #ifdef CONFIG_ACPI_LPIT
282 void acpi_init_lpit(void);
283 #else
284 static inline void acpi_init_lpit(void) { }
285 #endif
286 
287 #endif /* _ACPI_INTERNAL_H_ */
288