[PATCH v3 07/16] Documentation: DT: MIPS: lantiq: Add docs for the RCU bindings

[Hauke Mehrtens]

On 05/31/2017 10:05 PM, Rob Herring wrote:
> On Sun, May 28, 2017 at 08:39:57PM +0200, Hauke Mehrtens wrote:
>> From: Martin Blumenstingl <martin.blumenstingl at googlemail.com>
>>
>> This adds the initial documentation for the RCU module (a MFD device
>> which provides USB PHYs, reset controllers and more).
>>
>> The RCU register range is used for multiple purposes. Mostly one device
>> uses one or multiple register exclusively, but for some registers some
>> bits are for one driver and some other bits are for a different driver.
>> With this patch all accesses to the RCU registers will go through
>> syscon.
>>
>> Signed-off-by: Hauke Mehrtens <hauke at hauke-m.de>
>> ---
>>  .../devicetree/bindings/mips/lantiq/rcu.txt        | 97 ++++++++++++++++++++++
>>  1 file changed, 97 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/mips/lantiq/rcu.txt
>>
>> diff --git a/Documentation/devicetree/bindings/mips/lantiq/rcu.txt b/Documentation/devicetree/bindings/mips/lantiq/rcu.txt
>> new file mode 100644
>> index 000000000000..3e2461262218
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mips/lantiq/rcu.txt
>> @@ -0,0 +1,97 @@
>> +Lantiq XWAY SoC RCU binding
>> +===========================
>> +
>> +This binding describes the RCU (reset controller unit) multifunction device,
>> +where each sub-device has it's own set of registers.
>> +
>> +The RCU register range is used for multiple purposes. Mostly one device
>> +uses one or multiple register exclusively, but for some registers some
>> +bits are for one driver and some other bits are for a different driver.
>> +With this patch all accesses to the RCU registers will go through
>> +syscon.
>> +
>> +
>> +-------------------------------------------------------------------------------
>> +Required properties:
>> +- compatible	: The first and second values must be: "simple-mfd", "syscon"
>> +- reg		: The address and length of the system control registers
>> +
>> +
>> +-------------------------------------------------------------------------------
>> +Example of the RCU bindings on a xRX200 SoC:
>> +	rcu0: rcu at 203000 {
>> +		compatible = "lantiq,rcu-xrx200", "simple-mfd", "syscon";
>> +		reg = <0x203000 0x100>;
>> +		big-endian;
>> +
>> +		gphy0: gphy at 0 {
> 
> Unit address without reg address is not valid.
> 
>> +			compatible = "lantiq,xrx200a2x-rcu-gphy";
>> +
>> +			regmap = <&rcu0>;
>> +			offset = <0x20>;
> 
> Does reg not work instead?

Is it ok to access some registers in this range with a reg = <0x20 0x04>
setting and some others through syscon? This specific register is only
used by this gphy, but the reset controller shares the register with
some other drivers like the watchdog driver.

>> +			resets = <&reset0 31 30>, <&reset1 7 7>;
>> +			reset-names = "gphy", "gphy2";
>> +			lantiq,gphy-mode = <GPHY_MODE_GE>;
>> +		};
>> +
>> +		gphy1: gphy at 1 {
>> +			compatible = "lantiq,xrx200a2x-rcu-gphy";
>> +
>> +			regmap = <&rcu0>;
>> +			offset = <0x68>;
>> +			resets = <&reset0 29 28>, <&reset1 6 6>;
>> +			reset-names = "gphy", "gphy2";
>> +			lantiq,gphy-mode = <GPHY_MODE_GE>;
>> +		};
>> +
>> +		reset0: reset-controller at 0 {
>> +			compatible = "lantiq,rcu-reset";
>> +
>> +			regmap = <&rcu0>;
>> +			offset-set = <0x10>;
>> +			offset-status = <0x14>;
>> +			#reset-cells = <2>;
>> +		};
>> +
>> +		reset1: reset-controller at 1 {
>> +			compatible = "lantiq,rcu-reset";
>> +
>> +			regmap = <&rcu0>;
>> +			offset-set = <0x48>;
>> +			offset-status = <0x24>;
>> +			#reset-cells = <2>;
>> +		};
>> +
>> +		usb_phy0: usb2-phy at 0 {
>> +			compatible = "lantiq,xrx200-rcu-usb2-phy";
>> +			status = "disabled";
>> +
>> +			regmap = <&rcu0>;
>> +			offset-phy = <0x18>;
>> +			offset-ana = <0x38>;
>> +			resets = <&reset1 4 4>, <&reset0 4 4>;
>> +			reset-names = "phy", "ctrl";
>> +			#phy-cells = <0>;
>> +		};
>> +
>> +		usb_phy1: usb2-phy at 1 {
>> +			compatible = "lantiq,xrx200-rcu-usb2-phy";
>> +			status = "disabled";
>> +
>> +			regmap = <&rcu0>;
>> +			offset-phy = <0x34>;
>> +			offset-ana = <0x3C>;
>> +			resets = <&reset1 5 4>, <&reset0 4 4>;
>> +			reset-names = "phy", "ctrl";
>> +			#phy-cells = <0>;
>> +		};
>> +
>> +		reboot {
>> +			compatible = "syscon-reboot";
>> +
>> +			regmap = <&rcu0>;
>> +			offset = <0x10>;
>> +			mask = <0x40000000>;
>> +		};
>> +	};
>> +
>> -- 
>> 2.11.0
>>