include/linux/pm.h

   1 /*
   2  *  pm.h - Power management interface
   3  *
   4  *  Copyright (C) 2000 Andrew Henroid
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef _LINUX_PM_H
  22 #define _LINUX_PM_H
  23
  24 #ifdef __KERNEL__
  25
  26 #include <linux/config.h>
  27 #include <linux/list.h>
  28
  29 /*
  30  * Power management requests
  31  */
  32 enum
  33 {
  34         PM_SUSPEND, /* enter D1-D3 */
  35         PM_RESUME,  /* enter D0 */
  36
  37         /* enable wake-on */
  38         PM_SET_WAKEUP,
  39
  40         /* bus resource management */
  41         PM_GET_RESOURCES,
  42         PM_SET_RESOURCES,
  43
  44         /* base station management */
  45         PM_EJECT,
  46         PM_LOCK,
  47 };
  48
  49 typedef int pm_request_t;
  50
  51 /*
  52  * Device types
  53  */
  54 enum
  55 {
  56         PM_UNKNOWN_DEV = 0, /* generic */
  57         PM_SYS_DEV,         /* system device (fan, KB controller, ...) */
  58         PM_PCI_DEV,         /* PCI device */
  59         PM_USB_DEV,         /* USB device */
  60         PM_SCSI_DEV,        /* SCSI device */
  61         PM_ISA_DEV,         /* ISA device */
  62         PM_MTD_DEV,         /* Memory Technology Device */
  63 };
  64
  65 typedef int pm_dev_t;
  66
  67 /*
  68  * System device hardware ID (PnP) values
  69  */
  70 enum
  71 {
  72         PM_SYS_UNKNOWN = 0x00000000, /* generic */
  73         PM_SYS_KBC =     0x41d00303, /* keyboard controller */
  74         PM_SYS_COM =     0x41d00500, /* serial port */
  75         PM_SYS_IRDA =    0x41d00510, /* IRDA controller */
  76         PM_SYS_FDC =     0x41d00700, /* floppy controller */
  77         PM_SYS_VGA =     0x41d00900, /* VGA controller */
  78         PM_SYS_PCMCIA =  0x41d00e00, /* PCMCIA controller */
  79 };
  80
  81 /*
  82  * Device identifier
  83  */
  84 #define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn)
  85
  86 /*
  87  * Request handler callback
  88  */
  89 struct pm_dev;
  90
  91 typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data);
  92
  93 /*
  94  * Dynamic device information
  95  */
  96 struct pm_dev
  97 {
  98         pm_dev_t         type;
  99         unsigned long    id;
 100         pm_callback      callback;
 101         void            *data;
 102
 103         unsigned long    flags;
 104         int              state;
 105         int              prev_state;
 106
 107         struct list_head entry;
 108 };
 109
 110 #ifdef CONFIG_PM
 111
 112 extern int pm_active;
 113
 114 #define PM_IS_ACTIVE() (pm_active != 0)
 115
 116 /*
 117  * Register a device with power management
 118  */
 119 struct pm_dev *pm_register(pm_dev_t type,
 120                            unsigned long id,
 121                            pm_callback callback);
 122
 123 /*
 124  * Unregister a device with power management
 125  */
 126 void pm_unregister(struct pm_dev *dev);
 127
 128 /*
 129  * Unregister all devices with matching callback
 130  */
 131 void pm_unregister_all(pm_callback callback);
 132
 133 /*
 134  * Send a request to a single device
 135  */
 136 int pm_send(struct pm_dev *dev, pm_request_t rqst, void *data);
 137
 138 /*
 139  * Send a request to all devices
 140  */
 141 int pm_send_all(pm_request_t rqst, void *data);
 142
 143 /*
 144  * Find a device
 145  */
 146 struct pm_dev *pm_find(pm_dev_t type, struct pm_dev *from);
 147
 148 extern inline void pm_access(struct pm_dev *dev) {}
 149 extern inline void pm_dev_idle(struct pm_dev *dev) {}
 150
 151 #else /* CONFIG_PM */
 152
 153 #define PM_IS_ACTIVE() 0
 154
 155 extern inline struct pm_dev *pm_register(pm_dev_t type,
 156                                          unsigned long id,
 157                                          pm_callback callback)
 158 {
 159         return 0;
 160 }
 161
 162 extern inline void pm_unregister(struct pm_dev *dev) {}
 163
 164 extern inline void pm_unregister_all(pm_callback callback) {}
 165
 166 extern inline int pm_send(struct pm_dev *dev, pm_request_t rqst, void *data)
 167 {
 168         return 0;
 169 }
 170
 171 extern inline int pm_send_all(pm_request_t rqst, void *data)
 172 {
 173         return 0;
 174 }
 175
 176 extern inline struct pm_dev *pm_find(pm_dev_t type, struct pm_dev *from)
 177 {
 178         return 0;
 179 }
 180
 181 extern inline void pm_access(struct pm_dev *dev) {}
 182 extern inline void pm_dev_idle(struct pm_dev *dev) {}
 183
 184 #endif /* CONFIG_PM */
 185
 186 extern void (*pm_idle)(void);
 187 extern void (*pm_power_off)(void);
 188
 189 #endif /* __KERNEL__ */
 190
 191 #endif /* _LINUX_PM_H */