€•V”      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ*/translations/zh_CN/power/pm_qos_interface”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ*/translations/zh_TW/power/pm_qos_interface”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ*/translations/it_IT/power/pm_qos_interface”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ*/translations/ja_JP/power/pm_qos_interface”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ*/translations/ko_KR/power/pm_qos_interface”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ*/translations/sp_SP/power/pm_qos_interface”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒPM Quality Of Service Interface”h]”hŒPM Quality Of Service Interface”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒD/var/lib/git/docbuild/linux/Documentation/power/pm_qos_interface.rst”h KubhŒ	paragraph”“”)”}”(hŒ®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.”h]”hŒ®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.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubhŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒ¶Two different PM QoS frameworks are available:
* CPU latency QoS.
* The per-device PM QoS framework provides the API to manage the
  per-device latency constraints and PM QoS flags.
”h]”(hŒterm”“”)”}”(hŒ.Two different PM QoS frameworks are available:”h]”hŒ.Two different PM QoS frameworks are available:”…””}”(hhÔhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h KhhÎubhŒ
definition”“”)”}”(hhh]”hŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒCPU latency QoS.”h]”h¸)”}”(hhðh]”hŒCPU latency QoS.”…””}”(hhòhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K
hhîubah}”(h]”h ]”h"]”h$]”h&]”uh1hìhhéubhí)”}”(hŒpThe per-device PM QoS framework provides the API to manage the
per-device latency constraints and PM QoS flags.
”h]”h¸)”}”(hŒoThe per-device PM QoS framework provides the API to manage the
per-device latency constraints and PM QoS flags.”h]”hŒoThe per-device PM QoS framework provides the API to manage the
per-device latency constraints and PM QoS flags.”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hìhhéubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1hçhŸh¶h K
hhäubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhhÎubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h KhhÉubah}”(h]”h ]”h"]”h$]”h&]”uh1hÇhh£hžhhŸNh Nubh¸)”}”(hŒHThe latency unit used in the PM QoS framework is the microsecond (usec).”h]”hŒHThe latency unit used in the PM QoS framework is the microsecond (usec).”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒ1. PM QoS framework”h]”hŒ1. PM QoS framework”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjE  hžhhŸh¶h Kubh¸)”}”(hXA  A global list of CPU latency QoS requests is maintained along with an aggregated
(effective) target value.  The aggregated target value is updated with changes
to the request list or elements of the list.  For CPU latency QoS, the
aggregated target value is simply the min of the request values held in the list
elements.”h]”hXA  A global list of CPU latency QoS requests is maintained along with an aggregated
(effective) target value.  The aggregated target value is updated with changes
to the request list or elements of the list.  For CPU latency QoS, the
aggregated target value is simply the min of the request values held in the list
elements.”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjE  hžhubh¸)”}”(hŒ“Note: the aggregated target value is implemented as an atomic variable so that
reading the aggregated value does not require any locking mechanism.”h]”hŒ“Note: the aggregated target value is implemented as an atomic variable so that
reading the aggregated value does not require any locking mechanism.”…””}”(hjd  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjE  hžhubh¸)”}”(hŒ6From kernel space the use of this interface is simple:”h]”hŒ6From kernel space the use of this interface is simple:”…””}”(hjr  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjE  hžhubhÈ)”}”(hhh]”(hÍ)”}”(hXn  void cpu_latency_qos_add_request(handle, target_value):
Will insert an element into the CPU latency QoS list 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 PM QoS need to save the returned handle for future use in other
PM QoS API functions.
”h]”(hÓ)”}”(hŒ7void cpu_latency_qos_add_request(handle, target_value):”h]”hŒ7void cpu_latency_qos_add_request(handle, target_value):”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K$hjƒ  ubhã)”}”(hhh]”h¸)”}”(hX5  Will insert an element into the CPU latency QoS list 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 PM QoS need to save the returned handle for future use in other
PM QoS API functions.”h]”hX5  Will insert an element into the CPU latency QoS list 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 PM QoS need to save the returned handle for future use in other
PM QoS API functions.”…””}”(hj˜  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K hj•  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjƒ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K$hj€  ubhÍ)”}”(hŒðvoid cpu_latency_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.
”h]”(hÓ)”}”(hŒ>void cpu_latency_qos_update_request(handle, new_target_value):”h]”hŒ>void cpu_latency_qos_update_request(handle, new_target_value):”…””}”(hj¶  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K)hj²  ubhã)”}”(hhh]”h¸)”}”(hŒ°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.”h]”hŒ°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.”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K'hjÄ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj²  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K)hj€  hžhubhÍ)”}”(hŒ×void cpu_latency_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.
”h]”(hÓ)”}”(hŒ,void cpu_latency_qos_remove_request(handle):”h]”hŒ,void cpu_latency_qos_remove_request(handle):”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K.hjá  ubhã)”}”(hhh]”h¸)”}”(hŒ©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.”h]”hŒ©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.”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K,hjó  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjá  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K.hj€  hžhubhÍ)”}”(hŒSint cpu_latency_qos_limit():
Returns the aggregated value for the CPU latency QoS.
”h]”(hÓ)”}”(hŒint cpu_latency_qos_limit():”h]”hŒint cpu_latency_qos_limit():”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K1hj  ubhã)”}”(hhh]”h¸)”}”(hŒ5Returns the aggregated value for the CPU latency QoS.”h]”hŒ5Returns the aggregated value for the CPU latency QoS.”…””}”(hj%  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K1hj"  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K1hj€  hžhubhÍ)”}”(hŒ‘int cpu_latency_qos_request_active(handle):
Returns if the request is still active, i.e. it has not been removed from the
CPU latency QoS list.

”h]”(hÓ)”}”(hŒ+int cpu_latency_qos_request_active(handle):”h]”hŒ+int cpu_latency_qos_request_active(handle):”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K6hj?  ubhã)”}”(hhh]”h¸)”}”(hŒcReturns if the request is still active, i.e. it has not been removed from the
CPU latency QoS list.”h]”hŒcReturns if the request is still active, i.e. it has not been removed from the
CPU latency QoS list.”…””}”(hjT  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K4hjQ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj?  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K6hj€  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÇhjE  hžhhŸh¶h Nubh¸)”}”(hŒFrom user space:”h]”hŒFrom user space:”…””}”(hjt  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K8hjE  hžhubh¸)”}”(hŒZThe infrastructure exposes one device node, /dev/cpu_dma_latency, for the CPU
latency QoS.”h]”hŒZThe infrastructure exposes one device node, /dev/cpu_dma_latency, for the CPU
latency QoS.”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K:hjE  hžhubh¸)”}”(hŒ¯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 as follows.”h]”hŒ¯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 as follows.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K=hjE  hžhubh¸)”}”(hŒjTo register the default PM QoS target for the CPU latency QoS, the process must
open /dev/cpu_dma_latency.”h]”hŒjTo register the default PM QoS target for the CPU latency QoS, the process must
open /dev/cpu_dma_latency.”…””}”(hjž  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KAhjE  hžhubh¸)”}”(hŒ_As long as the device node is held open that process has a registered
request on the parameter.”h]”hŒ_As long as the device node is held open that process has a registered
request on the parameter.”…””}”(hj¬  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KDhjE  hžhubh¸)”}”(hX  To change the requested target value, the process needs to write an s32 value to
the open device node.  Alternatively, it can write a hex string for the value
using the 10 char long format e.g. "0x12345678".  This translates to a
cpu_latency_qos_update_request() call.”h]”hX  To change the requested target value, the process needs to write an s32 value to
the open device node.  Alternatively, it can write a hex string for the value
using the 10 char long format e.g. â€œ0x12345678â€.  This translates to a
cpu_latency_qos_update_request() call.”…””}”(hjº  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KGhjE  hžhubh¸)”}”(hŒPTo remove the user mode request for a target value simply close the device
node.”h]”hŒPTo remove the user mode request for a target value simply close the device
node.”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KLhjE  hžhubeh}”(h]”Œpm-qos-framework”ah ]”h"]”Œ1. pm qos framework”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒ02. PM QoS per-device latency and flags framework”h]”hŒ02. PM QoS per-device latency and flags framework”…””}”(hjá  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÞ  hžhhŸh¶h KQubh¸)”}”(hX$  For each device, there are three lists of PM QoS requests. Two of them are
maintained along with the aggregated targets of resume latency and active
state latency tolerance (in microseconds) and the third one is for PM QoS flags.
Values are updated in response to changes of the request list.”h]”hX$  For each device, there are three lists of PM QoS requests. Two of them are
maintained along with the aggregated targets of resume latency and active
state latency tolerance (in microseconds) and the third one is for PM QoS flags.
Values are updated in response to changes of the request list.”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KShjÞ  hžhubh¸)”}”(hX8  The target values of resume latency and active state latency tolerance are
simply the minimum of the request values held in the parameter list elements.
The PM QoS flags aggregate value is a gather (bitwise OR) of all list elements'
values.  One device PM QoS flag is defined currently: PM_QOS_FLAG_NO_POWER_OFF.”h]”hX:  The target values of resume latency and active state latency tolerance are
simply the minimum of the request values held in the parameter list elements.
The PM QoS flags aggregate value is a gather (bitwise OR) of all list elementsâ€™
values.  One device PM QoS flag is defined currently: PM_QOS_FLAG_NO_POWER_OFF.”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KXhjÞ  hžhubh¸)”}”(hŒŠNote: The aggregated target values are implemented in such a way that reading
the aggregated value does not require any locking mechanism.”h]”hŒŠNote: The aggregated target values are implemented in such a way that reading
the aggregated value does not require any locking mechanism.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K]hjÞ  hžhubh¸)”}”(hŒ<From kernel mode the use of this interface is the following:”h]”hŒ<From kernel mode the use of this interface is the following:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KahjÞ  hžhubhÈ)”}”(hhh]”(hÍ)”}”(hXz  int dev_pm_qos_add_request(device, handle, type, 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.
”h]”(hÓ)”}”(hŒ8int dev_pm_qos_add_request(device, handle, type, value):”h]”hŒ8int dev_pm_qos_add_request(device, handle, type, value):”…””}”(hj.  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h Khhj*  ubhã)”}”(hhh]”h¸)”}”(hX@  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.”h]”hX@  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.”…””}”(hj?  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kdhj<  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj*  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Khhj'  ubhÍ)”}”(hŒä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.
”h]”(hÓ)”}”(hŒ1int dev_pm_qos_update_request(handle, new_value):”h]”hŒ1int dev_pm_qos_update_request(handle, new_value):”…””}”(hj]  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h KmhjY  ubhã)”}”(hhh]”h¸)”}”(hŒ±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.”h]”hŒ±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.”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kkhjk  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjY  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Kmhj'  hžhubhÍ)”}”(hŒÒ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.
”h]”(hÓ)”}”(hŒ&int dev_pm_qos_remove_request(handle):”h]”hŒ&int dev_pm_qos_remove_request(handle):”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h Krhjˆ  ubhã)”}”(hhh]”h¸)”}”(hŒª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.”h]”hŒª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.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kphjš  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjˆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Krhj'  hžhubhÍ)”}”(hŒms32 dev_pm_qos_read_value(device, type):
Returns the aggregated value for a given device's constraints list.
”h]”(hÓ)”}”(hŒ(s32 dev_pm_qos_read_value(device, type):”h]”hŒ(s32 dev_pm_qos_read_value(device, type):”…””}”(hj»  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h Kuhj·  ubhã)”}”(hhh]”h¸)”}”(hŒCReturns the aggregated value for a given device's constraints list.”h]”hŒEReturns the aggregated value for a given deviceâ€™s constraints list.”…””}”(hjÌ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KuhjÉ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj·  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Kuhj'  hžhubhÍ)”}”(hX  enum pm_qos_flags_status dev_pm_qos_flags(device, mask)
Check PM QoS flags of the given device against the given mask of flags.
The meaning of the return values is as follows:

      PM_QOS_FLAGS_ALL:
              All flags from the mask are set
      PM_QOS_FLAGS_SOME:
              Some flags from the mask are set
      PM_QOS_FLAGS_NONE:
              No flags from the mask are set
      PM_QOS_FLAGS_UNDEFINED:
              The device's PM QoS structure has not been initialized
              or the list of requests is empty.
”h]”(hÓ)”}”(hŒ7enum pm_qos_flags_status dev_pm_qos_flags(device, mask)”h]”hŒ7enum pm_qos_flags_status dev_pm_qos_flags(device, mask)”…””}”(hjê  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h Kƒhjæ  ubhã)”}”(hhh]”(h¸)”}”(hŒwCheck PM QoS flags of the given device against the given mask of flags.
The meaning of the return values is as follows:”h]”hŒwCheck PM QoS flags of the given device against the given mask of flags.
The meaning of the return values is as follows:”…””}”(hjû  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kxhjø  ubhŒblock_quote”“”)”}”(hX1  PM_QOS_FLAGS_ALL:
        All flags from the mask are set
PM_QOS_FLAGS_SOME:
        Some flags from the mask are set
PM_QOS_FLAGS_NONE:
        No flags from the mask are set
PM_QOS_FLAGS_UNDEFINED:
        The device's PM QoS structure has not been initialized
        or the list of requests is empty.
”h]”hÈ)”}”(hhh]”(hÍ)”}”(hŒ1PM_QOS_FLAGS_ALL:
All flags from the mask are set”h]”(hÓ)”}”(hŒPM_QOS_FLAGS_ALL:”h]”hŒPM_QOS_FLAGS_ALL:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K{hj  ubhã)”}”(hhh]”h¸)”}”(hŒAll flags from the mask are set”h]”hŒAll flags from the mask are set”…””}”(hj'  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K|hj$  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K{hj  ubhÍ)”}”(hŒ3PM_QOS_FLAGS_SOME:
Some flags from the mask are set”h]”(hÓ)”}”(hŒPM_QOS_FLAGS_SOME:”h]”hŒPM_QOS_FLAGS_SOME:”…””}”(hjE  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K}hjA  ubhã)”}”(hhh]”h¸)”}”(hŒ Some flags from the mask are set”h]”hŒ Some flags from the mask are set”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K~hjS  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjA  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K}hj  ubhÍ)”}”(hŒ1PM_QOS_FLAGS_NONE:
No flags from the mask are set”h]”(hÓ)”}”(hŒPM_QOS_FLAGS_NONE:”h]”hŒPM_QOS_FLAGS_NONE:”…””}”(hjt  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h Khjp  ubhã)”}”(hhh]”h¸)”}”(hŒNo flags from the mask are set”h]”hŒNo flags from the mask are set”…””}”(hj…  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K€hj‚  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjp  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Khj  ubhÍ)”}”(hŒqPM_QOS_FLAGS_UNDEFINED:
The device's PM QoS structure has not been initialized
or the list of requests is empty.
”h]”(hÓ)”}”(hŒPM_QOS_FLAGS_UNDEFINED:”h]”hŒPM_QOS_FLAGS_UNDEFINED:”…””}”(hj£  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h KƒhjŸ  ubhã)”}”(hhh]”h¸)”}”(hŒXThe device's PM QoS structure has not been initialized
or the list of requests is empty.”h]”hŒZThe deviceâ€™s PM QoS structure has not been initialized
or the list of requests is empty.”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K‚hj±  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjŸ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Kƒhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÇhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j	  hŸh¶h K{hjø  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hâhjæ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Kƒhj'  hžhubhÍ)”}”(hXG  int dev_pm_qos_add_ancestor_request(dev, handle, type, value)
Add a PM QoS request for the first direct ancestor of the given device whose
power.ignore_children flag is unset (for DEV_PM_QOS_RESUME_LATENCY requests)
or whose power.set_latency_tolerance callback pointer is not NULL (for
DEV_PM_QOS_LATENCY_TOLERANCE requests).
”h]”(hÓ)”}”(hŒ=int dev_pm_qos_add_ancestor_request(dev, handle, type, value)”h]”hŒ=int dev_pm_qos_add_ancestor_request(dev, handle, type, value)”…””}”(hjê  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K‰hjæ  ubhã)”}”(hhh]”h¸)”}”(hX  Add a PM QoS request for the first direct ancestor of the given device whose
power.ignore_children flag is unset (for DEV_PM_QOS_RESUME_LATENCY requests)
or whose power.set_latency_tolerance callback pointer is not NULL (for
DEV_PM_QOS_LATENCY_TOLERANCE requests).”h]”hX  Add a PM QoS request for the first direct ancestor of the given device whose
power.ignore_children flag is unset (for DEV_PM_QOS_RESUME_LATENCY requests)
or whose power.set_latency_tolerance callback pointer is not NULL (for
DEV_PM_QOS_LATENCY_TOLERANCE requests).”…””}”(hjû  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K†hjø  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjæ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K‰hj'  hžhubhÍ)”}”(hX  int dev_pm_qos_expose_latency_limit(device, value)
Add a request to the device's PM QoS list of resume latency constraints and
create a sysfs attribute pm_qos_resume_latency_us under the device's power
directory allowing user space to manipulate that request.
”h]”(hÓ)”}”(hŒ2int dev_pm_qos_expose_latency_limit(device, value)”h]”hŒ2int dev_pm_qos_expose_latency_limit(device, value)”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h KŽhj  ubhã)”}”(hhh]”h¸)”}”(hŒÐAdd a request to the device's PM QoS list of resume latency constraints and
create a sysfs attribute pm_qos_resume_latency_us under the device's power
directory allowing user space to manipulate that request.”h]”hŒÔAdd a request to the deviceâ€™s PM QoS list of resume latency constraints and
create a sysfs attribute pm_qos_resume_latency_us under the deviceâ€™s power
directory allowing user space to manipulate that request.”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŒhj'  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h KŽhj'  hžhubhÍ)”}”(hŒúvoid dev_pm_qos_hide_latency_limit(device)
Drop the request added by dev_pm_qos_expose_latency_limit() from the device's
PM QoS list of resume latency constraints and remove sysfs attribute
pm_qos_resume_latency_us from the device's power directory.
”h]”(hÓ)”}”(hŒ*void dev_pm_qos_hide_latency_limit(device)”h]”hŒ*void dev_pm_qos_hide_latency_limit(device)”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K“hjD  ubhã)”}”(hhh]”h¸)”}”(hŒÎDrop the request added by dev_pm_qos_expose_latency_limit() from the device's
PM QoS list of resume latency constraints and remove sysfs attribute
pm_qos_resume_latency_us from the device's power directory.”h]”hŒÒDrop the request added by dev_pm_qos_expose_latency_limit() from the deviceâ€™s
PM QoS list of resume latency constraints and remove sysfs attribute
pm_qos_resume_latency_us from the deviceâ€™s power directory.”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K‘hjV  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjD  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K“hj'  hžhubhÍ)”}”(hŒþint dev_pm_qos_expose_flags(device, value)
Add a request to the device's PM QoS list of flags and create sysfs attribute
pm_qos_no_power_off under the device's power directory allowing user space to
change the value of the PM_QOS_FLAG_NO_POWER_OFF flag.
”h]”(hÓ)”}”(hŒ*int dev_pm_qos_expose_flags(device, value)”h]”hŒ*int dev_pm_qos_expose_flags(device, value)”…””}”(hjw  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K˜hjs  ubhã)”}”(hhh]”h¸)”}”(hŒÒAdd a request to the device's PM QoS list of flags and create sysfs attribute
pm_qos_no_power_off under the device's power directory allowing user space to
change the value of the PM_QOS_FLAG_NO_POWER_OFF flag.”h]”hŒÖAdd a request to the deviceâ€™s PM QoS list of flags and create sysfs attribute
pm_qos_no_power_off under the deviceâ€™s power directory allowing user space to
change the value of the PM_QOS_FLAG_NO_POWER_OFF flag.”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K–hj…  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhjs  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K˜hj'  hžhubhÍ)”}”(hŒÐvoid dev_pm_qos_hide_flags(device)
Drop the request added by dev_pm_qos_expose_flags() from the device's PM QoS
list of flags and remove sysfs attribute pm_qos_no_power_off from the device's
power directory.
”h]”(hÓ)”}”(hŒ"void dev_pm_qos_hide_flags(device)”h]”hŒ"void dev_pm_qos_hide_flags(device)”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h Khj¢  ubhã)”}”(hhh]”h¸)”}”(hŒ¬Drop the request added by dev_pm_qos_expose_flags() from the device's PM QoS
list of flags and remove sysfs attribute pm_qos_no_power_off from the device's
power directory.”h]”hŒ°Drop the request added by dev_pm_qos_expose_flags() from the deviceâ€™s PM QoS
list of flags and remove sysfs attribute pm_qos_no_power_off from the deviceâ€™s
power directory.”…””}”(hj·  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K›hj´  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj¢  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h Khj'  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÇhjÞ  hžhhŸh¶h Nubh¸)”}”(hŒNotification mechanisms:”h]”hŒNotification mechanisms:”…””}”(hj×  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŸhjÞ  hžhubh¸)”}”(hŒCThe per-device PM QoS framework has a per-device notification tree.”h]”hŒCThe per-device PM QoS framework has a per-device notification tree.”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¡hjÞ  hžhubhÈ)”}”(hhh]”(hÍ)”}”(hŒæint dev_pm_qos_add_notifier(device, notifier, type):
Adds a notification callback function for the device for a particular request
type.

The callback is called when the aggregated value of the device constraints
list is changed.
”h]”(hÓ)”}”(hŒ4int dev_pm_qos_add_notifier(device, notifier, type):”h]”hŒ4int dev_pm_qos_add_notifier(device, notifier, type):”…””}”(hjú  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K¨hjö  ubhã)”}”(hhh]”(h¸)”}”(hŒSAdds a notification callback function for the device for a particular request
type.”h]”hŒSAdds a notification callback function for the device for a particular request
type.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¤hj  ubh¸)”}”(hŒ[The callback is called when the aggregated value of the device constraints
list is changed.”h]”hŒ[The callback is called when the aggregated value of the device constraints
list is changed.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K§hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hâhjö  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K¨hjó  ubhÍ)”}”(hŒtint dev_pm_qos_remove_notifier(device, notifier, type):
Removes the notification callback function for the device.

”h]”(hÓ)”}”(hŒ7int dev_pm_qos_remove_notifier(device, notifier, type):”h]”hŒ7int dev_pm_qos_remove_notifier(device, notifier, type):”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhŸh¶h K¬hj3  ubhã)”}”(hhh]”h¸)”}”(hŒ:Removes the notification callback function for the device.”h]”hŒ:Removes the notification callback function for the device.”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K«hjE  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hâhj3  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÌhŸh¶h K¬hjó  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÇhjÞ  hžhhŸh¶h Nubh¢)”}”(hhh]”(h§)”}”(hŒActive state latency tolerance”h]”hŒActive state latency tolerance”…””}”(hjk  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjh  hžhhŸh¶h K¯ubh¸)”}”(hX€  This device PM QoS type is used to support systems in which hardware may switch
to energy-saving operation modes on the fly.  In those systems, if the operation
mode chosen by the hardware attempts to save energy in an overly aggressive way,
it may cause excess latencies to be visible to software, causing it to miss
certain protocol requirements or target frame or sample rates etc.”h]”hX€  This device PM QoS type is used to support systems in which hardware may switch
to energy-saving operation modes on the fly.  In those systems, if the operation
mode chosen by the hardware attempts to save energy in an overly aggressive way,
it may cause excess latencies to be visible to software, causing it to miss
certain protocol requirements or target frame or sample rates etc.”…””}”(hjy  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K±hjh  hžhubh¸)”}”(hX@  If there is a latency tolerance control mechanism for a given device available
to software, the .set_latency_tolerance callback in that device's dev_pm_info
structure should be populated.  The routine pointed to by it is should implement
whatever is necessary to transfer the effective requirement value to the
hardware.”h]”hXB  If there is a latency tolerance control mechanism for a given device available
to software, the .set_latency_tolerance callback in that deviceâ€™s dev_pm_info
structure should be populated.  The routine pointed to by it is should implement
whatever is necessary to transfer the effective requirement value to the
hardware.”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K·hjh  hžhubh¸)”}”(hX5  Whenever the effective latency tolerance changes for the device, its
.set_latency_tolerance() callback will be executed and the effective value will
be passed to it.  If that value is negative, which means that the list of
latency tolerance requirements for the device is empty, the callback is expected
to switch the underlying hardware latency tolerance control mechanism to an
autonomous mode if available.  If that value is PM_QOS_LATENCY_ANY, in turn, and
the hardware supports a special "no requirement" setting, the callback is
expected to use it.  That allows software to prevent the hardware from
automatically updating the device's latency tolerance in response to its power
state changes (e.g. during transitions from D3cold to D0), which generally may
be done in the autonomous latency tolerance control mode.”h]”hX;  Whenever the effective latency tolerance changes for the device, its
.set_latency_tolerance() callback will be executed and the effective value will
be passed to it.  If that value is negative, which means that the list of
latency tolerance requirements for the device is empty, the callback is expected
to switch the underlying hardware latency tolerance control mechanism to an
autonomous mode if available.  If that value is PM_QOS_LATENCY_ANY, in turn, and
the hardware supports a special â€œno requirementâ€ setting, the callback is
expected to use it.  That allows software to prevent the hardware from
automatically updating the deviceâ€™s latency tolerance in response to its power
state changes (e.g. during transitions from D3cold to D0), which generally may
be done in the autonomous latency tolerance control mode.”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K½hjh  hžhubh¸)”}”(hX  If .set_latency_tolerance() is present for the device, sysfs attribute
pm_qos_latency_tolerance_us will be present in the devivce's power directory.
Then, user space can use that attribute to specify its latency tolerance
requirement for the device, if any.  Writing "any" to it means "no requirement,
but do not let the hardware control latency tolerance" and writing "auto" to it
allows the hardware to be switched to the autonomous mode if there are no other
requirements from the kernel side in the device's list.”h]”hX  If .set_latency_tolerance() is present for the device, sysfs attribute
pm_qos_latency_tolerance_us will be present in the devivceâ€™s power directory.
Then, user space can use that attribute to specify its latency tolerance
requirement for the device, if any.  Writing â€œanyâ€ to it means â€œno requirement,
but do not let the hardware control latency toleranceâ€ and writing â€œautoâ€ to it
allows the hardware to be switched to the autonomous mode if there are no other
requirements from the kernel side in the deviceâ€™s list.”…””}”(hj£  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÉhjh  hžhubh¸)”}”(hŒ¶Kernel code can use the functions described above along with the
DEV_PM_QOS_LATENCY_TOLERANCE device PM QoS type to add, remove and update
latency tolerance requirements for devices.”h]”hŒ¶Kernel code can use the functions described above along with the
DEV_PM_QOS_LATENCY_TOLERANCE device PM QoS type to add, remove and update
latency tolerance requirements for devices.”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÑhjh  hžhubeh}”(h]”Œactive-state-latency-tolerance”ah ]”h"]”Œactive state latency tolerance”ah$]”h&]”uh1h¡hjÞ  hžhhŸh¶h K¯ubeh}”(h]”Œ-pm-qos-per-device-latency-and-flags-framework”ah ]”h"]”Œ02. pm qos per-device latency and flags framework”ah$]”h&]”uh1h¡hh£hžhhŸh¶h KQubeh}”(h]”Œpm-quality-of-service-interface”ah ]”h"]”Œpm quality of service interface”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jú  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jÔ  jÑ  jÛ  jØ  jÌ  jÉ  jÄ  jÁ  uŒ	nametypes”}”(jÔ  ‰jÛ  ‰jÌ  ‰jÄ  ‰uh}”(jÑ  h£jØ  jE  jÉ  jÞ  jÁ  jh  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.