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 no_hotplug:1; 173 u32 reserved:26; 174 }; 175 176 /* File System */ 177 178 struct acpi_device_dir { 179 struct proc_dir_entry *entry; 180 }; 181 182 #define acpi_device_dir(d) ((d)->dir.entry) 183 184 /* Plug and Play */ 185 186 typedef char acpi_bus_id[8]; 187 typedef unsigned long acpi_bus_address; 188 typedef char acpi_device_name[40]; 189 typedef char acpi_device_class[20]; 190 191 struct acpi_hardware_id { 192 struct list_head list; 193 char *id; 194 }; 195 196 struct acpi_pnp_type { 197 u32 hardware_id:1; 198 u32 bus_address:1; 199 u32 reserved:30; 200 }; 201 202 struct acpi_device_pnp { 203 acpi_bus_id bus_id; /* Object name */ 204 struct acpi_pnp_type type; /* ID type */ 205 acpi_bus_address bus_address; /* _ADR */ 206 char *unique_id; /* _UID */ 207 struct list_head ids; /* _HID and _CIDs */ 208 acpi_device_name device_name; /* Driver-determined */ 209 acpi_device_class device_class; /* " */ 210 union acpi_object *str_obj; /* unicode string for _STR method */ 211 unsigned long sun; /* _SUN */ 212 }; 213 214 #define acpi_device_bid(d) ((d)->pnp.bus_id) 215 #define acpi_device_adr(d) ((d)->pnp.bus_address) 216 const char *acpi_device_hid(struct acpi_device *device); 217 #define acpi_device_name(d) ((d)->pnp.device_name) 218 #define acpi_device_class(d) ((d)->pnp.device_class) 219 220 /* Power Management */ 221 222 struct acpi_device_power_flags { 223 u32 explicit_get:1; /* _PSC present? */ 224 u32 power_resources:1; /* Power resources */ 225 u32 inrush_current:1; /* Serialize Dx->D0 */ 226 u32 power_removed:1; /* Optimize Dx->D0 */ 227 u32 ignore_parent:1; /* Power is independent of parent power state */ 228 u32 reserved:27; 229 }; 230 231 struct acpi_device_power_state { 232 struct { 233 u8 valid:1; 234 u8 os_accessible:1; 235 u8 explicit_set:1; /* _PSx present? */ 236 u8 reserved:6; 237 } flags; 238 int power; /* % Power (compared to D0) */ 239 int latency; /* Dx->D0 time (microseconds) */ 240 struct list_head resources; /* Power resources referenced */ 241 }; 242 243 struct acpi_device_power { 244 int state; /* Current state */ 245 struct acpi_device_power_flags flags; 246 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 247 }; 248 249 /* Performance Management */ 250 251 struct acpi_device_perf_flags { 252 u8 reserved:8; 253 }; 254 255 struct acpi_device_perf_state { 256 struct { 257 u8 valid:1; 258 u8 reserved:7; 259 } flags; 260 u8 power; /* % Power (compared to P0) */ 261 u8 performance; /* % Performance ( " ) */ 262 int latency; /* Px->P0 time (microseconds) */ 263 }; 264 265 struct acpi_device_perf { 266 int state; 267 struct acpi_device_perf_flags flags; 268 int state_count; 269 struct acpi_device_perf_state *states; 270 }; 271 272 /* Wakeup Management */ 273 struct acpi_device_wakeup_flags { 274 u8 valid:1; /* Can successfully enable wakeup? */ 275 u8 run_wake:1; /* Run-Wake GPE devices */ 276 u8 notifier_present:1; /* Wake-up notify handler has been installed */ 277 }; 278 279 struct acpi_device_wakeup { 280 acpi_handle gpe_device; 281 u64 gpe_number; 282 u64 sleep_state; 283 struct list_head resources; 284 struct acpi_device_wakeup_flags flags; 285 int prepare_count; 286 }; 287 288 struct acpi_device_physical_node { 289 unsigned int node_id; 290 struct list_head node; 291 struct device *dev; 292 bool put_online:1; 293 }; 294 295 /* Device */ 296 struct acpi_device { 297 int device_type; 298 acpi_handle handle; /* no handle for fixed hardware */ 299 struct acpi_device *parent; 300 struct list_head children; 301 struct list_head node; 302 struct list_head wakeup_list; 303 struct acpi_device_status status; 304 struct acpi_device_flags flags; 305 struct acpi_device_pnp pnp; 306 struct acpi_device_power power; 307 struct acpi_device_wakeup wakeup; 308 struct acpi_device_perf performance; 309 struct acpi_device_dir dir; 310 struct acpi_scan_handler *handler; 311 struct acpi_driver *driver; 312 void *driver_data; 313 struct device dev; 314 unsigned int physical_node_count; 315 struct list_head physical_node_list; 316 struct mutex physical_node_lock; 317 void (*remove)(struct acpi_device *); 318 }; 319 320 static inline void *acpi_driver_data(struct acpi_device *d) 321 { 322 return d->driver_data; 323 } 324 325 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 326 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 327 328 /* acpi_device.dev.bus == &acpi_bus_type */ 329 extern struct bus_type acpi_bus_type; 330 331 /* 332 * Events 333 * ------ 334 */ 335 336 struct acpi_bus_event { 337 struct list_head node; 338 acpi_device_class device_class; 339 acpi_bus_id bus_id; 340 u32 type; 341 u32 data; 342 }; 343 344 extern struct kobject *acpi_kobj; 345 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 346 void acpi_bus_private_data_handler(acpi_handle, void *); 347 int acpi_bus_get_private_data(acpi_handle, void **); 348 void acpi_bus_no_hotplug(acpi_handle handle); 349 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 350 extern int register_acpi_notifier(struct notifier_block *); 351 extern int unregister_acpi_notifier(struct notifier_block *); 352 353 /* 354 * External Functions 355 */ 356 357 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 358 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 359 unsigned long long *sta); 360 int acpi_bus_get_status(struct acpi_device *device); 361 362 int acpi_bus_set_power(acpi_handle handle, int state); 363 const char *acpi_power_state_string(int state); 364 int acpi_device_get_power(struct acpi_device *device, int *state); 365 int acpi_device_set_power(struct acpi_device *device, int state); 366 int acpi_bus_init_power(struct acpi_device *device); 367 int acpi_device_fix_up_power(struct acpi_device *device); 368 int acpi_bus_update_power(acpi_handle handle, int *state_p); 369 bool acpi_bus_power_manageable(acpi_handle handle); 370 371 #ifdef CONFIG_PM 372 bool acpi_bus_can_wakeup(acpi_handle handle); 373 #else 374 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 375 #endif 376 377 void acpi_scan_lock_acquire(void); 378 void acpi_scan_lock_release(void); 379 int acpi_scan_add_handler(struct acpi_scan_handler *handler); 380 int acpi_bus_register_driver(struct acpi_driver *driver); 381 void acpi_bus_unregister_driver(struct acpi_driver *driver); 382 int acpi_bus_scan(acpi_handle handle); 383 void acpi_bus_trim(struct acpi_device *start); 384 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 385 int acpi_match_device_ids(struct acpi_device *device, 386 const struct acpi_device_id *ids); 387 int acpi_create_dir(struct acpi_device *); 388 void acpi_remove_dir(struct acpi_device *); 389 390 typedef void (*acpi_hp_callback)(void *data, u32 src); 391 392 acpi_status acpi_hotplug_execute(acpi_hp_callback func, void *data, u32 src); 393 394 /** 395 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 396 * @__acpi_driver: acpi_driver struct 397 * 398 * Helper macro for ACPI drivers which do not do anything special in module 399 * init/exit. This eliminates a lot of boilerplate. Each module may only 400 * use this macro once, and calling it replaces module_init() and module_exit() 401 */ 402 #define module_acpi_driver(__acpi_driver) \ 403 module_driver(__acpi_driver, acpi_bus_register_driver, \ 404 acpi_bus_unregister_driver) 405 406 /* 407 * Bind physical devices with ACPI devices 408 */ 409 struct acpi_bus_type { 410 struct list_head list; 411 const char *name; 412 bool (*match)(struct device *dev); 413 int (*find_device) (struct device *, acpi_handle *); 414 void (*setup)(struct device *); 415 void (*cleanup)(struct device *); 416 }; 417 int register_acpi_bus_type(struct acpi_bus_type *); 418 int unregister_acpi_bus_type(struct acpi_bus_type *); 419 420 struct acpi_pci_root { 421 struct acpi_device * device; 422 struct pci_bus *bus; 423 u16 segment; 424 struct resource secondary; /* downstream bus range */ 425 426 u32 osc_support_set; /* _OSC state of support bits */ 427 u32 osc_control_set; /* _OSC state of control bits */ 428 phys_addr_t mcfg_addr; 429 }; 430 431 /* helper */ 432 acpi_handle acpi_find_child(acpi_handle, u64, bool); 433 static inline acpi_handle acpi_get_child(acpi_handle handle, u64 addr) 434 { 435 return acpi_find_child(handle, addr, false); 436 } 437 void acpi_preset_companion(struct device *dev, acpi_handle parent, u64 addr); 438 int acpi_is_root_bridge(acpi_handle); 439 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 440 441 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 442 int acpi_disable_wakeup_device_power(struct acpi_device *dev); 443 444 #ifdef CONFIG_PM 445 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 446 acpi_notify_handler handler, void *context); 447 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev, 448 acpi_notify_handler handler); 449 int acpi_pm_device_sleep_state(struct device *, int *, int); 450 #else 451 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 452 acpi_notify_handler handler, 453 void *context) 454 { 455 return AE_SUPPORT; 456 } 457 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev, 458 acpi_notify_handler handler) 459 { 460 return AE_SUPPORT; 461 } 462 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 463 { 464 if (p) 465 *p = ACPI_STATE_D0; 466 467 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 468 m : ACPI_STATE_D0; 469 } 470 #endif 471 472 #ifdef CONFIG_PM_RUNTIME 473 int __acpi_device_run_wake(struct acpi_device *, bool); 474 int acpi_pm_device_run_wake(struct device *, bool); 475 #else 476 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en) 477 { 478 return -ENODEV; 479 } 480 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable) 481 { 482 return -ENODEV; 483 } 484 #endif 485 486 #ifdef CONFIG_PM_SLEEP 487 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool); 488 int acpi_pm_device_sleep_wake(struct device *, bool); 489 #else 490 static inline int __acpi_device_sleep_wake(struct acpi_device *adev, 491 u32 target_state, bool enable) 492 { 493 return -ENODEV; 494 } 495 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable) 496 { 497 return -ENODEV; 498 } 499 #endif 500 501 #ifdef CONFIG_ACPI_SLEEP 502 u32 acpi_target_system_state(void); 503 #else 504 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 505 #endif 506 507 static inline bool acpi_device_power_manageable(struct acpi_device *adev) 508 { 509 return adev->flags.power_manageable; 510 } 511 512 static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 513 { 514 return adev->wakeup.flags.valid; 515 } 516 517 static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 518 { 519 return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible; 520 } 521 522 #else /* CONFIG_ACPI */ 523 524 static inline int register_acpi_bus_type(void *bus) { return 0; } 525 static inline int unregister_acpi_bus_type(void *bus) { return 0; } 526 527 #endif /* CONFIG_ACPI */ 528 529 #endif /*__ACPI_BUS_H__*/ 530