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 #include <linux/cpumask.h>
  13 #include <linux/interrupt.h>
  14
  15 enum {
  16         PM_QOS_RESERVED = 0,
  17         PM_QOS_CPU_DMA_LATENCY,
  18         PM_QOS_NETWORK_LATENCY,
  19         PM_QOS_NETWORK_THROUGHPUT,
  20         PM_QOS_MEMORY_BANDWIDTH,
  21
  22         /* insert new class ID */
  23         PM_QOS_NUM_CLASSES,
  24 };
  25
  26 enum pm_qos_flags_status {
  27         PM_QOS_FLAGS_UNDEFINED = -1,
  28         PM_QOS_FLAGS_NONE,
  29         PM_QOS_FLAGS_SOME,
  30         PM_QOS_FLAGS_ALL,
  31 };
  32
  33 #define PM_QOS_DEFAULT_VALUE -1
  34
  35 #define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  36 #define PM_QOS_NETWORK_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  37 #define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
  38 #define PM_QOS_MEMORY_BANDWIDTH_DEFAULT_VALUE   0
  39 #define PM_QOS_RESUME_LATENCY_DEFAULT_VALUE     0
  40 #define PM_QOS_LATENCY_TOLERANCE_DEFAULT_VALUE  0
  41 #define PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT  (-1)
  42 #define PM_QOS_LATENCY_ANY                      ((s32)(~(__u32)0 >> 1))
  43
  44 #define PM_QOS_FLAG_NO_POWER_OFF        (1 << 0)
  45 #define PM_QOS_FLAG_REMOTE_WAKEUP       (1 << 1)
  46
  47 enum pm_qos_req_type {
  48         PM_QOS_REQ_ALL_CORES = 0,
  49         PM_QOS_REQ_AFFINE_CORES,
  50 #ifdef CONFIG_SMP
  51         PM_QOS_REQ_AFFINE_IRQ,
  52 #endif
  53 };
  54
  55 struct pm_qos_request {
  56         enum pm_qos_req_type type;
  57         struct cpumask cpus_affine;
  58 #ifdef CONFIG_SMP
  59         uint32_t irq;
  60         /* Internal structure members */
  61         struct irq_affinity_notify irq_notify;
  62 #endif
  63         struct plist_node node;
  64         int pm_qos_class;
  65         struct delayed_work work; /* for pm_qos_update_request_timeout */
  66 };
  67
  68 struct pm_qos_flags_request {
  69         struct list_head node;
  70         s32 flags;      /* Do not change to 64 bit */
  71 };
  72
  73 enum dev_pm_qos_req_type {
  74         DEV_PM_QOS_RESUME_LATENCY = 1,
  75         DEV_PM_QOS_LATENCY_TOLERANCE,
  76         DEV_PM_QOS_FLAGS,
  77 };
  78
  79 struct dev_pm_qos_request {
  80         enum dev_pm_qos_req_type type;
  81         union {
  82                 struct pm_qos_request lat;
  83                 struct pm_qos_flags_request flr;
  84         } data;
  85         struct device *dev;
  86 };
  87
  88 enum pm_qos_type {
  89         PM_QOS_UNITIALIZED,
  90         PM_QOS_MAX,             /* return the largest value */
  91         PM_QOS_MIN,             /* return the smallest value */
  92         PM_QOS_SUM              /* return the sum */
  93 };
  94
  95 /*
  96  * Note: The lockless read path depends on the CPU accessing target_value
  97  * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
  98  * types linux supports for 32 bit quantites
  99  */
 100 struct pm_qos_constraints {
 101         struct plist_head list;
 102         s32 target_value;       /* Do not change to 64 bit */
 103         s32 target_per_cpu[NR_CPUS];
 104         s32 default_value;
 105         s32 no_constraint_value;
 106         enum pm_qos_type type;
 107         struct blocking_notifier_head *notifiers;
 108 };
 109
 110 struct pm_qos_flags {
 111         struct list_head list;
 112         s32 effective_flags;    /* Do not change to 64 bit */
 113 };
 114
 115 struct dev_pm_qos {
 116         struct pm_qos_constraints resume_latency;
 117         struct pm_qos_constraints latency_tolerance;
 118         struct pm_qos_flags flags;
 119         struct dev_pm_qos_request *resume_latency_req;
 120         struct dev_pm_qos_request *latency_tolerance_req;
 121         struct dev_pm_qos_request *flags_req;
 122 };
 123
 124 /* Action requested to pm_qos_update_target */
 125 enum pm_qos_req_action {
 126         PM_QOS_ADD_REQ,         /* Add a new request */
 127         PM_QOS_UPDATE_REQ,      /* Update an existing request */
 128         PM_QOS_REMOVE_REQ       /* Remove an existing request */
 129 };
 130
 131 static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
 132 {
 133         return req->dev != NULL;
 134 }
 135
 136 int pm_qos_update_target(struct pm_qos_constraints *c,
 137                                 struct pm_qos_request *req,
 138                                 enum pm_qos_req_action action, int value);
 139 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
 140                          struct pm_qos_flags_request *req,
 141                          enum pm_qos_req_action action, s32 val);
 142 void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
 143                         s32 value);
 144 void pm_qos_update_request(struct pm_qos_request *req,
 145                            s32 new_value);
 146 void pm_qos_update_request_timeout(struct pm_qos_request *req,
 147                                    s32 new_value, unsigned long timeout_us);
 148 void pm_qos_remove_request(struct pm_qos_request *req);
 149
 150 int pm_qos_request(int pm_qos_class);
 151 int pm_qos_request_for_cpu(int pm_qos_class, int cpu);
 152 int pm_qos_request_for_cpumask(int pm_qos_class, struct cpumask *mask);
 153 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
 154 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
 155 int pm_qos_request_active(struct pm_qos_request *req);
 156 s32 pm_qos_read_value(struct pm_qos_constraints *c);
 157
 158 #ifdef CONFIG_PM
 159 enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
 160 enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
 161 s32 __dev_pm_qos_read_value(struct device *dev);
 162 s32 dev_pm_qos_read_value(struct device *dev);
 163 int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
 164                            enum dev_pm_qos_req_type type, s32 value);
 165 int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
 166 int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
 167 int dev_pm_qos_add_notifier(struct device *dev,
 168                             struct notifier_block *notifier);
 169 int dev_pm_qos_remove_notifier(struct device *dev,
 170                                struct notifier_block *notifier);
 171 int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
 172 int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
 173 void dev_pm_qos_constraints_init(struct device *dev);
 174 void dev_pm_qos_constraints_destroy(struct device *dev);
 175 int dev_pm_qos_add_ancestor_request(struct device *dev,
 176                                     struct dev_pm_qos_request *req,
 177                                     enum dev_pm_qos_req_type type, s32 value);
 178 int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
 179 void dev_pm_qos_hide_latency_limit(struct device *dev);
 180 int dev_pm_qos_expose_flags(struct device *dev, s32 value);
 181 void dev_pm_qos_hide_flags(struct device *dev);
 182 int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
 183 s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev);
 184 int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val);
 185 int dev_pm_qos_expose_latency_tolerance(struct device *dev);
 186 void dev_pm_qos_hide_latency_tolerance(struct device *dev);
 187
 188 static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
 189 {
 190         return dev->power.qos->resume_latency_req->data.lat.node.prio;
 191 }
 192
 193 static inline s32 dev_pm_qos_requested_flags(struct device *dev)
 194 {
 195         return dev->power.qos->flags_req->data.flr.flags;
 196 }
 197 #else
 198 static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
 199                                                           s32 mask)
 200                         { return PM_QOS_FLAGS_UNDEFINED; }
 201 static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
 202                                                         s32 mask)
 203                         { return PM_QOS_FLAGS_UNDEFINED; }
 204 static inline s32 __dev_pm_qos_read_value(struct device *dev)
 205                         { return 0; }
 206 static inline s32 dev_pm_qos_read_value(struct device *dev)
 207                         { return 0; }
 208 static inline int dev_pm_qos_add_request(struct device *dev,
 209                                          struct dev_pm_qos_request *req,
 210                                          enum dev_pm_qos_req_type type,
 211                                          s32 value)
 212                         { return 0; }
 213 static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
 214                                             s32 new_value)
 215                         { return 0; }
 216 static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
 217                         { return 0; }
 218 static inline int dev_pm_qos_add_notifier(struct device *dev,
 219                                           struct notifier_block *notifier)
 220                         { return 0; }
 221 static inline int dev_pm_qos_remove_notifier(struct device *dev,
 222                                              struct notifier_block *notifier)
 223                         { return 0; }
 224 static inline int dev_pm_qos_add_global_notifier(
 225                                         struct notifier_block *notifier)
 226                         { return 0; }
 227 static inline int dev_pm_qos_remove_global_notifier(
 228                                         struct notifier_block *notifier)
 229                         { return 0; }
 230 static inline void dev_pm_qos_constraints_init(struct device *dev)
 231 {
 232         dev->power.power_state = PMSG_ON;
 233 }
 234 static inline void dev_pm_qos_constraints_destroy(struct device *dev)
 235 {
 236         dev->power.power_state = PMSG_INVALID;
 237 }
 238 static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
 239                                                   struct dev_pm_qos_request *req,
 240                                                   enum dev_pm_qos_req_type type,
 241                                                   s32 value)
 242                         { return 0; }
 243 static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
 244                         { return 0; }
 245 static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
 246 static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
 247                         { return 0; }
 248 static inline void dev_pm_qos_hide_flags(struct device *dev) {}
 249 static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
 250                         { return 0; }
 251 static inline s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev)
 252                         { return PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT; }
 253 static inline int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val)
 254                         { return 0; }
 255 static inline int dev_pm_qos_expose_latency_tolerance(struct device *dev)
 256                         { return 0; }
 257 static inline void dev_pm_qos_hide_latency_tolerance(struct device *dev) {}
 258
 259 static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev) { return 0; }
 260 static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
 261 #endif
 262
 263 #endif