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 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 lockable:1;
 148         u32 suprise_removal_ok:1;
 149         u32 power_manageable:1;
 150         u32 performance_manageable:1;
 151         u32 eject_pending:1;
 152         u32 reserved:23;
 153 };
 154
 155 /* File System */
 156
 157 struct acpi_device_dir {
 158         struct proc_dir_entry *entry;
 159 };
 160
 161 #define acpi_device_dir(d)      ((d)->dir.entry)
 162
 163 /* Plug and Play */
 164
 165 typedef char acpi_bus_id[8];
 166 typedef unsigned long acpi_bus_address;
 167 typedef char acpi_device_name[40];
 168 typedef char acpi_device_class[20];
 169
 170 struct acpi_hardware_id {
 171         struct list_head list;
 172         char *id;
 173 };
 174
 175 struct acpi_device_pnp {
 176         acpi_bus_id bus_id;     /* Object name */
 177         acpi_bus_address bus_address;   /* _ADR */
 178         char *unique_id;        /* _UID */
 179         struct list_head ids;           /* _HID and _CIDs */
 180         acpi_device_name device_name;   /* Driver-determined */
 181         acpi_device_class device_class; /*        "          */
 182 };
 183
 184 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 185 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 186 const char *acpi_device_hid(struct acpi_device *device);
 187 #define acpi_device_name(d)     ((d)->pnp.device_name)
 188 #define acpi_device_class(d)    ((d)->pnp.device_class)
 189
 190 /* Power Management */
 191
 192 struct acpi_device_power_flags {
 193         u32 explicit_get:1;     /* _PSC present? */
 194         u32 power_resources:1;  /* Power resources */
 195         u32 inrush_current:1;   /* Serialize Dx->D0 */
 196         u32 power_removed:1;    /* Optimize Dx->D0 */
 197         u32 reserved:28;
 198 };
 199
 200 struct acpi_device_power_state {
 201         struct {
 202                 u8 valid:1;
 203                 u8 explicit_set:1;      /* _PSx present? */
 204                 u8 reserved:6;
 205         } flags;
 206         int power;              /* % Power (compared to D0) */
 207         int latency;            /* Dx->D0 time (microseconds) */
 208         struct acpi_handle_list resources;      /* Power resources referenced */
 209 };
 210
 211 struct acpi_device_power {
 212         int state;              /* Current state */
 213         struct acpi_device_power_flags flags;
 214         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 215 };
 216
 217 /* Performance Management */
 218
 219 struct acpi_device_perf_flags {
 220         u8 reserved:8;
 221 };
 222
 223 struct acpi_device_perf_state {
 224         struct {
 225                 u8 valid:1;
 226                 u8 reserved:7;
 227         } flags;
 228         u8 power;               /* % Power (compared to P0) */
 229         u8 performance;         /* % Performance (    "   ) */
 230         int latency;            /* Px->P0 time (microseconds) */
 231 };
 232
 233 struct acpi_device_perf {
 234         int state;
 235         struct acpi_device_perf_flags flags;
 236         int state_count;
 237         struct acpi_device_perf_state *states;
 238 };
 239
 240 /* Wakeup Management */
 241 struct acpi_device_wakeup_flags {
 242         u8 valid:1;             /* Can successfully enable wakeup? */
 243         u8 run_wake:1;          /* Run-Wake GPE devices */
 244         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 245 };
 246
 247 struct acpi_device_wakeup {
 248         acpi_handle gpe_device;
 249         u64 gpe_number;
 250         u64 sleep_state;
 251         struct acpi_handle_list resources;
 252         struct acpi_device_wakeup_flags flags;
 253         int prepare_count;
 254 };
 255
 256 /* Device */
 257
 258 struct acpi_device {
 259         int device_type;
 260         acpi_handle handle;             /* no handle for fixed hardware */
 261         struct acpi_device *parent;
 262         struct list_head children;
 263         struct list_head node;
 264         struct list_head wakeup_list;
 265         struct acpi_device_status status;
 266         struct acpi_device_flags flags;
 267         struct acpi_device_pnp pnp;
 268         struct acpi_device_power power;
 269         struct acpi_device_wakeup wakeup;
 270         struct acpi_device_perf performance;
 271         struct acpi_device_dir dir;
 272         struct acpi_device_ops ops;
 273         struct acpi_driver *driver;
 274         void *driver_data;
 275         struct device dev;
 276         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 277         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 278 };
 279
 280 static inline void *acpi_driver_data(struct acpi_device *d)
 281 {
 282         return d->driver_data;
 283 }
 284
 285 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 286 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 287
 288 /* acpi_device.dev.bus == &acpi_bus_type */
 289 extern struct bus_type acpi_bus_type;
 290
 291 /*
 292  * Events
 293  * ------
 294  */
 295
 296 struct acpi_bus_event {
 297         struct list_head node;
 298         acpi_device_class device_class;
 299         acpi_bus_id bus_id;
 300         u32 type;
 301         u32 data;
 302 };
 303
 304 struct acpi_eject_event {
 305         acpi_handle     handle;
 306         u32             event;
 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_set_power(acpi_handle handle, int state);
 329 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 330 bool acpi_bus_power_manageable(acpi_handle handle);
 331 bool acpi_bus_can_wakeup(acpi_handle handle);
 332 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
 333 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
 334 #ifdef CONFIG_ACPI_PROC_EVENT
 335 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
 336 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
 337 int acpi_bus_receive_event(struct acpi_bus_event *event);
 338 #else
 339 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
 340         { return 0; }
 341 #endif
 342 int acpi_bus_register_driver(struct acpi_driver *driver);
 343 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 344 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
 345                  acpi_handle handle, int type);
 346 void acpi_bus_hot_remove_device(void *context);
 347 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 348 int acpi_bus_start(struct acpi_device *device);
 349 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 350 int acpi_match_device_ids(struct acpi_device *device,
 351                           const struct acpi_device_id *ids);
 352 int acpi_create_dir(struct acpi_device *);
 353 void acpi_remove_dir(struct acpi_device *);
 354
 355 /*
 356  * Bind physical devices with ACPI devices
 357  */
 358 struct acpi_bus_type {
 359         struct list_head list;
 360         struct bus_type *bus;
 361         /* For general devices under the bus */
 362         int (*find_device) (struct device *, acpi_handle *);
 363         /* For bridges, such as PCI root bridge, IDE controller */
 364         int (*find_bridge) (struct device *, acpi_handle *);
 365 };
 366 int register_acpi_bus_type(struct acpi_bus_type *);
 367 int unregister_acpi_bus_type(struct acpi_bus_type *);
 368 struct device *acpi_get_physical_device(acpi_handle);
 369
 370 struct acpi_pci_root {
 371         struct list_head node;
 372         struct acpi_device * device;
 373         struct acpi_pci_id id;
 374         struct pci_bus *bus;
 375         u16 segment;
 376         struct resource secondary;      /* downstream bus range */
 377
 378         u32 osc_support_set;    /* _OSC state of support bits */
 379         u32 osc_control_set;    /* _OSC state of control bits */
 380         phys_addr_t mcfg_addr;
 381 };
 382
 383 /* helper */
 384 acpi_handle acpi_get_child(acpi_handle, u64);
 385 int acpi_is_root_bridge(acpi_handle);
 386 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 387 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 388 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 389
 390 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 391 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 392
 393 #ifdef CONFIG_PM
 394 int acpi_pm_device_sleep_state(struct device *, int *, int);
 395 #else
 396 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 397 {
 398         if (p)
 399                 *p = ACPI_STATE_D0;
 400         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
 401 }
 402 #endif
 403
 404 #ifdef CONFIG_PM_SLEEP
 405 int acpi_pm_device_run_wake(struct device *, bool);
 406 int acpi_pm_device_sleep_wake(struct device *, bool);
 407 #else
 408 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 409 {
 410         return -ENODEV;
 411 }
 412 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 413 {
 414         return -ENODEV;
 415 }
 416 #endif
 417
 418 #else   /* CONFIG_ACPI */
 419
 420 static inline int register_acpi_bus_type(void *bus) { return 0; }
 421 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 422
 423 #endif                          /* CONFIG_ACPI */
 424
 425 #endif /*__ACPI_BUS_H__*/