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