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
  54 #ifdef CONFIG_ACPI
  55
  56 #include <linux/proc_fs.h>
  57
  58 #define ACPI_BUS_FILE_ROOT      "acpi"
  59 extern struct proc_dir_entry *acpi_root_dir;
  60
  61 enum acpi_bus_removal_type {
  62         ACPI_BUS_REMOVAL_NORMAL = 0,
  63         ACPI_BUS_REMOVAL_EJECT,
  64         ACPI_BUS_REMOVAL_SUPRISE,
  65         ACPI_BUS_REMOVAL_TYPE_COUNT
  66 };
  67
  68 enum acpi_bus_device_type {
  69         ACPI_BUS_TYPE_DEVICE = 0,
  70         ACPI_BUS_TYPE_POWER,
  71         ACPI_BUS_TYPE_PROCESSOR,
  72         ACPI_BUS_TYPE_THERMAL,
  73         ACPI_BUS_TYPE_POWER_BUTTON,
  74         ACPI_BUS_TYPE_SLEEP_BUTTON,
  75         ACPI_BUS_DEVICE_TYPE_COUNT
  76 };
  77
  78 struct acpi_driver;
  79 struct acpi_device;
  80
  81 /*
  82  * ACPI Driver
  83  * -----------
  84  */
  85
  86 typedef int (*acpi_op_add) (struct acpi_device * device);
  87 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
  88 typedef int (*acpi_op_start) (struct acpi_device * device);
  89 typedef int (*acpi_op_suspend) (struct acpi_device * device,
  90                                 pm_message_t state);
  91 typedef int (*acpi_op_resume) (struct acpi_device * device);
  92 typedef int (*acpi_op_bind) (struct acpi_device * device);
  93 typedef int (*acpi_op_unbind) (struct acpi_device * device);
  94 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
  95
  96 struct acpi_bus_ops {
  97         u32 acpi_op_add:1;
  98         u32 acpi_op_start:1;
  99 };
 100
 101 struct acpi_device_ops {
 102         acpi_op_add add;
 103         acpi_op_remove remove;
 104         acpi_op_start start;
 105         acpi_op_suspend suspend;
 106         acpi_op_resume resume;
 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 lockable:1;
 148         u32 suprise_removal_ok:1;
 149         u32 power_manageable:1;
 150         u32 performance_manageable:1;
 151         u32 wake_capable:1;     /* Wakeup(_PRW) supported? */
 152         u32 force_power_state:1;
 153         u32 reserved:22;
 154 };
 155
 156 /* File System */
 157
 158 struct acpi_device_dir {
 159         struct proc_dir_entry *entry;
 160 };
 161
 162 #define acpi_device_dir(d)      ((d)->dir.entry)
 163
 164 /* Plug and Play */
 165
 166 typedef char acpi_bus_id[8];
 167 typedef unsigned long acpi_bus_address;
 168 typedef char acpi_device_name[40];
 169 typedef char acpi_device_class[20];
 170
 171 struct acpi_hardware_id {
 172         struct list_head list;
 173         char *id;
 174 };
 175
 176 struct acpi_device_pnp {
 177         acpi_bus_id bus_id;     /* Object name */
 178         acpi_bus_address bus_address;   /* _ADR */
 179         char *unique_id;        /* _UID */
 180         struct list_head ids;           /* _HID and _CIDs */
 181         acpi_device_name device_name;   /* Driver-determined */
 182         acpi_device_class device_class; /*        "          */
 183 };
 184
 185 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 186 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 187 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 explicit_set:1;      /* _PSx present? */
 205                 u8 reserved:6;
 206         } flags;
 207         int power;              /* % Power (compared to D0) */
 208         int latency;            /* Dx->D0 time (microseconds) */
 209         struct acpi_handle_list resources;      /* Power resources referenced */
 210 };
 211
 212 struct acpi_device_power {
 213         int state;              /* Current state */
 214         struct acpi_device_power_flags flags;
 215         struct acpi_device_power_state states[4];       /* Power states (D0-D3) */
 216 };
 217
 218 /* Performance Management */
 219
 220 struct acpi_device_perf_flags {
 221         u8 reserved:8;
 222 };
 223
 224 struct acpi_device_perf_state {
 225         struct {
 226                 u8 valid:1;
 227                 u8 reserved:7;
 228         } flags;
 229         u8 power;               /* % Power (compared to P0) */
 230         u8 performance;         /* % Performance (    "   ) */
 231         int latency;            /* Px->P0 time (microseconds) */
 232 };
 233
 234 struct acpi_device_perf {
 235         int state;
 236         struct acpi_device_perf_flags flags;
 237         int state_count;
 238         struct acpi_device_perf_state *states;
 239 };
 240
 241 /* Wakeup Management */
 242 struct acpi_device_wakeup_flags {
 243         u8 valid:1;             /* Can successfully enable wakeup? */
 244         u8 run_wake:1;          /* Run-Wake GPE devices */
 245 };
 246
 247 struct acpi_device_wakeup_state {
 248         u8 enabled:1;
 249 };
 250
 251 struct acpi_device_wakeup {
 252         acpi_handle gpe_device;
 253         acpi_integer gpe_number;
 254         acpi_integer sleep_state;
 255         struct acpi_handle_list resources;
 256         struct acpi_device_wakeup_state state;
 257         struct acpi_device_wakeup_flags flags;
 258         int prepare_count;
 259 };
 260
 261 /* Device */
 262
 263 struct acpi_device {
 264         int device_type;
 265         acpi_handle handle;             /* no handle for fixed hardware */
 266         struct acpi_device *parent;
 267         struct list_head children;
 268         struct list_head node;
 269         struct list_head wakeup_list;
 270         struct acpi_device_status status;
 271         struct acpi_device_flags flags;
 272         struct acpi_device_pnp pnp;
 273         struct acpi_device_power power;
 274         struct acpi_device_wakeup wakeup;
 275         struct acpi_device_perf performance;
 276         struct acpi_device_dir dir;
 277         struct acpi_device_ops ops;
 278         struct acpi_driver *driver;
 279         void *driver_data;
 280         struct device dev;
 281         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 282         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 283 };
 284
 285 static inline void *acpi_driver_data(struct acpi_device *d)
 286 {
 287         return d->driver_data;
 288 }
 289
 290 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 291 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 292
 293 /* acpi_device.dev.bus == &acpi_bus_type */
 294 extern struct bus_type acpi_bus_type;
 295
 296 /*
 297  * Events
 298  * ------
 299  */
 300
 301 struct acpi_bus_event {
 302         struct list_head node;
 303         acpi_device_class device_class;
 304         acpi_bus_id bus_id;
 305         u32 type;
 306         u32 data;
 307 };
 308
 309 extern struct kobject *acpi_kobj;
 310 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 311 void acpi_bus_private_data_handler(acpi_handle, void *);
 312 int acpi_bus_get_private_data(acpi_handle, void **);
 313 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 314 extern int register_acpi_notifier(struct notifier_block *);
 315 extern int unregister_acpi_notifier(struct notifier_block *);
 316
 317 extern int register_acpi_bus_notifier(struct notifier_block *nb);
 318 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
 319 /*
 320  * External Functions
 321  */
 322
 323 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 324 void acpi_bus_data_handler(acpi_handle handle, void *context);
 325 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 326                                        unsigned long long *sta);
 327 int acpi_bus_get_status(struct acpi_device *device);
 328 int acpi_bus_get_power(acpi_handle handle, int *state);
 329 int acpi_bus_set_power(acpi_handle handle, int state);
 330 bool acpi_bus_power_manageable(acpi_handle handle);
 331 bool acpi_bus_can_wakeup(acpi_handle handle);
 332 #ifdef CONFIG_ACPI_PROC_EVENT
 333 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
 334 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
 335 int acpi_bus_receive_event(struct acpi_bus_event *event);
 336 #else
 337 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
 338         { return 0; }
 339 #endif
 340 int acpi_bus_register_driver(struct acpi_driver *driver);
 341 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 342 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
 343                  acpi_handle handle, int type);
 344 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 345 int acpi_bus_start(struct acpi_device *device);
 346 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 347 int acpi_match_device_ids(struct acpi_device *device,
 348                           const struct acpi_device_id *ids);
 349 int acpi_create_dir(struct acpi_device *);
 350 void acpi_remove_dir(struct acpi_device *);
 351
 352 /*
 353  * Bind physical devices with ACPI devices
 354  */
 355 struct acpi_bus_type {
 356         struct list_head list;
 357         struct bus_type *bus;
 358         /* For general devices under the bus */
 359         int (*find_device) (struct device *, acpi_handle *);
 360         /* For bridges, such as PCI root bridge, IDE controller */
 361         int (*find_bridge) (struct device *, acpi_handle *);
 362 };
 363 int register_acpi_bus_type(struct acpi_bus_type *);
 364 int unregister_acpi_bus_type(struct acpi_bus_type *);
 365 struct device *acpi_get_physical_device(acpi_handle);
 366
 367 struct acpi_pci_root {
 368         struct list_head node;
 369         struct acpi_device * device;
 370         struct acpi_pci_id id;
 371         struct pci_bus *bus;
 372         u16 segment;
 373         u8 bus_nr;
 374
 375         u32 osc_support_set;    /* _OSC state of support bits */
 376         u32 osc_control_set;    /* _OSC state of control bits */
 377         u32 osc_control_qry;    /* the latest _OSC query result */
 378
 379         u32 osc_queried:1;      /* has _OSC control been queried? */
 380 };
 381
 382 /* helper */
 383 acpi_handle acpi_get_child(acpi_handle, acpi_integer);
 384 int acpi_is_root_bridge(acpi_handle);
 385 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 386 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 387 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 388
 389 #ifdef CONFIG_PM_SLEEP
 390 int acpi_pm_device_sleep_state(struct device *, int *);
 391 int acpi_pm_device_sleep_wake(struct device *, bool);
 392 #else /* !CONFIG_PM_SLEEP */
 393 static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
 394 {
 395         if (p)
 396                 *p = ACPI_STATE_D0;
 397         return ACPI_STATE_D3;
 398 }
 399 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 400 {
 401         return -ENODEV;
 402 }
 403 #endif /* !CONFIG_PM_SLEEP */
 404
 405 #endif                          /* CONFIG_ACPI */
 406
 407 #endif /*__ACPI_BUS_H__*/