Documentation/power/pm_qos_interface.rst

   1 ===============================
   2 PM Quality Of Service Interface
   3 ===============================
   4
   5 This interface provides a kernel and user mode interface for registering
   6 performance expectations by drivers, subsystems and user space applications on
   7 one of the parameters.
   8
   9 Two different PM QoS frameworks are available:
  10 1. PM QoS classes for cpu_dma_latency, network_latency, network_throughput,
  11 memory_bandwidth.
  12 2. the per-device PM QoS framework provides the API to manage the per-device latency
  13 constraints and PM QoS flags.
  14
  15 Each parameters have defined units:
  16
  17  * latency: usec
  18  * timeout: usec
  19  * throughput: kbs (kilo bit / sec)
  20  * memory bandwidth: mbs (mega bit / sec)
  21
  22
  23 1. PM QoS framework
  24 ===================
  25
  26 The infrastructure exposes multiple misc device nodes one per implemented
  27 parameter.  The set of parameters implement is defined by pm_qos_power_init()
  28 and pm_qos_params.h.  This is done because having the available parameters
  29 being runtime configurable or changeable from a driver was seen as too easy to
  30 abuse.
  31
  32 For each parameter a list of performance requests is maintained along with
  33 an aggregated target value.  The aggregated target value is updated with
  34 changes to the request list or elements of the list.  Typically the
  35 aggregated target value is simply the max or min of the request values held
  36 in the parameter list elements.
  37 Note: the aggregated target value is implemented as an atomic variable so that
  38 reading the aggregated value does not require any locking mechanism.
  39
  40
  41 From kernel mode the use of this interface is simple:
  42
  43 void pm_qos_add_request(handle, param_class, target_value):
  44   Will insert an element into the list for that identified PM QoS class with the
  45   target value.  Upon change to this list the new target is recomputed and any
  46   registered notifiers are called only if the target value is now different.
  47   Clients of pm_qos need to save the returned handle for future use in other
  48   pm_qos API functions.
  49
  50 void pm_qos_update_request(handle, new_target_value):
  51   Will update the list element pointed to by the handle with the new target value
  52   and recompute the new aggregated target, calling the notification tree if the
  53   target is changed.
  54
  55 void pm_qos_remove_request(handle):
  56   Will remove the element.  After removal it will update the aggregate target and
  57   call the notification tree if the target was changed as a result of removing
  58   the request.
  59
  60 int pm_qos_request(param_class):
  61   Returns the aggregated value for a given PM QoS class.
  62
  63 int pm_qos_request_active(handle):
  64   Returns if the request is still active, i.e. it has not been removed from a
  65   PM QoS class constraints list.
  66
  67 int pm_qos_add_notifier(param_class, notifier):
  68   Adds a notification callback function to the PM QoS class. The callback is
  69   called when the aggregated value for the PM QoS class is changed.
  70
  71 int pm_qos_remove_notifier(int param_class, notifier):
  72   Removes the notification callback function for the PM QoS class.
  73
  74
  75 From user mode:
  76
  77 Only processes can register a pm_qos request.  To provide for automatic
  78 cleanup of a process, the interface requires the process to register its
  79 parameter requests in the following way:
  80
  81 To register the default pm_qos target for the specific parameter, the process
  82 must open one of /dev/[cpu_dma_latency, network_latency, network_throughput]
  83
  84 As long as the device node is held open that process has a registered
  85 request on the parameter.
  86
  87 To change the requested target value the process needs to write an s32 value to
  88 the open device node.  Alternatively the user mode program could write a hex
  89 string for the value using 10 char long format e.g. "0x12345678".  This
  90 translates to a pm_qos_update_request call.
  91
  92 To remove the user mode request for a target value simply close the device
  93 node.
  94
  95
  96 2. PM QoS per-device latency and flags framework
  97 ================================================
  98
  99 For each device, there are three lists of PM QoS requests. Two of them are
 100 maintained along with the aggregated targets of resume latency and active
 101 state latency tolerance (in microseconds) and the third one is for PM QoS flags.
 102 Values are updated in response to changes of the request list.
 103
 104 The target values of resume latency and active state latency tolerance are
 105 simply the minimum of the request values held in the parameter list elements.
 106 The PM QoS flags aggregate value is a gather (bitwise OR) of all list elements'
 107 values.  One device PM QoS flag is defined currently: PM_QOS_FLAG_NO_POWER_OFF.
 108
 109 Note: The aggregated target values are implemented in such a way that reading
 110 the aggregated value does not require any locking mechanism.
 111
 112
 113 From kernel mode the use of this interface is the following:
 114
 115 int dev_pm_qos_add_request(device, handle, type, value):
 116   Will insert an element into the list for that identified device with the
 117   target value.  Upon change to this list the new target is recomputed and any
 118   registered notifiers are called only if the target value is now different.
 119   Clients of dev_pm_qos need to save the handle for future use in other
 120   dev_pm_qos API functions.
 121
 122 int dev_pm_qos_update_request(handle, new_value):
 123   Will update the list element pointed to by the handle with the new target
 124   value and recompute the new aggregated target, calling the notification
 125   trees if the target is changed.
 126
 127 int dev_pm_qos_remove_request(handle):
 128   Will remove the element.  After removal it will update the aggregate target
 129   and call the notification trees if the target was changed as a result of
 130   removing the request.
 131
 132 s32 dev_pm_qos_read_value(device, type):
 133   Returns the aggregated value for a given device's constraints list.
 134
 135 enum pm_qos_flags_status dev_pm_qos_flags(device, mask)
 136   Check PM QoS flags of the given device against the given mask of flags.
 137   The meaning of the return values is as follows:
 138
 139         PM_QOS_FLAGS_ALL:
 140                 All flags from the mask are set
 141         PM_QOS_FLAGS_SOME:
 142                 Some flags from the mask are set
 143         PM_QOS_FLAGS_NONE:
 144                 No flags from the mask are set
 145         PM_QOS_FLAGS_UNDEFINED:
 146                 The device's PM QoS structure has not been initialized
 147                 or the list of requests is empty.
 148
 149 int dev_pm_qos_add_ancestor_request(dev, handle, type, value)
 150   Add a PM QoS request for the first direct ancestor of the given device whose
 151   power.ignore_children flag is unset (for DEV_PM_QOS_RESUME_LATENCY requests)
 152   or whose power.set_latency_tolerance callback pointer is not NULL (for
 153   DEV_PM_QOS_LATENCY_TOLERANCE requests).
 154
 155 int dev_pm_qos_expose_latency_limit(device, value)
 156   Add a request to the device's PM QoS list of resume latency constraints and
 157   create a sysfs attribute pm_qos_resume_latency_us under the device's power
 158   directory allowing user space to manipulate that request.
 159
 160 void dev_pm_qos_hide_latency_limit(device)
 161   Drop the request added by dev_pm_qos_expose_latency_limit() from the device's
 162   PM QoS list of resume latency constraints and remove sysfs attribute
 163   pm_qos_resume_latency_us from the device's power directory.
 164
 165 int dev_pm_qos_expose_flags(device, value)
 166   Add a request to the device's PM QoS list of flags and create sysfs attribute
 167   pm_qos_no_power_off under the device's power directory allowing user space to
 168   change the value of the PM_QOS_FLAG_NO_POWER_OFF flag.
 169
 170 void dev_pm_qos_hide_flags(device)
 171   Drop the request added by dev_pm_qos_expose_flags() from the device's PM QoS list
 172   of flags and remove sysfs attribute pm_qos_no_power_off from the device's power
 173   directory.
 174
 175 Notification mechanisms:
 176
 177 The per-device PM QoS framework has a per-device notification tree.
 178
 179 int dev_pm_qos_add_notifier(device, notifier, type):
 180   Adds a notification callback function for the device for a particular request
 181   type.
 182
 183   The callback is called when the aggregated value of the device constraints list
 184   is changed.
 185
 186 int dev_pm_qos_remove_notifier(device, notifier, type):
 187   Removes the notification callback function for the device.
 188
 189
 190 Active state latency tolerance
 191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 192
 193 This device PM QoS type is used to support systems in which hardware may switch
 194 to energy-saving operation modes on the fly.  In those systems, if the operation
 195 mode chosen by the hardware attempts to save energy in an overly aggressive way,
 196 it may cause excess latencies to be visible to software, causing it to miss
 197 certain protocol requirements or target frame or sample rates etc.
 198
 199 If there is a latency tolerance control mechanism for a given device available
 200 to software, the .set_latency_tolerance callback in that device's dev_pm_info
 201 structure should be populated.  The routine pointed to by it is should implement
 202 whatever is necessary to transfer the effective requirement value to the
 203 hardware.
 204
 205 Whenever the effective latency tolerance changes for the device, its
 206 .set_latency_tolerance() callback will be executed and the effective value will
 207 be passed to it.  If that value is negative, which means that the list of
 208 latency tolerance requirements for the device is empty, the callback is expected
 209 to switch the underlying hardware latency tolerance control mechanism to an
 210 autonomous mode if available.  If that value is PM_QOS_LATENCY_ANY, in turn, and
 211 the hardware supports a special "no requirement" setting, the callback is
 212 expected to use it.  That allows software to prevent the hardware from
 213 automatically updating the device's latency tolerance in response to its power
 214 state changes (e.g. during transitions from D3cold to D0), which generally may
 215 be done in the autonomous latency tolerance control mode.
 216
 217 If .set_latency_tolerance() is present for the device, sysfs attribute
 218 pm_qos_latency_tolerance_us will be present in the devivce's power directory.
 219 Then, user space can use that attribute to specify its latency tolerance
 220 requirement for the device, if any.  Writing "any" to it means "no requirement,
 221 but do not let the hardware control latency tolerance" and writing "auto" to it
 222 allows the hardware to be switched to the autonomous mode if there are no other
 223 requirements from the kernel side in the device's list.
 224
 225 Kernel code can use the functions described above along with the
 226 DEV_PM_QOS_LATENCY_TOLERANCE device PM QoS type to add, remove and update
 227 latency tolerance requirements for devices.