diff mbox series

[v2,3/6] dt-bindings: phy: Add binding for TI TCAN104x CAN transceivers

Message ID 20210414140521.11463-4-a-govindraju@ti.com (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series CAN TRANSCEIVER: Add support for CAN transceivers | expand

Checks

Context Check Description
netdev/cover_letter success Link
netdev/fixes_present success Link
netdev/patch_count success Link
netdev/tree_selection success Guessed tree name to be net-next
netdev/subject_prefix success Link
netdev/cc_maintainers success CCed 9 of 9 maintainers
netdev/source_inline success Was 0 now: 0
netdev/verify_signedoff success Link
netdev/module_param success Was 0 now: 0
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/verify_fixes success Link
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 63 lines checked
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/header_inline success Link

Commit Message

Aswath Govindraju April 14, 2021, 2:05 p.m. UTC
Add binding documentation for TI TCAN104x CAN transceivers.

Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
---
 .../bindings/phy/ti,tcan104x-can.yaml         | 56 +++++++++++++++++++
 MAINTAINERS                                   |  1 +
 2 files changed, 57 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml

Comments

Marc Kleine-Budde April 14, 2021, 3:33 p.m. UTC | #1
On 14.04.2021 19:35:18, Aswath Govindraju wrote:
> Add binding documentation for TI TCAN104x CAN transceivers.
> 
> Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
> ---
>  .../bindings/phy/ti,tcan104x-can.yaml         | 56 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 57 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> 
> diff --git a/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> new file mode 100644
> index 000000000000..4abfc30a97d0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/phy/ti,tcan104x-can.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: TCAN104x CAN TRANSCEIVER PHY
> +
> +maintainers:
> +  - Aswath Govindraju <a-govindraju@ti.com>
> +
> +properties:
> +  $nodename:
> +    pattern: "^tcan104x-phy"
> +
> +  compatible:
> +    enum:
> +      - ti,tcan1042
> +      - ti,tcan1043

Can you ensure that the 1042 has only the standby gpio and the 1043 has both?

> +
> +  '#phy-cells':
> +    const: 0
> +
> +  standby-gpios:
> +    description:
> +      gpio node to toggle standby signal on transceiver
> +    maxItems: 1
> +
> +  enable-gpios:
> +    description:
> +      gpio node to toggle enable signal on transceiver
> +    maxItems: 1
> +
> +  max-bitrate:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      max bit rate supported in bps
> +    minimum: 1
> +
> +required:
> +  - compatible
> +  - '#phy-cells'
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    transceiver1: tcan104x-phy {
> +      compatible = "ti,tcan1043";
> +      #phy-cells = <0>;
> +      max-bitrate = <5000000>;
> +      standby-gpios = <&wakeup_gpio1 16 GPIO_ACTIVE_LOW>;
> +      enable-gpios = <&main_gpio1 67 GPIO_ACTIVE_LOW>;

AFAICS the enable gpio is active high.

Marc
Aswath Govindraju April 15, 2021, 6:27 a.m. UTC | #2
Hi Marc,

On 14/04/21 9:03 pm, Marc Kleine-Budde wrote:
> On 14.04.2021 19:35:18, Aswath Govindraju wrote:
>> Add binding documentation for TI TCAN104x CAN transceivers.
>>
>> Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
>> ---
>>  .../bindings/phy/ti,tcan104x-can.yaml         | 56 +++++++++++++++++++
>>  MAINTAINERS                                   |  1 +
>>  2 files changed, 57 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
>> new file mode 100644
>> index 000000000000..4abfc30a97d0
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
>> @@ -0,0 +1,56 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: "http://devicetree.org/schemas/phy/ti,tcan104x-can.yaml#"
>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>> +
>> +title: TCAN104x CAN TRANSCEIVER PHY
>> +
>> +maintainers:
>> +  - Aswath Govindraju <a-govindraju@ti.com>
>> +
>> +properties:
>> +  $nodename:
>> +    pattern: "^tcan104x-phy"
>> +
>> +  compatible:
>> +    enum:
>> +      - ti,tcan1042
>> +      - ti,tcan1043
> 
> Can you ensure that the 1042 has only the standby gpio and the 1043 has both?
> 

In the driver, it is the way the flags have been set for ti,tcan1042 and
ti,tcan1043.

>> +
>> +  '#phy-cells':
>> +    const: 0
>> +
>> +  standby-gpios:
>> +    description:
>> +      gpio node to toggle standby signal on transceiver
>> +    maxItems: 1
>> +
>> +  enable-gpios:
>> +    description:
>> +      gpio node to toggle enable signal on transceiver
>> +    maxItems: 1
>> +
>> +  max-bitrate:
>> +    $ref: /schemas/types.yaml#/definitions/uint32
>> +    description:
>> +      max bit rate supported in bps
>> +    minimum: 1
>> +
>> +required:
>> +  - compatible
>> +  - '#phy-cells'
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/gpio/gpio.h>
>> +
>> +    transceiver1: tcan104x-phy {
>> +      compatible = "ti,tcan1043";
>> +      #phy-cells = <0>;
>> +      max-bitrate = <5000000>;
>> +      standby-gpios = <&wakeup_gpio1 16 GPIO_ACTIVE_LOW>;
>> +      enable-gpios = <&main_gpio1 67 GPIO_ACTIVE_LOW>;
> 
> AFAICS the enable gpio is active high.
> 

I will correct this in the respin.

Thanks,
Aswath

> Marc
>
Marc Kleine-Budde April 15, 2021, 7:38 a.m. UTC | #3
On 15.04.2021 11:57:20, Aswath Govindraju wrote:
> Hi Marc,
> 
> On 14/04/21 9:03 pm, Marc Kleine-Budde wrote:
> > On 14.04.2021 19:35:18, Aswath Govindraju wrote:
> >> Add binding documentation for TI TCAN104x CAN transceivers.
> >>
> >> Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
> >> ---
> >>  .../bindings/phy/ti,tcan104x-can.yaml         | 56 +++++++++++++++++++
> >>  MAINTAINERS                                   |  1 +
> >>  2 files changed, 57 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> >>
> >> diff --git a/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> >> new file mode 100644
> >> index 000000000000..4abfc30a97d0
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> >> @@ -0,0 +1,56 @@
> >> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> >> +%YAML 1.2
> >> +---
> >> +$id: "http://devicetree.org/schemas/phy/ti,tcan104x-can.yaml#"
> >> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> >> +
> >> +title: TCAN104x CAN TRANSCEIVER PHY
> >> +
> >> +maintainers:
> >> +  - Aswath Govindraju <a-govindraju@ti.com>

Can you create a maintainers entry for this file with your address?

> >> +
> >> +properties:
> >> +  $nodename:
> >> +    pattern: "^tcan104x-phy"
> >> +
> >> +  compatible:
> >> +    enum:
> >> +      - ti,tcan1042
> >> +      - ti,tcan1043
> > 
> > Can you ensure that the 1042 has only the standby gpio and the 1043 has both?
> > 
> 
> In the driver, it is the way the flags have been set for ti,tcan1042 and
> ti,tcan1043.

I was wondering if we would enforce in the DT the 1042 has exactly one
the standby GPIO and the 1043 has exactly the standby and the enable
GPIO.

On the other hand the HW might have pulled one or the other pin high or
low and only one of the pins is connected to a GPIO.

> >> +
> >> +  '#phy-cells':
> >> +    const: 0
> >> +
> >> +  standby-gpios:
> >> +    description:
> >> +      gpio node to toggle standby signal on transceiver
> >> +    maxItems: 1
> >> +
> >> +  enable-gpios:
> >> +    description:
> >> +      gpio node to toggle enable signal on transceiver
> >> +    maxItems: 1
> >> +
> >> +  max-bitrate:
> >> +    $ref: /schemas/types.yaml#/definitions/uint32
> >> +    description:
> >> +      max bit rate supported in bps
> >> +    minimum: 1
> >> +
> >> +required:
> >> +  - compatible
> >> +  - '#phy-cells'
> >> +
> >> +additionalProperties: false
> >> +
> >> +examples:
> >> +  - |
> >> +    #include <dt-bindings/gpio/gpio.h>
> >> +
> >> +    transceiver1: tcan104x-phy {
> >> +      compatible = "ti,tcan1043";
> >> +      #phy-cells = <0>;
> >> +      max-bitrate = <5000000>;
> >> +      standby-gpios = <&wakeup_gpio1 16 GPIO_ACTIVE_LOW>;
> >> +      enable-gpios = <&main_gpio1 67 GPIO_ACTIVE_LOW>;
> > 
> > AFAICS the enable gpio is active high.
> > 
> 
> I will correct this in the respin.

Marc
Aswath Govindraju April 15, 2021, 9:11 a.m. UTC | #4
Hi Marc,

On 15/04/21 1:08 pm, Marc Kleine-Budde wrote:
> On 15.04.2021 11:57:20, Aswath Govindraju wrote:
>> Hi Marc,
>>
>> On 14/04/21 9:03 pm, Marc Kleine-Budde wrote:
>>> On 14.04.2021 19:35:18, Aswath Govindraju wrote:
>>>> Add binding documentation for TI TCAN104x CAN transceivers.
>>>>
>>>> Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
>>>> ---
>>>>  .../bindings/phy/ti,tcan104x-can.yaml         | 56 +++++++++++++++++++
>>>>  MAINTAINERS                                   |  1 +
>>>>  2 files changed, 57 insertions(+)
>>>>  create mode 100644 Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
>>>> new file mode 100644
>>>> index 000000000000..4abfc30a97d0
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
>>>> @@ -0,0 +1,56 @@
>>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: "http://devicetree.org/schemas/phy/ti,tcan104x-can.yaml#"
>>>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>>>> +
>>>> +title: TCAN104x CAN TRANSCEIVER PHY
>>>> +
>>>> +maintainers:
>>>> +  - Aswath Govindraju <a-govindraju@ti.com>
> 
> Can you create a maintainers entry for this file with your address?

I don't see this being done for other phy yamls in the
Documentation/devicetree/bindings/phy folder. Also,
scripts/get_maintainer.pl is giving the names of maintainers after
reading the yaml files too.

Thanks,
Aswath

> 
>>>> +
>>>> +properties:
>>>> +  $nodename:
>>>> +    pattern: "^tcan104x-phy"
>>>> +
>>>> +  compatible:
>>>> +    enum:
>>>> +      - ti,tcan1042
>>>> +      - ti,tcan1043
>>>
>>> Can you ensure that the 1042 has only the standby gpio and the 1043 has both?
>>>
>>
>> In the driver, it is the way the flags have been set for ti,tcan1042 and
>> ti,tcan1043.
> 
> I was wondering if we would enforce in the DT the 1042 has exactly one
> the standby GPIO and the 1043 has exactly the standby and the enable
> GPIO.
> 
> On the other hand the HW might have pulled one or the other pin high or
> low and only one of the pins is connected to a GPIO.
> 
>>>> +
>>>> +  '#phy-cells':
>>>> +    const: 0
>>>> +
>>>> +  standby-gpios:
>>>> +    description:
>>>> +      gpio node to toggle standby signal on transceiver
>>>> +    maxItems: 1
>>>> +
>>>> +  enable-gpios:
>>>> +    description:
>>>> +      gpio node to toggle enable signal on transceiver
>>>> +    maxItems: 1
>>>> +
>>>> +  max-bitrate:
>>>> +    $ref: /schemas/types.yaml#/definitions/uint32
>>>> +    description:
>>>> +      max bit rate supported in bps
>>>> +    minimum: 1
>>>> +
>>>> +required:
>>>> +  - compatible
>>>> +  - '#phy-cells'
>>>> +
>>>> +additionalProperties: false
>>>> +
>>>> +examples:
>>>> +  - |
>>>> +    #include <dt-bindings/gpio/gpio.h>
>>>> +
>>>> +    transceiver1: tcan104x-phy {
>>>> +      compatible = "ti,tcan1043";
>>>> +      #phy-cells = <0>;
>>>> +      max-bitrate = <5000000>;
>>>> +      standby-gpios = <&wakeup_gpio1 16 GPIO_ACTIVE_LOW>;
>>>> +      enable-gpios = <&main_gpio1 67 GPIO_ACTIVE_LOW>;
>>>
>>> AFAICS the enable gpio is active high.
>>>
>>
>> I will correct this in the respin.
> 
> Marc
>
Marc Kleine-Budde April 15, 2021, 9:15 a.m. UTC | #5
On 15.04.2021 14:41:57, Aswath Govindraju wrote:
> >>>> +++ b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> > Can you create a maintainers entry for this file with your address?
> 
> I don't see this being done for other phy yamls in the
> Documentation/devicetree/bindings/phy folder. Also,
> scripts/get_maintainer.pl is giving the names of maintainers after
> reading the yaml files too.

Nice! Clever script.

Marc
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
new file mode 100644
index 000000000000..4abfc30a97d0
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
@@ -0,0 +1,56 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/phy/ti,tcan104x-can.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: TCAN104x CAN TRANSCEIVER PHY
+
+maintainers:
+  - Aswath Govindraju <a-govindraju@ti.com>
+
+properties:
+  $nodename:
+    pattern: "^tcan104x-phy"
+
+  compatible:
+    enum:
+      - ti,tcan1042
+      - ti,tcan1043
+
+  '#phy-cells':
+    const: 0
+
+  standby-gpios:
+    description:
+      gpio node to toggle standby signal on transceiver
+    maxItems: 1
+
+  enable-gpios:
+    description:
+      gpio node to toggle enable signal on transceiver
+    maxItems: 1
+
+  max-bitrate:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      max bit rate supported in bps
+    minimum: 1
+
+required:
+  - compatible
+  - '#phy-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    transceiver1: tcan104x-phy {
+      compatible = "ti,tcan1043";
+      #phy-cells = <0>;
+      max-bitrate = <5000000>;
+      standby-gpios = <&wakeup_gpio1 16 GPIO_ACTIVE_LOW>;
+      enable-gpios = <&main_gpio1 67 GPIO_ACTIVE_LOW>;
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 84ef96a444c3..e666d33af10d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4046,6 +4046,7 @@  W:	https://github.com/linux-can
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can.git
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git
 F:	Documentation/devicetree/bindings/net/can/
+F:	Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
 F:	drivers/net/can/
 F:	include/linux/can/bittiming.h
 F:	include/linux/can/dev.h