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_DEV_LAT_DEFAULT_VALUE            0
  36
  37 struct pm_qos_request {
  38         struct plist_node node;
  39         int pm_qos_class;
  40         struct delayed_work work; /* for pm_qos_update_request_timeout */
  41 };
  42
  43 struct pm_qos_flags_request {
  44         struct list_head node;
  45         s32 flags;      /* Do not change to 64 bit */
  46 };
  47
  48 enum dev_pm_qos_req_type {
  49         DEV_PM_QOS_LATENCY = 1,
  50         DEV_PM_QOS_FLAGS,
  51 };
  52
  53 struct dev_pm_qos_request {
  54         enum dev_pm_qos_req_type type;
  55         union {
  56                 struct plist_node pnode;
  57                 struct pm_qos_flags_request flr;
  58         } data;
  59         struct device *dev;
  60 };
  61
  62 enum pm_qos_type {
  63         PM_QOS_UNITIALIZED,
  64         PM_QOS_MAX,             /* return the largest value */
  65         PM_QOS_MIN              /* return the smallest value */
  66 };
  67
  68 /*
  69  * Note: The lockless read path depends on the CPU accessing target_value
  70  * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
  71  * types linux supports for 32 bit quantites
  72  */
  73 struct pm_qos_constraints {
  74         struct plist_head list;
  75         s32 target_value;       /* Do not change to 64 bit */
  76         s32 default_value;
  77         enum pm_qos_type type;
  78         struct blocking_notifier_head *notifiers;
  79 };
  80
  81 struct pm_qos_flags {
  82         struct list_head list;
  83         s32 effective_flags;    /* Do not change to 64 bit */
  84 };
  85
  86 struct dev_pm_qos {
  87         struct pm_qos_constraints latency;
  88         struct pm_qos_flags flags;
  89 };
  90
  91 /* Action requested to pm_qos_update_target */
  92 enum pm_qos_req_action {
  93         PM_QOS_ADD_REQ,         /* Add a new request */
  94         PM_QOS_UPDATE_REQ,      /* Update an existing request */
  95         PM_QOS_REMOVE_REQ       /* Remove an existing request */
  96 };
  97
  98 static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
  99 {
 100         return req->dev != NULL;
 101 }
 102
 103 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
 104                          enum pm_qos_req_action action, int value);
 105 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
 106                          struct pm_qos_flags_request *req,
 107                          enum pm_qos_req_action action, s32 val);
 108 void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
 109                         s32 value);
 110 void pm_qos_update_request(struct pm_qos_request *req,
 111                            s32 new_value);
 112 void pm_qos_update_request_timeout(struct pm_qos_request *req,
 113                                    s32 new_value, unsigned long timeout_us);
 114 void pm_qos_remove_request(struct pm_qos_request *req);
 115
 116 int pm_qos_request(int pm_qos_class);
 117 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
 118 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
 119 int pm_qos_request_active(struct pm_qos_request *req);
 120 s32 pm_qos_read_value(struct pm_qos_constraints *c);
 121
 122 #ifdef CONFIG_PM
 123 enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
 124 enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
 125 s32 __dev_pm_qos_read_value(struct device *dev);
 126 s32 dev_pm_qos_read_value(struct device *dev);
 127 int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
 128                            enum dev_pm_qos_req_type type, s32 value);
 129 int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
 130 int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
 131 int dev_pm_qos_add_notifier(struct device *dev,
 132                             struct notifier_block *notifier);
 133 int dev_pm_qos_remove_notifier(struct device *dev,
 134                                struct notifier_block *notifier);
 135 int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
 136 int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
 137 void dev_pm_qos_constraints_init(struct device *dev);
 138 void dev_pm_qos_constraints_destroy(struct device *dev);
 139 int dev_pm_qos_add_ancestor_request(struct device *dev,
 140                                     struct dev_pm_qos_request *req, s32 value);
 141 #else
 142 static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
 143                                                           s32 mask)
 144                         { return PM_QOS_FLAGS_UNDEFINED; }
 145 static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
 146                                                         s32 mask)
 147                         { return PM_QOS_FLAGS_UNDEFINED; }
 148 static inline s32 __dev_pm_qos_read_value(struct device *dev)
 149                         { return 0; }
 150 static inline s32 dev_pm_qos_read_value(struct device *dev)
 151                         { return 0; }
 152 static inline int dev_pm_qos_add_request(struct device *dev,
 153                                          struct dev_pm_qos_request *req,
 154                                          enum dev_pm_qos_req_type type,
 155                                          s32 value)
 156                         { return 0; }
 157 static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
 158                                             s32 new_value)
 159                         { return 0; }
 160 static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
 161                         { return 0; }
 162 static inline int dev_pm_qos_add_notifier(struct device *dev,
 163                                           struct notifier_block *notifier)
 164                         { return 0; }
 165 static inline int dev_pm_qos_remove_notifier(struct device *dev,
 166                                              struct notifier_block *notifier)
 167                         { return 0; }
 168 static inline int dev_pm_qos_add_global_notifier(
 169                                         struct notifier_block *notifier)
 170                         { return 0; }
 171 static inline int dev_pm_qos_remove_global_notifier(
 172                                         struct notifier_block *notifier)
 173                         { return 0; }
 174 static inline void dev_pm_qos_constraints_init(struct device *dev)
 175 {
 176         dev->power.power_state = PMSG_ON;
 177 }
 178 static inline void dev_pm_qos_constraints_destroy(struct device *dev)
 179 {
 180         dev->power.power_state = PMSG_INVALID;
 181 }
 182 static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
 183                                     struct dev_pm_qos_request *req, s32 value)
 184                         { return 0; }
 185 #endif
 186
 187 #ifdef CONFIG_PM_RUNTIME
 188 int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
 189 void dev_pm_qos_hide_latency_limit(struct device *dev);
 190 #else
 191 static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
 192                         { return 0; }
 193 static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
 194 #endif
 195
 196 #endif