Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7a400585 authored by Andy Gross's avatar Andy Gross Committed by Mark Brown
Browse files

soc: qcom: documentation: Update SMD/RPM Docs 



This patch moves the qcom,smd-rpm.txt to the correct location and splits
out the smd and rpm documentation.  In addition, a smd-rpm-regulator
document is added.

Signed-off-by: default avatarAndy Gross <agross@codeaurora.org>
Acked-by: default avatarBjorn Andersson <bjorn.andersson@sonymobile.com>
Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 8005c49d

Documentation/devicetree/bindings/soc/qcom,smd-rpm.txt→Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.txt

+10 −21
Original line number Diff line number Diff line 
Qualcomm Resource Power Manager (RPM) over SMD

QCOM SMD RPM REGULATOR



This driver is used to interface with the Resource Power Manager (RPM) found in

various Qualcomm platforms. The RPM allows each component in the system to vote

for state of the system resources, such as clocks, regulators and bus

frequencies.

The Qualcomm RPM over SMD regulator is modelled as a subdevice of the RPM.

Because SMD is used as the communication transport mechanism, the RPM resides as

a subnode of the SMD.  As such, the SMD-RPM regulator requires that the SMD and

RPM nodes be present.



- compatible:

	Usage: required

	Value type: <string>

	Definition: must be one of:

		    "qcom,rpm-msm8974"

Please refer to Documentation/devicetree/bindings/soc/qcom/qcom,smd.txt for

information pertaining to the SMD node.



- qcom,smd-channels:

	Usage: required

	Value type: <stringlist>

	Definition: Shared Memory channel used for communication with the RPM



= SUBDEVICES

Please refer to Documentation/devicetree/bindings/soc/qcom/qcom,smd-rpm.txt for

information regarding the RPM node.



The RPM exposes resources to its subnodes. The below bindings specify the set

of valid subnodes that can operate on these resources.



== Regulators

== Regulator



Regulator nodes are identified by their compatible:
@@ -114,4 +104,3 @@ see regulator.txt. 
			};

		};

	};

Documentation/devicetree/bindings/soc/qcom/qcom,smd-rpm.txt

0 → 100644
+58 −0
Original line number Diff line number Diff line 
Qualcomm Resource Power Manager (RPM) over SMD



This driver is used to interface with the Resource Power Manager (RPM) found in

various Qualcomm platforms. The RPM allows each component in the system to vote

for state of the system resources, such as clocks, regulators and bus

frequencies.



The SMD information for the RPM edge should be filled out.  See qcom,smd.txt for

the required edge properties.  All SMD related properties will reside within the

RPM node itself.



= SUBDEVICES



The RPM exposes resources to its subnodes.  The rpm_requests node must be

present and this subnode may contain children that designate regulator

resources.



- compatible:

	Usage: required

	Value type: <string>

	Definition: must be one of:

		    "qcom,rpm-apq8084"

		    "qcom,rpm-msm8916"

		    "qcom,rpm-msm8974"



- qcom,smd-channels:

	Usage: required

	Value type: <string>

	Definition: must be "rpm_requests"



Refer to Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.txt

for information on the regulator subnodes that can exist under the rpm_requests.



Example:



	soc {

		apcs: syscon@f9011000 {

			compatible = "syscon";

			reg = <0xf9011000 0x1000>;

		};

	};



	smd {

		compatible = "qcom,smd";



		rpm {

			interrupts = <0 168 1>;

			qcom,ipc = <&apcs 8 0>;

			qcom,smd-edge = <15>;



			rpm_requests {

				compatible = "qcom,rpm-msm8974";

				qcom,smd-channels = "rpm_requests";



				...

			};

		};

	};