blob: 233149cb19f4ae8af9ad35b7f6d2d5ab5929e288 [file] [log] [blame]
Jean Pihete8db0be2011-08-25 15:35:03 +02001#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>
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +020010#include <linux/device.h>
MyungJoo Hamc4772d12012-03-28 23:31:24 +020011#include <linux/workqueue.h>
Jean Pihete8db0be2011-08-25 15:35:03 +020012
Alex Fridd031e1d2012-01-29 20:39:25 +010013enum {
14 PM_QOS_RESERVED = 0,
15 PM_QOS_CPU_DMA_LATENCY,
16 PM_QOS_NETWORK_LATENCY,
17 PM_QOS_NETWORK_THROUGHPUT,
Jean Pihete8db0be2011-08-25 15:35:03 +020018
Alex Fridd031e1d2012-01-29 20:39:25 +010019 /* insert new class ID */
20 PM_QOS_NUM_CLASSES,
21};
22
Jean Pihete8db0be2011-08-25 15:35:03 +020023#define PM_QOS_DEFAULT_VALUE -1
24
25#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
26#define PM_QOS_NETWORK_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
27#define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
Jean Pihet91ff4cb2011-08-25 15:35:41 +020028#define PM_QOS_DEV_LAT_DEFAULT_VALUE 0
Jean Pihete8db0be2011-08-25 15:35:03 +020029
Jean Pihetcc749982011-08-25 15:35:12 +020030struct pm_qos_request {
31 struct plist_node node;
Jean Pihete8db0be2011-08-25 15:35:03 +020032 int pm_qos_class;
MyungJoo Hamc4772d12012-03-28 23:31:24 +020033 struct delayed_work work; /* for pm_qos_update_request_timeout */
Jean Pihete8db0be2011-08-25 15:35:03 +020034};
35
Jean Pihet91ff4cb2011-08-25 15:35:41 +020036struct dev_pm_qos_request {
37 struct plist_node node;
38 struct device *dev;
39};
40
Jean Pihet4e1779b2011-08-25 15:35:27 +020041enum pm_qos_type {
42 PM_QOS_UNITIALIZED,
43 PM_QOS_MAX, /* return the largest value */
44 PM_QOS_MIN /* return the smallest value */
45};
46
47/*
48 * Note: The lockless read path depends on the CPU accessing
49 * target_value atomically. Atomic access is only guaranteed on all CPU
50 * types linux supports for 32 bit quantites
51 */
52struct pm_qos_constraints {
53 struct plist_head list;
54 s32 target_value; /* Do not change to 64 bit */
55 s32 default_value;
56 enum pm_qos_type type;
57 struct blocking_notifier_head *notifiers;
58};
59
Jean Pihetabe98ec2011-08-25 15:35:34 +020060/* Action requested to pm_qos_update_target */
61enum pm_qos_req_action {
62 PM_QOS_ADD_REQ, /* Add a new request */
63 PM_QOS_UPDATE_REQ, /* Update an existing request */
64 PM_QOS_REMOVE_REQ /* Remove an existing request */
65};
66
Jean Pihet91ff4cb2011-08-25 15:35:41 +020067static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
68{
69 return req->dev != 0;
70}
71
Jean Pihetabe98ec2011-08-25 15:35:34 +020072int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
73 enum pm_qos_req_action action, int value);
Jean Pihetcc749982011-08-25 15:35:12 +020074void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
75 s32 value);
76void pm_qos_update_request(struct pm_qos_request *req,
Jean Pihete8db0be2011-08-25 15:35:03 +020077 s32 new_value);
MyungJoo Hamc4772d12012-03-28 23:31:24 +020078void pm_qos_update_request_timeout(struct pm_qos_request *req,
79 s32 new_value, unsigned long timeout_us);
Jean Pihetcc749982011-08-25 15:35:12 +020080void pm_qos_remove_request(struct pm_qos_request *req);
Jean Pihete8db0be2011-08-25 15:35:03 +020081
82int pm_qos_request(int pm_qos_class);
83int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
84int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
Jean Pihetcc749982011-08-25 15:35:12 +020085int pm_qos_request_active(struct pm_qos_request *req);
Jean Pihetb66213c2011-08-25 15:35:47 +020086s32 pm_qos_read_value(struct pm_qos_constraints *c);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020087
Jean Piheta9b542e2012-02-13 16:23:42 +010088#ifdef CONFIG_PM
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +010089s32 __dev_pm_qos_read_value(struct device *dev);
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +020090s32 dev_pm_qos_read_value(struct device *dev);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020091int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
92 s32 value);
93int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
94int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
95int dev_pm_qos_add_notifier(struct device *dev,
96 struct notifier_block *notifier);
97int dev_pm_qos_remove_notifier(struct device *dev,
98 struct notifier_block *notifier);
Jean Pihetb66213c2011-08-25 15:35:47 +020099int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
100int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200101void dev_pm_qos_constraints_init(struct device *dev);
102void dev_pm_qos_constraints_destroy(struct device *dev);
Rafael J. Wysocki40a5f8b2011-12-23 01:23:52 +0100103int dev_pm_qos_add_ancestor_request(struct device *dev,
104 struct dev_pm_qos_request *req, s32 value);
Jean Pihete8db0be2011-08-25 15:35:03 +0200105#else
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +0100106static inline s32 __dev_pm_qos_read_value(struct device *dev)
107 { return 0; }
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200108static inline s32 dev_pm_qos_read_value(struct device *dev)
109 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200110static inline int dev_pm_qos_add_request(struct device *dev,
111 struct dev_pm_qos_request *req,
112 s32 value)
113 { return 0; }
114static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
115 s32 new_value)
116 { return 0; }
117static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
118 { return 0; }
119static inline int dev_pm_qos_add_notifier(struct device *dev,
120 struct notifier_block *notifier)
121 { return 0; }
122static inline int dev_pm_qos_remove_notifier(struct device *dev,
123 struct notifier_block *notifier)
124 { return 0; }
Jean Pihetb66213c2011-08-25 15:35:47 +0200125static inline int dev_pm_qos_add_global_notifier(
126 struct notifier_block *notifier)
127 { return 0; }
128static inline int dev_pm_qos_remove_global_notifier(
129 struct notifier_block *notifier)
130 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200131static inline void dev_pm_qos_constraints_init(struct device *dev)
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200132{
133 dev->power.power_state = PMSG_ON;
134}
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200135static inline void dev_pm_qos_constraints_destroy(struct device *dev)
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200136{
137 dev->power.power_state = PMSG_INVALID;
138}
Rafael J. Wysocki40a5f8b2011-12-23 01:23:52 +0100139static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
140 struct dev_pm_qos_request *req, s32 value)
141 { return 0; }
Jean Pihete8db0be2011-08-25 15:35:03 +0200142#endif
143
Rafael J. Wysocki85dc0b82012-03-13 01:01:39 +0100144#ifdef CONFIG_PM_RUNTIME
145int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
146void dev_pm_qos_hide_latency_limit(struct device *dev);
147#else
148static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
149 { return 0; }
150static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
151#endif
152
Jean Pihete8db0be2011-08-25 15:35:03 +0200153#endif