Re: [rtc-linux] Re: [PATCH v5 1/4] dt-bindings: mfd: s2mps11: add documentation for s2mps15 PMIC

[Krzysztof Kozlowski]

On 09.11.2015 14:54, Alim Akhtar wrote:
> Hi Krzysztof,
> 
> On 11/07/2015 08:39 AM, Krzysztof Kozlowski wrote:
>> W dniu 07.11.2015 o 07:33, Rob Herring pisze:
>>> On Fri, Oct 30, 2015 at 11:55:31AM +0530, Alim Akhtar wrote:
>>>> From: Thomas Abraham <thomas.ab@xxxxxxxxxxx>
>>>>
>>>> Add dt-binding documentation for s2mps15 PMIC device. The s2mps15
>>>> device
>>>> is similar to s2mps11/14 PMIC device and has 27 LDO and 10 buck
>>>> regulators.
>>>> This also supports RTC and three 32.768KHz clock outputs.
>>>>
>>>> Cc: devicetree@xxxxxxxxxxxxxxx
>>>> Signed-off-by: Thomas Abraham <thomas.ab@xxxxxxxxxxx>
>>>> Signed-off-by: Alim Akhtar <alim.akhtar@xxxxxxxxxxx>
>>>> ---
>>>>   Documentation/devicetree/bindings/mfd/s2mps11.txt |   21
>>>> ++++++++++++++-------
>>>>   1 file changed, 14 insertions(+), 7 deletions(-)
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/mfd/s2mps11.txt
>>>> b/Documentation/devicetree/bindings/mfd/s2mps11.txt
>>>> index 890f0b0e1643..4c0543ceec25 100644
>>>> --- a/Documentation/devicetree/bindings/mfd/s2mps11.txt
>>>> +++ b/Documentation/devicetree/bindings/mfd/s2mps11.txt
>>>> @@ -1,5 +1,5 @@
>>>>
>>>> -* Samsung S2MPS11, S2MPS13, S2MPS14 and S2MPU02 Voltage and Current
>>>> Regulator
>>>> +* Samsung S2MPS11/13/14/15 and S2MPU02 Voltage and Current Regulator
>>>>
>>>>   The Samsung S2MPS11 is a multi-function device which includes
>>>> voltage and
>>>>   current regulators, RTC, charger controller and other sub-blocks.
>>>> It is
>>>> @@ -7,8 +7,12 @@ interfaced to the host controller using an I2C
>>>> interface. Each sub-block is
>>>>   addressed by the host system using different I2C slave addresses.
>>>>
>>>>   Required properties:
>>>> -- compatible: Should be "samsung,s2mps11-pmic" or
>>>> "samsung,s2mps13-pmic"
>>>> -          or "samsung,s2mps14-pmic" or "samsung,s2mpu02-pmic".
>>>> +- compatible: Should be one of the following
>>>> +    - "samsung,s2mps11-pmic"
>>>> +    - "samsung,s2mps13-pmic"
>>>> +    - "samsung,s2mps14-pmic"
>>>> +    - "samsung,s2mps15-pmic"
>>>> +    - "samsung,s2mpu02-pmic".
>>>>   - reg: Specifies the I2C slave address of the pmic block. It
>>>> should be 0x66.
>>>>
>>>>   Optional properties:
>>>> @@ -24,7 +28,7 @@ Optional properties:
>>>>     unwanted buck warm reset (setting buck voltages to default values).
>>>>
>>>>   Optional nodes:
>>>> -- clocks: s2mps11, s2mps13 and s5m8767 provide three(AP/CP/BT)
>>>> buffered 32.768
>>>> +- clocks: s2mps11, s2mps13, s2mps15 and s5m8767 provide
>>>> three(AP/CP/BT) buffered 32.768
>>>
>>> s5m8767 doesn't seem to be documented. Can you please fix or remove.
>>
>> What exactly do you have in mind?
>>
>> The s5m8767-clk is already documented as part of clk-s2mps11.c driver:
>> Documentation/devicetree/bindings/mfd/s2mps11.txt
>>
>> The main s5m8767 MFD driver is documented as part of regulator driver:
>> Documentation/devicetree/bindings/regulator/s5m8767-regulator.txt
>>
>> Yes, this may be confusing... They S2M and S5M family devices share:
>>   - main mfd driver,
>>   - rtc driver,
>>   - clk driver.
>>
>> but regulator drivers are separate.
>>
> Indeed things are documented but in very confusing manners, e.g.
> compatible name "samsung,s5m8767-pmic" belongs to MFD not regulator.

The compatible itself belongs to MFD but in the same time the required
properties for regulator driver (which expects to be child of that
compatible) are stored next to it.

> It should have being in */bindings/mfd/s2mps11.txt
> Not sure if it make sense to change it though.

Then the naming would be confusing. :)

Actually I have it on my todo list to fix things up. Truth is that all
of these devices are tightly coupled.

Best regards,
Krzysztof

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/