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