SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 *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 extern struct fadt_descriptor acpi_fadt;
  63
  64 enum acpi_bus_removal_type {
  65         ACPI_BUS_REMOVAL_NORMAL = 0,
  66         ACPI_BUS_REMOVAL_EJECT,
  67         ACPI_BUS_REMOVAL_SUPRISE,
  68         ACPI_BUS_REMOVAL_TYPE_COUNT
  69 };
  70
  71 enum acpi_bus_device_type {
  72         ACPI_BUS_TYPE_DEVICE = 0,
  73         ACPI_BUS_TYPE_POWER,
  74         ACPI_BUS_TYPE_PROCESSOR,
  75         ACPI_BUS_TYPE_THERMAL,
  76         ACPI_BUS_TYPE_SYSTEM,
  77         ACPI_BUS_TYPE_POWER_BUTTON,
  78         ACPI_BUS_TYPE_SLEEP_BUTTON,
  79         ACPI_BUS_DEVICE_TYPE_COUNT
  80 };
  81
  82 struct acpi_driver;
  83 struct acpi_device;
  84
  85 /*
  86  * ACPI Driver
  87  * -----------
  88  */
  89
  90 typedef int (*acpi_op_add) (struct acpi_device * device);
  91 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
  92 typedef int (*acpi_op_lock) (struct acpi_device * device, int type);
  93 typedef int (*acpi_op_start) (struct acpi_device * device);
  94 typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
  95 typedef int (*acpi_op_suspend) (struct acpi_device * device, pm_message_t state);
  96 typedef int (*acpi_op_resume) (struct acpi_device * device);
  97 typedef int (*acpi_op_scan) (struct acpi_device * device);
  98 typedef int (*acpi_op_bind) (struct acpi_device * device);
  99 typedef int (*acpi_op_unbind) (struct acpi_device * device);
 100 typedef int (*acpi_op_match) (struct acpi_device * device,
 101                               struct acpi_driver * driver);
 102 typedef int (*acpi_op_shutdown) (struct acpi_device * device);
 103
 104 struct acpi_bus_ops {
 105         u32 acpi_op_add:1;
 106         u32 acpi_op_remove:1;
 107         u32 acpi_op_lock:1;
 108         u32 acpi_op_start:1;
 109         u32 acpi_op_stop:1;
 110         u32 acpi_op_suspend:1;
 111         u32 acpi_op_resume:1;
 112         u32 acpi_op_scan:1;
 113         u32 acpi_op_bind:1;
 114         u32 acpi_op_unbind:1;
 115         u32 acpi_op_match:1;
 116         u32 acpi_op_shutdown:1;
 117         u32 reserved:20;
 118 };
 119
 120 struct acpi_device_ops {
 121         acpi_op_add add;
 122         acpi_op_remove remove;
 123         acpi_op_lock lock;
 124         acpi_op_start start;
 125         acpi_op_stop stop;
 126         acpi_op_suspend suspend;
 127         acpi_op_resume resume;
 128         acpi_op_scan scan;
 129         acpi_op_bind bind;
 130         acpi_op_unbind unbind;
 131         acpi_op_match match;
 132         acpi_op_shutdown shutdown;
 133 };
 134
 135 struct acpi_driver {
 136         char name[80];
 137         char class[80];
 138         char *ids;              /* Supported Hardware IDs */
 139         struct acpi_device_ops ops;
 140         struct device_driver drv;
 141         struct module *owner;
 142 };
 143
 144 /*
 145  * ACPI Device
 146  * -----------
 147  */
 148
 149 /* Status (_STA) */
 150
 151 struct acpi_device_status {
 152         u32 present:1;
 153         u32 enabled:1;
 154         u32 show_in_ui:1;
 155         u32 functional:1;
 156         u32 battery_present:1;
 157         u32 reserved:27;
 158 };
 159
 160 /* Flags */
 161
 162 struct acpi_device_flags {
 163         u32 dynamic_status:1;
 164         u32 hardware_id:1;
 165         u32 compatible_ids:1;
 166         u32 bus_address:1;
 167         u32 unique_id:1;
 168         u32 removable:1;
 169         u32 ejectable:1;
 170         u32 lockable:1;
 171         u32 suprise_removal_ok:1;
 172         u32 power_manageable:1;
 173         u32 performance_manageable:1;
 174         u32 wake_capable:1;     /* Wakeup(_PRW) supported? */
 175         u32 force_power_state:1;
 176         u32 reserved:19;
 177 };
 178
 179 /* File System */
 180
 181 struct acpi_device_dir {
 182         struct proc_dir_entry *entry;
 183 };
 184
 185 #define acpi_device_dir(d)      ((d)->dir.entry)
 186
 187 /* Plug and Play */
 188
 189 typedef char acpi_bus_id[5];
 190 typedef unsigned long acpi_bus_address;
 191 typedef char acpi_hardware_id[9];
 192 typedef char acpi_unique_id[9];
 193 typedef char acpi_device_name[40];
 194 typedef char acpi_device_class[20];
 195
 196 struct acpi_device_pnp {
 197         acpi_bus_id bus_id;     /* Object name */
 198         acpi_bus_address bus_address;   /* _ADR */
 199         acpi_hardware_id hardware_id;   /* _HID */
 200         struct acpi_compatible_id_list *cid_list;       /* _CIDs */
 201         acpi_unique_id unique_id;       /* _UID */
 202         acpi_device_name device_name;   /* Driver-determined */
 203         acpi_device_class device_class; /*        "          */
 204 };
 205
 206 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 207 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 208 #define acpi_device_hid(d)      ((d)->pnp.hardware_id)
 209 #define acpi_device_uid(d)      ((d)->pnp.unique_id)
 210 #define acpi_device_name(d)     ((d)->pnp.device_name)
 211 #define acpi_device_class(d)    ((d)->pnp.device_class)
 212
 213 /* Power Management */
 214
 215 struct acpi_device_power_flags {
 216         u32 explicit_get:1;     /* _PSC present? */
 217         u32 power_resources:1;  /* Power resources */
 218         u32 inrush_current:1;   /* Serialize Dx->D0 */
 219         u32 power_removed:1;    /* Optimize Dx->D0 */
 220         u32 reserved:28;
 221 };
 222
 223 struct acpi_device_power_state {
 224         struct {
 225                 u8 valid:1;
 226                 u8 explicit_set:1;      /* _PSx present? */
 227                 u8 reserved:6;
 228         } flags;
 229         int power;              /* % Power (compared to D0) */
 230         int latency;            /* Dx->D0 time (microseconds) */
 231         struct acpi_handle_list resources;      /* Power resources referenced */
 232 };
 233
 234 struct acpi_device_power {
 235         int state;              /* Current state */
 236         struct acpi_device_power_flags flags;
 237         struct acpi_device_power_state states[4];       /* Power states (D0-D3) */
 238 };
 239
 240 /* Performance Management */
 241
 242 struct acpi_device_perf_flags {
 243         u8 reserved:8;
 244 };
 245
 246 struct acpi_device_perf_state {
 247         struct {
 248                 u8 valid:1;
 249                 u8 reserved:7;
 250         } flags;
 251         u8 power;               /* % Power (compared to P0) */
 252         u8 performance;         /* % Performance (    "   ) */
 253         int latency;            /* Px->P0 time (microseconds) */
 254 };
 255
 256 struct acpi_device_perf {
 257         int state;
 258         struct acpi_device_perf_flags flags;
 259         int state_count;
 260         struct acpi_device_perf_state *states;
 261 };
 262
 263 /* Wakeup Management */
 264 struct acpi_device_wakeup_flags {
 265         u8 valid:1;             /* Can successfully enable wakeup? */
 266         u8 run_wake:1;          /* Run-Wake GPE devices */
 267 };
 268
 269 struct acpi_device_wakeup_state {
 270         u8 enabled:1;
 271         u8 active:1;
 272 };
 273
 274 struct acpi_device_wakeup {
 275         acpi_handle gpe_device;
 276         acpi_integer gpe_number;
 277         acpi_integer sleep_state;
 278         struct acpi_handle_list resources;
 279         struct acpi_device_wakeup_state state;
 280         struct acpi_device_wakeup_flags flags;
 281 };
 282
 283 /* Device */
 284
 285 struct acpi_device {
 286         acpi_handle handle;
 287         struct acpi_device *parent;
 288         struct list_head children;
 289         struct list_head node;
 290         struct list_head wakeup_list;
 291         struct list_head g_list;
 292         struct acpi_device_status status;
 293         struct acpi_device_flags flags;
 294         struct acpi_device_pnp pnp;
 295         struct acpi_device_power power;
 296         struct acpi_device_wakeup wakeup;
 297         struct acpi_device_perf performance;
 298         struct acpi_device_dir dir;
 299         struct acpi_device_ops ops;
 300         struct acpi_driver *driver;
 301         void *driver_data;
 302         struct device dev;
 303         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 304         enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
 305 };
 306
 307 #define acpi_driver_data(d)     ((d)->driver_data)
 308 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 309 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 310
 311 /*
 312  * Events
 313  * ------
 314  */
 315
 316 struct acpi_bus_event {
 317         struct list_head node;
 318         acpi_device_class device_class;
 319         acpi_bus_id bus_id;
 320         u32 type;
 321         u32 data;
 322 };
 323
 324 extern struct subsystem acpi_subsys;
 325
 326 /*
 327  * External Functions
 328  */
 329
 330 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 331 void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
 332 int acpi_bus_get_status(struct acpi_device *device);
 333 int acpi_bus_get_power(acpi_handle handle, int *state);
 334 int acpi_bus_set_power(acpi_handle handle, int state);
 335 int acpi_bus_generate_event(struct acpi_device *device, u8 type, int data);
 336 int acpi_bus_receive_event(struct acpi_bus_event *event);
 337 int acpi_bus_register_driver(struct acpi_driver *driver);
 338 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 339 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
 340                  acpi_handle handle, int type);
 341 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 342 int acpi_bus_start(struct acpi_device *device);
 343 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd);
 344 int acpi_match_ids(struct acpi_device *device, char *ids);
 345 int acpi_create_dir(struct acpi_device *);
 346 void acpi_remove_dir(struct acpi_device *);
 347
 348 /*
 349  * Bind physical devices with ACPI devices
 350  */
 351 #include <linux/device.h>
 352 struct acpi_bus_type {
 353         struct list_head list;
 354         struct bus_type *bus;
 355         /* For general devices under the bus */
 356         int (*find_device) (struct device *, acpi_handle *);
 357         /* For bridges, such as PCI root bridge, IDE controller */
 358         int (*find_bridge) (struct device *, acpi_handle *);
 359 };
 360 int register_acpi_bus_type(struct acpi_bus_type *);
 361 int unregister_acpi_bus_type(struct acpi_bus_type *);
 362 struct device *acpi_get_physical_device(acpi_handle);
 363 /* helper */
 364 acpi_handle acpi_get_child(acpi_handle, acpi_integer);
 365 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 366 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 367
 368 #endif /* CONFIG_ACPI */
 369
 370 #endif /*__ACPI_BUS_H__*/