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