]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/acpi/acpi_bus.h
Merge branch 'merge' of git://git.kernel.org/pub/scm/linux/kernel/git/benh/powerpc
[mirror_ubuntu-bionic-kernel.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,
1da177e4
LT
73 ACPI_BUS_TYPE_POWER_BUTTON,
74 ACPI_BUS_TYPE_SLEEP_BUTTON,
75 ACPI_BUS_DEVICE_TYPE_COUNT
76};
77
78struct acpi_driver;
79struct acpi_device;
80
1da177e4
LT
81/*
82 * ACPI Driver
83 * -----------
84 */
85
4be44fcd
LB
86typedef int (*acpi_op_add) (struct acpi_device * device);
87typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
4be44fcd 88typedef int (*acpi_op_start) (struct acpi_device * device);
fd350943
LB
89typedef int (*acpi_op_suspend) (struct acpi_device * device,
90 pm_message_t state);
5d9464a4 91typedef int (*acpi_op_resume) (struct acpi_device * device);
4be44fcd
LB
92typedef int (*acpi_op_bind) (struct acpi_device * device);
93typedef int (*acpi_op_unbind) (struct acpi_device * device);
46ec8598 94typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
1da177e4 95
3fb02738 96struct acpi_bus_ops {
4be44fcd 97 u32 acpi_op_add:1;
4be44fcd 98 u32 acpi_op_start:1;
3fb02738
RS
99};
100
1da177e4 101struct acpi_device_ops {
4be44fcd
LB
102 acpi_op_add add;
103 acpi_op_remove remove;
4be44fcd 104 acpi_op_start start;
4be44fcd
LB
105 acpi_op_suspend suspend;
106 acpi_op_resume resume;
4be44fcd
LB
107 acpi_op_bind bind;
108 acpi_op_unbind unbind;
46ec8598 109 acpi_op_notify notify;
1da177e4
LT
110};
111
6d278131
BH
112#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
113
1da177e4 114struct acpi_driver {
4be44fcd
LB
115 char name[80];
116 char class[80];
8c8eb78f 117 const struct acpi_device_id *ids; /* Supported Hardware IDs */
6d278131 118 unsigned int flags;
4be44fcd 119 struct acpi_device_ops ops;
d43ec68e 120 struct device_driver drv;
1890a97a 121 struct module *owner;
1da177e4
LT
122};
123
124/*
125 * ACPI Device
126 * -----------
127 */
128
129/* Status (_STA) */
130
131struct acpi_device_status {
4be44fcd
LB
132 u32 present:1;
133 u32 enabled:1;
134 u32 show_in_ui:1;
135 u32 functional:1;
136 u32 battery_present:1;
137 u32 reserved:27;
1da177e4
LT
138};
139
1da177e4
LT
140/* Flags */
141
142struct acpi_device_flags {
4be44fcd 143 u32 dynamic_status:1;
4be44fcd 144 u32 bus_address:1;
4be44fcd
LB
145 u32 removable:1;
146 u32 ejectable:1;
147 u32 lockable:1;
148 u32 suprise_removal_ok:1;
149 u32 power_manageable:1;
150 u32 performance_manageable:1;
d57d09a4 151 u32 reserved:24;
1da177e4
LT
152};
153
1da177e4
LT
154/* File System */
155
156struct acpi_device_dir {
4be44fcd 157 struct proc_dir_entry *entry;
1da177e4
LT
158};
159
160#define acpi_device_dir(d) ((d)->dir.entry)
161
1da177e4
LT
162/* Plug and Play */
163
24c5c4c2 164typedef char acpi_bus_id[8];
4be44fcd 165typedef unsigned long acpi_bus_address;
4be44fcd
LB
166typedef char acpi_device_name[40];
167typedef char acpi_device_class[20];
1da177e4 168
7f47fa6c
BH
169struct acpi_hardware_id {
170 struct list_head list;
171 char *id;
172};
173
1da177e4 174struct acpi_device_pnp {
4be44fcd
LB
175 acpi_bus_id bus_id; /* Object name */
176 acpi_bus_address bus_address; /* _ADR */
15b8dd53 177 char *unique_id; /* _UID */
7f47fa6c 178 struct list_head ids; /* _HID and _CIDs */
4be44fcd
LB
179 acpi_device_name device_name; /* Driver-determined */
180 acpi_device_class device_class; /* " */
1da177e4
LT
181};
182
183#define acpi_device_bid(d) ((d)->pnp.bus_id)
184#define acpi_device_adr(d) ((d)->pnp.bus_address)
620e112c 185const char *acpi_device_hid(struct acpi_device *device);
1da177e4
LT
186#define acpi_device_name(d) ((d)->pnp.device_name)
187#define acpi_device_class(d) ((d)->pnp.device_class)
188
1da177e4
LT
189/* Power Management */
190
191struct acpi_device_power_flags {
4be44fcd
LB
192 u32 explicit_get:1; /* _PSC present? */
193 u32 power_resources:1; /* Power resources */
194 u32 inrush_current:1; /* Serialize Dx->D0 */
195 u32 power_removed:1; /* Optimize Dx->D0 */
196 u32 reserved:28;
1da177e4
LT
197};
198
199struct acpi_device_power_state {
200 struct {
4be44fcd
LB
201 u8 valid:1;
202 u8 explicit_set:1; /* _PSx present? */
203 u8 reserved:6;
204 } flags;
205 int power; /* % Power (compared to D0) */
206 int latency; /* Dx->D0 time (microseconds) */
207 struct acpi_handle_list resources; /* Power resources referenced */
1da177e4
LT
208};
209
210struct acpi_device_power {
4be44fcd 211 int state; /* Current state */
1da177e4 212 struct acpi_device_power_flags flags;
4be44fcd 213 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
1da177e4
LT
214};
215
1da177e4
LT
216/* Performance Management */
217
218struct acpi_device_perf_flags {
4be44fcd 219 u8 reserved:8;
1da177e4
LT
220};
221
222struct acpi_device_perf_state {
223 struct {
4be44fcd
LB
224 u8 valid:1;
225 u8 reserved:7;
226 } flags;
227 u8 power; /* % Power (compared to P0) */
228 u8 performance; /* % Performance ( " ) */
229 int latency; /* Px->P0 time (microseconds) */
1da177e4
LT
230};
231
232struct acpi_device_perf {
4be44fcd 233 int state;
1da177e4 234 struct acpi_device_perf_flags flags;
4be44fcd 235 int state_count;
1da177e4
LT
236 struct acpi_device_perf_state *states;
237};
238
239/* Wakeup Management */
240struct acpi_device_wakeup_flags {
4be44fcd
LB
241 u8 valid:1; /* Can successfully enable wakeup? */
242 u8 run_wake:1; /* Run-Wake GPE devices */
b67ea761 243 u8 notifier_present:1; /* Wake-up notify handler has been installed */
1da177e4
LT
244};
245
1da177e4 246struct acpi_device_wakeup {
4be44fcd 247 acpi_handle gpe_device;
439913ff
LM
248 u64 gpe_number;
249 u64 sleep_state;
4be44fcd 250 struct acpi_handle_list resources;
4be44fcd 251 struct acpi_device_wakeup_flags flags;
9b83ccd2 252 int prepare_count;
1da177e4
LT
253};
254
255/* Device */
256
257struct acpi_device {
caaa6efb
BH
258 int device_type;
259 acpi_handle handle; /* no handle for fixed hardware */
4be44fcd
LB
260 struct acpi_device *parent;
261 struct list_head children;
262 struct list_head node;
263 struct list_head wakeup_list;
1da177e4
LT
264 struct acpi_device_status status;
265 struct acpi_device_flags flags;
4be44fcd 266 struct acpi_device_pnp pnp;
1da177e4
LT
267 struct acpi_device_power power;
268 struct acpi_device_wakeup wakeup;
4be44fcd
LB
269 struct acpi_device_perf performance;
270 struct acpi_device_dir dir;
271 struct acpi_device_ops ops;
272 struct acpi_driver *driver;
273 void *driver_data;
5b327265 274 struct device dev;
c4168bff 275 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
fd350943 276 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
1da177e4
LT
277};
278
db89b4f0
PM
279static inline void *acpi_driver_data(struct acpi_device *d)
280{
281 return d->driver_data;
282}
283
d43ec68e
PM
284#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
285#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
1da177e4 286
55955aad
DB
287/* acpi_device.dev.bus == &acpi_bus_type */
288extern struct bus_type acpi_bus_type;
289
1da177e4
LT
290/*
291 * Events
292 * ------
293 */
294
295struct acpi_bus_event {
4be44fcd
LB
296 struct list_head node;
297 acpi_device_class device_class;
298 acpi_bus_id bus_id;
299 u32 type;
300 u32 data;
1da177e4
LT
301};
302
99e0d2fc 303extern struct kobject *acpi_kobj;
962ce8ca 304extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
8e4319c4 305void acpi_bus_private_data_handler(acpi_handle, void *);
20733939 306int acpi_bus_get_private_data(acpi_handle, void **);
9ee85241
ZR
307extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
308extern int register_acpi_notifier(struct notifier_block *);
309extern int unregister_acpi_notifier(struct notifier_block *);
6bd00a61
SL
310
311extern int register_acpi_bus_notifier(struct notifier_block *nb);
312extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
1da177e4
LT
313/*
314 * External Functions
315 */
316
317int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
8e4319c4 318void acpi_bus_data_handler(acpi_handle handle, void *context);
402ac536
BH
319acpi_status acpi_bus_get_status_handle(acpi_handle handle,
320 unsigned long long *sta);
4be44fcd 321int acpi_bus_get_status(struct acpi_device *device);
4be44fcd 322int acpi_bus_set_power(acpi_handle handle, int state);
25eed407 323int acpi_bus_update_power(acpi_handle handle, int *state_p);
3737b2b1 324bool acpi_bus_power_manageable(acpi_handle handle);
eb9d0fe4 325bool acpi_bus_can_wakeup(acpi_handle handle);
14e04fb3
LB
326#ifdef CONFIG_ACPI_PROC_EVENT
327int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
8db85d4c 328int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
4be44fcd 329int acpi_bus_receive_event(struct acpi_bus_event *event);
14e04fb3
LB
330#else
331static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
332 { return 0; }
333#endif
4be44fcd 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);
fd350943 340acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
8c8eb78f
TR
341int acpi_match_device_ids(struct acpi_device *device,
342 const struct acpi_device_id *ids);
1da177e4
LT
343int acpi_create_dir(struct acpi_device *);
344void acpi_remove_dir(struct acpi_device *);
345
4e10d12a
DSL
346/*
347 * Bind physical devices with ACPI devices
348 */
4e10d12a 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);
22c13f9d 360
76d56de5
AC
361struct acpi_pci_root {
362 struct list_head node;
363 struct acpi_device * device;
364 struct acpi_pci_id id;
365 struct pci_bus *bus;
366 u16 segment;
6ad95513 367 struct resource secondary; /* downstream bus range */
76d56de5
AC
368
369 u32 osc_support_set; /* _OSC state of support bits */
370 u32 osc_control_set; /* _OSC state of control bits */
76d56de5
AC
371};
372
4e10d12a 373/* helper */
439913ff 374acpi_handle acpi_get_child(acpi_handle, u64);
27558203 375int acpi_is_root_bridge(acpi_handle);
4e10d12a 376acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
76d56de5 377struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
465ae641 378#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
4e10d12a 379
b67ea761
RW
380int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
381int acpi_disable_wakeup_device_power(struct acpi_device *dev);
382
aa338601 383#ifdef CONFIG_PM
06166780 384int acpi_pm_device_sleep_state(struct device *, int *);
761afb86 385#else
06166780 386static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
296699de
RW
387{
388 if (p)
389 *p = ACPI_STATE_D0;
390 return ACPI_STATE_D3;
391}
761afb86
RW
392#endif
393
394#ifdef CONFIG_PM_SLEEP
395int acpi_pm_device_sleep_wake(struct device *, bool);
396#else
f7a1b860
DH
397static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
398{
399 return -ENODEV;
400}
761afb86 401#endif
fd4aff1a 402
fd350943 403#endif /* CONFIG_ACPI */
1da177e4
LT
404
405#endif /*__ACPI_BUS_H__*/