LXR linux/include/linux/pm

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _LINUX_PM_QOS_H
   3#define _LINUX_PM_QOS_H
   4/* interface for the pm_qos_power infrastructure of the linux kernel.
   5 *
   6 * Mark Gross <mgross@linux.intel.com>
   7 */
   8#include <linux/plist.h>
   9#include <linux/notifier.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
  17        /* insert new class ID */
  18        PM_QOS_NUM_CLASSES,
  19};
  20
  21enum pm_qos_flags_status {
  22        PM_QOS_FLAGS_UNDEFINED = -1,
  23        PM_QOS_FLAGS_NONE,
  24        PM_QOS_FLAGS_SOME,
  25        PM_QOS_FLAGS_ALL,
  26};
  27
  28#define PM_QOS_DEFAULT_VALUE    (-1)
  29#define PM_QOS_LATENCY_ANY      S32_MAX
  30#define PM_QOS_LATENCY_ANY_NS   ((s64)PM_QOS_LATENCY_ANY * NSEC_PER_USEC)
  31
  32#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE        (2000 * USEC_PER_SEC)
  33#define PM_QOS_RESUME_LATENCY_DEFAULT_VALUE     PM_QOS_LATENCY_ANY
  34#define PM_QOS_RESUME_LATENCY_NO_CONSTRAINT     PM_QOS_LATENCY_ANY
  35#define PM_QOS_RESUME_LATENCY_NO_CONSTRAINT_NS  PM_QOS_LATENCY_ANY_NS
  36#define PM_QOS_LATENCY_TOLERANCE_DEFAULT_VALUE  0
  37#define PM_QOS_MIN_FREQUENCY_DEFAULT_VALUE      0
  38#define PM_QOS_MAX_FREQUENCY_DEFAULT_VALUE      FREQ_QOS_MAX_DEFAULT_VALUE
  39#define PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT  (-1)
  40
  41#define PM_QOS_FLAG_NO_POWER_OFF        (1 << 0)
  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 pm_qos_type {
  55        PM_QOS_UNITIALIZED,
  56        PM_QOS_MAX,             /* return the largest value */
  57        PM_QOS_MIN,             /* return the smallest value */
  58        PM_QOS_SUM              /* return the sum */
  59};
  60
  61/*
  62 * Note: The lockless read path depends on the CPU accessing target_value
  63 * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
  64 * types linux supports for 32 bit quantites
  65 */
  66struct pm_qos_constraints {
  67        struct plist_head list;
  68        s32 target_value;       /* Do not change to 64 bit */
  69        s32 default_value;
  70        s32 no_constraint_value;
  71        enum pm_qos_type type;
  72        struct blocking_notifier_head *notifiers;
  73};
  74
  75struct pm_qos_flags {
  76        struct list_head list;
  77        s32 effective_flags;    /* Do not change to 64 bit */
  78};
  79
  80
  81#define FREQ_QOS_MIN_DEFAULT_VALUE      0
  82#define FREQ_QOS_MAX_DEFAULT_VALUE      S32_MAX
  83
  84enum freq_qos_req_type {
  85        FREQ_QOS_MIN = 1,
  86        FREQ_QOS_MAX,
  87};
  88
  89struct freq_constraints {
  90        struct pm_qos_constraints min_freq;
  91        struct blocking_notifier_head min_freq_notifiers;
  92        struct pm_qos_constraints max_freq;
  93        struct blocking_notifier_head max_freq_notifiers;
  94};
  95
  96struct freq_qos_request {
  97        enum freq_qos_req_type type;
  98        struct plist_node pnode;
  99        struct freq_constraints *qos;
 100};
 101
 102
 103enum dev_pm_qos_req_type {
 104        DEV_PM_QOS_RESUME_LATENCY = 1,
 105        DEV_PM_QOS_LATENCY_TOLERANCE,
 106        DEV_PM_QOS_MIN_FREQUENCY,
 107        DEV_PM_QOS_MAX_FREQUENCY,
 108        DEV_PM_QOS_FLAGS,
 109};
 110
 111struct dev_pm_qos_request {
 112        enum dev_pm_qos_req_type type;
 113        union {
 114                struct plist_node pnode;
 115                struct pm_qos_flags_request flr;
 116                struct freq_qos_request freq;
 117        } data;
 118        struct device *dev;
 119};
 120
 121struct dev_pm_qos {
 122        struct pm_qos_constraints resume_latency;
 123        struct pm_qos_constraints latency_tolerance;
 124        struct freq_constraints freq;
 125        struct pm_qos_flags flags;
 126        struct dev_pm_qos_request *resume_latency_req;
 127        struct dev_pm_qos_request *latency_tolerance_req;
 128        struct dev_pm_qos_request *flags_req;
 129};
 130
 131/* Action requested to pm_qos_update_target */
 132enum pm_qos_req_action {
 133        PM_QOS_ADD_REQ,         /* Add a new request */
 134        PM_QOS_UPDATE_REQ,      /* Update an existing request */
 135        PM_QOS_REMOVE_REQ       /* Remove an existing request */
 136};
 137
 138static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
 139{
 140        return req->dev != NULL;
 141}
 142
 143int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
 144                         enum pm_qos_req_action action, int value);
 145bool pm_qos_update_flags(struct pm_qos_flags *pqf,
 146                         struct pm_qos_flags_request *req,
 147                         enum pm_qos_req_action action, s32 val);
 148void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
 149                        s32 value);
 150void pm_qos_update_request(struct pm_qos_request *req,
 151                           s32 new_value);
 152void pm_qos_update_request_timeout(struct pm_qos_request *req,
 153                                   s32 new_value, unsigned long timeout_us);
 154void pm_qos_remove_request(struct pm_qos_request *req);
 155
 156int pm_qos_request(int pm_qos_class);
 157int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
 158int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
 159int pm_qos_request_active(struct pm_qos_request *req);
 160s32 pm_qos_read_value(struct pm_qos_constraints *c);
 161
 162#ifdef CONFIG_PM
 163enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
 164enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
 165s32 __dev_pm_qos_resume_latency(struct device *dev);
 166s32 dev_pm_qos_read_value(struct device *dev, enum dev_pm_qos_req_type type);
 167int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
 168                           enum dev_pm_qos_req_type type, s32 value);
 169int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
 170int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
 171int dev_pm_qos_add_notifier(struct device *dev,
 172                            struct notifier_block *notifier,
 173                            enum dev_pm_qos_req_type type);
 174int dev_pm_qos_remove_notifier(struct device *dev,
 175                               struct notifier_block *notifier,
 176                               enum dev_pm_qos_req_type type);
 177void dev_pm_qos_constraints_init(struct device *dev);
 178void dev_pm_qos_constraints_destroy(struct device *dev);
 179int dev_pm_qos_add_ancestor_request(struct device *dev,
 180                                    struct dev_pm_qos_request *req,
 181                                    enum dev_pm_qos_req_type type, s32 value);
 182int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
 183void dev_pm_qos_hide_latency_limit(struct device *dev);
 184int dev_pm_qos_expose_flags(struct device *dev, s32 value);
 185void dev_pm_qos_hide_flags(struct device *dev);
 186int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
 187s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev);
 188int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val);
 189int dev_pm_qos_expose_latency_tolerance(struct device *dev);
 190void dev_pm_qos_hide_latency_tolerance(struct device *dev);
 191
 192static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
 193{
 194        return dev->power.qos->resume_latency_req->data.pnode.prio;
 195}
 196
 197static inline s32 dev_pm_qos_requested_flags(struct device *dev)
 198{
 199        return dev->power.qos->flags_req->data.flr.flags;
 200}
 201
 202static inline s32 dev_pm_qos_raw_resume_latency(struct device *dev)
 203{
 204        return IS_ERR_OR_NULL(dev->power.qos) ?
 205                PM_QOS_RESUME_LATENCY_NO_CONSTRAINT :
 206                pm_qos_read_value(&dev->power.qos->resume_latency);
 207}
 208#else
 209static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
 210                                                          s32 mask)
 211                        { return PM_QOS_FLAGS_UNDEFINED; }
 212static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
 213                                                        s32 mask)
 214                        { return PM_QOS_FLAGS_UNDEFINED; }
 215static inline s32 __dev_pm_qos_resume_latency(struct device *dev)
 216                        { return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT; }
 217static inline s32 dev_pm_qos_read_value(struct device *dev,
 218                                        enum dev_pm_qos_req_type type)
 219{
 220        switch (type) {
 221        case DEV_PM_QOS_RESUME_LATENCY:
 222                return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT;
 223        case DEV_PM_QOS_MIN_FREQUENCY:
 224                return PM_QOS_MIN_FREQUENCY_DEFAULT_VALUE;
 225        case DEV_PM_QOS_MAX_FREQUENCY:
 226                return PM_QOS_MAX_FREQUENCY_DEFAULT_VALUE;
 227        default:
 228                WARN_ON(1);
 229                return 0;
 230        }
 231}
 232
 233static inline int dev_pm_qos_add_request(struct device *dev,
 234                                         struct dev_pm_qos_request *req,
 235                                         enum dev_pm_qos_req_type type,
 236                                         s32 value)
 237                        { return 0; }
 238static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
 239                                            s32 new_value)
 240                        { return 0; }
 241static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
 242                        { return 0; }
 243static inline int dev_pm_qos_add_notifier(struct device *dev,
 244                                          struct notifier_block *notifier,
 245                                          enum dev_pm_qos_req_type type)
 246                        { return 0; }
 247static inline int dev_pm_qos_remove_notifier(struct device *dev,
 248                                             struct notifier_block *notifier,
 249                                             enum dev_pm_qos_req_type type)
 250                        { return 0; }
 251static inline void dev_pm_qos_constraints_init(struct device *dev)
 252{
 253        dev->power.power_state = PMSG_ON;
 254}
 255static inline void dev_pm_qos_constraints_destroy(struct device *dev)
 256{
 257        dev->power.power_state = PMSG_INVALID;
 258}
 259static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
 260                                                  struct dev_pm_qos_request *req,
 261                                                  enum dev_pm_qos_req_type type,
 262                                                  s32 value)
 263                        { return 0; }
 264static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
 265                        { return 0; }
 266static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
 267static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
 268                        { return 0; }
 269static inline void dev_pm_qos_hide_flags(struct device *dev) {}
 270static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
 271                        { return 0; }
 272static inline s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev)
 273                        { return PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT; }
 274static inline int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val)
 275                        { return 0; }
 276static inline int dev_pm_qos_expose_latency_tolerance(struct device *dev)
 277                        { return 0; }
 278static inline void dev_pm_qos_hide_latency_tolerance(struct device *dev) {}
 279
 280static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
 281{
 282        return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT;
 283}
 284static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
 285static inline s32 dev_pm_qos_raw_resume_latency(struct device *dev)
 286{
 287        return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT;
 288}
 289#endif
 290
 291static inline int freq_qos_request_active(struct freq_qos_request *req)
 292{
 293        return !IS_ERR_OR_NULL(req->qos);
 294}
 295
 296void freq_constraints_init(struct freq_constraints *qos);
 297
 298s32 freq_qos_read_value(struct freq_constraints *qos,
 299                        enum freq_qos_req_type type);
 300
 301int freq_qos_add_request(struct freq_constraints *qos,
 302                         struct freq_qos_request *req,
 303                         enum freq_qos_req_type type, s32 value);
 304int freq_qos_update_request(struct freq_qos_request *req, s32 new_value);
 305int freq_qos_remove_request(struct freq_qos_request *req);
 306int freq_qos_apply(struct freq_qos_request *req,
 307                   enum pm_qos_req_action action, s32 value);
 308
 309int freq_qos_add_notifier(struct freq_constraints *qos,
 310                          enum freq_qos_req_type type,
 311                          struct notifier_block *notifier);
 312int freq_qos_remove_notifier(struct freq_constraints *qos,
 313                             enum freq_qos_req_type type,
 314                             struct notifier_block *notifier);
 315
 316#endif
 317