blob: fdd10953b2b6503760c91b8035b85d54243770bd [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;
Bob Moore793c2382006-03-31 00:00:00 -050062extern struct fadt_descriptor acpi_fadt;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64enum acpi_bus_removal_type {
Len Brown4be44fc2005-08-05 00:44:28 -040065 ACPI_BUS_REMOVAL_NORMAL = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 ACPI_BUS_REMOVAL_EJECT,
67 ACPI_BUS_REMOVAL_SUPRISE,
68 ACPI_BUS_REMOVAL_TYPE_COUNT
69};
70
71enum acpi_bus_device_type {
Len Brown4be44fc2005-08-05 00:44:28 -040072 ACPI_BUS_TYPE_DEVICE = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/*
86 * ACPI Driver
87 * -----------
88 */
89
Len Brown4be44fc2005-08-05 00:44:28 -040090typedef 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Rajesh Shah3fb02732005-04-28 00:25:52 -0700103struct acpi_bus_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400104 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;
Rajesh Shah3fb02732005-04-28 00:25:52 -0700116};
117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118struct acpi_device_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400119 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130};
131
132struct acpi_driver {
Len Brown4be44fc2005-08-05 00:44:28 -0400133 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139};
140
141/*
142 * ACPI Device
143 * -----------
144 */
145
146/* Status (_STA) */
147
148struct acpi_device_status {
Len Brown4be44fc2005-08-05 00:44:28 -0400149 u32 present:1;
150 u32 enabled:1;
151 u32 show_in_ui:1;
152 u32 functional:1;
153 u32 battery_present:1;
154 u32 reserved:27;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155};
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157/* Flags */
158
159struct acpi_device_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400160 u32 dynamic_status:1;
161 u32 hardware_id:1;
162 u32 compatible_ids:1;
163 u32 bus_address:1;
164 u32 unique_id:1;
165 u32 removable:1;
166 u32 ejectable:1;
167 u32 lockable:1;
168 u32 suprise_removal_ok:1;
169 u32 power_manageable:1;
170 u32 performance_manageable:1;
171 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
Konstantin Karasyov0feabb02006-05-08 00:00:00 -0400172 u32 force_power_state:1;
173 u32 reserved:19;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174};
175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176/* File System */
177
178struct acpi_device_dir {
Len Brown4be44fc2005-08-05 00:44:28 -0400179 struct proc_dir_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180};
181
182#define acpi_device_dir(d) ((d)->dir.entry)
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/* Plug and Play */
185
Len Brown4be44fc2005-08-05 00:44:28 -0400186typedef char acpi_bus_id[5];
187typedef unsigned long acpi_bus_address;
188typedef char acpi_hardware_id[9];
189typedef char acpi_unique_id[9];
190typedef char acpi_device_name[40];
191typedef char acpi_device_class[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193struct acpi_device_pnp {
Len Brown4be44fc2005-08-05 00:44:28 -0400194 acpi_bus_id bus_id; /* Object name */
195 acpi_bus_address bus_address; /* _ADR */
196 acpi_hardware_id hardware_id; /* _HID */
197 struct acpi_compatible_id_list *cid_list; /* _CIDs */
198 acpi_unique_id unique_id; /* _UID */
199 acpi_device_name device_name; /* Driver-determined */
200 acpi_device_class device_class; /* " */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201};
202
203#define acpi_device_bid(d) ((d)->pnp.bus_id)
204#define acpi_device_adr(d) ((d)->pnp.bus_address)
205#define acpi_device_hid(d) ((d)->pnp.hardware_id)
206#define acpi_device_uid(d) ((d)->pnp.unique_id)
207#define acpi_device_name(d) ((d)->pnp.device_name)
208#define acpi_device_class(d) ((d)->pnp.device_class)
209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210/* Power Management */
211
212struct acpi_device_power_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400213 u32 explicit_get:1; /* _PSC present? */
214 u32 power_resources:1; /* Power resources */
215 u32 inrush_current:1; /* Serialize Dx->D0 */
216 u32 power_removed:1; /* Optimize Dx->D0 */
217 u32 reserved:28;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218};
219
220struct acpi_device_power_state {
221 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400222 u8 valid:1;
223 u8 explicit_set:1; /* _PSx present? */
224 u8 reserved:6;
225 } flags;
226 int power; /* % Power (compared to D0) */
227 int latency; /* Dx->D0 time (microseconds) */
228 struct acpi_handle_list resources; /* Power resources referenced */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229};
230
231struct acpi_device_power {
Len Brown4be44fc2005-08-05 00:44:28 -0400232 int state; /* Current state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct acpi_device_power_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400234 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235};
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/* Performance Management */
238
239struct acpi_device_perf_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400240 u8 reserved:8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241};
242
243struct acpi_device_perf_state {
244 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400245 u8 valid:1;
246 u8 reserved:7;
247 } flags;
248 u8 power; /* % Power (compared to P0) */
249 u8 performance; /* % Performance ( " ) */
250 int latency; /* Px->P0 time (microseconds) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251};
252
253struct acpi_device_perf {
Len Brown4be44fc2005-08-05 00:44:28 -0400254 int state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 struct acpi_device_perf_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400256 int state_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 struct acpi_device_perf_state *states;
258};
259
260/* Wakeup Management */
261struct acpi_device_wakeup_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400262 u8 valid:1; /* Can successfully enable wakeup? */
263 u8 run_wake:1; /* Run-Wake GPE devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264};
265
266struct acpi_device_wakeup_state {
Len Brown4be44fc2005-08-05 00:44:28 -0400267 u8 enabled:1;
268 u8 active:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269};
270
271struct acpi_device_wakeup {
Len Brown4be44fc2005-08-05 00:44:28 -0400272 acpi_handle gpe_device;
Alexey Dobriyan53b35312006-03-24 03:16:13 -0800273 acpi_integer gpe_number;
Len Brown4be44fc2005-08-05 00:44:28 -0400274 acpi_integer sleep_state;
275 struct acpi_handle_list resources;
276 struct acpi_device_wakeup_state state;
277 struct acpi_device_wakeup_flags flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278};
279
280/* Device */
281
282struct acpi_device {
Len Brown4be44fc2005-08-05 00:44:28 -0400283 acpi_handle handle;
284 struct acpi_device *parent;
285 struct list_head children;
286 struct list_head node;
287 struct list_head wakeup_list;
288 struct list_head g_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct acpi_device_status status;
290 struct acpi_device_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400291 struct acpi_device_pnp pnp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 struct acpi_device_power power;
293 struct acpi_device_wakeup wakeup;
Len Brown4be44fc2005-08-05 00:44:28 -0400294 struct acpi_device_perf performance;
295 struct acpi_device_dir dir;
296 struct acpi_device_ops ops;
297 struct acpi_driver *driver;
298 void *driver_data;
299 struct kobject kobj;
Patrick Mochel5b327262006-05-10 10:33:00 -0400300 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301};
302
303#define acpi_driver_data(d) ((d)->driver_data)
304
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305/*
306 * Events
307 * ------
308 */
309
310struct acpi_bus_event {
Len Brown4be44fc2005-08-05 00:44:28 -0400311 struct list_head node;
312 acpi_device_class device_class;
313 acpi_bus_id bus_id;
314 u32 type;
315 u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316};
317
318extern struct subsystem acpi_subsys;
319
320/*
321 * External Functions
322 */
323
324int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
325void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
Len Brown4be44fc2005-08-05 00:44:28 -0400326int acpi_bus_get_status(struct acpi_device *device);
327int acpi_bus_get_power(acpi_handle handle, int *state);
328int acpi_bus_set_power(acpi_handle handle, int state);
329int acpi_bus_generate_event(struct acpi_device *device, u8 type, int data);
330int acpi_bus_receive_event(struct acpi_bus_event *event);
331int acpi_bus_register_driver(struct acpi_driver *driver);
Bjorn Helgaas06ea8e082006-04-27 05:25:00 -0400332void acpi_bus_unregister_driver(struct acpi_driver *driver);
Len Brown4be44fc2005-08-05 00:44:28 -0400333int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
334 acpi_handle handle, int type);
Kristen Accardiceaba662006-02-23 17:56:01 -0800335int acpi_bus_trim(struct acpi_device *start, int rmdevice);
Len Brown4be44fc2005-08-05 00:44:28 -0400336int acpi_bus_start(struct acpi_device *device);
Len Brownc8f7a62c2006-07-09 17:22:28 -0400337acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd);
Len Brown4be44fc2005-08-05 00:44:28 -0400338int acpi_match_ids(struct acpi_device *device, char *ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339int acpi_create_dir(struct acpi_device *);
340void acpi_remove_dir(struct acpi_device *);
341
David Shaohua Li4e10d122005-03-18 18:45:35 -0500342/*
343 * Bind physical devices with ACPI devices
344 */
345#include <linux/device.h>
346struct acpi_bus_type {
Len Brown4be44fc2005-08-05 00:44:28 -0400347 struct list_head list;
348 struct bus_type *bus;
349 /* For general devices under the bus */
350 int (*find_device) (struct device *, acpi_handle *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500351 /* For bridges, such as PCI root bridge, IDE controller */
Len Brown4be44fc2005-08-05 00:44:28 -0400352 int (*find_bridge) (struct device *, acpi_handle *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500353};
354int register_acpi_bus_type(struct acpi_bus_type *);
355int unregister_acpi_bus_type(struct acpi_bus_type *);
356struct device *acpi_get_physical_device(acpi_handle);
357/* helper */
358acpi_handle acpi_get_child(acpi_handle, acpi_integer);
359acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
Benjamin Herrenschmidt465ae642006-11-11 17:18:42 +1100360#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
David Shaohua Li4e10d122005-03-18 18:45:35 -0500361
Len Brown76f58582005-08-24 12:10:49 -0400362#endif /* CONFIG_ACPI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364#endif /*__ACPI_BUS_H__*/