]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/acpi/acpi_bus.h
ACPI: maintain a single list of _HID and _CID IDs
[net-next-2.6.git] / include / acpi / acpi_bus.h
CommitLineData
1da177e4
LT
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
5b327265 29#include <linux/device.h>
1da177e4
LT
30
31#include <acpi/acpi.h>
32
1da177e4
LT
33/* TBD: Make dynamic */
34#define ACPI_MAX_HANDLES 10
35struct acpi_handle_list {
4be44fcd
LB
36 u32 count;
37 acpi_handle handles[ACPI_MAX_HANDLES];
1da177e4
LT
38};
39
1da177e4
LT
40/* acpi_utils.h */
41acpi_status
4be44fcd
LB
42acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer);
1da177e4 44acpi_status
4be44fcd
LB
45acpi_evaluate_integer(acpi_handle handle,
46 acpi_string pathname,
27663c58 47 struct acpi_object_list *arguments, unsigned long long *data);
1da177e4 48acpi_status
4be44fcd
LB
49acpi_evaluate_reference(acpi_handle handle,
50 acpi_string pathname,
51 struct acpi_object_list *arguments,
52 struct acpi_handle_list *list);
1da177e4 53
76f58584 54#ifdef CONFIG_ACPI
1da177e4
LT
55
56#include <linux/proc_fs.h>
57
58#define ACPI_BUS_FILE_ROOT "acpi"
4be44fcd 59extern struct proc_dir_entry *acpi_root_dir;
1da177e4
LT
60
61enum acpi_bus_removal_type {
4be44fcd 62 ACPI_BUS_REMOVAL_NORMAL = 0,
1da177e4
LT
63 ACPI_BUS_REMOVAL_EJECT,
64 ACPI_BUS_REMOVAL_SUPRISE,
65 ACPI_BUS_REMOVAL_TYPE_COUNT
66};
67
68enum acpi_bus_device_type {
4be44fcd 69 ACPI_BUS_TYPE_DEVICE = 0,
1da177e4
LT
70 ACPI_BUS_TYPE_POWER,
71 ACPI_BUS_TYPE_PROCESSOR,
72 ACPI_BUS_TYPE_THERMAL,
1da177e4
LT
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
1da177e4
LT
81/*
82 * ACPI Driver
83 * -----------
84 */
85
4be44fcd
LB
86typedef int (*acpi_op_add) (struct acpi_device * device);
87typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
4be44fcd 88typedef int (*acpi_op_start) (struct acpi_device * device);
fd350943
LB
89typedef int (*acpi_op_suspend) (struct acpi_device * device,
90 pm_message_t state);
5d9464a4 91typedef int (*acpi_op_resume) (struct acpi_device * device);
4be44fcd
LB
92typedef int (*acpi_op_bind) (struct acpi_device * device);
93typedef int (*acpi_op_unbind) (struct acpi_device * device);
46ec8598 94typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
1da177e4 95
3fb02738 96struct acpi_bus_ops {
4be44fcd 97 u32 acpi_op_add:1;
4be44fcd 98 u32 acpi_op_start:1;
3fb02738
RS
99};
100
1da177e4 101struct acpi_device_ops {
4be44fcd
LB
102 acpi_op_add add;
103 acpi_op_remove remove;
4be44fcd 104 acpi_op_start start;
4be44fcd
LB
105 acpi_op_suspend suspend;
106 acpi_op_resume resume;
4be44fcd
LB
107 acpi_op_bind bind;
108 acpi_op_unbind unbind;
46ec8598 109 acpi_op_notify notify;
1da177e4
LT
110};
111
6d278131
BH
112#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
113
1da177e4 114struct acpi_driver {
4be44fcd
LB
115 char name[80];
116 char class[80];
8c8eb78f 117 const struct acpi_device_id *ids; /* Supported Hardware IDs */
6d278131 118 unsigned int flags;
4be44fcd 119 struct acpi_device_ops ops;
d43ec68e 120 struct device_driver drv;
1890a97a 121 struct module *owner;
1da177e4
LT
122};
123
124/*
125 * ACPI Device
126 * -----------
127 */
128
129/* Status (_STA) */
130
131struct acpi_device_status {
4be44fcd
LB
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;
1da177e4
LT
138};
139
1da177e4
LT
140/* Flags */
141
142struct acpi_device_flags {
4be44fcd
LB
143 u32 dynamic_status:1;
144 u32 hardware_id:1;
145 u32 compatible_ids:1;
146 u32 bus_address:1;
147 u32 unique_id:1;
148 u32 removable:1;
149 u32 ejectable:1;
150 u32 lockable:1;
151 u32 suprise_removal_ok:1;
152 u32 power_manageable:1;
153 u32 performance_manageable:1;
154 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
ec68373c
LB
155 u32 force_power_state:1;
156 u32 reserved:19;
1da177e4
LT
157};
158
1da177e4
LT
159/* File System */
160
161struct acpi_device_dir {
4be44fcd 162 struct proc_dir_entry *entry;
1da177e4
LT
163};
164
165#define acpi_device_dir(d) ((d)->dir.entry)
166
1da177e4
LT
167/* Plug and Play */
168
24c5c4c2 169typedef char acpi_bus_id[8];
4be44fcd 170typedef unsigned long acpi_bus_address;
4be44fcd
LB
171typedef char acpi_device_name[40];
172typedef char acpi_device_class[20];
1da177e4 173
7f47fa6c
BH
174struct acpi_hardware_id {
175 struct list_head list;
176 char *id;
177};
178
1da177e4 179struct acpi_device_pnp {
4be44fcd
LB
180 acpi_bus_id bus_id; /* Object name */
181 acpi_bus_address bus_address; /* _ADR */
15b8dd53 182 char *unique_id; /* _UID */
7f47fa6c 183 struct list_head ids; /* _HID and _CIDs */
4be44fcd
LB
184 acpi_device_name device_name; /* Driver-determined */
185 acpi_device_class device_class; /* " */
1da177e4
LT
186};
187
188#define acpi_device_bid(d) ((d)->pnp.bus_id)
189#define acpi_device_adr(d) ((d)->pnp.bus_address)
7f47fa6c 190char *acpi_device_hid(struct acpi_device *device);
1da177e4
LT
191#define acpi_device_uid(d) ((d)->pnp.unique_id)
192#define acpi_device_name(d) ((d)->pnp.device_name)
193#define acpi_device_class(d) ((d)->pnp.device_class)
194
1da177e4
LT
195/* Power Management */
196
197struct acpi_device_power_flags {
4be44fcd
LB
198 u32 explicit_get:1; /* _PSC present? */
199 u32 power_resources:1; /* Power resources */
200 u32 inrush_current:1; /* Serialize Dx->D0 */
201 u32 power_removed:1; /* Optimize Dx->D0 */
202 u32 reserved:28;
1da177e4
LT
203};
204
205struct acpi_device_power_state {
206 struct {
4be44fcd
LB
207 u8 valid:1;
208 u8 explicit_set:1; /* _PSx present? */
209 u8 reserved:6;
210 } flags;
211 int power; /* % Power (compared to D0) */
212 int latency; /* Dx->D0 time (microseconds) */
213 struct acpi_handle_list resources; /* Power resources referenced */
1da177e4
LT
214};
215
216struct acpi_device_power {
4be44fcd 217 int state; /* Current state */
1da177e4 218 struct acpi_device_power_flags flags;
4be44fcd 219 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
1da177e4
LT
220};
221
1da177e4
LT
222/* Performance Management */
223
224struct acpi_device_perf_flags {
4be44fcd 225 u8 reserved:8;
1da177e4
LT
226};
227
228struct acpi_device_perf_state {
229 struct {
4be44fcd
LB
230 u8 valid:1;
231 u8 reserved:7;
232 } flags;
233 u8 power; /* % Power (compared to P0) */
234 u8 performance; /* % Performance ( " ) */
235 int latency; /* Px->P0 time (microseconds) */
1da177e4
LT
236};
237
238struct acpi_device_perf {
4be44fcd 239 int state;
1da177e4 240 struct acpi_device_perf_flags flags;
4be44fcd 241 int state_count;
1da177e4
LT
242 struct acpi_device_perf_state *states;
243};
244
245/* Wakeup Management */
246struct acpi_device_wakeup_flags {
4be44fcd
LB
247 u8 valid:1; /* Can successfully enable wakeup? */
248 u8 run_wake:1; /* Run-Wake GPE devices */
1da177e4
LT
249};
250
251struct acpi_device_wakeup_state {
4be44fcd 252 u8 enabled:1;
1da177e4
LT
253};
254
255struct acpi_device_wakeup {
4be44fcd 256 acpi_handle gpe_device;
53b3531b 257 acpi_integer gpe_number;
4be44fcd
LB
258 acpi_integer sleep_state;
259 struct acpi_handle_list resources;
260 struct acpi_device_wakeup_state state;
261 struct acpi_device_wakeup_flags flags;
9b83ccd2 262 int prepare_count;
1da177e4
LT
263};
264
265/* Device */
266
267struct acpi_device {
caaa6efb
BH
268 int device_type;
269 acpi_handle handle; /* no handle for fixed hardware */
4be44fcd
LB
270 struct acpi_device *parent;
271 struct list_head children;
272 struct list_head node;
273 struct list_head wakeup_list;
1da177e4
LT
274 struct acpi_device_status status;
275 struct acpi_device_flags flags;
4be44fcd 276 struct acpi_device_pnp pnp;
1da177e4
LT
277 struct acpi_device_power power;
278 struct acpi_device_wakeup wakeup;
4be44fcd
LB
279 struct acpi_device_perf performance;
280 struct acpi_device_dir dir;
281 struct acpi_device_ops ops;
282 struct acpi_driver *driver;
283 void *driver_data;
5b327265 284 struct device dev;
c4168bff 285 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
fd350943 286 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
1da177e4
LT
287};
288
db89b4f0
PM
289static inline void *acpi_driver_data(struct acpi_device *d)
290{
291 return d->driver_data;
292}
293
d43ec68e
PM
294#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
295#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
1da177e4 296
55955aad
DB
297/* acpi_device.dev.bus == &acpi_bus_type */
298extern struct bus_type acpi_bus_type;
299
1da177e4
LT
300/*
301 * Events
302 * ------
303 */
304
305struct acpi_bus_event {
4be44fcd
LB
306 struct list_head node;
307 acpi_device_class device_class;
308 acpi_bus_id bus_id;
309 u32 type;
310 u32 data;
1da177e4
LT
311};
312
99e0d2fc 313extern struct kobject *acpi_kobj;
962ce8ca 314extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
8e4319c4 315void acpi_bus_private_data_handler(acpi_handle, void *);
20733939 316int acpi_bus_get_private_data(acpi_handle, void **);
9ee85241
ZR
317extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
318extern int register_acpi_notifier(struct notifier_block *);
319extern int unregister_acpi_notifier(struct notifier_block *);
6bd00a61
SL
320
321extern int register_acpi_bus_notifier(struct notifier_block *nb);
322extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
1da177e4
LT
323/*
324 * External Functions
325 */
326
327int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
8e4319c4 328void acpi_bus_data_handler(acpi_handle handle, void *context);
402ac536
BH
329acpi_status acpi_bus_get_status_handle(acpi_handle handle,
330 unsigned long long *sta);
4be44fcd
LB
331int acpi_bus_get_status(struct acpi_device *device);
332int acpi_bus_get_power(acpi_handle handle, int *state);
333int acpi_bus_set_power(acpi_handle handle, int state);
3737b2b1 334bool acpi_bus_power_manageable(acpi_handle handle);
eb9d0fe4 335bool acpi_bus_can_wakeup(acpi_handle handle);
14e04fb3
LB
336#ifdef CONFIG_ACPI_PROC_EVENT
337int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
8db85d4c 338int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
4be44fcd 339int acpi_bus_receive_event(struct acpi_bus_event *event);
14e04fb3
LB
340#else
341static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
342 { return 0; }
343#endif
4be44fcd 344int acpi_bus_register_driver(struct acpi_driver *driver);
06ea8e08 345void acpi_bus_unregister_driver(struct acpi_driver *driver);
4be44fcd
LB
346int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
347 acpi_handle handle, int type);
ceaba663 348int acpi_bus_trim(struct acpi_device *start, int rmdevice);
4be44fcd 349int acpi_bus_start(struct acpi_device *device);
fd350943 350acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
8c8eb78f
TR
351int acpi_match_device_ids(struct acpi_device *device,
352 const struct acpi_device_id *ids);
1da177e4
LT
353int acpi_create_dir(struct acpi_device *);
354void acpi_remove_dir(struct acpi_device *);
355
4e10d12a
DSL
356/*
357 * Bind physical devices with ACPI devices
358 */
4e10d12a 359struct acpi_bus_type {
4be44fcd
LB
360 struct list_head list;
361 struct bus_type *bus;
362 /* For general devices under the bus */
363 int (*find_device) (struct device *, acpi_handle *);
4e10d12a 364 /* For bridges, such as PCI root bridge, IDE controller */
4be44fcd 365 int (*find_bridge) (struct device *, acpi_handle *);
4e10d12a
DSL
366};
367int register_acpi_bus_type(struct acpi_bus_type *);
368int unregister_acpi_bus_type(struct acpi_bus_type *);
369struct device *acpi_get_physical_device(acpi_handle);
22c13f9d 370
76d56de5
AC
371struct acpi_pci_root {
372 struct list_head node;
373 struct acpi_device * device;
374 struct acpi_pci_id id;
375 struct pci_bus *bus;
376 u16 segment;
377 u8 bus_nr;
378
379 u32 osc_support_set; /* _OSC state of support bits */
380 u32 osc_control_set; /* _OSC state of control bits */
381 u32 osc_control_qry; /* the latest _OSC query result */
382
383 u32 osc_queried:1; /* has _OSC control been queried? */
384};
385
4e10d12a
DSL
386/* helper */
387acpi_handle acpi_get_child(acpi_handle, acpi_integer);
27558203 388int acpi_is_root_bridge(acpi_handle);
4e10d12a 389acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
76d56de5 390struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
465ae641 391#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
4e10d12a 392
296699de 393#ifdef CONFIG_PM_SLEEP
06166780 394int acpi_pm_device_sleep_state(struct device *, int *);
eb9d0fe4 395int acpi_pm_device_sleep_wake(struct device *, bool);
296699de 396#else /* !CONFIG_PM_SLEEP */
06166780 397static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
296699de
RW
398{
399 if (p)
400 *p = ACPI_STATE_D0;
401 return ACPI_STATE_D3;
402}
f7a1b860
DH
403static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
404{
405 return -ENODEV;
406}
296699de 407#endif /* !CONFIG_PM_SLEEP */
fd4aff1a 408
fd350943 409#endif /* CONFIG_ACPI */
1da177e4
LT
410
411#endif /*__ACPI_BUS_H__*/