Loading...
1/*
2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#ifndef __ACPI_BUS_H__
27#define __ACPI_BUS_H__
28
29#include <linux/device.h>
30
31#include <acpi/acpi.h>
32
33/* TBD: Make dynamic */
34#define ACPI_MAX_HANDLES 10
35struct acpi_handle_list {
36 u32 count;
37 acpi_handle handles[ACPI_MAX_HANDLES];
38};
39
40/* acpi_utils.h */
41acpi_status
42acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer);
44acpi_status
45acpi_evaluate_integer(acpi_handle handle,
46 acpi_string pathname,
47 struct acpi_object_list *arguments, unsigned long long *data);
48acpi_status
49acpi_evaluate_reference(acpi_handle handle,
50 acpi_string pathname,
51 struct acpi_object_list *arguments,
52 struct acpi_handle_list *list);
53
54#ifdef CONFIG_ACPI
55
56#include <linux/proc_fs.h>
57
58#define ACPI_BUS_FILE_ROOT "acpi"
59extern struct proc_dir_entry *acpi_root_dir;
60
61enum acpi_bus_removal_type {
62 ACPI_BUS_REMOVAL_NORMAL = 0,
63 ACPI_BUS_REMOVAL_EJECT,
64 ACPI_BUS_REMOVAL_SUPRISE,
65 ACPI_BUS_REMOVAL_TYPE_COUNT
66};
67
68enum acpi_bus_device_type {
69 ACPI_BUS_TYPE_DEVICE = 0,
70 ACPI_BUS_TYPE_POWER,
71 ACPI_BUS_TYPE_PROCESSOR,
72 ACPI_BUS_TYPE_THERMAL,
73 ACPI_BUS_TYPE_POWER_BUTTON,
74 ACPI_BUS_TYPE_SLEEP_BUTTON,
75 ACPI_BUS_DEVICE_TYPE_COUNT
76};
77
78struct acpi_driver;
79struct acpi_device;
80
81/*
82 * ACPI Driver
83 * -----------
84 */
85
86typedef int (*acpi_op_add) (struct acpi_device * device);
87typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
88typedef int (*acpi_op_start) (struct acpi_device * device);
89typedef int (*acpi_op_suspend) (struct acpi_device * device,
90 pm_message_t state);
91typedef int (*acpi_op_resume) (struct acpi_device * device);
92typedef int (*acpi_op_bind) (struct acpi_device * device);
93typedef int (*acpi_op_unbind) (struct acpi_device * device);
94typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
95
96struct acpi_bus_ops {
97 u32 acpi_op_add:1;
98 u32 acpi_op_start:1;
99};
100
101struct acpi_device_ops {
102 acpi_op_add add;
103 acpi_op_remove remove;
104 acpi_op_start start;
105 acpi_op_suspend suspend;
106 acpi_op_resume resume;
107 acpi_op_bind bind;
108 acpi_op_unbind unbind;
109 acpi_op_notify notify;
110};
111
112#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
113
114struct acpi_driver {
115 char name[80];
116 char class[80];
117 const struct acpi_device_id *ids; /* Supported Hardware IDs */
118 unsigned int flags;
119 struct acpi_device_ops ops;
120 struct device_driver drv;
121 struct module *owner;
122};
123
124/*
125 * ACPI Device
126 * -----------
127 */
128
129/* Status (_STA) */
130
131struct acpi_device_status {
132 u32 present:1;
133 u32 enabled:1;
134 u32 show_in_ui:1;
135 u32 functional:1;
136 u32 battery_present:1;
137 u32 reserved:27;
138};
139
140/* Flags */
141
142struct acpi_device_flags {
143 u32 dynamic_status:1;
144 u32 bus_address:1;
145 u32 removable:1;
146 u32 ejectable:1;
147 u32 lockable:1;
148 u32 suprise_removal_ok:1;
149 u32 power_manageable:1;
150 u32 performance_manageable:1;
151 u32 reserved:24;
152};
153
154/* File System */
155
156struct acpi_device_dir {
157 struct proc_dir_entry *entry;
158};
159
160#define acpi_device_dir(d) ((d)->dir.entry)
161
162/* Plug and Play */
163
164typedef char acpi_bus_id[8];
165typedef unsigned long acpi_bus_address;
166typedef char acpi_device_name[40];
167typedef char acpi_device_class[20];
168
169struct acpi_hardware_id {
170 struct list_head list;
171 char *id;
172};
173
174struct acpi_device_pnp {
175 acpi_bus_id bus_id; /* Object name */
176 acpi_bus_address bus_address; /* _ADR */
177 char *unique_id; /* _UID */
178 struct list_head ids; /* _HID and _CIDs */
179 acpi_device_name device_name; /* Driver-determined */
180 acpi_device_class device_class; /* " */
181};
182
183#define acpi_device_bid(d) ((d)->pnp.bus_id)
184#define acpi_device_adr(d) ((d)->pnp.bus_address)
185const char *acpi_device_hid(struct acpi_device *device);
186#define acpi_device_name(d) ((d)->pnp.device_name)
187#define acpi_device_class(d) ((d)->pnp.device_class)
188
189/* Power Management */
190
191struct acpi_device_power_flags {
192 u32 explicit_get:1; /* _PSC present? */
193 u32 power_resources:1; /* Power resources */
194 u32 inrush_current:1; /* Serialize Dx->D0 */
195 u32 power_removed:1; /* Optimize Dx->D0 */
196 u32 reserved:28;
197};
198
199struct acpi_device_power_state {
200 struct {
201 u8 valid:1;
202 u8 explicit_set:1; /* _PSx present? */
203 u8 reserved:6;
204 } flags;
205 int power; /* % Power (compared to D0) */
206 int latency; /* Dx->D0 time (microseconds) */
207 struct acpi_handle_list resources; /* Power resources referenced */
208};
209
210struct acpi_device_power {
211 int state; /* Current state */
212 struct acpi_device_power_flags flags;
213 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
214};
215
216/* Performance Management */
217
218struct acpi_device_perf_flags {
219 u8 reserved:8;
220};
221
222struct acpi_device_perf_state {
223 struct {
224 u8 valid:1;
225 u8 reserved:7;
226 } flags;
227 u8 power; /* % Power (compared to P0) */
228 u8 performance; /* % Performance ( " ) */
229 int latency; /* Px->P0 time (microseconds) */
230};
231
232struct acpi_device_perf {
233 int state;
234 struct acpi_device_perf_flags flags;
235 int state_count;
236 struct acpi_device_perf_state *states;
237};
238
239/* Wakeup Management */
240struct acpi_device_wakeup_flags {
241 u8 valid:1; /* Can successfully enable wakeup? */
242 u8 run_wake:1; /* Run-Wake GPE devices */
243 u8 notifier_present:1; /* Wake-up notify handler has been installed */
244};
245
246struct acpi_device_wakeup {
247 acpi_handle gpe_device;
248 u64 gpe_number;
249 u64 sleep_state;
250 struct acpi_handle_list resources;
251 struct acpi_device_wakeup_flags flags;
252 int prepare_count;
253};
254
255/* Device */
256
257struct acpi_device {
258 int device_type;
259 acpi_handle handle; /* no handle for fixed hardware */
260 struct acpi_device *parent;
261 struct list_head children;
262 struct list_head node;
263 struct list_head wakeup_list;
264 struct acpi_device_status status;
265 struct acpi_device_flags flags;
266 struct acpi_device_pnp pnp;
267 struct acpi_device_power power;
268 struct acpi_device_wakeup wakeup;
269 struct acpi_device_perf performance;
270 struct acpi_device_dir dir;
271 struct acpi_device_ops ops;
272 struct acpi_driver *driver;
273 void *driver_data;
274 struct device dev;
275 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
276 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
277};
278
279static inline void *acpi_driver_data(struct acpi_device *d)
280{
281 return d->driver_data;
282}
283
284#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
285#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
286
287/* acpi_device.dev.bus == &acpi_bus_type */
288extern struct bus_type acpi_bus_type;
289
290/*
291 * Events
292 * ------
293 */
294
295struct acpi_bus_event {
296 struct list_head node;
297 acpi_device_class device_class;
298 acpi_bus_id bus_id;
299 u32 type;
300 u32 data;
301};
302
303extern struct kobject *acpi_kobj;
304extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
305void acpi_bus_private_data_handler(acpi_handle, void *);
306int acpi_bus_get_private_data(acpi_handle, void **);
307extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
308extern int register_acpi_notifier(struct notifier_block *);
309extern int unregister_acpi_notifier(struct notifier_block *);
310
311extern int register_acpi_bus_notifier(struct notifier_block *nb);
312extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
313/*
314 * External Functions
315 */
316
317int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
318void acpi_bus_data_handler(acpi_handle handle, void *context);
319acpi_status acpi_bus_get_status_handle(acpi_handle handle,
320 unsigned long long *sta);
321int acpi_bus_get_status(struct acpi_device *device);
322int acpi_bus_set_power(acpi_handle handle, int state);
323int acpi_bus_update_power(acpi_handle handle, int *state_p);
324bool acpi_bus_power_manageable(acpi_handle handle);
325bool acpi_bus_can_wakeup(acpi_handle handle);
326#ifdef CONFIG_ACPI_PROC_EVENT
327int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
328int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
329int acpi_bus_receive_event(struct acpi_bus_event *event);
330#else
331static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
332 { return 0; }
333#endif
334int acpi_bus_register_driver(struct acpi_driver *driver);
335void acpi_bus_unregister_driver(struct acpi_driver *driver);
336int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
337 acpi_handle handle, int type);
338int acpi_bus_trim(struct acpi_device *start, int rmdevice);
339int acpi_bus_start(struct acpi_device *device);
340acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
341int acpi_match_device_ids(struct acpi_device *device,
342 const struct acpi_device_id *ids);
343int acpi_create_dir(struct acpi_device *);
344void acpi_remove_dir(struct acpi_device *);
345
346/*
347 * Bind physical devices with ACPI devices
348 */
349struct acpi_bus_type {
350 struct list_head list;
351 struct bus_type *bus;
352 /* For general devices under the bus */
353 int (*find_device) (struct device *, acpi_handle *);
354 /* For bridges, such as PCI root bridge, IDE controller */
355 int (*find_bridge) (struct device *, acpi_handle *);
356};
357int register_acpi_bus_type(struct acpi_bus_type *);
358int unregister_acpi_bus_type(struct acpi_bus_type *);
359struct device *acpi_get_physical_device(acpi_handle);
360
361struct acpi_pci_root {
362 struct list_head node;
363 struct acpi_device * device;
364 struct acpi_pci_id id;
365 struct pci_bus *bus;
366 u16 segment;
367 struct resource secondary; /* downstream bus range */
368
369 u32 osc_support_set; /* _OSC state of support bits */
370 u32 osc_control_set; /* _OSC state of control bits */
371};
372
373/* helper */
374acpi_handle acpi_get_child(acpi_handle, u64);
375int acpi_is_root_bridge(acpi_handle);
376acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
377struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
378#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
379
380int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
381int acpi_disable_wakeup_device_power(struct acpi_device *dev);
382
383#ifdef CONFIG_PM
384int acpi_pm_device_sleep_state(struct device *, int *);
385#else
386static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
387{
388 if (p)
389 *p = ACPI_STATE_D0;
390 return ACPI_STATE_D3;
391}
392#endif
393
394#ifdef CONFIG_PM_SLEEP
395int acpi_pm_device_sleep_wake(struct device *, bool);
396#else
397static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
398{
399 return -ENODEV;
400}
401#endif
402
403#endif /* CONFIG_ACPI */
404
405#endif /*__ACPI_BUS_H__*/
1/*
2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 */
21
22#ifndef __ACPI_BUS_H__
23#define __ACPI_BUS_H__
24
25#include <linux/device.h>
26#include <linux/property.h>
27
28/* TBD: Make dynamic */
29#define ACPI_MAX_HANDLES 10
30struct acpi_handle_list {
31 u32 count;
32 acpi_handle handles[ACPI_MAX_HANDLES];
33};
34
35/* acpi_utils.h */
36acpi_status
37acpi_extract_package(union acpi_object *package,
38 struct acpi_buffer *format, struct acpi_buffer *buffer);
39acpi_status
40acpi_evaluate_integer(acpi_handle handle,
41 acpi_string pathname,
42 struct acpi_object_list *arguments, unsigned long long *data);
43acpi_status
44acpi_evaluate_reference(acpi_handle handle,
45 acpi_string pathname,
46 struct acpi_object_list *arguments,
47 struct acpi_handle_list *list);
48acpi_status
49acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
50 struct acpi_buffer *status_buf);
51
52acpi_status
53acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
54
55bool acpi_has_method(acpi_handle handle, char *name);
56acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
57 u64 arg);
58acpi_status acpi_evaluate_ej0(acpi_handle handle);
59acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
60bool acpi_ata_match(acpi_handle handle);
61bool acpi_bay_match(acpi_handle handle);
62bool acpi_dock_match(acpi_handle handle);
63
64bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
65union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
66 u64 rev, u64 func, union acpi_object *argv4);
67
68static inline union acpi_object *
69acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
70 u64 func, union acpi_object *argv4,
71 acpi_object_type type)
72{
73 union acpi_object *obj;
74
75 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
76 if (obj && obj->type != type) {
77 ACPI_FREE(obj);
78 obj = NULL;
79 }
80
81 return obj;
82}
83
84#define ACPI_INIT_DSM_ARGV4(cnt, eles) \
85 { \
86 .package.type = ACPI_TYPE_PACKAGE, \
87 .package.count = (cnt), \
88 .package.elements = (eles) \
89 }
90
91bool acpi_dev_found(const char *hid);
92bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
93
94const char *
95acpi_dev_get_first_match_name(const char *hid, const char *uid, s64 hrv);
96
97#ifdef CONFIG_ACPI
98
99#include <linux/proc_fs.h>
100
101#define ACPI_BUS_FILE_ROOT "acpi"
102extern struct proc_dir_entry *acpi_root_dir;
103
104enum acpi_bus_device_type {
105 ACPI_BUS_TYPE_DEVICE = 0,
106 ACPI_BUS_TYPE_POWER,
107 ACPI_BUS_TYPE_PROCESSOR,
108 ACPI_BUS_TYPE_THERMAL,
109 ACPI_BUS_TYPE_POWER_BUTTON,
110 ACPI_BUS_TYPE_SLEEP_BUTTON,
111 ACPI_BUS_TYPE_ECDT_EC,
112 ACPI_BUS_DEVICE_TYPE_COUNT
113};
114
115struct acpi_driver;
116struct acpi_device;
117
118/*
119 * ACPI Scan Handler
120 * -----------------
121 */
122
123struct acpi_hotplug_profile {
124 struct kobject kobj;
125 int (*scan_dependent)(struct acpi_device *adev);
126 void (*notify_online)(struct acpi_device *adev);
127 bool enabled:1;
128 bool demand_offline:1;
129};
130
131static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
132 struct kobject *kobj)
133{
134 return container_of(kobj, struct acpi_hotplug_profile, kobj);
135}
136
137struct acpi_scan_handler {
138 const struct acpi_device_id *ids;
139 struct list_head list_node;
140 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
141 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
142 void (*detach)(struct acpi_device *dev);
143 void (*bind)(struct device *phys_dev);
144 void (*unbind)(struct device *phys_dev);
145 struct acpi_hotplug_profile hotplug;
146};
147
148/*
149 * ACPI Hotplug Context
150 * --------------------
151 */
152
153struct acpi_hotplug_context {
154 struct acpi_device *self;
155 int (*notify)(struct acpi_device *, u32);
156 void (*uevent)(struct acpi_device *, u32);
157 void (*fixup)(struct acpi_device *);
158};
159
160/*
161 * ACPI Driver
162 * -----------
163 */
164
165typedef int (*acpi_op_add) (struct acpi_device * device);
166typedef int (*acpi_op_remove) (struct acpi_device * device);
167typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
168
169struct acpi_device_ops {
170 acpi_op_add add;
171 acpi_op_remove remove;
172 acpi_op_notify notify;
173};
174
175#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
176
177struct acpi_driver {
178 char name[80];
179 char class[80];
180 const struct acpi_device_id *ids; /* Supported Hardware IDs */
181 unsigned int flags;
182 struct acpi_device_ops ops;
183 struct device_driver drv;
184 struct module *owner;
185};
186
187/*
188 * ACPI Device
189 * -----------
190 */
191
192/* Status (_STA) */
193
194struct acpi_device_status {
195 u32 present:1;
196 u32 enabled:1;
197 u32 show_in_ui:1;
198 u32 functional:1;
199 u32 battery_present:1;
200 u32 reserved:27;
201};
202
203/* Flags */
204
205struct acpi_device_flags {
206 u32 dynamic_status:1;
207 u32 removable:1;
208 u32 ejectable:1;
209 u32 power_manageable:1;
210 u32 match_driver:1;
211 u32 initialized:1;
212 u32 visited:1;
213 u32 hotplug_notify:1;
214 u32 is_dock_station:1;
215 u32 of_compatible_ok:1;
216 u32 coherent_dma:1;
217 u32 cca_seen:1;
218 u32 enumeration_by_parent:1;
219 u32 reserved:19;
220};
221
222/* File System */
223
224struct acpi_device_dir {
225 struct proc_dir_entry *entry;
226};
227
228#define acpi_device_dir(d) ((d)->dir.entry)
229
230/* Plug and Play */
231
232typedef char acpi_bus_id[8];
233typedef unsigned long acpi_bus_address;
234typedef char acpi_device_name[40];
235typedef char acpi_device_class[20];
236
237struct acpi_hardware_id {
238 struct list_head list;
239 const char *id;
240};
241
242struct acpi_pnp_type {
243 u32 hardware_id:1;
244 u32 bus_address:1;
245 u32 platform_id:1;
246 u32 reserved:29;
247};
248
249struct acpi_device_pnp {
250 acpi_bus_id bus_id; /* Object name */
251 struct acpi_pnp_type type; /* ID type */
252 acpi_bus_address bus_address; /* _ADR */
253 char *unique_id; /* _UID */
254 struct list_head ids; /* _HID and _CIDs */
255 acpi_device_name device_name; /* Driver-determined */
256 acpi_device_class device_class; /* " */
257 union acpi_object *str_obj; /* unicode string for _STR method */
258};
259
260#define acpi_device_bid(d) ((d)->pnp.bus_id)
261#define acpi_device_adr(d) ((d)->pnp.bus_address)
262const char *acpi_device_hid(struct acpi_device *device);
263#define acpi_device_uid(d) ((d)->pnp.unique_id)
264#define acpi_device_name(d) ((d)->pnp.device_name)
265#define acpi_device_class(d) ((d)->pnp.device_class)
266
267/* Power Management */
268
269struct acpi_device_power_flags {
270 u32 explicit_get:1; /* _PSC present? */
271 u32 power_resources:1; /* Power resources */
272 u32 inrush_current:1; /* Serialize Dx->D0 */
273 u32 power_removed:1; /* Optimize Dx->D0 */
274 u32 ignore_parent:1; /* Power is independent of parent power state */
275 u32 dsw_present:1; /* _DSW present? */
276 u32 reserved:26;
277};
278
279struct acpi_device_power_state {
280 struct {
281 u8 valid:1;
282 u8 explicit_set:1; /* _PSx present? */
283 u8 reserved:6;
284 } flags;
285 int power; /* % Power (compared to D0) */
286 int latency; /* Dx->D0 time (microseconds) */
287 struct list_head resources; /* Power resources referenced */
288};
289
290struct acpi_device_power {
291 int state; /* Current state */
292 struct acpi_device_power_flags flags;
293 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
294};
295
296/* Performance Management */
297
298struct acpi_device_perf_flags {
299 u8 reserved:8;
300};
301
302struct acpi_device_perf_state {
303 struct {
304 u8 valid:1;
305 u8 reserved:7;
306 } flags;
307 u8 power; /* % Power (compared to P0) */
308 u8 performance; /* % Performance ( " ) */
309 int latency; /* Px->P0 time (microseconds) */
310};
311
312struct acpi_device_perf {
313 int state;
314 struct acpi_device_perf_flags flags;
315 int state_count;
316 struct acpi_device_perf_state *states;
317};
318
319/* Wakeup Management */
320struct acpi_device_wakeup_flags {
321 u8 valid:1; /* Can successfully enable wakeup? */
322 u8 notifier_present:1; /* Wake-up notify handler has been installed */
323};
324
325struct acpi_device_wakeup_context {
326 void (*func)(struct acpi_device_wakeup_context *context);
327 struct device *dev;
328};
329
330struct acpi_device_wakeup {
331 acpi_handle gpe_device;
332 u64 gpe_number;
333 u64 sleep_state;
334 struct list_head resources;
335 struct acpi_device_wakeup_flags flags;
336 struct acpi_device_wakeup_context context;
337 struct wakeup_source *ws;
338 int prepare_count;
339 int enable_count;
340};
341
342struct acpi_device_physical_node {
343 unsigned int node_id;
344 struct list_head node;
345 struct device *dev;
346 bool put_online:1;
347};
348
349/* ACPI Device Specific Data (_DSD) */
350struct acpi_device_data {
351 const union acpi_object *pointer;
352 const union acpi_object *properties;
353 const union acpi_object *of_compatible;
354 struct list_head subnodes;
355};
356
357struct acpi_gpio_mapping;
358
359/* Device */
360struct acpi_device {
361 int device_type;
362 acpi_handle handle; /* no handle for fixed hardware */
363 struct fwnode_handle fwnode;
364 struct acpi_device *parent;
365 struct list_head children;
366 struct list_head node;
367 struct list_head wakeup_list;
368 struct list_head del_list;
369 struct acpi_device_status status;
370 struct acpi_device_flags flags;
371 struct acpi_device_pnp pnp;
372 struct acpi_device_power power;
373 struct acpi_device_wakeup wakeup;
374 struct acpi_device_perf performance;
375 struct acpi_device_dir dir;
376 struct acpi_device_data data;
377 struct acpi_scan_handler *handler;
378 struct acpi_hotplug_context *hp;
379 struct acpi_driver *driver;
380 const struct acpi_gpio_mapping *driver_gpios;
381 void *driver_data;
382 struct device dev;
383 unsigned int physical_node_count;
384 unsigned int dep_unmet;
385 struct list_head physical_node_list;
386 struct mutex physical_node_lock;
387 void (*remove)(struct acpi_device *);
388};
389
390/* Non-device subnode */
391struct acpi_data_node {
392 const char *name;
393 acpi_handle handle;
394 struct fwnode_handle fwnode;
395 struct fwnode_handle *parent;
396 struct acpi_device_data data;
397 struct list_head sibling;
398 struct kobject kobj;
399 struct completion kobj_done;
400};
401
402extern const struct fwnode_operations acpi_device_fwnode_ops;
403extern const struct fwnode_operations acpi_data_fwnode_ops;
404extern const struct fwnode_operations acpi_static_fwnode_ops;
405
406bool is_acpi_device_node(const struct fwnode_handle *fwnode);
407bool is_acpi_data_node(const struct fwnode_handle *fwnode);
408
409static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
410{
411 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
412}
413
414#define to_acpi_device_node(__fwnode) \
415 ({ \
416 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
417 \
418 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
419 container_of(__to_acpi_device_node_fwnode, \
420 struct acpi_device, fwnode) : \
421 NULL; \
422 })
423
424#define to_acpi_data_node(__fwnode) \
425 ({ \
426 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
427 \
428 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
429 container_of(__to_acpi_data_node_fwnode, \
430 struct acpi_data_node, fwnode) : \
431 NULL; \
432 })
433
434static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
435{
436 return !IS_ERR_OR_NULL(fwnode) &&
437 fwnode->ops == &acpi_static_fwnode_ops;
438}
439
440static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
441 const char *name)
442{
443 return is_acpi_data_node(fwnode) ?
444 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
445}
446
447static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
448{
449 return &adev->fwnode;
450}
451
452static inline void *acpi_driver_data(struct acpi_device *d)
453{
454 return d->driver_data;
455}
456
457#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
458#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
459
460static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
461{
462 *((u32 *)&adev->status) = sta;
463}
464
465static inline void acpi_set_hp_context(struct acpi_device *adev,
466 struct acpi_hotplug_context *hp)
467{
468 hp->self = adev;
469 adev->hp = hp;
470}
471
472void acpi_initialize_hp_context(struct acpi_device *adev,
473 struct acpi_hotplug_context *hp,
474 int (*notify)(struct acpi_device *, u32),
475 void (*uevent)(struct acpi_device *, u32));
476
477/* acpi_device.dev.bus == &acpi_bus_type */
478extern struct bus_type acpi_bus_type;
479
480/*
481 * Events
482 * ------
483 */
484
485struct acpi_bus_event {
486 struct list_head node;
487 acpi_device_class device_class;
488 acpi_bus_id bus_id;
489 u32 type;
490 u32 data;
491};
492
493extern struct kobject *acpi_kobj;
494extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
495void acpi_bus_private_data_handler(acpi_handle, void *);
496int acpi_bus_get_private_data(acpi_handle, void **);
497int acpi_bus_attach_private_data(acpi_handle, void *);
498void acpi_bus_detach_private_data(acpi_handle);
499extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
500extern int register_acpi_notifier(struct notifier_block *);
501extern int unregister_acpi_notifier(struct notifier_block *);
502
503/*
504 * External Functions
505 */
506
507int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
508struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
509void acpi_bus_put_acpi_device(struct acpi_device *adev);
510acpi_status acpi_bus_get_status_handle(acpi_handle handle,
511 unsigned long long *sta);
512int acpi_bus_get_status(struct acpi_device *device);
513
514int acpi_bus_set_power(acpi_handle handle, int state);
515const char *acpi_power_state_string(int state);
516int acpi_device_get_power(struct acpi_device *device, int *state);
517int acpi_device_set_power(struct acpi_device *device, int state);
518int acpi_bus_init_power(struct acpi_device *device);
519int acpi_device_fix_up_power(struct acpi_device *device);
520int acpi_bus_update_power(acpi_handle handle, int *state_p);
521int acpi_device_update_power(struct acpi_device *device, int *state_p);
522bool acpi_bus_power_manageable(acpi_handle handle);
523
524#ifdef CONFIG_PM
525bool acpi_bus_can_wakeup(acpi_handle handle);
526#else
527static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
528#endif
529
530void acpi_scan_lock_acquire(void);
531void acpi_scan_lock_release(void);
532void acpi_lock_hp_context(void);
533void acpi_unlock_hp_context(void);
534int acpi_scan_add_handler(struct acpi_scan_handler *handler);
535int acpi_bus_register_driver(struct acpi_driver *driver);
536void acpi_bus_unregister_driver(struct acpi_driver *driver);
537int acpi_bus_scan(acpi_handle handle);
538void acpi_bus_trim(struct acpi_device *start);
539acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
540int acpi_match_device_ids(struct acpi_device *device,
541 const struct acpi_device_id *ids);
542void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
543 char *modalias, size_t len);
544int acpi_create_dir(struct acpi_device *);
545void acpi_remove_dir(struct acpi_device *);
546
547static inline bool acpi_device_enumerated(struct acpi_device *adev)
548{
549 return adev && adev->flags.initialized && adev->flags.visited;
550}
551
552/**
553 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
554 * @__acpi_driver: acpi_driver struct
555 *
556 * Helper macro for ACPI drivers which do not do anything special in module
557 * init/exit. This eliminates a lot of boilerplate. Each module may only
558 * use this macro once, and calling it replaces module_init() and module_exit()
559 */
560#define module_acpi_driver(__acpi_driver) \
561 module_driver(__acpi_driver, acpi_bus_register_driver, \
562 acpi_bus_unregister_driver)
563
564/*
565 * Bind physical devices with ACPI devices
566 */
567struct acpi_bus_type {
568 struct list_head list;
569 const char *name;
570 bool (*match)(struct device *dev);
571 struct acpi_device * (*find_companion)(struct device *);
572 void (*setup)(struct device *);
573 void (*cleanup)(struct device *);
574};
575int register_acpi_bus_type(struct acpi_bus_type *);
576int unregister_acpi_bus_type(struct acpi_bus_type *);
577int acpi_bind_one(struct device *dev, struct acpi_device *adev);
578int acpi_unbind_one(struct device *dev);
579
580struct acpi_pci_root {
581 struct acpi_device * device;
582 struct pci_bus *bus;
583 u16 segment;
584 struct resource secondary; /* downstream bus range */
585
586 u32 osc_support_set; /* _OSC state of support bits */
587 u32 osc_control_set; /* _OSC state of control bits */
588 phys_addr_t mcfg_addr;
589};
590
591/* helper */
592
593bool acpi_dma_supported(struct acpi_device *adev);
594enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
595int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
596 u64 *size);
597int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
598void acpi_dma_deconfigure(struct device *dev);
599
600struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
601 u64 address, bool check_children);
602int acpi_is_root_bridge(acpi_handle);
603struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
604
605int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
606int acpi_disable_wakeup_device_power(struct acpi_device *dev);
607
608#ifdef CONFIG_X86
609bool acpi_device_always_present(struct acpi_device *adev);
610#else
611static inline bool acpi_device_always_present(struct acpi_device *adev)
612{
613 return false;
614}
615#endif
616
617#ifdef CONFIG_PM
618void acpi_pm_wakeup_event(struct device *dev);
619acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
620 void (*func)(struct acpi_device_wakeup_context *context));
621acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
622bool acpi_pm_device_can_wakeup(struct device *dev);
623int acpi_pm_device_sleep_state(struct device *, int *, int);
624int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
625int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable);
626#else
627static inline void acpi_pm_wakeup_event(struct device *dev)
628{
629}
630static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
631 struct device *dev,
632 void (*func)(struct acpi_device_wakeup_context *context))
633{
634 return AE_SUPPORT;
635}
636static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
637{
638 return AE_SUPPORT;
639}
640static inline bool acpi_pm_device_can_wakeup(struct device *dev)
641{
642 return false;
643}
644static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
645{
646 if (p)
647 *p = ACPI_STATE_D0;
648
649 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
650 m : ACPI_STATE_D0;
651}
652static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
653{
654 return -ENODEV;
655}
656static inline int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable)
657{
658 return -ENODEV;
659}
660#endif
661
662#ifdef CONFIG_ACPI_SLEEP
663u32 acpi_target_system_state(void);
664#else
665static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
666#endif
667
668static inline bool acpi_device_power_manageable(struct acpi_device *adev)
669{
670 return adev->flags.power_manageable;
671}
672
673static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
674{
675 return adev->wakeup.flags.valid;
676}
677
678static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
679{
680 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
681 ((acpi_gbl_FADT.header.revision < 6) &&
682 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
683}
684
685#else /* CONFIG_ACPI */
686
687static inline int register_acpi_bus_type(void *bus) { return 0; }
688static inline int unregister_acpi_bus_type(void *bus) { return 0; }
689
690#endif /* CONFIG_ACPI */
691
692#endif /*__ACPI_BUS_H__*/