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 #define PREFIX                  "ACPI: "
  34
  35 /* TBD: Make dynamic */
  36 #define ACPI_MAX_HANDLES        10
  37 struct acpi_handle_list {
  38         u32 count;
  39         acpi_handle handles[ACPI_MAX_HANDLES];
  40 };
  41
  42 /* acpi_utils.h */
  43 acpi_status
  44 acpi_extract_package(union acpi_object *package,
  45                      struct acpi_buffer *format, struct acpi_buffer *buffer);
  46 acpi_status
  47 acpi_evaluate_integer(acpi_handle handle,
  48                       acpi_string pathname,
  49                       struct acpi_object_list *arguments, unsigned long long *data);
  50 acpi_status
  51 acpi_evaluate_reference(acpi_handle handle,
  52                         acpi_string pathname,
  53                         struct acpi_object_list *arguments,
  54                         struct acpi_handle_list *list);
  55
  56 #ifdef CONFIG_ACPI
  57
  58 #include <linux/proc_fs.h>
  59
  60 #define ACPI_BUS_FILE_ROOT      "acpi"
  61 extern struct proc_dir_entry *acpi_root_dir;
  62
  63 enum acpi_bus_removal_type {
  64         ACPI_BUS_REMOVAL_NORMAL = 0,
  65         ACPI_BUS_REMOVAL_EJECT,
  66         ACPI_BUS_REMOVAL_SUPRISE,
  67         ACPI_BUS_REMOVAL_TYPE_COUNT
  68 };
  69
  70 enum acpi_bus_device_type {
  71         ACPI_BUS_TYPE_DEVICE = 0,
  72         ACPI_BUS_TYPE_POWER,
  73         ACPI_BUS_TYPE_PROCESSOR,
  74         ACPI_BUS_TYPE_THERMAL,
  75         ACPI_BUS_TYPE_SYSTEM,
  76         ACPI_BUS_TYPE_POWER_BUTTON,
  77         ACPI_BUS_TYPE_SLEEP_BUTTON,
  78         ACPI_BUS_DEVICE_TYPE_COUNT
  79 };
  80
  81 struct acpi_driver;
  82 struct acpi_device;
  83
  84 /*
  85  * ACPI Driver
  86  * -----------
  87  */
  88
  89 typedef int (*acpi_op_add) (struct acpi_device * device);
  90 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
  91 typedef int (*acpi_op_start) (struct acpi_device * device);
  92 typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
  93 typedef int (*acpi_op_suspend) (struct acpi_device * device,
  94                                 pm_message_t state);
  95 typedef int (*acpi_op_resume) (struct acpi_device * device);
  96 typedef int (*acpi_op_bind) (struct acpi_device * device);
  97 typedef int (*acpi_op_unbind) (struct acpi_device * device);
  98 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
  99
 100 struct acpi_bus_ops {
 101         u32 acpi_op_add:1;
 102         u32 acpi_op_start:1;
 103 };
 104
 105 struct acpi_device_ops {
 106         acpi_op_add add;
 107         acpi_op_remove remove;
 108         acpi_op_start start;
 109         acpi_op_stop stop;
 110         acpi_op_suspend suspend;
 111         acpi_op_resume resume;
 112         acpi_op_bind bind;
 113         acpi_op_unbind unbind;
 114         acpi_op_notify notify;
 115 };
 116
 117 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 118
 119 struct acpi_driver {
 120         char name[80];
 121         char class[80];
 122         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 123         unsigned int flags;
 124         struct acpi_device_ops ops;
 125         struct device_driver drv;
 126         struct module *owner;
 127 };
 128
 129 /*
 130  * ACPI Device
 131  * -----------
 132  */
 133
 134 /* Status (_STA) */
 135
 136 struct acpi_device_status {
 137         u32 present:1;
 138         u32 enabled:1;
 139         u32 show_in_ui:1;
 140         u32 functional:1;
 141         u32 battery_present:1;
 142         u32 reserved:27;
 143 };
 144
 145 /* Flags */
 146
 147 struct acpi_device_flags {
 148         u32 dynamic_status:1;
 149         u32 hardware_id:1;
 150         u32 compatible_ids:1;
 151         u32 bus_address:1;
 152         u32 unique_id:1;
 153         u32 removable:1;
 154         u32 ejectable:1;
 155         u32 lockable:1;
 156         u32 suprise_removal_ok:1;
 157         u32 power_manageable:1;
 158         u32 performance_manageable:1;
 159         u32 wake_capable:1;     /* Wakeup(_PRW) supported? */
 160         u32 force_power_state:1;
 161         u32 reserved:19;
 162 };
 163
 164 /* File System */
 165
 166 struct acpi_device_dir {
 167         struct proc_dir_entry *entry;
 168 };
 169
 170 #define acpi_device_dir(d)      ((d)->dir.entry)
 171
 172 /* Plug and Play */
 173
 174 typedef char acpi_bus_id[8];
 175 typedef unsigned long acpi_bus_address;
 176 typedef char acpi_device_name[40];
 177 typedef char acpi_device_class[20];
 178
 179 struct acpi_device_pnp {
 180         acpi_bus_id bus_id;     /* Object name */
 181         acpi_bus_address bus_address;   /* _ADR */
 182         char *hardware_id;      /* _HID */
 183         struct acpica_device_id_list *cid_list; /* _CIDs */
 184         char *unique_id;        /* _UID */
 185         acpi_device_name device_name;   /* Driver-determined */
 186         acpi_device_class device_class; /*        "          */
 187 };
 188
 189 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 190 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 191 #define acpi_device_hid(d)      ((d)->pnp.hardware_id)
 192 #define acpi_device_uid(d)      ((d)->pnp.unique_id)
 193 #define acpi_device_name(d)     ((d)->pnp.device_name)
 194 #define acpi_device_class(d)    ((d)->pnp.device_class)
 195
 196 /* Power Management */
 197
 198 struct acpi_device_power_flags {
 199         u32 explicit_get:1;     /* _PSC present? */
 200         u32 power_resources:1;  /* Power resources */
 201         u32 inrush_current:1;   /* Serialize Dx->D0 */
 202         u32 power_removed:1;    /* Optimize Dx->D0 */
 203         u32 reserved:28;
 204 };
 205
 206 struct acpi_device_power_state {
 207         struct {
 208                 u8 valid:1;
 209                 u8 explicit_set:1;      /* _PSx present? */
 210                 u8 reserved:6;
 211         } flags;
 212         int power;              /* % Power (compared to D0) */
 213         int latency;            /* Dx->D0 time (microseconds) */
 214         struct acpi_handle_list resources;      /* Power resources referenced */
 215 };
 216
 217 struct acpi_device_power {
 218         int state;              /* Current state */
 219         struct acpi_device_power_flags flags;
 220         struct acpi_device_power_state states[4];       /* Power states (D0-D3) */
 221 };
 222
 223 /* Performance Management */
 224
 225 struct acpi_device_perf_flags {
 226         u8 reserved:8;
 227 };
 228
 229 struct acpi_device_perf_state {
 230         struct {
 231                 u8 valid:1;
 232                 u8 reserved:7;
 233         } flags;
 234         u8 power;               /* % Power (compared to P0) */
 235         u8 performance;         /* % Performance (    "   ) */
 236         int latency;            /* Px->P0 time (microseconds) */
 237 };
 238
 239 struct acpi_device_perf {
 240         int state;
 241         struct acpi_device_perf_flags flags;
 242         int state_count;
 243         struct acpi_device_perf_state *states;
 244 };
 245
 246 /* Wakeup Management */
 247 struct acpi_device_wakeup_flags {
 248         u8 valid:1;             /* Can successfully enable wakeup? */
 249         u8 prepared:1;          /* Has the wake-up capability been enabled? */
 250         u8 run_wake:1;          /* Run-Wake GPE devices */
 251 };
 252
 253 struct acpi_device_wakeup_state {
 254         u8 enabled:1;
 255 };
 256
 257 struct acpi_device_wakeup {
 258         acpi_handle gpe_device;
 259         acpi_integer gpe_number;
 260         acpi_integer sleep_state;
 261         struct acpi_handle_list resources;
 262         struct acpi_device_wakeup_state state;
 263         struct acpi_device_wakeup_flags flags;
 264 };
 265
 266 /* Device */
 267
 268 struct acpi_device {
 269         acpi_handle handle;
 270         struct acpi_device *parent;
 271         struct list_head children;
 272         struct list_head node;
 273         struct list_head wakeup_list;
 274         struct acpi_device_status status;
 275         struct acpi_device_flags flags;
 276         struct acpi_device_pnp pnp;
 277         struct acpi_device_power power;
 278         struct acpi_device_wakeup wakeup;
 279         struct acpi_device_perf performance;
 280         struct acpi_device_dir dir;
 281         struct acpi_device_ops ops;
 282         struct acpi_driver *driver;
 283         void *driver_data;
 284         struct device dev;
 285         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 286         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 287 };
 288
 289 static inline void *acpi_driver_data(struct acpi_device *d)
 290 {
 291         return d->driver_data;
 292 }
 293
 294 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 295 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 296
 297 /* acpi_device.dev.bus == &acpi_bus_type */
 298 extern struct bus_type acpi_bus_type;
 299
 300 /*
 301  * Events
 302  * ------
 303  */
 304
 305 struct acpi_bus_event {
 306         struct list_head node;
 307         acpi_device_class device_class;
 308         acpi_bus_id bus_id;
 309         u32 type;
 310         u32 data;
 311 };
 312
 313 extern struct kobject *acpi_kobj;
 314 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 315 void acpi_bus_private_data_handler(acpi_handle, u32, void *);
 316 int acpi_bus_get_private_data(acpi_handle, void **);
 317 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 318 extern int register_acpi_notifier(struct notifier_block *);
 319 extern int unregister_acpi_notifier(struct notifier_block *);
 320
 321 extern int register_acpi_bus_notifier(struct notifier_block *nb);
 322 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
 323 /*
 324  * External Functions
 325  */
 326
 327 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 328 void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
 329 int acpi_bus_get_status(struct acpi_device *device);
 330 int acpi_bus_get_power(acpi_handle handle, int *state);
 331 int acpi_bus_set_power(acpi_handle handle, int state);
 332 bool acpi_bus_power_manageable(acpi_handle handle);
 333 bool acpi_bus_can_wakeup(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 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 347 int acpi_bus_start(struct acpi_device *device);
 348 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 349 int acpi_match_device_ids(struct acpi_device *device,
 350                           const struct acpi_device_id *ids);
 351 int acpi_create_dir(struct acpi_device *);
 352 void acpi_remove_dir(struct acpi_device *);
 353
 354 /*
 355  * Bind physical devices with ACPI devices
 356  */
 357 #include <linux/device.h>
 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 /* helper */
 371 acpi_handle acpi_get_child(acpi_handle, acpi_integer);
 372 int acpi_is_root_bridge(acpi_handle);
 373 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 374 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 375
 376 #ifdef CONFIG_PM_SLEEP
 377 int acpi_pm_device_sleep_state(struct device *, int *);
 378 int acpi_pm_device_sleep_wake(struct device *, bool);
 379 #else /* !CONFIG_PM_SLEEP */
 380 static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
 381 {
 382         if (p)
 383                 *p = ACPI_STATE_D0;
 384         return ACPI_STATE_D3;
 385 }
 386 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 387 {
 388         return -ENODEV;
 389 }
 390 #endif /* !CONFIG_PM_SLEEP */
 391
 392 #endif                          /* CONFIG_ACPI */
 393
 394 #endif /*__ACPI_BUS_H__*/