blob: 2e9191a712f301574a6109541358b3a2d3ae9e52 [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>
Jean Pihete8db0be2011-08-25 15:35:03 +020011
Alex Fridd031e1d2012-01-29 20:39:25 +010012enum {
13 PM_QOS_RESERVED = 0,
14 PM_QOS_CPU_DMA_LATENCY,
15 PM_QOS_NETWORK_LATENCY,
16 PM_QOS_NETWORK_THROUGHPUT,
Jean Pihete8db0be2011-08-25 15:35:03 +020017
Alex Fridd031e1d2012-01-29 20:39:25 +010018 /* insert new class ID */
19 PM_QOS_NUM_CLASSES,
20};
21
Jean Pihete8db0be2011-08-25 15:35:03 +020022#define PM_QOS_DEFAULT_VALUE -1
23
24#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
25#define PM_QOS_NETWORK_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
26#define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
Jean Pihet91ff4cb2011-08-25 15:35:41 +020027#define PM_QOS_DEV_LAT_DEFAULT_VALUE 0
Jean Pihete8db0be2011-08-25 15:35:03 +020028
Jean Pihetcc749982011-08-25 15:35:12 +020029struct pm_qos_request {
30 struct plist_node node;
Jean Pihete8db0be2011-08-25 15:35:03 +020031 int pm_qos_class;
32};
33
Jean Pihet91ff4cb2011-08-25 15:35:41 +020034struct dev_pm_qos_request {
35 struct plist_node node;
36 struct device *dev;
37};
38
Jean Pihet4e1779b2011-08-25 15:35:27 +020039enum pm_qos_type {
40 PM_QOS_UNITIALIZED,
41 PM_QOS_MAX, /* return the largest value */
42 PM_QOS_MIN /* return the smallest value */
43};
44
45/*
46 * Note: The lockless read path depends on the CPU accessing
47 * target_value atomically. Atomic access is only guaranteed on all CPU
48 * types linux supports for 32 bit quantites
49 */
50struct pm_qos_constraints {
51 struct plist_head list;
52 s32 target_value; /* Do not change to 64 bit */
53 s32 default_value;
54 enum pm_qos_type type;
55 struct blocking_notifier_head *notifiers;
56};
57
Jean Pihetabe98ec2011-08-25 15:35:34 +020058/* Action requested to pm_qos_update_target */
59enum pm_qos_req_action {
60 PM_QOS_ADD_REQ, /* Add a new request */
61 PM_QOS_UPDATE_REQ, /* Update an existing request */
62 PM_QOS_REMOVE_REQ /* Remove an existing request */
63};
64
Jean Pihet91ff4cb2011-08-25 15:35:41 +020065static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
66{
67 return req->dev != 0;
68}
69
Jean Pihetabe98ec2011-08-25 15:35:34 +020070int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
71 enum pm_qos_req_action action, int value);
Jean Pihetcc749982011-08-25 15:35:12 +020072void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
73 s32 value);
74void pm_qos_update_request(struct pm_qos_request *req,
Jean Pihete8db0be2011-08-25 15:35:03 +020075 s32 new_value);
Jean Pihetcc749982011-08-25 15:35:12 +020076void pm_qos_remove_request(struct pm_qos_request *req);
Jean Pihete8db0be2011-08-25 15:35:03 +020077
78int pm_qos_request(int pm_qos_class);
79int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
80int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
Jean Pihetcc749982011-08-25 15:35:12 +020081int pm_qos_request_active(struct pm_qos_request *req);
Jean Pihetb66213c2011-08-25 15:35:47 +020082s32 pm_qos_read_value(struct pm_qos_constraints *c);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020083
Jean Piheta9b542e2012-02-13 16:23:42 +010084#ifdef CONFIG_PM
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +010085s32 __dev_pm_qos_read_value(struct device *dev);
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +020086s32 dev_pm_qos_read_value(struct device *dev);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020087int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
88 s32 value);
89int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
90int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
91int dev_pm_qos_add_notifier(struct device *dev,
92 struct notifier_block *notifier);
93int dev_pm_qos_remove_notifier(struct device *dev,
94 struct notifier_block *notifier);
Jean Pihetb66213c2011-08-25 15:35:47 +020095int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
96int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020097void dev_pm_qos_constraints_init(struct device *dev);
98void dev_pm_qos_constraints_destroy(struct device *dev);
Rafael J. Wysocki40a5f8b2011-12-23 01:23:52 +010099int dev_pm_qos_add_ancestor_request(struct device *dev,
100 struct dev_pm_qos_request *req, s32 value);
Jean Pihete8db0be2011-08-25 15:35:03 +0200101#else
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +0100102static inline s32 __dev_pm_qos_read_value(struct device *dev)
103 { return 0; }
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200104static inline s32 dev_pm_qos_read_value(struct device *dev)
105 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200106static inline int dev_pm_qos_add_request(struct device *dev,
107 struct dev_pm_qos_request *req,
108 s32 value)
109 { return 0; }
110static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
111 s32 new_value)
112 { return 0; }
113static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
114 { return 0; }
115static inline int dev_pm_qos_add_notifier(struct device *dev,
116 struct notifier_block *notifier)
117 { return 0; }
118static inline int dev_pm_qos_remove_notifier(struct device *dev,
119 struct notifier_block *notifier)
120 { return 0; }
Jean Pihetb66213c2011-08-25 15:35:47 +0200121static inline int dev_pm_qos_add_global_notifier(
122 struct notifier_block *notifier)
123 { return 0; }
124static inline int dev_pm_qos_remove_global_notifier(
125 struct notifier_block *notifier)
126 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200127static inline void dev_pm_qos_constraints_init(struct device *dev)
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200128{
129 dev->power.power_state = PMSG_ON;
130}
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200131static inline void dev_pm_qos_constraints_destroy(struct device *dev)
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200132{
133 dev->power.power_state = PMSG_INVALID;
134}
Rafael J. Wysocki40a5f8b2011-12-23 01:23:52 +0100135static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
136 struct dev_pm_qos_request *req, s32 value)
137 { return 0; }
Jean Pihete8db0be2011-08-25 15:35:03 +0200138#endif
139
Rafael J. Wysocki85dc0b82012-03-13 01:01:39 +0100140#ifdef CONFIG_PM_RUNTIME
141int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
142void dev_pm_qos_hide_latency_limit(struct device *dev);
143#else
144static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
145 { return 0; }
146static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
147#endif
148
Jean Pihete8db0be2011-08-25 15:35:03 +0200149#endif