include/linux/pm_qos.h

   1 #ifndef _LINUX_PM_QOS_H
   2 #define _LINUX_PM_QOS_H
   3 /* interface for the pm_qos_power infrastructure of the linux kernel.
   4  *
   5  * Mark Gross <mgross@linux.intel.com>
   6  */
   7 #include <linux/plist.h>
   8 #include <linux/notifier.h>
   9 #include <linux/miscdevice.h>
  10 #include <linux/device.h>
  11 #include <linux/workqueue.h>
  12
  13 enum {
  14         PM_QOS_RESERVED = 0,
  15         PM_QOS_CPU_DMA_LATENCY,
  16         PM_QOS_NETWORK_LATENCY,
  17         PM_QOS_NETWORK_THROUGHPUT,
  18 #ifdef CONFIG_CPUQUIET_FRAMEWORK
  19         PM_QOS_MIN_ONLINE_CPUS,
  20         PM_QOS_MAX_ONLINE_CPUS,
  21 #endif
  22
  23         /* insert new class ID */
  24         PM_QOS_NUM_CLASSES,
  25 };
  26
  27 enum pm_qos_flags_status {
  28         PM_QOS_FLAGS_UNDEFINED = -1,
  29         PM_QOS_FLAGS_NONE,
  30         PM_QOS_FLAGS_SOME,
  31         PM_QOS_FLAGS_ALL,
  32 };
  33
  34 #define PM_QOS_DEFAULT_VALUE -1
  35
  36 #define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  37 #define PM_QOS_NETWORK_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  38 #define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
  39 #ifdef CONFIG_CPUQUIET_FRAMEWORK
  40 #define PM_QOS_MIN_ONLINE_CPUS_DEFAULT_VALUE    0
  41 #define PM_QOS_MAX_ONLINE_CPUS_DEFAULT_VALUE    INT_MAX
  42 #endif
  43 #define PM_QOS_DEV_LAT_DEFAULT_VALUE            0
  44
  45 #define PM_QOS_FLAG_NO_POWER_OFF        (1 << 0)
  46 #define PM_QOS_FLAG_REMOTE_WAKEUP       (1 << 1)
  47
  48 struct pm_qos_request {
  49         struct plist_node node;
  50         int pm_qos_class;
  51         struct delayed_work work; /* for pm_qos_update_request_timeout */
  52 };
  53
  54 struct pm_qos_flags_request {
  55         struct list_head node;
  56         s32 flags;      /* Do not change to 64 bit */
  57 };
  58
  59 enum dev_pm_qos_req_type {
  60         DEV_PM_QOS_LATENCY = 1,
  61         DEV_PM_QOS_FLAGS,
  62 };
  63
  64 struct dev_pm_qos_request {
  65         enum dev_pm_qos_req_type type;
  66         union {
  67                 struct plist_node pnode;
  68                 struct pm_qos_flags_request flr;
  69         } data;
  70         struct device *dev;
  71 };
  72
  73 enum pm_qos_type {
  74         PM_QOS_UNITIALIZED,
  75         PM_QOS_MAX,             /* return the largest value */
  76         PM_QOS_MIN              /* return the smallest value */
  77 };
  78
  79 /*
  80  * Note: The lockless read path depends on the CPU accessing target_value
  81  * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
  82  * types linux supports for 32 bit quantites
  83  */
  84 struct pm_qos_constraints {
  85         struct plist_head list;
  86         s32 target_value;       /* Do not change to 64 bit */
  87         s32 default_value;
  88         enum pm_qos_type type;
  89         struct blocking_notifier_head *notifiers;
  90 };
  91
  92 struct pm_qos_flags {
  93         struct list_head list;
  94         s32 effective_flags;    /* Do not change to 64 bit */
  95 };
  96
  97 struct dev_pm_qos {
  98         struct pm_qos_constraints latency;
  99         struct pm_qos_flags flags;
 100         struct dev_pm_qos_request *latency_req;
 101         struct dev_pm_qos_request *flags_req;
 102 };
 103
 104 /* Action requested to pm_qos_update_target */
 105 enum pm_qos_req_action {
 106         PM_QOS_ADD_REQ,         /* Add a new request */
 107         PM_QOS_UPDATE_REQ,      /* Update an existing request */
 108         PM_QOS_REMOVE_REQ       /* Remove an existing request */
 109 };
 110
 111 static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
 112 {
 113         return req->dev != NULL;
 114 }
 115
 116 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
 117                          enum pm_qos_req_action action, int value);
 118 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
 119                          struct pm_qos_flags_request *req,
 120                          enum pm_qos_req_action action, s32 val);
 121 void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
 122                         s32 value);
 123 void pm_qos_update_request(struct pm_qos_request *req,
 124                            s32 new_value);
 125 void pm_qos_update_request_timeout(struct pm_qos_request *req,
 126                                    s32 new_value, unsigned long timeout_us);
 127 void pm_qos_remove_request(struct pm_qos_request *req);
 128
 129 int pm_qos_request(int pm_qos_class);
 130 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
 131 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
 132 int pm_qos_request_active(struct pm_qos_request *req);
 133 s32 pm_qos_read_value(struct pm_qos_constraints *c);
 134
 135 #ifdef CONFIG_PM
 136 enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
 137 enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
 138 s32 __dev_pm_qos_read_value(struct device *dev);
 139 s32 dev_pm_qos_read_value(struct device *dev);
 140 int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
 141                            enum dev_pm_qos_req_type type, s32 value);
 142 int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
 143 int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
 144 int dev_pm_qos_add_notifier(struct device *dev,
 145                             struct notifier_block *notifier);
 146 int dev_pm_qos_remove_notifier(struct device *dev,
 147                                struct notifier_block *notifier);
 148 int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
 149 int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
 150 void dev_pm_qos_constraints_init(struct device *dev);
 151 void dev_pm_qos_constraints_destroy(struct device *dev);
 152 int dev_pm_qos_add_ancestor_request(struct device *dev,
 153                                     struct dev_pm_qos_request *req, s32 value);
 154 #else
 155 static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
 156                                                           s32 mask)
 157                         { return PM_QOS_FLAGS_UNDEFINED; }
 158 static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
 159                                                         s32 mask)
 160                         { return PM_QOS_FLAGS_UNDEFINED; }
 161 static inline s32 __dev_pm_qos_read_value(struct device *dev)
 162                         { return 0; }
 163 static inline s32 dev_pm_qos_read_value(struct device *dev)
 164                         { return 0; }
 165 static inline int dev_pm_qos_add_request(struct device *dev,
 166                                          struct dev_pm_qos_request *req,
 167                                          enum dev_pm_qos_req_type type,
 168                                          s32 value)
 169                         { return 0; }
 170 static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
 171                                             s32 new_value)
 172                         { return 0; }
 173 static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
 174                         { return 0; }
 175 static inline int dev_pm_qos_add_notifier(struct device *dev,
 176                                           struct notifier_block *notifier)
 177                         { return 0; }
 178 static inline int dev_pm_qos_remove_notifier(struct device *dev,
 179                                              struct notifier_block *notifier)
 180                         { return 0; }
 181 static inline int dev_pm_qos_add_global_notifier(
 182                                         struct notifier_block *notifier)
 183                         { return 0; }
 184 static inline int dev_pm_qos_remove_global_notifier(
 185                                         struct notifier_block *notifier)
 186                         { return 0; }
 187 static inline void dev_pm_qos_constraints_init(struct device *dev)
 188 {
 189         dev->power.power_state = PMSG_ON;
 190 }
 191 static inline void dev_pm_qos_constraints_destroy(struct device *dev)
 192 {
 193         dev->power.power_state = PMSG_INVALID;
 194 }
 195 static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
 196                                     struct dev_pm_qos_request *req, s32 value)
 197                         { return 0; }
 198 #endif
 199
 200 #ifdef CONFIG_PM_RUNTIME
 201 int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
 202 void dev_pm_qos_hide_latency_limit(struct device *dev);
 203 int dev_pm_qos_expose_flags(struct device *dev, s32 value);
 204 void dev_pm_qos_hide_flags(struct device *dev);
 205 int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
 206
 207 static inline s32 dev_pm_qos_requested_latency(struct device *dev)
 208 {
 209         return dev->power.qos->latency_req->data.pnode.prio;
 210 }
 211
 212 static inline s32 dev_pm_qos_requested_flags(struct device *dev)
 213 {
 214         return dev->power.qos->flags_req->data.flr.flags;
 215 }
 216 #else
 217 static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
 218                         { return 0; }
 219 static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
 220 static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
 221                         { return 0; }
 222 static inline void dev_pm_qos_hide_flags(struct device *dev) {}
 223 static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
 224                         { return 0; }
 225
 226 static inline s32 dev_pm_qos_requested_latency(struct device *dev) { return 0; }
 227 static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
 228 #endif
 229
 230 #endif