[ACPI]
[reactos.git] / reactos / drivers / bus / acpi / include / acpi_bus.h
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
29 #include <acpi.h>
30
31 #include "list.h"
32
33
34 /* TBD: Make dynamic */
35 #define ACPI_MAX_HANDLES 10
36 struct acpi_handle_list {
37 UINT32 count;
38 ACPI_HANDLE handles[ACPI_MAX_HANDLES];
39 };
40
41
42 /* acpi_utils.h */
43 ACPI_STATUS
44 acpi_extract_package (
45 ACPI_OBJECT *package,
46 ACPI_BUFFER *format,
47 ACPI_BUFFER *buffer);
48 ACPI_STATUS
49 acpi_evaluate_integer (
50 ACPI_HANDLE handle,
51 ACPI_STRING pathname,
52 struct acpi_object_list *arguments,
53 unsigned long long *data);
54 ACPI_STATUS
55 acpi_evaluate_reference (
56 ACPI_HANDLE handle,
57 ACPI_STRING pathname,
58 struct acpi_object_list *arguments,
59 struct acpi_handle_list *list);
60
61 enum acpi_bus_removal_type {
62 ACPI_BUS_REMOVAL_NORMAL = 0,
63 ACPI_BUS_REMOVAL_EJECT,
64 ACPI_BUS_REMOVAL_SUPRISE,
65 ACPI_BUS_REMOVAL_TYPE_COUNT
66 };
67
68 enum acpi_bus_device_type {
69 ACPI_BUS_TYPE_DEVICE = 0,
70 ACPI_BUS_TYPE_POWER,
71 ACPI_BUS_TYPE_PROCESSOR,
72 ACPI_BUS_TYPE_THERMAL,
73 ACPI_BUS_TYPE_SYSTEM,
74 ACPI_BUS_TYPE_POWER_BUTTON,
75 ACPI_BUS_TYPE_SLEEP_BUTTON,
76 ACPI_BUS_DEVICE_TYPE_COUNT
77 };
78
79 struct acpi_driver;
80 struct acpi_device;
81
82
83 /*
84 * ACPI Driver
85 * -----------
86 */
87
88 typedef int (*acpi_op_add) (struct acpi_device *device);
89 typedef int (*acpi_op_remove) (struct acpi_device *device, int type);
90 typedef int (*acpi_op_start) (struct acpi_device *device);
91 typedef int (*acpi_op_suspend) (struct acpi_device *device, int state);
92 typedef int (*acpi_op_resume) (struct acpi_device *device, int state);
93 typedef int (*acpi_op_scan) (struct acpi_device *device);
94 typedef int (*acpi_op_bind) (struct acpi_device *device);
95 typedef int (*acpi_op_unbind) (struct acpi_device * device);
96 typedef void (*acpi_op_notify) (struct acpi_device * device, UINT32 event);
97
98 struct acpi_bus_ops {
99 UINT32 acpi_op_add:1;
100 UINT32 acpi_op_start:1;
101 };
102
103 struct acpi_device_ops {
104 acpi_op_add add;
105 acpi_op_remove remove;
106 acpi_op_start start;
107 acpi_op_suspend suspend;
108 acpi_op_resume resume;
109 acpi_op_bind bind;
110 acpi_op_unbind unbind;
111 acpi_op_notify notify;
112 acpi_op_scan scan;
113 };
114
115 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
116
117 struct acpi_driver {
118 struct list_head node;
119 char name[80];
120 char class[80];
121 int references;
122 unsigned int flags;
123 char *ids; /* Supported Hardware IDs */
124 struct acpi_device_ops ops;
125 };
126
127 /*
128 * ACPI Device
129 * -----------
130 */
131
132 /* Status (_STA) */
133
134 struct acpi_device_status {
135 UINT32 present:1;
136 UINT32 enabled:1;
137 UINT32 show_in_ui:1;
138 UINT32 functional:1;
139 UINT32 battery_present:1;
140 UINT32 reserved:27;
141 };
142
143
144 /* Flags */
145
146 struct acpi_device_flags {
147 UINT32 dynamic_status:1;
148 UINT32 hardware_id:1;
149 UINT32 compatible_ids:1;
150 UINT32 bus_address:1;
151 UINT32 unique_id:1;
152 UINT32 removable:1;
153 UINT32 ejectable:1;
154 UINT32 lockable:1;
155 UINT32 suprise_removal_ok:1;
156 UINT32 power_manageable:1;
157 UINT32 performance_manageable:1;
158 UINT32 wake_capable:1;
159 UINT32 force_power_state:1;
160 UINT32 reserved:20;
161 };
162
163 /* Plug and Play */
164
165 typedef char acpi_bus_id[8];
166 typedef unsigned long acpi_bus_address;
167 typedef char acpi_hardware_id[9];
168 typedef char acpi_unique_id[9];
169 typedef char acpi_device_name[40];
170 typedef char acpi_device_class[20];
171
172 struct acpi_device_pnp {
173 acpi_bus_id bus_id; /* Object name */
174 acpi_bus_address bus_address; /* _ADR */
175 acpi_hardware_id hardware_id; /* _HID */
176 ACPI_DEVICE_ID_LIST *cid_list; /* _CIDs */
177 acpi_unique_id unique_id; /* _UID */
178 acpi_device_name device_name; /* Driver-determined */
179 acpi_device_class device_class; /* " */
180 };
181
182 #define acpi_device_bid(d) ((d)->pnp.bus_id)
183 #define acpi_device_adr(d) ((d)->pnp.bus_address)
184 #define acpi_device_hid(d) ((d)->pnp.hardware_id)
185 #define acpi_device_uid(d) ((d)->pnp.unique_id)
186 #define acpi_device_name(d) ((d)->pnp.device_name)
187 #define acpi_device_class(d) ((d)->pnp.device_class)
188
189
190 /* Power Management */
191
192 struct acpi_device_power_flags {
193 UINT32 explicit_get:1; /* _PSC present? */
194 UINT32 power_resources:1; /* Power resources */
195 UINT32 inrush_current:1; /* Serialize Dx->D0 */
196 UINT32 power_removed:1; /* Optimize Dx->D0 */
197 UINT32 reserved:28;
198 };
199
200 struct acpi_device_power_state {
201 struct {
202 UINT8 valid:1;
203 UINT8 explicit_set:1; /* _PSx present? */
204 UINT8 reserved:6;
205 } flags;
206 int power; /* % Power (compared to D0) */
207 int latency; /* Dx->D0 time (microseconds) */
208 struct acpi_handle_list resources; /* Power resources referenced */
209 };
210
211 struct acpi_device_power {
212 int state; /* Current state */
213 struct acpi_device_power_flags flags;
214 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
215 };
216
217
218 /* Performance Management */
219
220 struct acpi_device_perf_flags {
221 UINT8 reserved:8;
222 };
223
224 struct acpi_device_perf_state {
225 struct {
226 UINT8 valid:1;
227 UINT8 reserved:7;
228 } flags;
229 UINT8 power; /* % Power (compared to P0) */
230 UINT8 performance; /* % Performance ( " ) */
231 int latency; /* Px->P0 time (microseconds) */
232 };
233
234 struct acpi_device_perf {
235 int state;
236 struct acpi_device_perf_flags flags;
237 int state_count;
238 struct acpi_device_perf_state *states;
239 };
240
241 /* Wakeup Management */
242 struct acpi_device_wakeup_flags {
243 UINT8 valid:1; /* Can successfully enable wakeup? */
244 UINT8 run_wake:1; /* Run-Wake GPE devices */
245 };
246
247 struct acpi_device_wakeup_state {
248 UINT8 enabled:1;
249 };
250
251 struct acpi_device_wakeup {
252 ACPI_HANDLE gpe_device;
253 ACPI_INTEGER gpe_number;
254 ACPI_INTEGER sleep_state;
255 struct acpi_handle_list resources;
256 struct acpi_device_wakeup_state state;
257 struct acpi_device_wakeup_flags flags;
258 int prepare_count;
259 };
260
261
262 /* Device */
263
264 struct acpi_device {
265 int device_type;
266 ACPI_HANDLE handle;
267 struct acpi_device *parent;
268 struct list_head children;
269 struct list_head node;
270 struct list_head wakeup_list;
271 struct acpi_device_status status;
272 struct acpi_device_flags flags;
273 struct acpi_device_pnp pnp;
274 struct acpi_device_power power;
275 struct acpi_device_wakeup wakeup;
276 struct acpi_device_perf performance;
277 struct acpi_device_ops ops;
278 struct acpi_driver *driver;
279 void *driver_data;
280 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
281 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
282
283 };
284
285 #define acpi_driver_data(d) ((d)->driver_data)
286
287 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
288 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
289
290 /* acpi_device.dev.bus == &acpi_bus_type */
291 extern struct bus_type acpi_bus_type;
292
293 /*
294 * Events
295 * ------
296 */
297
298 struct acpi_bus_event {
299 struct list_head node;
300 acpi_device_class device_class;
301 acpi_bus_id bus_id;
302 UINT32 type;
303 UINT32 data;
304 };
305
306
307 /*
308 * External Functions
309 */
310 int acpi_bus_get_private_data(ACPI_HANDLE, void **);
311
312 void acpi_bus_data_handler(ACPI_HANDLE handle, void *context);
313 ACPI_STATUS acpi_bus_get_status_handle(ACPI_HANDLE handle,
314 unsigned long long *sta);
315 int acpi_bus_get_status(struct acpi_device *device);
316 int acpi_bus_get_power(ACPI_HANDLE handle, int *state);
317 int acpi_bus_set_power(ACPI_HANDLE handle, int state);
318 BOOLEAN acpi_bus_power_manageable(ACPI_HANDLE handle);
319 BOOLEAN acpi_bus_can_wakeup(ACPI_HANDLE handle);
320 int acpi_bus_generate_proc_event(struct acpi_device *device, UINT8 type, int data);
321 int acpi_bus_generate_event(struct acpi_device *device, UINT8 type, int data);
322 int acpi_bus_receive_event(struct acpi_bus_event *event);
323 int acpi_bus_register_driver(struct acpi_driver *driver);
324 void acpi_bus_unregister_driver(struct acpi_driver *driver);
325 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
326 ACPI_HANDLE handle, int type);
327 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
328 int acpi_bus_start(struct acpi_device *device);
329 ACPI_STATUS acpi_bus_get_ejd(ACPI_HANDLE handle, ACPI_HANDLE * ejd);
330 int acpi_match_device_ids(struct acpi_device *device,
331 const struct acpi_device_id *ids);
332 int acpi_bus_get_device(ACPI_HANDLE handle, struct acpi_device **device);
333 int acpi_init(void);
334 ACPI_STATUS acpi_suspend (UINT32 state);
335
336 /*
337 * Bind physical devices with ACPI devices
338 */
339 //struct acpi_bus_type {
340 // struct list_head list;
341 // struct bus_type *bus;
342 // /* For general devices under the bus */
343 // int (*find_device) (struct device *, ACPI_HANDLE *);
344 // /* For bridges, such as PCI root bridge, IDE controller */
345 // int (*find_bridge) (struct device *, ACPI_HANDLE *);
346 //};
347 //int register_acpi_bus_type(struct acpi_bus_type *);
348 //int unregister_acpi_bus_type(struct acpi_bus_type *);
349 //struct device *acpi_get_physical_device(ACPI_HANDLE);
350
351 struct acpi_pci_root {
352 struct list_head node;
353 struct acpi_device * device;
354 struct acpi_pci_id id;
355 struct pci_bus *bus;
356 UINT16 segment;
357 UINT8 bus_nr;
358
359 UINT32 osc_support_set; /* _OSC state of support bits */
360 UINT32 osc_control_set; /* _OSC state of control bits */
361 UINT32 osc_control_qry; /* the latest _OSC query result */
362
363 UINT32 osc_queried:1; /* has _OSC control been queried? */
364 };
365
366 //static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
367 //{
368 // if (p)
369 // *p = ACPI_STATE_D0;
370 // return ACPI_STATE_D3;
371 //}
372 //static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
373 //{
374 // return -1;
375 //}
376
377 /* system defines: move to bigger header */
378 extern enum acpi_irq_model_id acpi_irq_model;
379
380 enum acpi_irq_model_id {
381 ACPI_IRQ_MODEL_PIC = 0,
382 ACPI_IRQ_MODEL_IOAPIC,
383 ACPI_IRQ_MODEL_IOSAPIC,
384 ACPI_IRQ_MODEL_COUNT
385 };
386
387
388
389 #endif /*__ACPI_BUS_H__*/