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
  19         /* insert new class ID */
  20         PM_QOS_NUM_CLASSES,
  21 };
  22
  23 enum pm_qos_flags_status {
  24         PM_QOS_FLAGS_UNDEFINED = -1,
  25         PM_QOS_FLAGS_NONE,
  26         PM_QOS_FLAGS_SOME,
  27         PM_QOS_FLAGS_ALL,
  28 };
  29
  30 #define PM_QOS_DEFAULT_VALUE -1
  31
  32 #define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  33 #define PM_QOS_NETWORK_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  34 #define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
  35 #define PM_QOS_RESUME_LATENCY_DEFAULT_VALUE     0
  36 #define PM_QOS_LATENCY_TOLERANCE_DEFAULT_VALUE  0
  37 #define PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT  (-1)
  38 #define PM_QOS_LATENCY_ANY                      ((s32)(~(__u32)0 >> 1))
  39
  40 #define PM_QOS_FLAG_NO_POWER_OFF        (1 << 0)
  41 #define PM_QOS_FLAG_REMOTE_WAKEUP       (1 << 1)
  42
  43 struct pm_qos_request {
  44         struct plist_node node;
  45         int pm_qos_class;
  46         struct delayed_work work; /* for pm_qos_update_request_timeout */
  47 };
  48
  49 struct pm_qos_flags_request {
  50         struct list_head node;
  51         s32 flags;      /* Do not change to 64 bit */
  52 };
  53
  54 enum dev_pm_qos_req_type {
  55         DEV_PM_QOS_RESUME_LATENCY = 1,
  56         DEV_PM_QOS_LATENCY_TOLERANCE,
  57         DEV_PM_QOS_FLAGS,
  58 };
  59
  60 struct dev_pm_qos_request {
  61         enum dev_pm_qos_req_type type;
  62         union {
  63                 struct plist_node pnode;
  64                 struct pm_qos_flags_request flr;
  65         } data;
  66         struct device *dev;
  67 };
  68
  69 enum pm_qos_type {
  70         PM_QOS_UNITIALIZED,
  71         PM_QOS_MAX,             /* return the largest value */
  72         PM_QOS_MIN              /* return the smallest value */
  73 };
  74
  75 /*
  76  * Note: The lockless read path depends on the CPU accessing target_value
  77  * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
  78  * types linux supports for 32 bit quantites
  79  */
  80 struct pm_qos_constraints {
  81         struct plist_head list;
  82         s32 target_value;       /* Do not change to 64 bit */
  83         s32 default_value;
  84         s32 no_constraint_value;
  85         enum pm_qos_type type;
  86         struct blocking_notifier_head *notifiers;
  87 };
  88
  89 struct pm_qos_flags {
  90         struct list_head list;
  91         s32 effective_flags;    /* Do not change to 64 bit */
  92 };
  93
  94 struct dev_pm_qos {
  95         struct pm_qos_constraints resume_latency;
  96         struct pm_qos_constraints latency_tolerance;
  97         struct pm_qos_flags flags;
  98         struct dev_pm_qos_request *resume_latency_req;
  99         struct dev_pm_qos_request *latency_tolerance_req;
 100         struct dev_pm_qos_request *flags_req;
 101 };
 102
 103 /* Action requested to pm_qos_update_target */
 104 enum pm_qos_req_action {
 105         PM_QOS_ADD_REQ,         /* Add a new request */
 106         PM_QOS_UPDATE_REQ,      /* Update an existing request */
 107         PM_QOS_REMOVE_REQ       /* Remove an existing request */
 108 };
 109
 110 static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
 111 {
 112         return req->dev != NULL;
 113 }
 114
 115 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
 116                          enum pm_qos_req_action action, int value);
 117 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
 118                          struct pm_qos_flags_request *req,
 119                          enum pm_qos_req_action action, s32 val);
 120 void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
 121                         s32 value);
 122 void pm_qos_update_request(struct pm_qos_request *req,
 123                            s32 new_value);
 124 void pm_qos_update_request_timeout(struct pm_qos_request *req,
 125                                    s32 new_value, unsigned long timeout_us);
 126 void pm_qos_remove_request(struct pm_qos_request *req);
 127
 128 int pm_qos_request(int pm_qos_class);
 129 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
 130 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
 131 int pm_qos_request_active(struct pm_qos_request *req);
 132 s32 pm_qos_read_value(struct pm_qos_constraints *c);
 133
 134 #ifdef CONFIG_PM
 135 enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
 136 enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
 137 s32 __dev_pm_qos_read_value(struct device *dev);
 138 s32 dev_pm_qos_read_value(struct device *dev);
 139 int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
 140                            enum dev_pm_qos_req_type type, s32 value);
 141 int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
 142 int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
 143 int dev_pm_qos_add_notifier(struct device *dev,
 144                             struct notifier_block *notifier);
 145 int dev_pm_qos_remove_notifier(struct device *dev,
 146                                struct notifier_block *notifier);
 147 int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
 148 int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
 149 void dev_pm_qos_constraints_init(struct device *dev);
 150 void dev_pm_qos_constraints_destroy(struct device *dev);
 151 int dev_pm_qos_add_ancestor_request(struct device *dev,
 152                                     struct dev_pm_qos_request *req,
 153                                     enum dev_pm_qos_req_type type, 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,
 197                                                   enum dev_pm_qos_req_type type,
 198                                                   s32 value)
 199                         { return 0; }
 200 #endif
 201
 202 #ifdef CONFIG_PM_RUNTIME
 203 int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
 204 void dev_pm_qos_hide_latency_limit(struct device *dev);
 205 int dev_pm_qos_expose_flags(struct device *dev, s32 value);
 206 void dev_pm_qos_hide_flags(struct device *dev);
 207 int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
 208 s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev);
 209 int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val);
 210
 211 static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
 212 {
 213         return dev->power.qos->resume_latency_req->data.pnode.prio;
 214 }
 215
 216 static inline s32 dev_pm_qos_requested_flags(struct device *dev)
 217 {
 218         return dev->power.qos->flags_req->data.flr.flags;
 219 }
 220 #else
 221 static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
 222                         { return 0; }
 223 static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
 224 static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
 225                         { return 0; }
 226 static inline void dev_pm_qos_hide_flags(struct device *dev) {}
 227 static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
 228                         { return 0; }
 229 static inline s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev)
 230                         { return PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT; }
 231 static inline int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val)
 232                         { return 0; }
 233
 234 static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev) { return 0; }
 235 static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
 236 #endif
 237
 238 #endif