include/acpi/acpi_bus.h

   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 struct acpi_pld {
  58         unsigned int revision:7; /* 0 */
  59         unsigned int ignore_colour:1; /* 7 */
  60         unsigned int colour:24; /* 8 */
  61         unsigned int width:16; /* 32 */
  62         unsigned int height:16; /* 48 */
  63         unsigned int user_visible:1; /* 64 */
  64         unsigned int dock:1; /* 65 */
  65         unsigned int lid:1; /* 66 */
  66         unsigned int panel:3; /* 67 */
  67         unsigned int vertical_pos:2; /* 70 */
  68         unsigned int horizontal_pos:2; /* 72 */
  69         unsigned int shape:4; /* 74 */
  70         unsigned int group_orientation:1; /* 78 */
  71         unsigned int group_token:8; /* 79 */
  72         unsigned int group_position:8; /* 87 */
  73         unsigned int bay:1; /* 95 */
  74         unsigned int ejectable:1; /* 96 */
  75         unsigned int ospm_eject_required:1; /* 97 */
  76         unsigned int cabinet_number:8; /* 98 */
  77         unsigned int card_cage_number:8; /* 106 */
  78         unsigned int reference:1; /* 114 */
  79         unsigned int rotation:4; /* 115 */
  80         unsigned int order:5; /* 119 */
  81         unsigned int reserved:4; /* 124 */
  82         unsigned int vertical_offset:16; /* 128 */
  83         unsigned int horizontal_offset:16; /* 144 */
  84 } __attribute__((__packed__));
  85
  86 acpi_status
  87 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld *pld);
  88 #ifdef CONFIG_ACPI
  89
  90 #include <linux/proc_fs.h>
  91
  92 #define ACPI_BUS_FILE_ROOT      "acpi"
  93 extern struct proc_dir_entry *acpi_root_dir;
  94
  95 enum acpi_bus_removal_type {
  96         ACPI_BUS_REMOVAL_NORMAL = 0,
  97         ACPI_BUS_REMOVAL_EJECT,
  98         ACPI_BUS_REMOVAL_SUPRISE,
  99         ACPI_BUS_REMOVAL_TYPE_COUNT
 100 };
 101
 102 enum acpi_bus_device_type {
 103         ACPI_BUS_TYPE_DEVICE = 0,
 104         ACPI_BUS_TYPE_POWER,
 105         ACPI_BUS_TYPE_PROCESSOR,
 106         ACPI_BUS_TYPE_THERMAL,
 107         ACPI_BUS_TYPE_POWER_BUTTON,
 108         ACPI_BUS_TYPE_SLEEP_BUTTON,
 109         ACPI_BUS_DEVICE_TYPE_COUNT
 110 };
 111
 112 struct acpi_driver;
 113 struct acpi_device;
 114
 115 /*
 116  * ACPI Driver
 117  * -----------
 118  */
 119
 120 typedef int (*acpi_op_add) (struct acpi_device * device);
 121 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
 122 typedef int (*acpi_op_start) (struct acpi_device * device);
 123 typedef int (*acpi_op_suspend) (struct acpi_device * device,
 124                                 pm_message_t state);
 125 typedef int (*acpi_op_resume) (struct acpi_device * device);
 126 typedef int (*acpi_op_bind) (struct acpi_device * device);
 127 typedef int (*acpi_op_unbind) (struct acpi_device * device);
 128 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
 129
 130 struct acpi_bus_ops {
 131         u32 acpi_op_add:1;
 132         u32 acpi_op_start:1;
 133 };
 134
 135 struct acpi_device_ops {
 136         acpi_op_add add;
 137         acpi_op_remove remove;
 138         acpi_op_start start;
 139         acpi_op_suspend suspend;
 140         acpi_op_resume resume;
 141         acpi_op_bind bind;
 142         acpi_op_unbind unbind;
 143         acpi_op_notify notify;
 144 };
 145
 146 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 147
 148 struct acpi_driver {
 149         char name[80];
 150         char class[80];
 151         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 152         unsigned int flags;
 153         struct acpi_device_ops ops;
 154         struct device_driver drv;
 155         struct module *owner;
 156 };
 157
 158 /*
 159  * ACPI Device
 160  * -----------
 161  */
 162
 163 /* Status (_STA) */
 164
 165 struct acpi_device_status {
 166         u32 present:1;
 167         u32 enabled:1;
 168         u32 show_in_ui:1;
 169         u32 functional:1;
 170         u32 battery_present:1;
 171         u32 reserved:27;
 172 };
 173
 174 /* Flags */
 175
 176 struct acpi_device_flags {
 177         u32 dynamic_status:1;
 178         u32 bus_address:1;
 179         u32 removable:1;
 180         u32 ejectable:1;
 181         u32 lockable:1;
 182         u32 suprise_removal_ok:1;
 183         u32 power_manageable:1;
 184         u32 performance_manageable:1;
 185         u32 eject_pending:1;
 186         u32 reserved:23;
 187 };
 188
 189 /* File System */
 190
 191 struct acpi_device_dir {
 192         struct proc_dir_entry *entry;
 193 };
 194
 195 #define acpi_device_dir(d)      ((d)->dir.entry)
 196
 197 /* Plug and Play */
 198
 199 typedef char acpi_bus_id[8];
 200 typedef unsigned long acpi_bus_address;
 201 typedef char acpi_device_name[40];
 202 typedef char acpi_device_class[20];
 203
 204 struct acpi_hardware_id {
 205         struct list_head list;
 206         char *id;
 207 };
 208
 209 struct acpi_device_pnp {
 210         acpi_bus_id bus_id;     /* Object name */
 211         acpi_bus_address bus_address;   /* _ADR */
 212         char *unique_id;        /* _UID */
 213         struct list_head ids;           /* _HID and _CIDs */
 214         acpi_device_name device_name;   /* Driver-determined */
 215         acpi_device_class device_class; /*        "          */
 216 };
 217
 218 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 219 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 220 const char *acpi_device_hid(struct acpi_device *device);
 221 #define acpi_device_name(d)     ((d)->pnp.device_name)
 222 #define acpi_device_class(d)    ((d)->pnp.device_class)
 223
 224 /* Power Management */
 225
 226 struct acpi_device_power_flags {
 227         u32 explicit_get:1;     /* _PSC present? */
 228         u32 power_resources:1;  /* Power resources */
 229         u32 inrush_current:1;   /* Serialize Dx->D0 */
 230         u32 power_removed:1;    /* Optimize Dx->D0 */
 231         u32 reserved:28;
 232 };
 233
 234 struct acpi_device_power_state {
 235         struct {
 236                 u8 valid:1;
 237                 u8 explicit_set:1;      /* _PSx present? */
 238                 u8 reserved:6;
 239         } flags;
 240         int power;              /* % Power (compared to D0) */
 241         int latency;            /* Dx->D0 time (microseconds) */
 242         struct acpi_handle_list resources;      /* Power resources referenced */
 243 };
 244
 245 struct acpi_device_power {
 246         int state;              /* Current state */
 247         struct acpi_device_power_flags flags;
 248         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 249 };
 250
 251 /* Performance Management */
 252
 253 struct acpi_device_perf_flags {
 254         u8 reserved:8;
 255 };
 256
 257 struct acpi_device_perf_state {
 258         struct {
 259                 u8 valid:1;
 260                 u8 reserved:7;
 261         } flags;
 262         u8 power;               /* % Power (compared to P0) */
 263         u8 performance;         /* % Performance (    "   ) */
 264         int latency;            /* Px->P0 time (microseconds) */
 265 };
 266
 267 struct acpi_device_perf {
 268         int state;
 269         struct acpi_device_perf_flags flags;
 270         int state_count;
 271         struct acpi_device_perf_state *states;
 272 };
 273
 274 /* Wakeup Management */
 275 struct acpi_device_wakeup_flags {
 276         u8 valid:1;             /* Can successfully enable wakeup? */
 277         u8 run_wake:1;          /* Run-Wake GPE devices */
 278         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 279 };
 280
 281 struct acpi_device_wakeup {
 282         acpi_handle gpe_device;
 283         u64 gpe_number;
 284         u64 sleep_state;
 285         struct acpi_handle_list resources;
 286         struct acpi_device_wakeup_flags flags;
 287         int prepare_count;
 288 };
 289
 290 /* Device */
 291
 292 struct acpi_device {
 293         int device_type;
 294         acpi_handle handle;             /* no handle for fixed hardware */
 295         struct acpi_device *parent;
 296         struct list_head children;
 297         struct list_head node;
 298         struct list_head wakeup_list;
 299         struct acpi_device_status status;
 300         struct acpi_device_flags flags;
 301         struct acpi_device_pnp pnp;
 302         struct acpi_device_power power;
 303         struct acpi_device_wakeup wakeup;
 304         struct acpi_device_perf performance;
 305         struct acpi_device_dir dir;
 306         struct acpi_device_ops ops;
 307         struct acpi_driver *driver;
 308         void *driver_data;
 309         struct device dev;
 310         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 311         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 312 };
 313
 314 static inline void *acpi_driver_data(struct acpi_device *d)
 315 {
 316         return d->driver_data;
 317 }
 318
 319 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 320 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 321
 322 /* acpi_device.dev.bus == &acpi_bus_type */
 323 extern struct bus_type acpi_bus_type;
 324
 325 /*
 326  * Events
 327  * ------
 328  */
 329
 330 struct acpi_bus_event {
 331         struct list_head node;
 332         acpi_device_class device_class;
 333         acpi_bus_id bus_id;
 334         u32 type;
 335         u32 data;
 336 };
 337
 338 struct acpi_eject_event {
 339         acpi_handle     handle;
 340         u32             event;
 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 extern int register_acpi_bus_notifier(struct notifier_block *nb);
 352 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
 353 /*
 354  * External Functions
 355  */
 356
 357 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 358 void acpi_bus_data_handler(acpi_handle handle, void *context);
 359 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 360                                        unsigned long long *sta);
 361 int acpi_bus_get_status(struct acpi_device *device);
 362 int acpi_bus_set_power(acpi_handle handle, int state);
 363 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 364 bool acpi_bus_power_manageable(acpi_handle handle);
 365 bool acpi_bus_can_wakeup(acpi_handle handle);
 366 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
 367 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
 368 #ifdef CONFIG_ACPI_PROC_EVENT
 369 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
 370 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
 371 int acpi_bus_receive_event(struct acpi_bus_event *event);
 372 #else
 373 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
 374         { return 0; }
 375 #endif
 376 int acpi_bus_register_driver(struct acpi_driver *driver);
 377 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 378 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
 379                  acpi_handle handle, int type);
 380 void acpi_bus_hot_remove_device(void *context);
 381 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 382 int acpi_bus_start(struct acpi_device *device);
 383 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 384 int acpi_match_device_ids(struct acpi_device *device,
 385                           const struct acpi_device_id *ids);
 386 int acpi_create_dir(struct acpi_device *);
 387 void acpi_remove_dir(struct acpi_device *);
 388
 389 /*
 390  * Bind physical devices with ACPI devices
 391  */
 392 struct acpi_bus_type {
 393         struct list_head list;
 394         struct bus_type *bus;
 395         /* For general devices under the bus */
 396         int (*find_device) (struct device *, acpi_handle *);
 397         /* For bridges, such as PCI root bridge, IDE controller */
 398         int (*find_bridge) (struct device *, acpi_handle *);
 399 };
 400 int register_acpi_bus_type(struct acpi_bus_type *);
 401 int unregister_acpi_bus_type(struct acpi_bus_type *);
 402 struct device *acpi_get_physical_device(acpi_handle);
 403
 404 struct acpi_pci_root {
 405         struct list_head node;
 406         struct acpi_device * device;
 407         struct acpi_pci_id id;
 408         struct pci_bus *bus;
 409         u16 segment;
 410         struct resource secondary;      /* downstream bus range */
 411
 412         u32 osc_support_set;    /* _OSC state of support bits */
 413         u32 osc_control_set;    /* _OSC state of control bits */
 414 };
 415
 416 /* helper */
 417 acpi_handle acpi_get_child(acpi_handle, u64);
 418 int acpi_is_root_bridge(acpi_handle);
 419 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 420 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 421 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 422
 423 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 424 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 425
 426 #ifdef CONFIG_PM
 427 int acpi_pm_device_sleep_state(struct device *, int *);
 428 #else
 429 static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
 430 {
 431         if (p)
 432                 *p = ACPI_STATE_D0;
 433         return ACPI_STATE_D3;
 434 }
 435 #endif
 436
 437 #ifdef CONFIG_PM_SLEEP
 438 int acpi_pm_device_run_wake(struct device *, bool);
 439 int acpi_pm_device_sleep_wake(struct device *, bool);
 440 #else
 441 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 442 {
 443         return -ENODEV;
 444 }
 445 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 446 {
 447         return -ENODEV;
 448 }
 449 #endif
 450
 451 #else   /* CONFIG_ACPI */
 452
 453 static int register_acpi_bus_type(struct acpi_bus_type *bus) { return 0; }
 454 static int unregister_acpi_bus_type(struct acpi_bus_type *bus) { return 0; }
 455
 456 #endif                          /* CONFIG_ACPI */
 457
 458 #endif /*__ACPI_BUS_H__*/