LXR linux/include/linux/pm

   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
  13enum {
  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
  23enum 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#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
  43struct 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
  49struct pm_qos_flags_request {
  50        struct list_head node;
  51        s32 flags;      /* Do not change to 64 bit */
  52};
  53
  54enum dev_pm_qos_req_type {
  55        DEV_PM_QOS_LATENCY = 1,
  56        DEV_PM_QOS_FLAGS,
  57#ifndef __GENKSYMS__
  58        DEV_PM_QOS_LATENCY_TOLERANCE,
  59#endif
  60};
  61
  62struct dev_pm_qos_request {
  63        enum dev_pm_qos_req_type type;
  64        union {
  65                struct plist_node pnode;
  66                struct pm_qos_flags_request flr;
  67        } data;
  68        struct device *dev;
  69};
  70
  71enum pm_qos_type {
  72        PM_QOS_UNITIALIZED,
  73        PM_QOS_MAX,             /* return the largest value */
  74        PM_QOS_MIN              /* return the smallest value */
  75};
  76
  77/*
  78 * Note: The lockless read path depends on the CPU accessing target_value
  79 * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
  80 * types linux supports for 32 bit quantites
  81 */
  82struct pm_qos_constraints {
  83        struct plist_head list;
  84        s32 target_value;       /* Do not change to 64 bit */
  85        s32 default_value;
  86        enum pm_qos_type type;
  87        struct blocking_notifier_head *notifiers;
  88};
  89
  90struct pm_qos_flags {
  91        struct list_head list;
  92        s32 effective_flags;    /* Do not change to 64 bit */
  93};
  94
  95struct dev_pm_qos {
  96        struct pm_qos_constraints latency;
  97        struct pm_qos_flags flags;
  98        struct dev_pm_qos_request *latency_req;
  99        struct dev_pm_qos_request *flags_req;
 100        RH_KABI_EXTEND(struct pm_qos_constraints latency_tolerance)
 101        RH_KABI_EXTEND(struct dev_pm_qos_request *latency_tolerance_req)
 102};
 103
 104/* Action requested to pm_qos_update_target */
 105enum 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
 111static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
 112{
 113        return req->dev != NULL;
 114}
 115
 116int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
 117                         enum pm_qos_req_action action, int value);
 118bool 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);
 121void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
 122                        s32 value);
 123void pm_qos_update_request(struct pm_qos_request *req,
 124                           s32 new_value);
 125void pm_qos_update_request_timeout(struct pm_qos_request *req,
 126                                   s32 new_value, unsigned long timeout_us);
 127void pm_qos_remove_request(struct pm_qos_request *req);
 128
 129int pm_qos_request(int pm_qos_class);
 130int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
 131int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
 132int pm_qos_request_active(struct pm_qos_request *req);
 133s32 pm_qos_read_value(struct pm_qos_constraints *c);
 134
 135#ifdef CONFIG_PM
 136enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
 137enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
 138s32 __dev_pm_qos_read_value(struct device *dev);
 139s32 dev_pm_qos_read_value(struct device *dev);
 140int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
 141                           enum dev_pm_qos_req_type type, s32 value);
 142int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
 143int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
 144int dev_pm_qos_add_notifier(struct device *dev,
 145                            struct notifier_block *notifier);
 146int dev_pm_qos_remove_notifier(struct device *dev,
 147                               struct notifier_block *notifier);
 148int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
 149int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
 150void dev_pm_qos_constraints_init(struct device *dev);
 151void dev_pm_qos_constraints_destroy(struct device *dev);
 152int dev_pm_qos_add_ancestor_request(struct device *dev,
 153                                    struct dev_pm_qos_request *req, s32 value);
 154#else
 155static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
 156                                                          s32 mask)
 157                        { return PM_QOS_FLAGS_UNDEFINED; }
 158static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
 159                                                        s32 mask)
 160                        { return PM_QOS_FLAGS_UNDEFINED; }
 161static inline s32 __dev_pm_qos_read_value(struct device *dev)
 162                        { return 0; }
 163static inline s32 dev_pm_qos_read_value(struct device *dev)
 164                        { return 0; }
 165static 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; }
 170static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
 171                                            s32 new_value)
 172                        { return 0; }
 173static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
 174                        { return 0; }
 175static inline int dev_pm_qos_add_notifier(struct device *dev,
 176                                          struct notifier_block *notifier)
 177                        { return 0; }
 178static inline int dev_pm_qos_remove_notifier(struct device *dev,
 179                                             struct notifier_block *notifier)
 180                        { return 0; }
 181static inline int dev_pm_qos_add_global_notifier(
 182                                        struct notifier_block *notifier)
 183                        { return 0; }
 184static inline int dev_pm_qos_remove_global_notifier(
 185                                        struct notifier_block *notifier)
 186                        { return 0; }
 187static inline void dev_pm_qos_constraints_init(struct device *dev)
 188{
 189        dev->power.power_state = PMSG_ON;
 190}
 191static inline void dev_pm_qos_constraints_destroy(struct device *dev)
 192{
 193        dev->power.power_state = PMSG_INVALID;
 194}
 195static 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
 201int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
 202void dev_pm_qos_hide_latency_limit(struct device *dev);
 203int dev_pm_qos_expose_flags(struct device *dev, s32 value);
 204void dev_pm_qos_hide_flags(struct device *dev);
 205int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
 206s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev);
 207int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val);
 208int dev_pm_qos_expose_latency_tolerance(struct device *dev);
 209void dev_pm_qos_hide_latency_tolerance(struct device *dev);
 210
 211static inline s32 dev_pm_qos_requested_latency(struct device *dev)
 212{
 213        return dev->power.qos->latency_req->data.pnode.prio;
 214}
 215
 216static inline s32 dev_pm_qos_requested_flags(struct device *dev)
 217{
 218        return dev->power.qos->flags_req->data.flr.flags;
 219}
 220#else
 221static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
 222                        { return 0; }
 223static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
 224static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
 225                        { return 0; }
 226static inline void dev_pm_qos_hide_flags(struct device *dev) {}
 227static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
 228                        { return 0; }
 229static inline s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev)
 230                        { return PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT; }
 231static inline int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val)
 232                        { return 0; }
 233static inline int dev_pm_qos_expose_latency_tolerance(struct device *dev)
 234                        { return 0; }
 235static inline void dev_pm_qos_hide_latency_tolerance(struct device *dev) {}
 236
 237static inline s32 dev_pm_qos_requested_latency(struct device *dev) { return 0; }
 238static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
 239#endif
 240
 241#endif
 242