Blame view
Documentation/power/pm_qos_interface.txt
5.9 KB
bf1db69fb pm_qos: spelling ... |
1 |
PM Quality Of Service Interface. |
d82b35186 pm qos infrastruc... |
2 3 4 5 |
This interface provides a kernel and user mode interface for registering performance expectations by drivers, subsystems and user space applications on one of the parameters. |
e3cba3243 PM / QoS: Update ... |
6 7 8 9 |
Two different PM QoS frameworks are available: 1. PM QoS classes for cpu_dma_latency, network_latency, network_throughput. 2. the per-device PM QoS framework provides the API to manage the per-device latency constraints. |
d82b35186 pm qos infrastruc... |
10 |
|
bf1db69fb pm_qos: spelling ... |
11 12 13 14 |
Each parameters have defined units: * latency: usec * timeout: usec * throughput: kbs (kilo bit / sec) |
e3cba3243 PM / QoS: Update ... |
15 16 |
1. PM QoS framework |
d82b35186 pm qos infrastruc... |
17 18 19 20 21 |
The infrastructure exposes multiple misc device nodes one per implemented parameter. The set of parameters implement is defined by pm_qos_power_init() and pm_qos_params.h. This is done because having the available parameters being runtime configurable or changeable from a driver was seen as too easy to abuse. |
ed77134bf PM QOS update |
22 |
For each parameter a list of performance requests is maintained along with |
d82b35186 pm qos infrastruc... |
23 |
an aggregated target value. The aggregated target value is updated with |
ed77134bf PM QOS update |
24 25 |
changes to the request list or elements of the list. Typically the aggregated target value is simply the max or min of the request values held |
d82b35186 pm qos infrastruc... |
26 |
in the parameter list elements. |
e3cba3243 PM / QoS: Update ... |
27 28 |
Note: the aggregated target value is implemented as an atomic variable so that reading the aggregated value does not require any locking mechanism. |
d82b35186 pm qos infrastruc... |
29 30 |
From kernel mode the use of this interface is simple: |
d82b35186 pm qos infrastruc... |
31 |
|
e3cba3243 PM / QoS: Update ... |
32 33 |
void pm_qos_add_request(handle, param_class, target_value): Will insert an element into the list for that identified PM QoS class with the |
ed77134bf PM QOS update |
34 35 |
target value. Upon change to this list the new target is recomputed and any registered notifiers are called only if the target value is now different. |
e3cba3243 PM / QoS: Update ... |
36 37 |
Clients of pm_qos need to save the returned handle for future use in other pm_qos API functions. |
d82b35186 pm qos infrastruc... |
38 |
|
ed77134bf PM QOS update |
39 40 41 42 43 44 45 46 47 |
void pm_qos_update_request(handle, new_target_value): Will update the list element pointed to by the handle with the new target value and recompute the new aggregated target, calling the notification tree if the target is changed. void pm_qos_remove_request(handle): Will remove the element. After removal it will update the aggregate target and call the notification tree if the target was changed as a result of removing the request. |
d82b35186 pm qos infrastruc... |
48 |
|
e3cba3243 PM / QoS: Update ... |
49 50 51 52 53 54 55 56 57 58 59 60 61 |
int pm_qos_request(param_class): Returns the aggregated value for a given PM QoS class. int pm_qos_request_active(handle): Returns if the request is still active, i.e. it has not been removed from a PM QoS class constraints list. int pm_qos_add_notifier(param_class, notifier): Adds a notification callback function to the PM QoS class. The callback is called when the aggregated value for the PM QoS class is changed. int pm_qos_remove_notifier(int param_class, notifier): Removes the notification callback function for the PM QoS class. |
d82b35186 pm qos infrastruc... |
62 63 |
From user mode: |
ed77134bf PM QOS update |
64 65 66 |
Only processes can register a pm_qos request. To provide for automatic cleanup of a process, the interface requires the process to register its parameter requests in the following way: |
d82b35186 pm qos infrastruc... |
67 68 69 70 71 |
To register the default pm_qos target for the specific parameter, the process must open one of /dev/[cpu_dma_latency, network_latency, network_throughput] As long as the device node is held open that process has a registered |
ed77134bf PM QOS update |
72 |
request on the parameter. |
d82b35186 pm qos infrastruc... |
73 |
|
ed77134bf PM QOS update |
74 75 76 77 |
To change the requested target value the process needs to write an s32 value to the open device node. Alternatively the user mode program could write a hex string for the value using 10 char long format e.g. "0x12345678". This translates to a pm_qos_update_request call. |
d82b35186 pm qos infrastruc... |
78 79 80 |
To remove the user mode request for a target value simply close the device node. |
e3cba3243 PM / QoS: Update ... |
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
2. PM QoS per-device latency framework For each device a list of performance requests is maintained along with an aggregated target value. The aggregated target value is updated with changes to the request list or elements of the list. Typically the aggregated target value is simply the max or min of the request values held in the parameter list elements. Note: the aggregated target value is implemented as an atomic variable so that reading the aggregated value does not require any locking mechanism. From kernel mode the use of this interface is the following: int dev_pm_qos_add_request(device, handle, value): Will insert an element into the list for that identified device with the target value. Upon change to this list the new target is recomputed and any registered notifiers are called only if the target value is now different. Clients of dev_pm_qos need to save the handle for future use in other dev_pm_qos API functions. int dev_pm_qos_update_request(handle, new_value): Will update the list element pointed to by the handle with the new target value and recompute the new aggregated target, calling the notification trees if the target is changed. int dev_pm_qos_remove_request(handle): Will remove the element. After removal it will update the aggregate target and call the notification trees if the target was changed as a result of removing the request. s32 dev_pm_qos_read_value(device): Returns the aggregated value for a given device's constraints list. Notification mechanisms: The per-device PM QoS framework has 2 different and distinct notification trees: a per-device notification tree and a global notification tree. int dev_pm_qos_add_notifier(device, notifier): Adds a notification callback function for the device. The callback is called when the aggregated value of the device constraints list is changed. int dev_pm_qos_remove_notifier(device, notifier): Removes the notification callback function for the device. int dev_pm_qos_add_global_notifier(notifier): Adds a notification callback function in the global notification tree of the framework. The callback is called when the aggregated value for any device is changed. int dev_pm_qos_remove_global_notifier(notifier): Removes the notification callback function from the global notification tree of the framework. From user mode: No API for user space access to the per-device latency constraints is provided yet - still under discussion. |
d82b35186 pm qos infrastruc... |
140 |