acpi_bus.h 11.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/*
 *  acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
 *
 *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
 *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or (at
 *  your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef __ACPI_BUS_H__
#define __ACPI_BUS_H__

29
#include <linux/device.h>
Linus Torvalds's avatar
Linus Torvalds committed
30
31
32
33
34
35

#include <acpi/acpi.h>

/* TBD: Make dynamic */
#define ACPI_MAX_HANDLES	10
struct acpi_handle_list {
Len Brown's avatar
Len Brown committed
36
37
	u32 count;
	acpi_handle handles[ACPI_MAX_HANDLES];
Linus Torvalds's avatar
Linus Torvalds committed
38
39
40
41
};

/* acpi_utils.h */
acpi_status
Len Brown's avatar
Len Brown committed
42
43
acpi_extract_package(union acpi_object *package,
		     struct acpi_buffer *format, struct acpi_buffer *buffer);
Linus Torvalds's avatar
Linus Torvalds committed
44
acpi_status
Len Brown's avatar
Len Brown committed
45
46
acpi_evaluate_integer(acpi_handle handle,
		      acpi_string pathname,
47
		      struct acpi_object_list *arguments, unsigned long long *data);
Linus Torvalds's avatar
Linus Torvalds committed
48
acpi_status
Len Brown's avatar
Len Brown committed
49
50
51
52
acpi_evaluate_reference(acpi_handle handle,
			acpi_string pathname,
			struct acpi_object_list *arguments,
			struct acpi_handle_list *list);
Linus Torvalds's avatar
Linus Torvalds committed
53

Len Brown's avatar
Len Brown committed
54
#ifdef CONFIG_ACPI
Linus Torvalds's avatar
Linus Torvalds committed
55
56
57
58

#include <linux/proc_fs.h>

#define ACPI_BUS_FILE_ROOT	"acpi"
Len Brown's avatar
Len Brown committed
59
extern struct proc_dir_entry *acpi_root_dir;
Linus Torvalds's avatar
Linus Torvalds committed
60
61

enum acpi_bus_removal_type {
Len Brown's avatar
Len Brown committed
62
	ACPI_BUS_REMOVAL_NORMAL = 0,
Linus Torvalds's avatar
Linus Torvalds committed
63
64
65
66
67
68
	ACPI_BUS_REMOVAL_EJECT,
	ACPI_BUS_REMOVAL_SUPRISE,
	ACPI_BUS_REMOVAL_TYPE_COUNT
};

enum acpi_bus_device_type {
Len Brown's avatar
Len Brown committed
69
	ACPI_BUS_TYPE_DEVICE = 0,
Linus Torvalds's avatar
Linus Torvalds committed
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
	ACPI_BUS_TYPE_POWER,
	ACPI_BUS_TYPE_PROCESSOR,
	ACPI_BUS_TYPE_THERMAL,
	ACPI_BUS_TYPE_POWER_BUTTON,
	ACPI_BUS_TYPE_SLEEP_BUTTON,
	ACPI_BUS_DEVICE_TYPE_COUNT
};

struct acpi_driver;
struct acpi_device;

/*
 * ACPI Driver
 * -----------
 */

Len Brown's avatar
Len Brown committed
86
87
88
typedef int (*acpi_op_add) (struct acpi_device * device);
typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
typedef int (*acpi_op_start) (struct acpi_device * device);
Len Brown's avatar
Len Brown committed
89
90
typedef int (*acpi_op_suspend) (struct acpi_device * device,
				pm_message_t state);
91
typedef int (*acpi_op_resume) (struct acpi_device * device);
Len Brown's avatar
Len Brown committed
92
93
typedef int (*acpi_op_bind) (struct acpi_device * device);
typedef int (*acpi_op_unbind) (struct acpi_device * device);
94
typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
Linus Torvalds's avatar
Linus Torvalds committed
95

96
struct acpi_bus_ops {
Len Brown's avatar
Len Brown committed
97
98
	u32 acpi_op_add:1;
	u32 acpi_op_start:1;
99
100
};

Linus Torvalds's avatar
Linus Torvalds committed
101
struct acpi_device_ops {
Len Brown's avatar
Len Brown committed
102
103
104
105
106
107
108
	acpi_op_add add;
	acpi_op_remove remove;
	acpi_op_start start;
	acpi_op_suspend suspend;
	acpi_op_resume resume;
	acpi_op_bind bind;
	acpi_op_unbind unbind;
109
	acpi_op_notify notify;
Linus Torvalds's avatar
Linus Torvalds committed
110
111
};

112
113
#define ACPI_DRIVER_ALL_NOTIFY_EVENTS	0x1	/* system AND device events */

Linus Torvalds's avatar
Linus Torvalds committed
114
struct acpi_driver {
Len Brown's avatar
Len Brown committed
115
116
	char name[80];
	char class[80];
117
	const struct acpi_device_id *ids; /* Supported Hardware IDs */
118
	unsigned int flags;
Len Brown's avatar
Len Brown committed
119
	struct acpi_device_ops ops;
120
	struct device_driver drv;
121
	struct module *owner;
Linus Torvalds's avatar
Linus Torvalds committed
122
123
124
125
126
127
128
129
130
131
};

/*
 * ACPI Device
 * -----------
 */

/* Status (_STA) */

struct acpi_device_status {
Len Brown's avatar
Len Brown committed
132
133
134
135
136
137
	u32 present:1;
	u32 enabled:1;
	u32 show_in_ui:1;
	u32 functional:1;
	u32 battery_present:1;
	u32 reserved:27;
Linus Torvalds's avatar
Linus Torvalds committed
138
139
140
141
142
};

/* Flags */

struct acpi_device_flags {
Len Brown's avatar
Len Brown committed
143
144
145
146
147
148
149
150
151
152
153
154
	u32 dynamic_status:1;
	u32 hardware_id:1;
	u32 compatible_ids:1;
	u32 bus_address:1;
	u32 unique_id:1;
	u32 removable:1;
	u32 ejectable:1;
	u32 lockable:1;
	u32 suprise_removal_ok:1;
	u32 power_manageable:1;
	u32 performance_manageable:1;
	u32 wake_capable:1;	/* Wakeup(_PRW) supported? */
155
156
	u32 force_power_state:1;
	u32 reserved:19;
Linus Torvalds's avatar
Linus Torvalds committed
157
158
159
160
161
};

/* File System */

struct acpi_device_dir {
Len Brown's avatar
Len Brown committed
162
	struct proc_dir_entry *entry;
Linus Torvalds's avatar
Linus Torvalds committed
163
164
165
166
167
168
};

#define acpi_device_dir(d)	((d)->dir.entry)

/* Plug and Play */

169
typedef char acpi_bus_id[8];
Len Brown's avatar
Len Brown committed
170
171
172
typedef unsigned long acpi_bus_address;
typedef char acpi_device_name[40];
typedef char acpi_device_class[20];
Linus Torvalds's avatar
Linus Torvalds committed
173
174

struct acpi_device_pnp {
Len Brown's avatar
Len Brown committed
175
176
	acpi_bus_id bus_id;	/* Object name */
	acpi_bus_address bus_address;	/* _ADR */
177
178
179
	char *hardware_id;	/* _HID */
	struct acpica_device_id_list *cid_list;	/* _CIDs */
	char *unique_id;	/* _UID */
Len Brown's avatar
Len Brown committed
180
181
	acpi_device_name device_name;	/* Driver-determined */
	acpi_device_class device_class;	/*        "          */
Linus Torvalds's avatar
Linus Torvalds committed
182
183
184
185
186
187
188
189
190
191
192
193
};

#define acpi_device_bid(d)	((d)->pnp.bus_id)
#define acpi_device_adr(d)	((d)->pnp.bus_address)
#define acpi_device_hid(d)	((d)->pnp.hardware_id)
#define acpi_device_uid(d)	((d)->pnp.unique_id)
#define acpi_device_name(d)	((d)->pnp.device_name)
#define acpi_device_class(d)	((d)->pnp.device_class)

/* Power Management */

struct acpi_device_power_flags {
Len Brown's avatar
Len Brown committed
194
195
196
197
198
	u32 explicit_get:1;	/* _PSC present? */
	u32 power_resources:1;	/* Power resources */
	u32 inrush_current:1;	/* Serialize Dx->D0 */
	u32 power_removed:1;	/* Optimize Dx->D0 */
	u32 reserved:28;
Linus Torvalds's avatar
Linus Torvalds committed
199
200
201
202
};

struct acpi_device_power_state {
	struct {
Len Brown's avatar
Len Brown committed
203
204
205
206
207
208
209
		u8 valid:1;
		u8 explicit_set:1;	/* _PSx present? */
		u8 reserved:6;
	} flags;
	int power;		/* % Power (compared to D0) */
	int latency;		/* Dx->D0 time (microseconds) */
	struct acpi_handle_list resources;	/* Power resources referenced */
Linus Torvalds's avatar
Linus Torvalds committed
210
211
212
};

struct acpi_device_power {
Len Brown's avatar
Len Brown committed
213
	int state;		/* Current state */
Linus Torvalds's avatar
Linus Torvalds committed
214
	struct acpi_device_power_flags flags;
Len Brown's avatar
Len Brown committed
215
	struct acpi_device_power_state states[4];	/* Power states (D0-D3) */
Linus Torvalds's avatar
Linus Torvalds committed
216
217
218
219
220
};

/* Performance Management */

struct acpi_device_perf_flags {
Len Brown's avatar
Len Brown committed
221
	u8 reserved:8;
Linus Torvalds's avatar
Linus Torvalds committed
222
223
224
225
};

struct acpi_device_perf_state {
	struct {
Len Brown's avatar
Len Brown committed
226
227
228
229
230
231
		u8 valid:1;
		u8 reserved:7;
	} flags;
	u8 power;		/* % Power (compared to P0) */
	u8 performance;		/* % Performance (    "   ) */
	int latency;		/* Px->P0 time (microseconds) */
Linus Torvalds's avatar
Linus Torvalds committed
232
233
234
};

struct acpi_device_perf {
Len Brown's avatar
Len Brown committed
235
	int state;
Linus Torvalds's avatar
Linus Torvalds committed
236
	struct acpi_device_perf_flags flags;
Len Brown's avatar
Len Brown committed
237
	int state_count;
Linus Torvalds's avatar
Linus Torvalds committed
238
239
240
241
242
	struct acpi_device_perf_state *states;
};

/* Wakeup Management */
struct acpi_device_wakeup_flags {
Len Brown's avatar
Len Brown committed
243
244
	u8 valid:1;		/* Can successfully enable wakeup? */
	u8 run_wake:1;		/* Run-Wake GPE devices */
Linus Torvalds's avatar
Linus Torvalds committed
245
246
247
};

struct acpi_device_wakeup_state {
Len Brown's avatar
Len Brown committed
248
	u8 enabled:1;
Linus Torvalds's avatar
Linus Torvalds committed
249
250
251
};

struct acpi_device_wakeup {
Len Brown's avatar
Len Brown committed
252
	acpi_handle gpe_device;
Alexey Dobriyan's avatar
Alexey Dobriyan committed
253
	acpi_integer gpe_number;
Len Brown's avatar
Len Brown committed
254
255
256
257
	acpi_integer sleep_state;
	struct acpi_handle_list resources;
	struct acpi_device_wakeup_state state;
	struct acpi_device_wakeup_flags flags;
258
	int prepare_count;
Linus Torvalds's avatar
Linus Torvalds committed
259
260
261
262
263
};

/* Device */

struct acpi_device {
264
265
	int device_type;
	acpi_handle handle;		/* no handle for fixed hardware */
Len Brown's avatar
Len Brown committed
266
267
268
269
	struct acpi_device *parent;
	struct list_head children;
	struct list_head node;
	struct list_head wakeup_list;
Linus Torvalds's avatar
Linus Torvalds committed
270
271
	struct acpi_device_status status;
	struct acpi_device_flags flags;
Len Brown's avatar
Len Brown committed
272
	struct acpi_device_pnp pnp;
Linus Torvalds's avatar
Linus Torvalds committed
273
274
	struct acpi_device_power power;
	struct acpi_device_wakeup wakeup;
Len Brown's avatar
Len Brown committed
275
276
277
278
279
	struct acpi_device_perf performance;
	struct acpi_device_dir dir;
	struct acpi_device_ops ops;
	struct acpi_driver *driver;
	void *driver_data;
280
	struct device dev;
281
	struct acpi_bus_ops bus_ops;	/* workaround for different code path for hotplug */
Len Brown's avatar
Len Brown committed
282
	enum acpi_bus_removal_type removal_type;	/* indicate for different removal type */
Linus Torvalds's avatar
Linus Torvalds committed
283
284
};

285
286
287
288
289
static inline void *acpi_driver_data(struct acpi_device *d)
{
	return d->driver_data;
}

290
291
#define to_acpi_device(d)	container_of(d, struct acpi_device, dev)
#define to_acpi_driver(d)	container_of(d, struct acpi_driver, drv)
Linus Torvalds's avatar
Linus Torvalds committed
292

293
294
295
/* acpi_device.dev.bus == &acpi_bus_type */
extern struct bus_type acpi_bus_type;

Linus Torvalds's avatar
Linus Torvalds committed
296
297
298
299
300
301
/*
 * Events
 * ------
 */

struct acpi_bus_event {
Len Brown's avatar
Len Brown committed
302
303
304
305
306
	struct list_head node;
	acpi_device_class device_class;
	acpi_bus_id bus_id;
	u32 type;
	u32 data;
Linus Torvalds's avatar
Linus Torvalds committed
307
308
};

309
extern struct kobject *acpi_kobj;
310
extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
311
void acpi_bus_private_data_handler(acpi_handle, void *);
Zhang Rui's avatar
Zhang Rui committed
312
int acpi_bus_get_private_data(acpi_handle, void **);
313
314
315
extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
extern int register_acpi_notifier(struct notifier_block *);
extern int unregister_acpi_notifier(struct notifier_block *);
316
317
318

extern int register_acpi_bus_notifier(struct notifier_block *nb);
extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
Linus Torvalds's avatar
Linus Torvalds committed
319
320
321
322
323
/*
 * External Functions
 */

int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
324
void acpi_bus_data_handler(acpi_handle handle, void *context);
325
326
acpi_status acpi_bus_get_status_handle(acpi_handle handle,
				       unsigned long long *sta);
Len Brown's avatar
Len Brown committed
327
328
329
int acpi_bus_get_status(struct acpi_device *device);
int acpi_bus_get_power(acpi_handle handle, int *state);
int acpi_bus_set_power(acpi_handle handle, int state);
330
bool acpi_bus_power_manageable(acpi_handle handle);
331
bool acpi_bus_can_wakeup(acpi_handle handle);
332
333
#ifdef CONFIG_ACPI_PROC_EVENT
int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
334
int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
Len Brown's avatar
Len Brown committed
335
int acpi_bus_receive_event(struct acpi_bus_event *event);
336
337
338
339
#else
static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
	{ return 0; }
#endif
Len Brown's avatar
Len Brown committed
340
int acpi_bus_register_driver(struct acpi_driver *driver);
341
void acpi_bus_unregister_driver(struct acpi_driver *driver);
Len Brown's avatar
Len Brown committed
342
343
int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
		 acpi_handle handle, int type);
344
int acpi_bus_trim(struct acpi_device *start, int rmdevice);
Len Brown's avatar
Len Brown committed
345
int acpi_bus_start(struct acpi_device *device);
Len Brown's avatar
Len Brown committed
346
acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
347
348
int acpi_match_device_ids(struct acpi_device *device,
			  const struct acpi_device_id *ids);
Linus Torvalds's avatar
Linus Torvalds committed
349
350
351
int acpi_create_dir(struct acpi_device *);
void acpi_remove_dir(struct acpi_device *);

352
353
354
355
/*
 * Bind physical devices with ACPI devices
 */
struct acpi_bus_type {
Len Brown's avatar
Len Brown committed
356
357
358
359
	struct list_head list;
	struct bus_type *bus;
	/* For general devices under the bus */
	int (*find_device) (struct device *, acpi_handle *);
360
	/* For bridges, such as PCI root bridge, IDE controller */
Len Brown's avatar
Len Brown committed
361
	int (*find_bridge) (struct device *, acpi_handle *);
362
363
364
365
};
int register_acpi_bus_type(struct acpi_bus_type *);
int unregister_acpi_bus_type(struct acpi_bus_type *);
struct device *acpi_get_physical_device(acpi_handle);
366

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
struct acpi_pci_root {
	struct list_head node;
	struct acpi_device * device;
	struct acpi_pci_id id;
	struct pci_bus *bus;
	u16 segment;
	u8 bus_nr;

	u32 osc_support_set;	/* _OSC state of support bits */
	u32 osc_control_set;	/* _OSC state of control bits */
	u32 osc_control_qry;	/* the latest _OSC query result */

	u32 osc_queried:1;	/* has _OSC control been queried? */
};

382
383
/* helper */
acpi_handle acpi_get_child(acpi_handle, acpi_integer);
384
int acpi_is_root_bridge(acpi_handle);
385
acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
386
struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
387
#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
388

389
#ifdef CONFIG_PM_SLEEP
390
int acpi_pm_device_sleep_state(struct device *, int *);
391
int acpi_pm_device_sleep_wake(struct device *, bool);
392
#else /* !CONFIG_PM_SLEEP */
393
static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
394
395
396
397
398
{
	if (p)
		*p = ACPI_STATE_D0;
	return ACPI_STATE_D3;
}
399
400
401
402
static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
{
	return -ENODEV;
}
403
#endif /* !CONFIG_PM_SLEEP */
404

Len Brown's avatar
Len Brown committed
405
#endif				/* CONFIG_ACPI */
Linus Torvalds's avatar
Linus Torvalds committed
406
407

#endif /*__ACPI_BUS_H__*/