Re: [PATCH 1/2] dt-bindings: arm: Add i.MX8M Mini Gateworks GW7904 board

[Tim Harvey]

On Fri, Sep 9, 2022 at 1:03 AM Krzysztof Kozlowski <krzk@xxxxxxxxxx> wrote:
>
> On 08/09/2022 23:44, Tim Harvey wrote:
> > On Thu, Sep 8, 2022 at 2:19 PM Rob Herring <robh@xxxxxxxxxx> wrote:
> >>
> >> On Fri, Sep 02, 2022 at 04:04:59PM -0700, Tim Harvey wrote:
> >>> Add DT compatible string for i.MX8M Mini based Gateworks GW7904 board.
> >>>
> >>> Signed-off-by: Tim Harvey <tharvey@xxxxxxxxxxxxx>
> >>> Cc: Rob Herring <robh+dt@xxxxxxxxxx>
> >>> Cc: Krzysztof Kozlowski <krzk+dt@xxxxxxxxxx>
> >>> Cc: Shawn Guo <shawnguo@xxxxxxxxxx>
> >>> Cc: Sascha Hauer <s.hauer@xxxxxxxxxxxxxx>
> >>> Cc: Pengutronix Kernel Team <kernel@xxxxxxxxxxxxxx>
> >>> Cc: Fabio Estevam <festevam@xxxxxxxxx>
> >>> Cc: NXP Linux Team <linux-imx@xxxxxxx>
> >>> ---
> >>>  Documentation/devicetree/bindings/arm/fsl.yaml | 1 +
> >>>  1 file changed, 1 insertion(+)
> >>>
> >>> diff --git a/Documentation/devicetree/bindings/arm/fsl.yaml b/Documentation/devicetree/bindings/arm/fsl.yaml
> >>> index 7431579ab0e8..ce89fac1898e 100644
> >>> --- a/Documentation/devicetree/bindings/arm/fsl.yaml
> >>> +++ b/Documentation/devicetree/bindings/arm/fsl.yaml
> >>> @@ -831,6 +831,7 @@ properties:
> >>>                - gw,imx8mm-gw7901          # i.MX8MM Gateworks Board
> >>>                - gw,imx8mm-gw7902          # i.MX8MM Gateworks Board
> >>>                - gw,imx8mm-gw7903          # i.MX8MM Gateworks Board
> >>> +              - gateworks,imx8mm-gw7904   # i.MX8MM Gateworks Board
> >>
> >> A useful comment would be ones that distuiguish these boards. It's
> >> obvious from the compatible it's a i.MX8MM board from Gateworks.
> >
> > But isn't it clear that you need to go to the device-tree itself to
> > understand the details?
> >
> > As far as basic features go sometimes there is very little difference
> > in these board models. It would be a struggle to list all the board
> > details (which I do in the dts commit) in a way that doesn't take up
> > too much space in fsl.yaml.
> >
>
> But then the comment you added is useless. So either add useful comment
> or no comment. :)
>
>
> Best regards,
> Krzysztof

Krzysztof,

so are you saying that no comment is fine here as well? It seems to me
that most of the comments in that file look just like mine which I
agree are about just as descriptive as the compatible string.

For discussion purposes here is for example the commit log for the GW7904 dts:
    The GW7904 is based on the i.MX 8M Mini SoC featuring:
     - LPDDR4 DRAM
     - eMMC FLASH
     - microSD connector with UHS support
     - LIS2DE12 3-axis accelerometer
     - Gateworks System Controller
     - IMX8M FEC
     - 2x RS232 off-board connectors
     - PMIC
     - 10x bi-color LED's
     - 1x miniPCIe socket with PCIe and USB2.0
     - 802.3at Class 4 PoE
     - 10-30VDC input via barrel-jack

And the comit log for the very similar GW7903 dts:
    The GW7903 is based on the i.MX 8M Mini SoC featuring:
     - LPDDR4 DRAM
     - eMMC FLASH
     - microSD connector with UHS support
     - LIS2DE12 3-axis accelerometer
     - Gateworks System Controller
     - IMX8M FEC
     - software selectable RS232/RS485/RS422 serial transceiver
     - PMIC
     - 2x off-board bi-directional opto-isolated digital I/O
     - 1x M.2 A-E Key Socket and 1x MiniPCIe socket with USB2.0 and PCIe
       (resistor loading to route PCIe/USB2 between M.2 and MiniPCIe socket)

Best Regards,

Tim