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