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