ACPI: Move definition of PREFIX from acpi_bus.h to internal..h
[deliverable/linux.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,
73 ACPI_BUS_TYPE_SYSTEM,
74 ACPI_BUS_TYPE_POWER_BUTTON,
75 ACPI_BUS_TYPE_SLEEP_BUTTON,
76 ACPI_BUS_DEVICE_TYPE_COUNT
77};
78
79struct acpi_driver;
80struct acpi_device;
81
1da177e4
LT
82/*
83 * ACPI Driver
84 * -----------
85 */
86
4be44fcd
LB
87typedef int (*acpi_op_add) (struct acpi_device * device);
88typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
4be44fcd
LB
89typedef int (*acpi_op_start) (struct acpi_device * device);
90typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
fd350943
LB
91typedef int (*acpi_op_suspend) (struct acpi_device * device,
92 pm_message_t state);
5d9464a4 93typedef int (*acpi_op_resume) (struct acpi_device * device);
4be44fcd
LB
94typedef int (*acpi_op_bind) (struct acpi_device * device);
95typedef int (*acpi_op_unbind) (struct acpi_device * device);
46ec8598 96typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
1da177e4 97
3fb02738 98struct acpi_bus_ops {
4be44fcd 99 u32 acpi_op_add:1;
4be44fcd 100 u32 acpi_op_start:1;
3fb02738
RS
101};
102
1da177e4 103struct acpi_device_ops {
4be44fcd
LB
104 acpi_op_add add;
105 acpi_op_remove remove;
4be44fcd
LB
106 acpi_op_start start;
107 acpi_op_stop stop;
108 acpi_op_suspend suspend;
109 acpi_op_resume resume;
4be44fcd
LB
110 acpi_op_bind bind;
111 acpi_op_unbind unbind;
46ec8598 112 acpi_op_notify notify;
1da177e4
LT
113};
114
6d278131
BH
115#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
116
1da177e4 117struct acpi_driver {
4be44fcd
LB
118 char name[80];
119 char class[80];
8c8eb78f 120 const struct acpi_device_id *ids; /* Supported Hardware IDs */
6d278131 121 unsigned int flags;
4be44fcd 122 struct acpi_device_ops ops;
d43ec68e 123 struct device_driver drv;
1890a97a 124 struct module *owner;
1da177e4
LT
125};
126
127/*
128 * ACPI Device
129 * -----------
130 */
131
132/* Status (_STA) */
133
134struct acpi_device_status {
4be44fcd
LB
135 u32 present:1;
136 u32 enabled:1;
137 u32 show_in_ui:1;
138 u32 functional:1;
139 u32 battery_present:1;
140 u32 reserved:27;
1da177e4
LT
141};
142
1da177e4
LT
143/* Flags */
144
145struct acpi_device_flags {
4be44fcd
LB
146 u32 dynamic_status:1;
147 u32 hardware_id:1;
148 u32 compatible_ids:1;
149 u32 bus_address:1;
150 u32 unique_id:1;
151 u32 removable:1;
152 u32 ejectable:1;
153 u32 lockable:1;
154 u32 suprise_removal_ok:1;
155 u32 power_manageable:1;
156 u32 performance_manageable:1;
157 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
ec68373c
LB
158 u32 force_power_state:1;
159 u32 reserved:19;
1da177e4
LT
160};
161
1da177e4
LT
162/* File System */
163
164struct acpi_device_dir {
4be44fcd 165 struct proc_dir_entry *entry;
1da177e4
LT
166};
167
168#define acpi_device_dir(d) ((d)->dir.entry)
169
1da177e4
LT
170/* Plug and Play */
171
24c5c4c2 172typedef char acpi_bus_id[8];
4be44fcd 173typedef unsigned long acpi_bus_address;
bb095854 174typedef char acpi_hardware_id[15];
4be44fcd
LB
175typedef char acpi_unique_id[9];
176typedef char acpi_device_name[40];
177typedef char acpi_device_class[20];
1da177e4
LT
178
179struct acpi_device_pnp {
4be44fcd
LB
180 acpi_bus_id bus_id; /* Object name */
181 acpi_bus_address bus_address; /* _ADR */
182 acpi_hardware_id hardware_id; /* _HID */
183 struct acpi_compatible_id_list *cid_list; /* _CIDs */
184 acpi_unique_id unique_id; /* _UID */
185 acpi_device_name device_name; /* Driver-determined */
186 acpi_device_class device_class; /* " */
1da177e4
LT
187};
188
189#define acpi_device_bid(d) ((d)->pnp.bus_id)
190#define acpi_device_adr(d) ((d)->pnp.bus_address)
191#define acpi_device_hid(d) ((d)->pnp.hardware_id)
192#define acpi_device_uid(d) ((d)->pnp.unique_id)
193#define acpi_device_name(d) ((d)->pnp.device_name)
194#define acpi_device_class(d) ((d)->pnp.device_class)
195
1da177e4
LT
196/* Power Management */
197
198struct acpi_device_power_flags {
4be44fcd
LB
199 u32 explicit_get:1; /* _PSC present? */
200 u32 power_resources:1; /* Power resources */
201 u32 inrush_current:1; /* Serialize Dx->D0 */
202 u32 power_removed:1; /* Optimize Dx->D0 */
203 u32 reserved:28;
1da177e4
LT
204};
205
206struct acpi_device_power_state {
207 struct {
4be44fcd
LB
208 u8 valid:1;
209 u8 explicit_set:1; /* _PSx present? */
210 u8 reserved:6;
211 } flags;
212 int power; /* % Power (compared to D0) */
213 int latency; /* Dx->D0 time (microseconds) */
214 struct acpi_handle_list resources; /* Power resources referenced */
1da177e4
LT
215};
216
217struct acpi_device_power {
4be44fcd 218 int state; /* Current state */
1da177e4 219 struct acpi_device_power_flags flags;
4be44fcd 220 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
1da177e4
LT
221};
222
1da177e4
LT
223/* Performance Management */
224
225struct acpi_device_perf_flags {
4be44fcd 226 u8 reserved:8;
1da177e4
LT
227};
228
229struct acpi_device_perf_state {
230 struct {
4be44fcd
LB
231 u8 valid:1;
232 u8 reserved:7;
233 } flags;
234 u8 power; /* % Power (compared to P0) */
235 u8 performance; /* % Performance ( " ) */
236 int latency; /* Px->P0 time (microseconds) */
1da177e4
LT
237};
238
239struct acpi_device_perf {
4be44fcd 240 int state;
1da177e4 241 struct acpi_device_perf_flags flags;
4be44fcd 242 int state_count;
1da177e4
LT
243 struct acpi_device_perf_state *states;
244};
245
246/* Wakeup Management */
247struct acpi_device_wakeup_flags {
4be44fcd 248 u8 valid:1; /* Can successfully enable wakeup? */
0af4b8c4 249 u8 prepared:1; /* Has the wake-up capability been enabled? */
4be44fcd 250 u8 run_wake:1; /* Run-Wake GPE devices */
1da177e4
LT
251};
252
253struct acpi_device_wakeup_state {
4be44fcd 254 u8 enabled:1;
1da177e4
LT
255};
256
257struct acpi_device_wakeup {
4be44fcd 258 acpi_handle gpe_device;
53b3531b 259 acpi_integer gpe_number;
4be44fcd
LB
260 acpi_integer sleep_state;
261 struct acpi_handle_list resources;
262 struct acpi_device_wakeup_state state;
263 struct acpi_device_wakeup_flags flags;
1da177e4
LT
264};
265
266/* Device */
267
268struct acpi_device {
4be44fcd
LB
269 acpi_handle handle;
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);
20733939
ZR
315void acpi_bus_private_data_handler(acpi_handle, u32, void *);
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);
328void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
4be44fcd
LB
329int acpi_bus_get_status(struct acpi_device *device);
330int acpi_bus_get_power(acpi_handle handle, int *state);
331int acpi_bus_set_power(acpi_handle handle, int state);
3737b2b1 332bool acpi_bus_power_manageable(acpi_handle handle);
eb9d0fe4 333bool acpi_bus_can_wakeup(acpi_handle handle);
14e04fb3
LB
334#ifdef CONFIG_ACPI_PROC_EVENT
335int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
8db85d4c 336int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
4be44fcd 337int acpi_bus_receive_event(struct acpi_bus_event *event);
14e04fb3
LB
338#else
339static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
340 { return 0; }
341#endif
4be44fcd 342int acpi_bus_register_driver(struct acpi_driver *driver);
06ea8e08 343void acpi_bus_unregister_driver(struct acpi_driver *driver);
4be44fcd
LB
344int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
345 acpi_handle handle, int type);
ceaba663 346int acpi_bus_trim(struct acpi_device *start, int rmdevice);
4be44fcd 347int acpi_bus_start(struct acpi_device *device);
fd350943 348acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
8c8eb78f
TR
349int acpi_match_device_ids(struct acpi_device *device,
350 const struct acpi_device_id *ids);
1da177e4
LT
351int acpi_create_dir(struct acpi_device *);
352void acpi_remove_dir(struct acpi_device *);
353
4e10d12a
DSL
354/*
355 * Bind physical devices with ACPI devices
356 */
357#include <linux/device.h>
358struct acpi_bus_type {
4be44fcd
LB
359 struct list_head list;
360 struct bus_type *bus;
361 /* For general devices under the bus */
362 int (*find_device) (struct device *, acpi_handle *);
4e10d12a 363 /* For bridges, such as PCI root bridge, IDE controller */
4be44fcd 364 int (*find_bridge) (struct device *, acpi_handle *);
4e10d12a
DSL
365};
366int register_acpi_bus_type(struct acpi_bus_type *);
367int unregister_acpi_bus_type(struct acpi_bus_type *);
368struct device *acpi_get_physical_device(acpi_handle);
22c13f9d 369
4e10d12a
DSL
370/* helper */
371acpi_handle acpi_get_child(acpi_handle, acpi_integer);
27558203 372int acpi_is_root_bridge(acpi_handle);
4e10d12a 373acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
465ae641 374#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
4e10d12a 375
296699de 376#ifdef CONFIG_PM_SLEEP
06166780 377int acpi_pm_device_sleep_state(struct device *, int *);
eb9d0fe4 378int acpi_pm_device_sleep_wake(struct device *, bool);
296699de 379#else /* !CONFIG_PM_SLEEP */
06166780 380static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
296699de
RW
381{
382 if (p)
383 *p = ACPI_STATE_D0;
384 return ACPI_STATE_D3;
385}
f7a1b860
DH
386static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
387{
388 return -ENODEV;
389}
296699de 390#endif /* !CONFIG_PM_SLEEP */
fd4aff1a 391
fd350943 392#endif /* CONFIG_ACPI */
1da177e4
LT
393
394#endif /*__ACPI_BUS_H__*/
This page took 0.48558 seconds and 5 git commands to generate.