Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 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> |
Rafael J. Wysocki | 1a9a915 | 2011-09-29 22:29:44 +0200 | [diff] [blame] | 10 | #include <linux/device.h> |
MyungJoo Ham | c4772d1 | 2012-03-28 23:31:24 +0200 | [diff] [blame] | 11 | #include <linux/workqueue.h> |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 12 | |
Alex Frid | d031e1d | 2012-01-29 20:39:25 +0100 | [diff] [blame] | 13 | enum { |
| 14 | PM_QOS_RESERVED = 0, |
| 15 | PM_QOS_CPU_DMA_LATENCY, |
| 16 | PM_QOS_NETWORK_LATENCY, |
| 17 | PM_QOS_NETWORK_THROUGHPUT, |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 18 | |
Alex Frid | d031e1d | 2012-01-29 20:39:25 +0100 | [diff] [blame] | 19 | /* insert new class ID */ |
| 20 | PM_QOS_NUM_CLASSES, |
| 21 | }; |
| 22 | |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 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 | |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 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 |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 35 | #define PM_QOS_DEV_LAT_DEFAULT_VALUE 0 |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 36 | |
Jean Pihet | cc74998 | 2011-08-25 15:35:12 +0200 | [diff] [blame] | 37 | struct pm_qos_request { |
| 38 | struct plist_node node; |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 39 | int pm_qos_class; |
MyungJoo Ham | c4772d1 | 2012-03-28 23:31:24 +0200 | [diff] [blame] | 40 | struct delayed_work work; /* for pm_qos_update_request_timeout */ |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 41 | }; |
| 42 | |
Rafael J. Wysocki | 5efbe42 | 2012-10-23 01:07:46 +0200 | [diff] [blame] | 43 | struct pm_qos_flags_request { |
| 44 | struct list_head node; |
| 45 | s32 flags; /* Do not change to 64 bit */ |
| 46 | }; |
| 47 | |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 48 | enum dev_pm_qos_req_type { |
| 49 | DEV_PM_QOS_LATENCY = 1, |
| 50 | DEV_PM_QOS_FLAGS, |
| 51 | }; |
| 52 | |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 53 | struct dev_pm_qos_request { |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 54 | enum dev_pm_qos_req_type type; |
Rafael J. Wysocki | 021c870 | 2012-10-23 01:09:00 +0200 | [diff] [blame] | 55 | union { |
| 56 | struct plist_node pnode; |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 57 | struct pm_qos_flags_request flr; |
Rafael J. Wysocki | 021c870 | 2012-10-23 01:09:00 +0200 | [diff] [blame] | 58 | } data; |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 59 | struct device *dev; |
| 60 | }; |
| 61 | |
Jean Pihet | 4e1779b | 2011-08-25 15:35:27 +0200 | [diff] [blame] | 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 | /* |
Rafael J. Wysocki | 5efbe42 | 2012-10-23 01:07:46 +0200 | [diff] [blame] | 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 |
Jean Pihet | 4e1779b | 2011-08-25 15:35:27 +0200 | [diff] [blame] | 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 | |
Rafael J. Wysocki | 5efbe42 | 2012-10-23 01:07:46 +0200 | [diff] [blame] | 81 | struct pm_qos_flags { |
| 82 | struct list_head list; |
| 83 | s32 effective_flags; /* Do not change to 64 bit */ |
| 84 | }; |
| 85 | |
Rafael J. Wysocki | 5f986c5 | 2012-10-23 01:07:27 +0200 | [diff] [blame] | 86 | struct dev_pm_qos { |
| 87 | struct pm_qos_constraints latency; |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 88 | struct pm_qos_flags flags; |
Rafael J. Wysocki | 5f986c5 | 2012-10-23 01:07:27 +0200 | [diff] [blame] | 89 | }; |
| 90 | |
Jean Pihet | abe98ec | 2011-08-25 15:35:34 +0200 | [diff] [blame] | 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 | |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 98 | static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req) |
| 99 | { |
Sachin Kamat | 8361809 | 2012-07-17 22:38:18 +0200 | [diff] [blame] | 100 | return req->dev != NULL; |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 101 | } |
| 102 | |
Jean Pihet | abe98ec | 2011-08-25 15:35:34 +0200 | [diff] [blame] | 103 | int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node, |
| 104 | enum pm_qos_req_action action, int value); |
Rafael J. Wysocki | 5efbe42 | 2012-10-23 01:07:46 +0200 | [diff] [blame] | 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); |
Jean Pihet | cc74998 | 2011-08-25 15:35:12 +0200 | [diff] [blame] | 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, |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 111 | s32 new_value); |
MyungJoo Ham | c4772d1 | 2012-03-28 23:31:24 +0200 | [diff] [blame] | 112 | void pm_qos_update_request_timeout(struct pm_qos_request *req, |
| 113 | s32 new_value, unsigned long timeout_us); |
Jean Pihet | cc74998 | 2011-08-25 15:35:12 +0200 | [diff] [blame] | 114 | void pm_qos_remove_request(struct pm_qos_request *req); |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 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); |
Jean Pihet | cc74998 | 2011-08-25 15:35:12 +0200 | [diff] [blame] | 119 | int pm_qos_request_active(struct pm_qos_request *req); |
Jean Pihet | b66213c | 2011-08-25 15:35:47 +0200 | [diff] [blame] | 120 | s32 pm_qos_read_value(struct pm_qos_constraints *c); |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 121 | |
Jean Pihet | a9b542e | 2012-02-13 16:23:42 +0100 | [diff] [blame] | 122 | #ifdef CONFIG_PM |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 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); |
Rafael J. Wysocki | 00dc9ad | 2011-12-01 00:01:31 +0100 | [diff] [blame] | 125 | s32 __dev_pm_qos_read_value(struct device *dev); |
Rafael J. Wysocki | 1a9a915 | 2011-09-29 22:29:44 +0200 | [diff] [blame] | 126 | s32 dev_pm_qos_read_value(struct device *dev); |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 127 | int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req, |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 128 | enum dev_pm_qos_req_type type, s32 value); |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 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); |
Jean Pihet | b66213c | 2011-08-25 15:35:47 +0200 | [diff] [blame] | 135 | int dev_pm_qos_add_global_notifier(struct notifier_block *notifier); |
| 136 | int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier); |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 137 | void dev_pm_qos_constraints_init(struct device *dev); |
| 138 | void dev_pm_qos_constraints_destroy(struct device *dev); |
Rafael J. Wysocki | 40a5f8b | 2011-12-23 01:23:52 +0100 | [diff] [blame] | 139 | int dev_pm_qos_add_ancestor_request(struct device *dev, |
| 140 | struct dev_pm_qos_request *req, s32 value); |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 141 | #else |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 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; } |
Rafael J. Wysocki | 00dc9ad | 2011-12-01 00:01:31 +0100 | [diff] [blame] | 148 | static inline s32 __dev_pm_qos_read_value(struct device *dev) |
| 149 | { return 0; } |
Rafael J. Wysocki | 1a9a915 | 2011-09-29 22:29:44 +0200 | [diff] [blame] | 150 | static inline s32 dev_pm_qos_read_value(struct device *dev) |
| 151 | { return 0; } |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 152 | static inline int dev_pm_qos_add_request(struct device *dev, |
| 153 | struct dev_pm_qos_request *req, |
Rafael J. Wysocki | ae0fb4b | 2012-10-23 01:09:12 +0200 | [diff] [blame^] | 154 | enum dev_pm_qos_req_type type, |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 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; } |
Jean Pihet | b66213c | 2011-08-25 15:35:47 +0200 | [diff] [blame] | 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; } |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 174 | static inline void dev_pm_qos_constraints_init(struct device *dev) |
Rafael J. Wysocki | 1a9a915 | 2011-09-29 22:29:44 +0200 | [diff] [blame] | 175 | { |
| 176 | dev->power.power_state = PMSG_ON; |
| 177 | } |
Jean Pihet | 91ff4cb | 2011-08-25 15:35:41 +0200 | [diff] [blame] | 178 | static inline void dev_pm_qos_constraints_destroy(struct device *dev) |
Rafael J. Wysocki | 1a9a915 | 2011-09-29 22:29:44 +0200 | [diff] [blame] | 179 | { |
| 180 | dev->power.power_state = PMSG_INVALID; |
| 181 | } |
Rafael J. Wysocki | 40a5f8b | 2011-12-23 01:23:52 +0100 | [diff] [blame] | 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; } |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 185 | #endif |
| 186 | |
Rafael J. Wysocki | 85dc0b8 | 2012-03-13 01:01:39 +0100 | [diff] [blame] | 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 | |
Jean Pihet | e8db0be | 2011-08-25 15:35:03 +0200 | [diff] [blame] | 196 | #endif |