blob: 504af20b10c10d9c5ee6da12e9075de548701344 [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,
49 struct acpi_object_list *arguments, unsigned 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);
91typedef int (*acpi_op_lock) (struct acpi_device * device, int type);
92typedef int (*acpi_op_start) (struct acpi_device * device);
93typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
Len Brownfd350942007-05-09 23:34:35 -040094typedef int (*acpi_op_suspend) (struct acpi_device * device,
95 pm_message_t state);
Patrick Mochel5d9464a2006-12-07 20:56:27 +080096typedef int (*acpi_op_resume) (struct acpi_device * device);
Len Brown4be44fc2005-08-05 00:44:28 -040097typedef int (*acpi_op_scan) (struct acpi_device * device);
98typedef int (*acpi_op_bind) (struct acpi_device * device);
99typedef int (*acpi_op_unbind) (struct acpi_device * device);
Patrick Mochel5d9464a2006-12-07 20:56:27 +0800100typedef int (*acpi_op_shutdown) (struct acpi_device * device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Rajesh Shah3fb02732005-04-28 00:25:52 -0700102struct acpi_bus_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400103 u32 acpi_op_add:1;
104 u32 acpi_op_remove:1;
105 u32 acpi_op_lock:1;
106 u32 acpi_op_start:1;
107 u32 acpi_op_stop:1;
108 u32 acpi_op_suspend:1;
109 u32 acpi_op_resume:1;
110 u32 acpi_op_scan:1;
111 u32 acpi_op_bind:1;
112 u32 acpi_op_unbind:1;
Patrick Mochel5d9464a2006-12-07 20:56:27 +0800113 u32 acpi_op_shutdown:1;
Len Brown4be44fc2005-08-05 00:44:28 -0400114 u32 reserved:21;
Rajesh Shah3fb02732005-04-28 00:25:52 -0700115};
116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117struct acpi_device_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400118 acpi_op_add add;
119 acpi_op_remove remove;
120 acpi_op_lock lock;
121 acpi_op_start start;
122 acpi_op_stop stop;
123 acpi_op_suspend suspend;
124 acpi_op_resume resume;
125 acpi_op_scan scan;
126 acpi_op_bind bind;
127 acpi_op_unbind unbind;
Patrick Mochel5d9464a2006-12-07 20:56:27 +0800128 acpi_op_shutdown shutdown;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129};
130
131struct acpi_driver {
Len Brown4be44fc2005-08-05 00:44:28 -0400132 char name[80];
133 char class[80];
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200134 const struct acpi_device_id *ids; /* Supported Hardware IDs */
Len Brown4be44fc2005-08-05 00:44:28 -0400135 struct acpi_device_ops ops;
Patrick Mocheld43ec682006-12-07 20:56:23 +0800136 struct device_driver drv;
Patrick Mochel1890a972006-12-07 20:56:31 +0800137 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138};
139
140/*
141 * ACPI Device
142 * -----------
143 */
144
145/* Status (_STA) */
146
147struct acpi_device_status {
Len Brown4be44fc2005-08-05 00:44:28 -0400148 u32 present:1;
149 u32 enabled:1;
150 u32 show_in_ui:1;
151 u32 functional:1;
152 u32 battery_present:1;
153 u32 reserved:27;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154};
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156/* Flags */
157
158struct acpi_device_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400159 u32 dynamic_status:1;
160 u32 hardware_id:1;
161 u32 compatible_ids:1;
162 u32 bus_address:1;
163 u32 unique_id:1;
164 u32 removable:1;
165 u32 ejectable:1;
166 u32 lockable:1;
167 u32 suprise_removal_ok:1;
168 u32 power_manageable:1;
169 u32 performance_manageable:1;
170 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
Len Brownec683732008-01-23 22:41:20 -0500171 u32 force_power_state:1;
172 u32 reserved:19;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173};
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/* File System */
176
177struct acpi_device_dir {
Len Brown4be44fc2005-08-05 00:44:28 -0400178 struct proc_dir_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179};
180
181#define acpi_device_dir(d) ((d)->dir.entry)
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183/* Plug and Play */
184
Len Brown4be44fc2005-08-05 00:44:28 -0400185typedef char acpi_bus_id[5];
186typedef unsigned long acpi_bus_address;
Zhang Ruibb095852007-01-04 15:03:18 +0800187typedef char acpi_hardware_id[15];
Len Brown4be44fc2005-08-05 00:44:28 -0400188typedef char acpi_unique_id[9];
189typedef char acpi_device_name[40];
190typedef char acpi_device_class[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192struct acpi_device_pnp {
Len Brown4be44fc2005-08-05 00:44:28 -0400193 acpi_bus_id bus_id; /* Object name */
194 acpi_bus_address bus_address; /* _ADR */
195 acpi_hardware_id hardware_id; /* _HID */
196 struct acpi_compatible_id_list *cid_list; /* _CIDs */
197 acpi_unique_id unique_id; /* _UID */
198 acpi_device_name device_name; /* Driver-determined */
199 acpi_device_class device_class; /* " */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200};
201
202#define acpi_device_bid(d) ((d)->pnp.bus_id)
203#define acpi_device_adr(d) ((d)->pnp.bus_address)
204#define acpi_device_hid(d) ((d)->pnp.hardware_id)
205#define acpi_device_uid(d) ((d)->pnp.unique_id)
206#define acpi_device_name(d) ((d)->pnp.device_name)
207#define acpi_device_class(d) ((d)->pnp.device_class)
208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209/* Power Management */
210
211struct acpi_device_power_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400212 u32 explicit_get:1; /* _PSC present? */
213 u32 power_resources:1; /* Power resources */
214 u32 inrush_current:1; /* Serialize Dx->D0 */
215 u32 power_removed:1; /* Optimize Dx->D0 */
216 u32 reserved:28;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217};
218
219struct acpi_device_power_state {
220 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400221 u8 valid:1;
222 u8 explicit_set:1; /* _PSx present? */
223 u8 reserved:6;
224 } flags;
225 int power; /* % Power (compared to D0) */
226 int latency; /* Dx->D0 time (microseconds) */
227 struct acpi_handle_list resources; /* Power resources referenced */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228};
229
230struct acpi_device_power {
Len Brown4be44fc2005-08-05 00:44:28 -0400231 int state; /* Current state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 struct acpi_device_power_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400233 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234};
235
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236/* Performance Management */
237
238struct acpi_device_perf_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400239 u8 reserved:8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240};
241
242struct acpi_device_perf_state {
243 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400244 u8 valid:1;
245 u8 reserved:7;
246 } flags;
247 u8 power; /* % Power (compared to P0) */
248 u8 performance; /* % Performance ( " ) */
249 int latency; /* Px->P0 time (microseconds) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250};
251
252struct acpi_device_perf {
Len Brown4be44fc2005-08-05 00:44:28 -0400253 int state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 struct acpi_device_perf_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400255 int state_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 struct acpi_device_perf_state *states;
257};
258
259/* Wakeup Management */
260struct acpi_device_wakeup_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400261 u8 valid:1; /* Can successfully enable wakeup? */
262 u8 run_wake:1; /* Run-Wake GPE devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263};
264
265struct acpi_device_wakeup_state {
Len Brown4be44fc2005-08-05 00:44:28 -0400266 u8 enabled:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267};
268
269struct acpi_device_wakeup {
Len Brown4be44fc2005-08-05 00:44:28 -0400270 acpi_handle gpe_device;
Alexey Dobriyan53b35312006-03-24 03:16:13 -0800271 acpi_integer gpe_number;
Len Brown4be44fc2005-08-05 00:44:28 -0400272 acpi_integer sleep_state;
273 struct acpi_handle_list resources;
274 struct acpi_device_wakeup_state state;
275 struct acpi_device_wakeup_flags flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276};
277
278/* Device */
279
280struct acpi_device {
Len Brown4be44fc2005-08-05 00:44:28 -0400281 acpi_handle handle;
282 struct acpi_device *parent;
283 struct list_head children;
284 struct list_head node;
285 struct list_head wakeup_list;
286 struct list_head g_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 struct acpi_device_status status;
288 struct acpi_device_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400289 struct acpi_device_pnp pnp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 struct acpi_device_power power;
291 struct acpi_device_wakeup wakeup;
Len Brown4be44fc2005-08-05 00:44:28 -0400292 struct acpi_device_perf performance;
293 struct acpi_device_dir dir;
294 struct acpi_device_ops ops;
295 struct acpi_driver *driver;
296 void *driver_data;
Patrick Mochel5b327262006-05-10 10:33:00 -0400297 struct device dev;
Li Shaohuac4168bf2006-12-07 20:56:41 +0800298 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
Len Brownfd350942007-05-09 23:34:35 -0400299 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300};
301
302#define acpi_driver_data(d) ((d)->driver_data)
Patrick Mocheld43ec682006-12-07 20:56:23 +0800303#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
304#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
David Brownell55955aa2007-05-08 00:28:35 -0700306/* acpi_device.dev.bus == &acpi_bus_type */
307extern struct bus_type acpi_bus_type;
308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309/*
310 * Events
311 * ------
312 */
313
314struct acpi_bus_event {
Len Brown4be44fc2005-08-05 00:44:28 -0400315 struct list_head node;
316 acpi_device_class device_class;
317 acpi_bus_id bus_id;
318 u32 type;
319 u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320};
321
Greg Kroah-Hartman99e0d2f2007-11-02 16:19:59 -0700322extern struct kobject *acpi_kobj;
Zhang Rui962ce8c2007-08-23 01:24:31 +0800323extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
Zhang Rui20733932008-01-17 15:51:21 +0800324void acpi_bus_private_data_handler(acpi_handle, u32, void *);
325int acpi_bus_get_private_data(acpi_handle, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326/*
327 * External Functions
328 */
329
330int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
331void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
Len Brown4be44fc2005-08-05 00:44:28 -0400332int acpi_bus_get_status(struct acpi_device *device);
333int acpi_bus_get_power(acpi_handle handle, int *state);
334int acpi_bus_set_power(acpi_handle handle, int state);
Len Brown14e04fb32007-08-23 15:20:26 -0400335#ifdef CONFIG_ACPI_PROC_EVENT
336int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
Alexey Starikovskiy8db85d42007-09-26 19:43:16 +0400337int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
Len Brown4be44fc2005-08-05 00:44:28 -0400338int acpi_bus_receive_event(struct acpi_bus_event *event);
Len Brown14e04fb32007-08-23 15:20:26 -0400339#else
340static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
341 { return 0; }
342#endif
Len Brown4be44fc2005-08-05 00:44:28 -0400343int acpi_bus_register_driver(struct acpi_driver *driver);
Bjorn Helgaas06ea8e082006-04-27 05:25:00 -0400344void acpi_bus_unregister_driver(struct acpi_driver *driver);
Len Brown4be44fc2005-08-05 00:44:28 -0400345int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
346 acpi_handle handle, int type);
Kristen Accardiceaba6632006-02-23 17:56:01 -0800347int acpi_bus_trim(struct acpi_device *start, int rmdevice);
Len Brown4be44fc2005-08-05 00:44:28 -0400348int acpi_bus_start(struct acpi_device *device);
Len Brownfd350942007-05-09 23:34:35 -0400349acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200350int acpi_match_device_ids(struct acpi_device *device,
351 const struct acpi_device_id *ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352int acpi_create_dir(struct acpi_device *);
353void acpi_remove_dir(struct acpi_device *);
354
David Shaohua Li4e10d122005-03-18 18:45:35 -0500355/*
356 * Bind physical devices with ACPI devices
357 */
358#include <linux/device.h>
359struct acpi_bus_type {
Len Brown4be44fc2005-08-05 00:44:28 -0400360 struct list_head list;
361 struct bus_type *bus;
362 /* For general devices under the bus */
363 int (*find_device) (struct device *, acpi_handle *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500364 /* For bridges, such as PCI root bridge, IDE controller */
Len Brown4be44fc2005-08-05 00:44:28 -0400365 int (*find_bridge) (struct device *, acpi_handle *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500366};
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);
370/* 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
Shaohua Lifd4aff12007-07-17 22:40:25 +0200376int acpi_pm_device_sleep_state(struct device *, int, int *);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200377#else /* !CONFIG_PM_SLEEP */
378static inline int acpi_pm_device_sleep_state(struct device *d, int w, int *p)
379{
380 if (p)
381 *p = ACPI_STATE_D0;
382 return ACPI_STATE_D3;
383}
384#endif /* !CONFIG_PM_SLEEP */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200385
Len Brownfd350942007-05-09 23:34:35 -0400386#endif /* CONFIG_ACPI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388#endif /*__ACPI_BUS_H__*/