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