diff mbox series

[v3,06/11] dt-bindings: net/can: Add serial (serdev) LIN adapter

Message ID 20240502182804.145926-7-christoph.fritz@hexdev.de (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series LIN Bus support for Linux | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next, async
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 932 this patch: 932
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 12 of 12 maintainers
netdev/build_clang success Errors and warnings before: 938 this patch: 938
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 944 this patch: 944
netdev/checkpatch warning WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Christoph Fritz May 2, 2024, 6:27 p.m. UTC
Add dt-bindings for serial LIN bus adapters. These adapters are
basically just LIN transceivers that are hard-wired to serial devices.

Signed-off-by: Christoph Fritz <christoph.fritz@hexdev.de>
---
 .../bindings/net/can/hexdev,lin-serdev.yaml   | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml

Comments

Conor Dooley May 3, 2024, 5:12 p.m. UTC | #1
On Thu, May 02, 2024 at 08:27:59PM +0200, Christoph Fritz wrote:
> Add dt-bindings for serial LIN bus adapters. These adapters are
> basically just LIN transceivers that are hard-wired to serial devices.
> 
> Signed-off-by: Christoph Fritz <christoph.fritz@hexdev.de>
> ---
>  .../bindings/net/can/hexdev,lin-serdev.yaml   | 32 +++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> new file mode 100644
> index 0000000000000..c178eb9be1391
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> @@ -0,0 +1,32 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/can/hexdev,lin-serdev.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Serial LIN Adapter
> +
> +description:
> +  LIN transceiver, mostly hard-wired to a serial device, used for communication
> +  on a LIN bus.
> +  For more details on an adapter, visit <https://hexdev.de/hexlin#tty>.
> +
> +maintainers:
> +  - Christoph Fritz <christoph.fritz@hexdev.de>
> +
> +properties:
> +  compatible:
> +    const: hexdev,lin-serdev

Maybe I've just missed something on earlier versions that I didn't
read, but the name of the device on the website you link is "hexLIN",
so why is "lin-serdev" used here instead?

> +
> +required:
> +  - compatible
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    serial {
> +        linbus {
> +            compatible = "hexdev,lin-serdev";
> +        };
> +    };
> -- 
> 2.39.2
>
Christoph Fritz May 3, 2024, 6:29 p.m. UTC | #2
Hello Conor,

 thanks for having an eye on this, please see my answer below.

On Fri, 2024-05-03 at 18:12 +0100, Conor Dooley wrote:
> On Thu, May 02, 2024 at 08:27:59PM +0200, Christoph Fritz wrote:
> > Add dt-bindings for serial LIN bus adapters. These adapters are
> > basically just LIN transceivers that are hard-wired to serial devices.
> > 
> > Signed-off-by: Christoph Fritz <christoph.fritz@hexdev.de>
> > ---
> >  .../bindings/net/can/hexdev,lin-serdev.yaml   | 32 +++++++++++++++++++
> >  1 file changed, 32 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> > new file mode 100644
> > index 0000000000000..c178eb9be1391
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> > @@ -0,0 +1,32 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/can/hexdev,lin-serdev.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Serial LIN Adapter
> > +
> > +description:
> > +  LIN transceiver, mostly hard-wired to a serial device, used for communication
> > +  on a LIN bus.
> > +  For more details on an adapter, visit <https://hexdev.de/hexlin#tty>.
> > +
> > +maintainers:
> > +  - Christoph Fritz <christoph.fritz@hexdev.de>
> > +
> > +properties:
> > +  compatible:
> > +    const: hexdev,lin-serdev
> 
> Maybe I've just missed something on earlier versions that I didn't
> read, but the name of the device on the website you link is "hexLIN",
> so why is "lin-serdev" used here instead?

The USB one is called hexLIN and has it's own HID driver.

This serial LIN adapter doesn't really have a product name. Currently
on our website it's generically called 'UART LIN Adapter'.

This LIN adapter is basically just a LIN transceiver and very generic,
so that one could solder it to any single-board computer with an uart.

I think 'lin-serdev' for LIN and serial device fits great, also serdev
is the name of the used kernel infrastructure (besides the LIN glue
driver).

If you still don't like it, I'm open to other names. What about
"hexlin-uart" or "linser"?

Thanks
  -- Christoph
>
Conor Dooley May 6, 2024, 4:16 p.m. UTC | #3
On Fri, May 03, 2024 at 08:29:15PM +0200, Christoph Fritz wrote:
> Hello Conor,
> 
>  thanks for having an eye on this, please see my answer below.
> 
> On Fri, 2024-05-03 at 18:12 +0100, Conor Dooley wrote:
> > On Thu, May 02, 2024 at 08:27:59PM +0200, Christoph Fritz wrote:
> > > Add dt-bindings for serial LIN bus adapters. These adapters are
> > > basically just LIN transceivers that are hard-wired to serial devices.
> > > 
> > > Signed-off-by: Christoph Fritz <christoph.fritz@hexdev.de>
> > > ---
> > >  .../bindings/net/can/hexdev,lin-serdev.yaml   | 32 +++++++++++++++++++
> > >  1 file changed, 32 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> > > 
> > > diff --git a/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> > > new file mode 100644
> > > index 0000000000000..c178eb9be1391
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
> > > @@ -0,0 +1,32 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/net/can/hexdev,lin-serdev.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Serial LIN Adapter
> > > +
> > > +description:
> > > +  LIN transceiver, mostly hard-wired to a serial device, used for communication
> > > +  on a LIN bus.
> > > +  For more details on an adapter, visit <https://hexdev.de/hexlin#tty>.
> > > +
> > > +maintainers:
> > > +  - Christoph Fritz <christoph.fritz@hexdev.de>
> > > +
> > > +properties:
> > > +  compatible:
> > > +    const: hexdev,lin-serdev
> > 
> > Maybe I've just missed something on earlier versions that I didn't
> > read, but the name of the device on the website you link is "hexLIN",
> > so why is "lin-serdev" used here instead?
> 
> The USB one is called hexLIN and has it's own HID driver.
> 
> This serial LIN adapter doesn't really have a product name. Currently
> on our website it's generically called 'UART LIN Adapter'.
> 
> This LIN adapter is basically just a LIN transceiver and very generic,
> so that one could solder it to any single-board computer with an uart.
> 
> I think 'lin-serdev' for LIN and serial device fits great, also serdev
> is the name of the used kernel infrastructure (besides the LIN glue
> driver).
> 
> If you still don't like it, I'm open to other names. What about
> "hexlin-uart" or "linser"?

I dunno, I don't really care about it being called "hexlin,lin-serdev",
all that much, I just found it confusing that the link in the description
sent me to the ""Hello World" in LIN" section of your site. If it had
dropped me off at the "UART LIN adapter" section things woud've been less
confusing.

That said, calling the compatible after a linux-ism is a bit odd to me
when the device seems to be called a "UART LIN adapter" on the page, not
a "serdev".

Cheers,
Conor.
Krzysztof Kozlowski May 6, 2024, 6:50 p.m. UTC | #4
On 06/05/2024 18:16, Conor Dooley wrote:
>>>> +maintainers:
>>>> +  - Christoph Fritz <christoph.fritz@hexdev.de>
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    const: hexdev,lin-serdev
>>>
>>> Maybe I've just missed something on earlier versions that I didn't
>>> read, but the name of the device on the website you link is "hexLIN",
>>> so why is "lin-serdev" used here instead?
>>
>> The USB one is called hexLIN and has it's own HID driver.
>>
>> This serial LIN adapter doesn't really have a product name. Currently
>> on our website it's generically called 'UART LIN Adapter'.
>>
>> This LIN adapter is basically just a LIN transceiver and very generic,
>> so that one could solder it to any single-board computer with an uart.
>>
>> I think 'lin-serdev' for LIN and serial device fits great, also serdev
>> is the name of the used kernel infrastructure (besides the LIN glue
>> driver).
>>
>> If you still don't like it, I'm open to other names. What about
>> "hexlin-uart" or "linser"?
> 
> I dunno, I don't really care about it being called "hexlin,lin-serdev",
> all that much, I just found it confusing that the link in the description
> sent me to the ""Hello World" in LIN" section of your site. If it had
> dropped me off at the "UART LIN adapter" section things woud've been less
> confusing.
> 
> That said, calling the compatible after a linux-ism is a bit odd to me
> when the device seems to be called a "UART LIN adapter" on the page, not
> a "serdev".
> 

If there is no real, fixed model name, I would also propose to use
whatever is on the website currently and avoid Linuxism.

Best regards,
Krzysztof
Christoph Fritz May 8, 2024, 11:34 a.m. UTC | #5
On Mon, 2024-05-06 at 20:50 +0200, Krzysztof Kozlowski wrote:
> On 06/05/2024 18:16, Conor Dooley wrote:
> > > > > +maintainers:
> > > > > +  - Christoph Fritz <christoph.fritz@hexdev.de>
> > > > > +
> > > > > +properties:
> > > > > +  compatible:
> > > > > +    const: hexdev,lin-serdev
> > > > 
> > > > Maybe I've just missed something on earlier versions that I didn't
> > > > read, but the name of the device on the website you link is "hexLIN",
> > > > so why is "lin-serdev" used here instead?
> > > 
> > > The USB one is called hexLIN and has it's own HID driver.
> > > 
> > > This serial LIN adapter doesn't really have a product name. Currently
> > > on our website it's generically called 'UART LIN Adapter'.
> > > 
> > > This LIN adapter is basically just a LIN transceiver and very generic,
> > > so that one could solder it to any single-board computer with an uart.
> > > 
> > > I think 'lin-serdev' for LIN and serial device fits great, also serdev
> > > is the name of the used kernel infrastructure (besides the LIN glue
> > > driver).
> > > 
> > > If you still don't like it, I'm open to other names. What about
> > > "hexlin-uart" or "linser"?
> >
> > I dunno, I don't really care about it being called "hexlin,lin-serdev",
> > all that much, I just found it confusing that the link in the description
> > sent me to the ""Hello World" in LIN" section of your site. If it had
> > dropped me off at the "UART LIN adapter" section things woud've been less
> > confusing.

Hi Conor and Krzysztof,

I guess this is a chromium oddity, because browsing to

 https://hexdev.de/hexlin#hexLINSER

brings the user to another headline ("hexLIN" not "hexLINSER") as long
as headline "hexLINSER" can be also displayed.

When using firefox, the top headline is hexLINSER as expected (at least
I do).

> > 
> > That said, calling the compatible after a linux-ism is a bit odd to me
> > when the device seems to be called a "UART LIN adapter" on the page, not
> > a "serdev".
> > 
> 
> If there is no real, fixed model name, I would also propose to use
> whatever is on the website currently and avoid Linuxism.

OK, I changed it to hexLINSER on the website and in the upcoming v4
revision of this patchset. LINSER for LIN and serial, or like in
"Linsen & Spätzle" :)

Thanks
  -- Christoph
Conor Dooley May 8, 2024, 4:16 p.m. UTC | #6
On Wed, May 08, 2024 at 01:34:34PM +0200, Christoph Fritz wrote:
> On Mon, 2024-05-06 at 20:50 +0200, Krzysztof Kozlowski wrote:
> > On 06/05/2024 18:16, Conor Dooley wrote:
> > > > > > +maintainers:
> > > > > > +  - Christoph Fritz <christoph.fritz@hexdev.de>
> > > > > > +
> > > > > > +properties:
> > > > > > +  compatible:
> > > > > > +    const: hexdev,lin-serdev
> > > > > 
> > > > > Maybe I've just missed something on earlier versions that I didn't
> > > > > read, but the name of the device on the website you link is "hexLIN",
> > > > > so why is "lin-serdev" used here instead?
> > > > 
> > > > The USB one is called hexLIN and has it's own HID driver.
> > > > 
> > > > This serial LIN adapter doesn't really have a product name. Currently
> > > > on our website it's generically called 'UART LIN Adapter'.
> > > > 
> > > > This LIN adapter is basically just a LIN transceiver and very generic,
> > > > so that one could solder it to any single-board computer with an uart.
> > > > 
> > > > I think 'lin-serdev' for LIN and serial device fits great, also serdev
> > > > is the name of the used kernel infrastructure (besides the LIN glue
> > > > driver).
> > > > 
> > > > If you still don't like it, I'm open to other names. What about
> > > > "hexlin-uart" or "linser"?
> > >
> > > I dunno, I don't really care about it being called "hexlin,lin-serdev",
> > > all that much, I just found it confusing that the link in the description
> > > sent me to the ""Hello World" in LIN" section of your site. If it had
> > > dropped me off at the "UART LIN adapter" section things woud've been less
> > > confusing.
> 
> Hi Conor and Krzysztof,
> 
> I guess this is a chromium oddity, because browsing to
> 
>  https://hexdev.de/hexlin#hexLINSER
> 
> brings the user to another headline ("hexLIN" not "hexLINSER") as long
> as headline "hexLINSER" can be also displayed.
> 
> When using firefox, the top headline is hexLINSER as expected (at least
> I do).


Yeah, I think its actually chrome that I saw it originally, but that's
probably irrelevant. After your re-org, in Chrome, if the window is small
enough, I still only see the "3 Open Source Tool: hexLIN" stuff, but
that's not an issue with the binding itself, so I won't hold things up
on that basis.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
new file mode 100644
index 0000000000000..c178eb9be1391
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/hexdev,lin-serdev.yaml
@@ -0,0 +1,32 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/can/hexdev,lin-serdev.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Serial LIN Adapter
+
+description:
+  LIN transceiver, mostly hard-wired to a serial device, used for communication
+  on a LIN bus.
+  For more details on an adapter, visit <https://hexdev.de/hexlin#tty>.
+
+maintainers:
+  - Christoph Fritz <christoph.fritz@hexdev.de>
+
+properties:
+  compatible:
+    const: hexdev,lin-serdev
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    serial {
+        linbus {
+            compatible = "hexdev,lin-serdev";
+        };
+    };