ACPI: add ACPI bus_type for driver model
[linux-2.6-block.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
33#define PREFIX "ACPI: "
34
35/* TBD: Make dynamic */
36#define ACPI_MAX_HANDLES 10
37struct acpi_handle_list {
4be44fcd
LB
38 u32 count;
39 acpi_handle handles[ACPI_MAX_HANDLES];
1da177e4
LT
40};
41
1da177e4
LT
42/* acpi_utils.h */
43acpi_status
4be44fcd
LB
44acpi_extract_package(union acpi_object *package,
45 struct acpi_buffer *format, struct acpi_buffer *buffer);
1da177e4 46acpi_status
4be44fcd
LB
47acpi_evaluate_integer(acpi_handle handle,
48 acpi_string pathname,
49 struct acpi_object_list *arguments, unsigned long *data);
1da177e4 50acpi_status
4be44fcd
LB
51acpi_evaluate_reference(acpi_handle handle,
52 acpi_string pathname,
53 struct acpi_object_list *arguments,
54 struct acpi_handle_list *list);
1da177e4 55
76f58584 56#ifdef CONFIG_ACPI
1da177e4
LT
57
58#include <linux/proc_fs.h>
59
60#define ACPI_BUS_FILE_ROOT "acpi"
4be44fcd 61extern struct proc_dir_entry *acpi_root_dir;
793c2388 62extern struct fadt_descriptor acpi_fadt;
1da177e4
LT
63
64enum acpi_bus_removal_type {
4be44fcd 65 ACPI_BUS_REMOVAL_NORMAL = 0,
1da177e4
LT
66 ACPI_BUS_REMOVAL_EJECT,
67 ACPI_BUS_REMOVAL_SUPRISE,
68 ACPI_BUS_REMOVAL_TYPE_COUNT
69};
70
71enum acpi_bus_device_type {
4be44fcd 72 ACPI_BUS_TYPE_DEVICE = 0,
1da177e4
LT
73 ACPI_BUS_TYPE_POWER,
74 ACPI_BUS_TYPE_PROCESSOR,
75 ACPI_BUS_TYPE_THERMAL,
76 ACPI_BUS_TYPE_SYSTEM,
77 ACPI_BUS_TYPE_POWER_BUTTON,
78 ACPI_BUS_TYPE_SLEEP_BUTTON,
79 ACPI_BUS_DEVICE_TYPE_COUNT
80};
81
82struct acpi_driver;
83struct acpi_device;
84
1da177e4
LT
85/*
86 * ACPI Driver
87 * -----------
88 */
89
4be44fcd
LB
90typedef int (*acpi_op_add) (struct acpi_device * device);
91typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
92typedef int (*acpi_op_lock) (struct acpi_device * device, int type);
93typedef int (*acpi_op_start) (struct acpi_device * device);
94typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
5d9464a4
PM
95typedef int (*acpi_op_suspend) (struct acpi_device * device, pm_message_t state);
96typedef int (*acpi_op_resume) (struct acpi_device * device);
4be44fcd
LB
97typedef 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);
100typedef int (*acpi_op_match) (struct acpi_device * device,
101 struct acpi_driver * driver);
5d9464a4 102typedef int (*acpi_op_shutdown) (struct acpi_device * device);
1da177e4 103
3fb02738 104struct acpi_bus_ops {
4be44fcd
LB
105 u32 acpi_op_add:1;
106 u32 acpi_op_remove:1;
107 u32 acpi_op_lock:1;
108 u32 acpi_op_start:1;
109 u32 acpi_op_stop:1;
110 u32 acpi_op_suspend:1;
111 u32 acpi_op_resume:1;
112 u32 acpi_op_scan:1;
113 u32 acpi_op_bind:1;
114 u32 acpi_op_unbind:1;
115 u32 acpi_op_match:1;
5d9464a4
PM
116 u32 acpi_op_shutdown:1;
117 u32 reserved:20;
3fb02738
RS
118};
119
1da177e4 120struct acpi_device_ops {
4be44fcd
LB
121 acpi_op_add add;
122 acpi_op_remove remove;
123 acpi_op_lock lock;
124 acpi_op_start start;
125 acpi_op_stop stop;
126 acpi_op_suspend suspend;
127 acpi_op_resume resume;
128 acpi_op_scan scan;
129 acpi_op_bind bind;
130 acpi_op_unbind unbind;
131 acpi_op_match match;
5d9464a4 132 acpi_op_shutdown shutdown;
1da177e4
LT
133};
134
135struct acpi_driver {
4be44fcd
LB
136 struct list_head node;
137 char name[80];
138 char class[80];
139 atomic_t references;
140 char *ids; /* Supported Hardware IDs */
141 struct acpi_device_ops ops;
d43ec68e 142 struct device_driver drv;
1da177e4
LT
143};
144
145/*
146 * ACPI Device
147 * -----------
148 */
149
150/* Status (_STA) */
151
152struct acpi_device_status {
4be44fcd
LB
153 u32 present:1;
154 u32 enabled:1;
155 u32 show_in_ui:1;
156 u32 functional:1;
157 u32 battery_present:1;
158 u32 reserved:27;
1da177e4
LT
159};
160
1da177e4
LT
161/* Flags */
162
163struct acpi_device_flags {
4be44fcd
LB
164 u32 dynamic_status:1;
165 u32 hardware_id:1;
166 u32 compatible_ids:1;
167 u32 bus_address:1;
168 u32 unique_id:1;
169 u32 removable:1;
170 u32 ejectable:1;
171 u32 lockable:1;
172 u32 suprise_removal_ok:1;
173 u32 power_manageable:1;
174 u32 performance_manageable:1;
175 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
0feabb01
KK
176 u32 force_power_state:1;
177 u32 reserved:19;
1da177e4
LT
178};
179
1da177e4
LT
180/* File System */
181
182struct acpi_device_dir {
4be44fcd 183 struct proc_dir_entry *entry;
1da177e4
LT
184};
185
186#define acpi_device_dir(d) ((d)->dir.entry)
187
1da177e4
LT
188/* Plug and Play */
189
4be44fcd
LB
190typedef char acpi_bus_id[5];
191typedef unsigned long acpi_bus_address;
192typedef char acpi_hardware_id[9];
193typedef char acpi_unique_id[9];
194typedef char acpi_device_name[40];
195typedef char acpi_device_class[20];
1da177e4
LT
196
197struct acpi_device_pnp {
4be44fcd
LB
198 acpi_bus_id bus_id; /* Object name */
199 acpi_bus_address bus_address; /* _ADR */
200 acpi_hardware_id hardware_id; /* _HID */
201 struct acpi_compatible_id_list *cid_list; /* _CIDs */
202 acpi_unique_id unique_id; /* _UID */
203 acpi_device_name device_name; /* Driver-determined */
204 acpi_device_class device_class; /* " */
1da177e4
LT
205};
206
207#define acpi_device_bid(d) ((d)->pnp.bus_id)
208#define acpi_device_adr(d) ((d)->pnp.bus_address)
209#define acpi_device_hid(d) ((d)->pnp.hardware_id)
210#define acpi_device_uid(d) ((d)->pnp.unique_id)
211#define acpi_device_name(d) ((d)->pnp.device_name)
212#define acpi_device_class(d) ((d)->pnp.device_class)
213
1da177e4
LT
214/* Power Management */
215
216struct acpi_device_power_flags {
4be44fcd
LB
217 u32 explicit_get:1; /* _PSC present? */
218 u32 power_resources:1; /* Power resources */
219 u32 inrush_current:1; /* Serialize Dx->D0 */
220 u32 power_removed:1; /* Optimize Dx->D0 */
221 u32 reserved:28;
1da177e4
LT
222};
223
224struct acpi_device_power_state {
225 struct {
4be44fcd
LB
226 u8 valid:1;
227 u8 explicit_set:1; /* _PSx present? */
228 u8 reserved:6;
229 } flags;
230 int power; /* % Power (compared to D0) */
231 int latency; /* Dx->D0 time (microseconds) */
232 struct acpi_handle_list resources; /* Power resources referenced */
1da177e4
LT
233};
234
235struct acpi_device_power {
4be44fcd 236 int state; /* Current state */
1da177e4 237 struct acpi_device_power_flags flags;
4be44fcd 238 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
1da177e4
LT
239};
240
1da177e4
LT
241/* Performance Management */
242
243struct acpi_device_perf_flags {
4be44fcd 244 u8 reserved:8;
1da177e4
LT
245};
246
247struct acpi_device_perf_state {
248 struct {
4be44fcd
LB
249 u8 valid:1;
250 u8 reserved:7;
251 } flags;
252 u8 power; /* % Power (compared to P0) */
253 u8 performance; /* % Performance ( " ) */
254 int latency; /* Px->P0 time (microseconds) */
1da177e4
LT
255};
256
257struct acpi_device_perf {
4be44fcd 258 int state;
1da177e4 259 struct acpi_device_perf_flags flags;
4be44fcd 260 int state_count;
1da177e4
LT
261 struct acpi_device_perf_state *states;
262};
263
264/* Wakeup Management */
265struct acpi_device_wakeup_flags {
4be44fcd
LB
266 u8 valid:1; /* Can successfully enable wakeup? */
267 u8 run_wake:1; /* Run-Wake GPE devices */
1da177e4
LT
268};
269
270struct acpi_device_wakeup_state {
4be44fcd
LB
271 u8 enabled:1;
272 u8 active:1;
1da177e4
LT
273};
274
275struct acpi_device_wakeup {
4be44fcd 276 acpi_handle gpe_device;
53b3531b 277 acpi_integer gpe_number;
4be44fcd
LB
278 acpi_integer sleep_state;
279 struct acpi_handle_list resources;
280 struct acpi_device_wakeup_state state;
281 struct acpi_device_wakeup_flags flags;
1da177e4
LT
282};
283
284/* Device */
285
286struct acpi_device {
4be44fcd
LB
287 acpi_handle handle;
288 struct acpi_device *parent;
289 struct list_head children;
290 struct list_head node;
291 struct list_head wakeup_list;
292 struct list_head g_list;
1da177e4
LT
293 struct acpi_device_status status;
294 struct acpi_device_flags flags;
4be44fcd 295 struct acpi_device_pnp pnp;
1da177e4
LT
296 struct acpi_device_power power;
297 struct acpi_device_wakeup wakeup;
4be44fcd
LB
298 struct acpi_device_perf performance;
299 struct acpi_device_dir dir;
300 struct acpi_device_ops ops;
301 struct acpi_driver *driver;
302 void *driver_data;
303 struct kobject kobj;
5b327265 304 struct device dev;
1da177e4
LT
305};
306
307#define acpi_driver_data(d) ((d)->driver_data)
d43ec68e
PM
308#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
309#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
1da177e4 310
1da177e4
LT
311/*
312 * Events
313 * ------
314 */
315
316struct acpi_bus_event {
4be44fcd
LB
317 struct list_head node;
318 acpi_device_class device_class;
319 acpi_bus_id bus_id;
320 u32 type;
321 u32 data;
1da177e4
LT
322};
323
324extern struct subsystem acpi_subsys;
325
326/*
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);
4be44fcd
LB
332int 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);
335int acpi_bus_generate_event(struct acpi_device *device, u8 type, int data);
336int acpi_bus_receive_event(struct acpi_bus_event *event);
337int acpi_bus_register_driver(struct acpi_driver *driver);
06ea8e08 338void acpi_bus_unregister_driver(struct acpi_driver *driver);
4be44fcd
LB
339int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
340 acpi_handle handle, int type);
ceaba663 341int acpi_bus_trim(struct acpi_device *start, int rmdevice);
4be44fcd 342int acpi_bus_start(struct acpi_device *device);
c8f7a62c 343acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd);
4be44fcd 344int acpi_match_ids(struct acpi_device *device, char *ids);
1da177e4
LT
345int acpi_create_dir(struct acpi_device *);
346void acpi_remove_dir(struct acpi_device *);
347
4e10d12a
DSL
348/*
349 * Bind physical devices with ACPI devices
350 */
351#include <linux/device.h>
352struct acpi_bus_type {
4be44fcd
LB
353 struct list_head list;
354 struct bus_type *bus;
355 /* For general devices under the bus */
356 int (*find_device) (struct device *, acpi_handle *);
4e10d12a 357 /* For bridges, such as PCI root bridge, IDE controller */
4be44fcd 358 int (*find_bridge) (struct device *, acpi_handle *);
4e10d12a
DSL
359};
360int register_acpi_bus_type(struct acpi_bus_type *);
361int unregister_acpi_bus_type(struct acpi_bus_type *);
362struct device *acpi_get_physical_device(acpi_handle);
363/* helper */
364acpi_handle acpi_get_child(acpi_handle, acpi_integer);
365acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
465ae641 366#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
4e10d12a 367
76f58584 368#endif /* CONFIG_ACPI */
1da177e4
LT
369
370#endif /*__ACPI_BUS_H__*/