diff mbox series

[1/2,v3] dt-bindings: dspi: added for semtech sx1301

Message ID 20220420035045.33940-1-jerry.huang@nxp.com (mailing list archive)
State Superseded
Headers show
Series [1/2,v3] dt-bindings: dspi: added for semtech sx1301 | expand

Commit Message

Changming Huang April 20, 2022, 3:50 a.m. UTC 
Add DT Binding doc for semtech sx1301

Signed-off-by: Changming Huang <jerry.huang@nxp.com>
---
changes in v3:
  - add the dt-bindings

 .../bindings/spi/semtech,sx1301.yaml          | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/semtech,sx1301.yaml

Comments

Krzysztof Kozlowski April 20, 2022, 6:58 a.m. UTC | #1 
On 20/04/2022 05:50, Changming Huang wrote:
> Add DT Binding doc for semtech sx1301
> 
> Signed-off-by: Changming Huang <jerry.huang@nxp.com>
> ---
> changes in v3:
>   - add the dt-bindings
> 
>  .../bindings/spi/semtech,sx1301.yaml          | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> 
> diff --git a/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> new file mode 100644
> index 000000000000..f65fb5809218
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/spi/semtech,sx1301.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Semtech sx1301 devicetree bindings

Remove "devicetree bindings" and add instead short description (type) of
the device (SPI controller?).

> +
> +allOf:
> +  - $ref: "spi-controller.yaml"

allOf after maintainers.

> +
> +maintainers:
> +  - Changming Huang <jerry.huang@nxp.com>
> +
> +properties:
> +  compatible:
> +    const: semtech,sx1301
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency: true
> +
> +  fsl,spi-cs-sck-delay: true
> +
> +  fsl,spi-sck-cs-delay: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-max-frequency
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    mikrobus@0 {

Isn't MikroBUS more than SPI, but you implement here only it's part? If
so, name it just "spi".


Best regards,
Krzysztof
Michael Walle April 20, 2022, 11:26 a.m. UTC | #2 
> Add DT Binding doc for semtech sx1301

Please be a bit more elaborate. The sx1301 seems to be an
SPI device, some kind of WAN device.

> 
> Signed-off-by: Changming Huang <jerry.huang@nxp.com>
> ---
> changes in v3:
>   - add the dt-bindings
> 
>  .../bindings/spi/semtech,sx1301.yaml          | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> 
> diff --git a/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> new file mode 100644
> index 000000000000..f65fb5809218
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/spi/semtech,sx1301.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Semtech sx1301 devicetree bindings
> +
> +allOf:
> +  - $ref: "spi-controller.yaml"

.. then why does it inherit the spi controllers properties?

Also *some* kind of information what the sx1301 is would be nice.

Anyway, I was about to comment on your patch 2. But maybe I'll
just leave it here. On the RDB there is a mikrobus connector, with
this, you are going to say "hey there is always a sx1301" module
there. What happens if it not there? What if you put another module
in that socket?

Maybe Krzystof knows better. But it really looks like you want to
have device tree overlays here instead of hardcoding exactly one
use case.

-michael

> +
> +maintainers:
> +  - Changming Huang <jerry.huang@nxp.com>
> +
> +properties:
> +  compatible:
> +    const: semtech,sx1301
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency: true
> +
> +  fsl,spi-cs-sck-delay: true
> +
> +  fsl,spi-sck-cs-delay: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-max-frequency
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    mikrobus@0 {
> +      compatible = "semtech,sx1301";
> +      reg = <0>;
> +      spi-max-frequency = <2000000>;
> +      fsl,spi-cs-sck-delay = <1000000>;
> +      fsl,spi-sck-cs-delay = <50>;
> +    };
> +
> +...
> -- 
> 2.25.1
> 
>
Changming Huang April 21, 2022, 9:01 a.m. UTC | #3 
Best Regards
Jerry Huang

-----Original Message-----
From: Michael Walle <michael@walle.cc> 
Sent: 2022年4月20日 19:27
To: Jerry Huang <jerry.huang@nxp.com>
Cc: broonie@kernel.org; devicetree@vger.kernel.org; krzysztof.kozlowski+dt@linaro.org; Leo Li <leoyang.li@nxp.com>; linux-arm-kernel@lists.infradead.org; linux-kernel@vger.kernel.org; linux-spi@vger.kernel.org; robh+dt@kernel.org; shawnguo@kernel.org; Michael Walle <michael@walle.cc>
Subject: [EXT] Re: [PATCH 1/2 v3] dt-bindings: dspi: added for semtech sx1301

Caution: EXT Email

> Add DT Binding doc for semtech sx1301

Please be a bit more elaborate. The sx1301 seems to be an SPI device, some kind of WAN device.
[Jerry Huang] I double checked the MikroBus devices, we used two MikcroBus devices:
BLE P click: https://www.mikroe.com/ble-p-click
BEE click: https://www.mikroe.com/bee-click
Both of them are SPI interface connect to ls1028ardb through MiKcroBus interface.
So the name "semtech sx1301" is not correct for this node.

>
> Signed-off-by: Changming Huang <jerry.huang@nxp.com>
> ---
> changes in v3:
>   - add the dt-bindings
>
>  .../bindings/spi/semtech,sx1301.yaml          | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 
> Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
>
> diff --git a/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml 
> b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> new file mode 100644
> index 000000000000..f65fb5809218
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: 
> +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> +cetree.org%2Fschemas%2Fspi%2Fsemtech%2Csx1301.yaml%23&amp;data=05%7C0
> +1%7Cjerry.huang%40nxp.com%7Cc45d97643d6b4639d00508da22c0b535%7C686ea1
> +d3bc2b4c6fa92cd99c5c301635%7C0%7C1%7C637860508327293217%7CUnknown%7CT
> +WFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVC
> +I6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=b3gaerVDOI1F3ml3fUlTJ47D2YcDqj6cts
> +0YKCYXqOM%3D&amp;reserved=0
> +$schema: 
> +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> +cetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=05%7C01%7Cjerry.hua
> +ng%40nxp.com%7Cc45d97643d6b4639d00508da22c0b535%7C686ea1d3bc2b4c6fa92
> +cd99c5c301635%7C0%7C1%7C637860508327293217%7CUnknown%7CTWFpbGZsb3d8ey
> +JWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C30
> +00%7C%7C%7C&amp;sdata=v88eUuFAVfTeoAWyADNYHJ8NwFja5CkYrqWeCndlayY%3D&
> +amp;reserved=0
> +
> +title: Semtech sx1301 devicetree bindings
> +
> +allOf:
> +  - $ref: "spi-controller.yaml"

.. then why does it inherit the spi controllers properties?

Also *some* kind of information what the sx1301 is would be nice.

Anyway, I was about to comment on your patch 2. But maybe I'll just leave it here. On the RDB there is a mikrobus connector, with this, you are going to say "hey there is always a sx1301" module there. What happens if it not there? What if you put another module in that socket?
[Jerry Huang] the name sx1301 is not correct, I think the purpose of it just is to invoke the spidev driver (./drivers/spi/spidev.c)
I will change the compatible name and add it to ./drivers/spi/spidev.c file.

Maybe Krzystof knows better. But it really looks like you want to have device tree overlays here instead of hardcoding exactly one use case.

-michael

> +
> +maintainers:
> +  - Changming Huang <jerry.huang@nxp.com>
> +
> +properties:
> +  compatible:
> +    const: semtech,sx1301
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency: true
> +
> +  fsl,spi-cs-sck-delay: true
> +
> +  fsl,spi-sck-cs-delay: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-max-frequency
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    mikrobus@0 {
> +      compatible = "semtech,sx1301";
> +      reg = <0>;
> +      spi-max-frequency = <2000000>;
> +      fsl,spi-cs-sck-delay = <1000000>;
> +      fsl,spi-sck-cs-delay = <50>;
> +    };
> +
> +...
> --
> 2.25.1
>
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
new file mode 100644
index 000000000000..f65fb5809218
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/semtech,sx1301.yaml
@@ -0,0 +1,45 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/semtech,sx1301.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Semtech sx1301 devicetree bindings
+
+allOf:
+  - $ref: "spi-controller.yaml"
+
+maintainers:
+  - Changming Huang <jerry.huang@nxp.com>
+
+properties:
+  compatible:
+    const: semtech,sx1301
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency: true
+
+  fsl,spi-cs-sck-delay: true
+
+  fsl,spi-sck-cs-delay: true
+
+required:
+  - compatible
+  - reg
+  - spi-max-frequency
+
+additionalProperties: false
+
+examples:
+  - |
+    mikrobus@0 {
+      compatible = "semtech,sx1301";
+      reg = <0>;
+      spi-max-frequency = <2000000>;
+      fsl,spi-cs-sck-delay = <1000000>;
+      fsl,spi-sck-cs-delay = <50>;
+    };
+
+...