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 <linux/device.h> 30 31 #include <acpi/acpi.h> 32 33 /* TBD: Make dynamic */ 34 #define ACPI_MAX_HANDLES 10 35 struct acpi_handle_list { 36 u32 count; 37 acpi_handle handles[ACPI_MAX_HANDLES]; 38 }; 39 40 /* acpi_utils.h */ 41 acpi_status 42 acpi_extract_package(union acpi_object *package, 43 struct acpi_buffer *format, struct acpi_buffer *buffer); 44 acpi_status 45 acpi_evaluate_integer(acpi_handle handle, 46 acpi_string pathname, 47 struct acpi_object_list *arguments, unsigned long long *data); 48 acpi_status 49 acpi_evaluate_reference(acpi_handle handle, 50 acpi_string pathname, 51 struct acpi_object_list *arguments, 52 struct acpi_handle_list *list); 53 acpi_status 54 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event, 55 u32 status_code, struct acpi_buffer *status_buf); 56 57 acpi_status 58 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); 59 #ifdef CONFIG_ACPI 60 61 #include <linux/proc_fs.h> 62 63 #define ACPI_BUS_FILE_ROOT "acpi" 64 extern struct proc_dir_entry *acpi_root_dir; 65 66 enum acpi_bus_device_type { 67 ACPI_BUS_TYPE_DEVICE = 0, 68 ACPI_BUS_TYPE_POWER, 69 ACPI_BUS_TYPE_PROCESSOR, 70 ACPI_BUS_TYPE_THERMAL, 71 ACPI_BUS_TYPE_POWER_BUTTON, 72 ACPI_BUS_TYPE_SLEEP_BUTTON, 73 ACPI_BUS_DEVICE_TYPE_COUNT 74 }; 75 76 struct acpi_driver; 77 struct acpi_device; 78 79 /* 80 * ACPI Scan Handler 81 * ----------------- 82 */ 83 84 enum acpi_hotplug_mode { 85 AHM_GENERIC = 0, 86 AHM_CONTAINER, 87 AHM_COUNT 88 }; 89 90 struct acpi_hotplug_profile { 91 struct kobject kobj; 92 bool enabled:1; 93 enum acpi_hotplug_mode mode; 94 }; 95 96 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile( 97 struct kobject *kobj) 98 { 99 return container_of(kobj, struct acpi_hotplug_profile, kobj); 100 } 101 102 struct acpi_scan_handler { 103 const struct acpi_device_id *ids; 104 struct list_head list_node; 105 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 106 void (*detach)(struct acpi_device *dev); 107 struct acpi_hotplug_profile hotplug; 108 }; 109 110 /* 111 * ACPI Driver 112 * ----------- 113 */ 114 115 typedef int (*acpi_op_add) (struct acpi_device * device); 116 typedef int (*acpi_op_remove) (struct acpi_device * device); 117 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 118 119 struct acpi_device_ops { 120 acpi_op_add add; 121 acpi_op_remove remove; 122 acpi_op_notify notify; 123 }; 124 125 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 126 127 struct acpi_driver { 128 char name[80]; 129 char class[80]; 130 const struct acpi_device_id *ids; /* Supported Hardware IDs */ 131 unsigned int flags; 132 struct acpi_device_ops ops; 133 struct device_driver drv; 134 struct module *owner; 135 }; 136 137 /* 138 * ACPI Device 139 * ----------- 140 */ 141 142 /* Status (_STA) */ 143 144 struct acpi_device_status { 145 u32 present:1; 146 u32 enabled:1; 147 u32 show_in_ui:1; 148 u32 functional:1; 149 u32 battery_present:1; 150 u32 reserved:27; 151 }; 152 153 /* Flags */ 154 155 struct acpi_device_flags { 156 u32 dynamic_status:1; 157 u32 removable:1; 158 u32 ejectable:1; 159 u32 power_manageable:1; 160 u32 eject_pending:1; 161 u32 match_driver:1; 162 u32 reserved:26; 163 }; 164 165 /* File System */ 166 167 struct acpi_device_dir { 168 struct proc_dir_entry *entry; 169 }; 170 171 #define acpi_device_dir(d) ((d)->dir.entry) 172 173 /* Plug and Play */ 174 175 typedef char acpi_bus_id[8]; 176 typedef unsigned long acpi_bus_address; 177 typedef char acpi_device_name[40]; 178 typedef char acpi_device_class[20]; 179 180 struct acpi_hardware_id { 181 struct list_head list; 182 char *id; 183 }; 184 185 struct acpi_pnp_type { 186 u32 hardware_id:1; 187 u32 bus_address:1; 188 u32 reserved:30; 189 }; 190 191 struct acpi_device_pnp { 192 acpi_bus_id bus_id; /* Object name */ 193 struct acpi_pnp_type type; /* ID type */ 194 acpi_bus_address bus_address; /* _ADR */ 195 char *unique_id; /* _UID */ 196 struct list_head ids; /* _HID and _CIDs */ 197 acpi_device_name device_name; /* Driver-determined */ 198 acpi_device_class device_class; /* " */ 199 union acpi_object *str_obj; /* unicode string for _STR method */ 200 unsigned long sun; /* _SUN */ 201 }; 202 203 #define acpi_device_bid(d) ((d)->pnp.bus_id) 204 #define acpi_device_adr(d) ((d)->pnp.bus_address) 205 const char *acpi_device_hid(struct acpi_device *device); 206 #define acpi_device_name(d) ((d)->pnp.device_name) 207 #define acpi_device_class(d) ((d)->pnp.device_class) 208 209 /* Power Management */ 210 211 struct acpi_device_power_flags { 212 u32 explicit_get:1; /* _PSC present? */ 213 u32 power_resources:1; /* Power resources */ 214 u32 inrush_current:1; /* Serialize Dx->D0 */ 215 u32 power_removed:1; /* Optimize Dx->D0 */ 216 u32 reserved:28; 217 }; 218 219 struct acpi_device_power_state { 220 struct { 221 u8 valid:1; 222 u8 os_accessible: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 list_head resources; /* Power resources referenced */ 229 }; 230 231 struct acpi_device_power { 232 int state; /* Current state */ 233 struct acpi_device_power_flags flags; 234 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 235 }; 236 237 /* Performance Management */ 238 239 struct acpi_device_perf_flags { 240 u8 reserved:8; 241 }; 242 243 struct acpi_device_perf_state { 244 struct { 245 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) */ 251 }; 252 253 struct acpi_device_perf { 254 int state; 255 struct acpi_device_perf_flags flags; 256 int state_count; 257 struct acpi_device_perf_state *states; 258 }; 259 260 /* Wakeup Management */ 261 struct acpi_device_wakeup_flags { 262 u8 valid:1; /* Can successfully enable wakeup? */ 263 u8 run_wake:1; /* Run-Wake GPE devices */ 264 u8 notifier_present:1; /* Wake-up notify handler has been installed */ 265 }; 266 267 struct acpi_device_wakeup { 268 acpi_handle gpe_device; 269 u64 gpe_number; 270 u64 sleep_state; 271 struct list_head resources; 272 struct acpi_device_wakeup_flags flags; 273 int prepare_count; 274 }; 275 276 struct acpi_device_physical_node { 277 u8 node_id; 278 struct list_head node; 279 struct device *dev; 280 bool put_online:1; 281 }; 282 283 /* set maximum of physical nodes to 32 for expansibility */ 284 #define ACPI_MAX_PHYSICAL_NODE 32 285 286 /* Device */ 287 struct acpi_device { 288 int device_type; 289 acpi_handle handle; /* no handle for fixed hardware */ 290 struct acpi_device *parent; 291 struct list_head children; 292 struct list_head node; 293 struct list_head wakeup_list; 294 struct acpi_device_status status; 295 struct acpi_device_flags flags; 296 struct acpi_device_pnp pnp; 297 struct acpi_device_power power; 298 struct acpi_device_wakeup wakeup; 299 struct acpi_device_perf performance; 300 struct acpi_device_dir dir; 301 struct acpi_scan_handler *handler; 302 struct acpi_driver *driver; 303 void *driver_data; 304 struct device dev; 305 u8 physical_node_count; 306 struct list_head physical_node_list; 307 struct mutex physical_node_lock; 308 DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE); 309 struct list_head power_dependent; 310 void (*remove)(struct acpi_device *); 311 }; 312 313 static inline void *acpi_driver_data(struct acpi_device *d) 314 { 315 return d->driver_data; 316 } 317 318 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 319 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 320 321 /* acpi_device.dev.bus == &acpi_bus_type */ 322 extern struct bus_type acpi_bus_type; 323 324 /* 325 * Events 326 * ------ 327 */ 328 329 struct acpi_bus_event { 330 struct list_head node; 331 acpi_device_class device_class; 332 acpi_bus_id bus_id; 333 u32 type; 334 u32 data; 335 }; 336 337 struct acpi_eject_event { 338 struct acpi_device *device; 339 u32 event; 340 }; 341 342 struct acpi_hp_work { 343 struct work_struct work; 344 acpi_handle handle; 345 u32 type; 346 void *context; 347 }; 348 void alloc_acpi_hp_work(acpi_handle handle, u32 type, void *context, 349 void (*func)(struct work_struct *work)); 350 351 extern struct kobject *acpi_kobj; 352 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 353 void acpi_bus_private_data_handler(acpi_handle, void *); 354 int acpi_bus_get_private_data(acpi_handle, void **); 355 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 356 extern int register_acpi_notifier(struct notifier_block *); 357 extern int unregister_acpi_notifier(struct notifier_block *); 358 359 extern int register_acpi_bus_notifier(struct notifier_block *nb); 360 extern void unregister_acpi_bus_notifier(struct notifier_block *nb); 361 /* 362 * External Functions 363 */ 364 365 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 366 void acpi_bus_data_handler(acpi_handle handle, void *context); 367 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 368 unsigned long long *sta); 369 int acpi_bus_get_status(struct acpi_device *device); 370 371 int acpi_bus_set_power(acpi_handle handle, int state); 372 const char *acpi_power_state_string(int state); 373 int acpi_device_get_power(struct acpi_device *device, int *state); 374 int acpi_device_set_power(struct acpi_device *device, int state); 375 int acpi_bus_init_power(struct acpi_device *device); 376 int acpi_device_fix_up_power(struct acpi_device *device); 377 int acpi_bus_update_power(acpi_handle handle, int *state_p); 378 bool acpi_bus_power_manageable(acpi_handle handle); 379 380 #ifdef CONFIG_PM 381 bool acpi_bus_can_wakeup(acpi_handle handle); 382 #else 383 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 384 #endif 385 386 #ifdef CONFIG_ACPI_PROC_EVENT 387 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data); 388 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data); 389 int acpi_bus_receive_event(struct acpi_bus_event *event); 390 #else 391 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data) 392 { return 0; } 393 #endif 394 395 void acpi_scan_lock_acquire(void); 396 void acpi_scan_lock_release(void); 397 int acpi_scan_add_handler(struct acpi_scan_handler *handler); 398 int acpi_bus_register_driver(struct acpi_driver *driver); 399 void acpi_bus_unregister_driver(struct acpi_driver *driver); 400 int acpi_bus_scan(acpi_handle handle); 401 void acpi_bus_hot_remove_device(void *context); 402 void acpi_bus_trim(struct acpi_device *start); 403 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 404 int acpi_match_device_ids(struct acpi_device *device, 405 const struct acpi_device_id *ids); 406 int acpi_create_dir(struct acpi_device *); 407 void acpi_remove_dir(struct acpi_device *); 408 409 410 /** 411 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 412 * @__acpi_driver: acpi_driver struct 413 * 414 * Helper macro for ACPI drivers which do not do anything special in module 415 * init/exit. This eliminates a lot of boilerplate. Each module may only 416 * use this macro once, and calling it replaces module_init() and module_exit() 417 */ 418 #define module_acpi_driver(__acpi_driver) \ 419 module_driver(__acpi_driver, acpi_bus_register_driver, \ 420 acpi_bus_unregister_driver) 421 422 /* 423 * Bind physical devices with ACPI devices 424 */ 425 struct acpi_bus_type { 426 struct list_head list; 427 const char *name; 428 bool (*match)(struct device *dev); 429 int (*find_device) (struct device *, acpi_handle *); 430 void (*setup)(struct device *); 431 void (*cleanup)(struct device *); 432 }; 433 int register_acpi_bus_type(struct acpi_bus_type *); 434 int unregister_acpi_bus_type(struct acpi_bus_type *); 435 436 struct acpi_pci_root { 437 struct acpi_device * device; 438 struct pci_bus *bus; 439 u16 segment; 440 struct resource secondary; /* downstream bus range */ 441 442 u32 osc_support_set; /* _OSC state of support bits */ 443 u32 osc_control_set; /* _OSC state of control bits */ 444 phys_addr_t mcfg_addr; 445 }; 446 447 /* helper */ 448 acpi_handle acpi_get_child(acpi_handle, u64); 449 int acpi_is_root_bridge(acpi_handle); 450 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 451 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev)) 452 453 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 454 int acpi_disable_wakeup_device_power(struct acpi_device *dev); 455 456 #ifdef CONFIG_PM 457 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 458 acpi_notify_handler handler, void *context); 459 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev, 460 acpi_notify_handler handler); 461 int acpi_pm_device_sleep_state(struct device *, int *, int); 462 void acpi_dev_pm_add_dependent(acpi_handle handle, struct device *depdev); 463 void acpi_dev_pm_remove_dependent(acpi_handle handle, struct device *depdev); 464 #else 465 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 466 acpi_notify_handler handler, 467 void *context) 468 { 469 return AE_SUPPORT; 470 } 471 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev, 472 acpi_notify_handler handler) 473 { 474 return AE_SUPPORT; 475 } 476 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 477 { 478 if (p) 479 *p = ACPI_STATE_D0; 480 481 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0; 482 } 483 static inline void acpi_dev_pm_add_dependent(acpi_handle handle, 484 struct device *depdev) {} 485 static inline void acpi_dev_pm_remove_dependent(acpi_handle handle, 486 struct device *depdev) {} 487 #endif 488 489 #ifdef CONFIG_PM_RUNTIME 490 int __acpi_device_run_wake(struct acpi_device *, bool); 491 int acpi_pm_device_run_wake(struct device *, bool); 492 #else 493 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en) 494 { 495 return -ENODEV; 496 } 497 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable) 498 { 499 return -ENODEV; 500 } 501 #endif 502 503 #ifdef CONFIG_PM_SLEEP 504 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool); 505 int acpi_pm_device_sleep_wake(struct device *, bool); 506 #else 507 static inline int __acpi_device_sleep_wake(struct acpi_device *adev, 508 u32 target_state, bool enable) 509 { 510 return -ENODEV; 511 } 512 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable) 513 { 514 return -ENODEV; 515 } 516 #endif 517 518 #ifdef CONFIG_ACPI_SLEEP 519 u32 acpi_target_system_state(void); 520 #else 521 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 522 #endif 523 524 static inline bool acpi_device_power_manageable(struct acpi_device *adev) 525 { 526 return adev->flags.power_manageable; 527 } 528 529 static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 530 { 531 return adev->wakeup.flags.valid; 532 } 533 534 static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 535 { 536 return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible; 537 } 538 539 #else /* CONFIG_ACPI */ 540 541 static inline int register_acpi_bus_type(void *bus) { return 0; } 542 static inline int unregister_acpi_bus_type(void *bus) { return 0; } 543 544 #endif /* CONFIG_ACPI */ 545 546 #endif /*__ACPI_BUS_H__*/ 547