blob: c34b11022908a01c521367ddf85249fcacb98ffe [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Patrick Mochel5b327262006-05-10 10:33:00 -040029#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#include <acpi/acpi.h>
32
33#define PREFIX "ACPI: "
34
35/* TBD: Make dynamic */
36#define ACPI_MAX_HANDLES 10
37struct acpi_handle_list {
Len Brown4be44fc2005-08-05 00:44:28 -040038 u32 count;
39 acpi_handle handles[ACPI_MAX_HANDLES];
Linus Torvalds1da177e2005-04-16 15:20:36 -070040};
41
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* acpi_utils.h */
43acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040044acpi_extract_package(union acpi_object *package,
45 struct acpi_buffer *format, struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040047acpi_evaluate_integer(acpi_handle handle,
48 acpi_string pathname,
Matthew Wilcox27663c52008-10-10 02:22:59 -040049 struct acpi_object_list *arguments, unsigned long long *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040051acpi_evaluate_reference(acpi_handle handle,
52 acpi_string pathname,
53 struct acpi_object_list *arguments,
54 struct acpi_handle_list *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Len Brown76f58582005-08-24 12:10:49 -040056#ifdef CONFIG_ACPI
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58#include <linux/proc_fs.h>
59
60#define ACPI_BUS_FILE_ROOT "acpi"
Len Brown4be44fc2005-08-05 00:44:28 -040061extern struct proc_dir_entry *acpi_root_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63enum acpi_bus_removal_type {
Len Brown4be44fc2005-08-05 00:44:28 -040064 ACPI_BUS_REMOVAL_NORMAL = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 ACPI_BUS_REMOVAL_EJECT,
66 ACPI_BUS_REMOVAL_SUPRISE,
67 ACPI_BUS_REMOVAL_TYPE_COUNT
68};
69
70enum acpi_bus_device_type {
Len Brown4be44fc2005-08-05 00:44:28 -040071 ACPI_BUS_TYPE_DEVICE = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 ACPI_BUS_TYPE_POWER,
73 ACPI_BUS_TYPE_PROCESSOR,
74 ACPI_BUS_TYPE_THERMAL,
75 ACPI_BUS_TYPE_SYSTEM,
76 ACPI_BUS_TYPE_POWER_BUTTON,
77 ACPI_BUS_TYPE_SLEEP_BUTTON,
78 ACPI_BUS_DEVICE_TYPE_COUNT
79};
80
81struct acpi_driver;
82struct acpi_device;
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/*
85 * ACPI Driver
86 * -----------
87 */
88
Len Brown4be44fc2005-08-05 00:44:28 -040089typedef int (*acpi_op_add) (struct acpi_device * device);
90typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
Len Brown4be44fc2005-08-05 00:44:28 -040091typedef int (*acpi_op_start) (struct acpi_device * device);
92typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
Len Brownfd350942007-05-09 23:34:35 -040093typedef int (*acpi_op_suspend) (struct acpi_device * device,
94 pm_message_t state);
Patrick Mochel5d9464a2006-12-07 20:56:27 +080095typedef int (*acpi_op_resume) (struct acpi_device * device);
Len Brown4be44fc2005-08-05 00:44:28 -040096typedef int (*acpi_op_bind) (struct acpi_device * device);
97typedef int (*acpi_op_unbind) (struct acpi_device * device);
Bjorn Helgaas46ec8592009-03-30 17:48:13 +000098typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Rajesh Shah3fb02732005-04-28 00:25:52 -0700100struct acpi_bus_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400101 u32 acpi_op_add:1;
Len Brown4be44fc2005-08-05 00:44:28 -0400102 u32 acpi_op_start:1;
Rajesh Shah3fb02732005-04-28 00:25:52 -0700103};
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105struct acpi_device_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400106 acpi_op_add add;
107 acpi_op_remove remove;
Len Brown4be44fc2005-08-05 00:44:28 -0400108 acpi_op_start start;
109 acpi_op_stop stop;
110 acpi_op_suspend suspend;
111 acpi_op_resume resume;
Len Brown4be44fc2005-08-05 00:44:28 -0400112 acpi_op_bind bind;
113 acpi_op_unbind unbind;
Bjorn Helgaas46ec8592009-03-30 17:48:13 +0000114 acpi_op_notify notify;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115};
116
117struct acpi_driver {
Len Brown4be44fc2005-08-05 00:44:28 -0400118 char name[80];
119 char class[80];
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200120 const struct acpi_device_id *ids; /* Supported Hardware IDs */
Len Brown4be44fc2005-08-05 00:44:28 -0400121 struct acpi_device_ops ops;
Patrick Mocheld43ec682006-12-07 20:56:23 +0800122 struct device_driver drv;
Patrick Mochel1890a972006-12-07 20:56:31 +0800123 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
126/*
127 * ACPI Device
128 * -----------
129 */
130
131/* Status (_STA) */
132
133struct acpi_device_status {
Len Brown4be44fc2005-08-05 00:44:28 -0400134 u32 present:1;
135 u32 enabled:1;
136 u32 show_in_ui:1;
137 u32 functional:1;
138 u32 battery_present:1;
139 u32 reserved:27;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
141
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142/* Flags */
143
144struct acpi_device_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400145 u32 dynamic_status:1;
146 u32 hardware_id:1;
147 u32 compatible_ids:1;
148 u32 bus_address:1;
149 u32 unique_id:1;
150 u32 removable:1;
151 u32 ejectable:1;
152 u32 lockable:1;
153 u32 suprise_removal_ok:1;
154 u32 power_manageable:1;
155 u32 performance_manageable:1;
156 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
Len Brownec683732008-01-23 22:41:20 -0500157 u32 force_power_state:1;
158 u32 reserved:19;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159};
160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161/* File System */
162
163struct acpi_device_dir {
Len Brown4be44fc2005-08-05 00:44:28 -0400164 struct proc_dir_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165};
166
167#define acpi_device_dir(d) ((d)->dir.entry)
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169/* Plug and Play */
170
Len Brown4be44fc2005-08-05 00:44:28 -0400171typedef char acpi_bus_id[5];
172typedef unsigned long acpi_bus_address;
Zhang Ruibb095852007-01-04 15:03:18 +0800173typedef char acpi_hardware_id[15];
Len Brown4be44fc2005-08-05 00:44:28 -0400174typedef char acpi_unique_id[9];
175typedef char acpi_device_name[40];
176typedef char acpi_device_class[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178struct acpi_device_pnp {
Len Brown4be44fc2005-08-05 00:44:28 -0400179 acpi_bus_id bus_id; /* Object name */
180 acpi_bus_address bus_address; /* _ADR */
181 acpi_hardware_id hardware_id; /* _HID */
182 struct acpi_compatible_id_list *cid_list; /* _CIDs */
183 acpi_unique_id unique_id; /* _UID */
184 acpi_device_name device_name; /* Driver-determined */
185 acpi_device_class device_class; /* " */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186};
187
188#define acpi_device_bid(d) ((d)->pnp.bus_id)
189#define acpi_device_adr(d) ((d)->pnp.bus_address)
190#define acpi_device_hid(d) ((d)->pnp.hardware_id)
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195/* Power Management */
196
197struct acpi_device_power_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400198 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203};
204
205struct acpi_device_power_state {
206 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400207 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214};
215
216struct acpi_device_power {
Len Brown4be44fc2005-08-05 00:44:28 -0400217 int state; /* Current state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 struct acpi_device_power_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400219 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220};
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/* Performance Management */
223
224struct acpi_device_perf_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400225 u8 reserved:8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226};
227
228struct acpi_device_perf_state {
229 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400230 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) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236};
237
238struct acpi_device_perf {
Len Brown4be44fc2005-08-05 00:44:28 -0400239 int state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 struct acpi_device_perf_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400241 int state_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 struct acpi_device_perf_state *states;
243};
244
245/* Wakeup Management */
246struct acpi_device_wakeup_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400247 u8 valid:1; /* Can successfully enable wakeup? */
Rafael J. Wysocki0af4b8c2008-07-07 03:34:11 +0200248 u8 prepared:1; /* Has the wake-up capability been enabled? */
Len Brown4be44fc2005-08-05 00:44:28 -0400249 u8 run_wake:1; /* Run-Wake GPE devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250};
251
252struct acpi_device_wakeup_state {
Len Brown4be44fc2005-08-05 00:44:28 -0400253 u8 enabled:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254};
255
256struct acpi_device_wakeup {
Len Brown4be44fc2005-08-05 00:44:28 -0400257 acpi_handle gpe_device;
Alexey Dobriyan53b35312006-03-24 03:16:13 -0800258 acpi_integer gpe_number;
Len Brown4be44fc2005-08-05 00:44:28 -0400259 acpi_integer sleep_state;
260 struct acpi_handle_list resources;
261 struct acpi_device_wakeup_state state;
262 struct acpi_device_wakeup_flags flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263};
264
265/* Device */
266
267struct acpi_device {
Len Brown4be44fc2005-08-05 00:44:28 -0400268 acpi_handle handle;
269 struct acpi_device *parent;
270 struct list_head children;
271 struct list_head node;
272 struct list_head wakeup_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 struct acpi_device_status status;
274 struct acpi_device_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400275 struct acpi_device_pnp pnp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 struct acpi_device_power power;
277 struct acpi_device_wakeup wakeup;
Len Brown4be44fc2005-08-05 00:44:28 -0400278 struct acpi_device_perf performance;
279 struct acpi_device_dir dir;
280 struct acpi_device_ops ops;
281 struct acpi_driver *driver;
282 void *driver_data;
Patrick Mochel5b327262006-05-10 10:33:00 -0400283 struct device dev;
Li Shaohuac4168bf2006-12-07 20:56:41 +0800284 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
Len Brownfd350942007-05-09 23:34:35 -0400285 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286};
287
Pavel Machekdb89b4f2008-09-22 14:37:34 -0700288static inline void *acpi_driver_data(struct acpi_device *d)
289{
290 return d->driver_data;
291}
292
Patrick Mocheld43ec682006-12-07 20:56:23 +0800293#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
294#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
David Brownell55955aa2007-05-08 00:28:35 -0700296/* acpi_device.dev.bus == &acpi_bus_type */
297extern struct bus_type acpi_bus_type;
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299/*
300 * Events
301 * ------
302 */
303
304struct acpi_bus_event {
Len Brown4be44fc2005-08-05 00:44:28 -0400305 struct list_head node;
306 acpi_device_class device_class;
307 acpi_bus_id bus_id;
308 u32 type;
309 u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310};
311
Greg Kroah-Hartman99e0d2f2007-11-02 16:19:59 -0700312extern struct kobject *acpi_kobj;
Zhang Rui962ce8c2007-08-23 01:24:31 +0800313extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
Zhang Rui20733932008-01-17 15:51:21 +0800314void acpi_bus_private_data_handler(acpi_handle, u32, void *);
315int acpi_bus_get_private_data(acpi_handle, void **);
Zhang Rui9ee85242008-01-25 14:48:06 +0800316extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
317extern int register_acpi_notifier(struct notifier_block *);
318extern int unregister_acpi_notifier(struct notifier_block *);
Shaohua Li6bd00a62008-08-28 10:04:29 +0800319
320extern int register_acpi_bus_notifier(struct notifier_block *nb);
321extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322/*
323 * External Functions
324 */
325
326int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
327void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
Len Brown4be44fc2005-08-05 00:44:28 -0400328int acpi_bus_get_status(struct acpi_device *device);
329int acpi_bus_get_power(acpi_handle handle, int *state);
330int acpi_bus_set_power(acpi_handle handle, int state);
Rafael J. Wysocki3737b2b2008-07-07 03:30:55 +0200331bool acpi_bus_power_manageable(acpi_handle handle);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200332bool acpi_bus_can_wakeup(acpi_handle handle);
Len Brown14e04fb2007-08-23 15:20:26 -0400333#ifdef CONFIG_ACPI_PROC_EVENT
334int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
Alexey Starikovskiy8db85d42007-09-26 19:43:16 +0400335int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
Len Brown4be44fc2005-08-05 00:44:28 -0400336int acpi_bus_receive_event(struct acpi_bus_event *event);
Len Brown14e04fb2007-08-23 15:20:26 -0400337#else
338static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
339 { return 0; }
340#endif
Len Brown4be44fc2005-08-05 00:44:28 -0400341int acpi_bus_register_driver(struct acpi_driver *driver);
Bjorn Helgaas06ea8e02006-04-27 05:25:00 -0400342void acpi_bus_unregister_driver(struct acpi_driver *driver);
Len Brown4be44fc2005-08-05 00:44:28 -0400343int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
344 acpi_handle handle, int type);
Kristen Accardiceaba662006-02-23 17:56:01 -0800345int acpi_bus_trim(struct acpi_device *start, int rmdevice);
Len Brown4be44fc2005-08-05 00:44:28 -0400346int acpi_bus_start(struct acpi_device *device);
Len Brownfd350942007-05-09 23:34:35 -0400347acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200348int acpi_match_device_ids(struct acpi_device *device,
349 const struct acpi_device_id *ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350int acpi_create_dir(struct acpi_device *);
351void acpi_remove_dir(struct acpi_device *);
352
David Shaohua Li4e10d122005-03-18 18:45:35 -0500353/*
354 * Bind physical devices with ACPI devices
355 */
356#include <linux/device.h>
357struct acpi_bus_type {
Len Brown4be44fc2005-08-05 00:44:28 -0400358 struct list_head list;
359 struct bus_type *bus;
360 /* For general devices under the bus */
361 int (*find_device) (struct device *, acpi_handle *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500362 /* For bridges, such as PCI root bridge, IDE controller */
Len Brown4be44fc2005-08-05 00:44:28 -0400363 int (*find_bridge) (struct device *, acpi_handle *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500364};
365int register_acpi_bus_type(struct acpi_bus_type *);
366int unregister_acpi_bus_type(struct acpi_bus_type *);
367struct device *acpi_get_physical_device(acpi_handle);
Thomas Renninger22c13f92008-08-01 17:37:54 +0200368struct device *acpi_get_physical_pci_device(acpi_handle);
369
David Shaohua Li4e10d122005-03-18 18:45:35 -0500370/* helper */
371acpi_handle acpi_get_child(acpi_handle, acpi_integer);
372acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
Benjamin Herrenschmidt465ae642006-11-11 17:18:42 +1100373#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
David Shaohua Li4e10d122005-03-18 18:45:35 -0500374
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200375#ifdef CONFIG_PM_SLEEP
David Brownell06166782008-06-05 01:15:40 +0200376int acpi_pm_device_sleep_state(struct device *, int *);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200377int acpi_pm_device_sleep_wake(struct device *, bool);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200378#else /* !CONFIG_PM_SLEEP */
David Brownell06166782008-06-05 01:15:40 +0200379static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200380{
381 if (p)
382 *p = ACPI_STATE_D0;
383 return ACPI_STATE_D3;
384}
David Howellsf7a1b862008-07-08 15:00:54 +0100385static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
386{
387 return -ENODEV;
388}
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200389#endif /* !CONFIG_PM_SLEEP */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200390
Len Brownfd350942007-05-09 23:34:35 -0400391#endif /* CONFIG_ACPI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393#endif /*__ACPI_BUS_H__*/