[PATCH 2/2] arm64: dts: rockchip: Add CM3588 NAS board

[Sebastian Kropatsch]

Hello Heiko,

Am 27.05.2024 um 22:54 schrieb Heiko Stübner:
> Am Montag, 27. Mai 2024, 21:02:02 CEST schrieb Jonas Karlman:
>> Hi Sebastian,
>>
>> On 2024-05-26 23:48, Sebastian Kropatsch wrote:
>>> The CM3588 NAS by FriendlyElec pairs the CM3588 compute module, based on
>>> the Rockchip RK3588 SoC, with the CM3588 NAS Kit carrier board.
>>>
>>> Hardware features:
>>>      - Rockchip RK3588 SoC
>>>      - 4GB/8GB/16GB LPDDR4x RAM
>>>      - 64GB eMMC
>>>      - MicroSD card slot
>>>      - 1x RTL8125B 2.5G Ethernet
>>>      - 4x M.2 M-Key with PCIe 3.0 x1 (via bifurcation) for NVMe SSDs
>>>      - 2x USB 3.0 (USB 3.1 Gen1) Type-A, 1x USB 2.0 Type-A
>>>      - 1x USB 3.0 Type-C with DP AltMode support
>>>      - 2x HDMI 2.1 out, 1x HDMI in
>>>      - MIPI-CSI Connector, MIPI-DSI Connector
>>>      - 40-pin GPIO header
>>>      - 4 buttons: power, reset, recovery, MASK, user button
>>>      - 3.5mm Headphone out, 2.0mm PH-2A Mic in
>>>      - 5V Fan connector, PWM buzzer, IR receiver, RTC battery connector
>>>
>>> PCIe bifurcation is used to handle all four M.2 sockets at PCIe 3.0 x1
>>> speed. Data lane mapping in the DT is done like described in commit
>>> f8020dfb311d ("phy: rockchip-snps-pcie3: fix bifurcation on rk3588").
>>>
>>> This device tree includes support for eMMC, SD card, ethernet, all USB2
>>> and USB3 ports, all four M.2 slots, GPU, RTC, buzzer, UART debugging as
>>> well as the buttons and LEDs.
>>> The GPIOs are labeled according to the schematics.
>>>
>>> Signed-off-by: Sebastian Kropatsch <seb-dev at web.de>
>>> ---
>>>   arch/arm64/boot/dts/rockchip/Makefile         |    1 +
>>>   .../boot/dts/rockchip/rk3588-cm3588-nas.dts   | 1269 +++++++++++++++++
>>>   2 files changed, 1270 insertions(+)
>>>   create mode 100644 arch/arm64/boot/dts/rockchip/rk3588-cm3588-nas.dts
>>
>> Because the CM3588 is a SoM and the NAS is a carrier board this should
>> probably be split in two, cm3588.dtsi and cm3588-nas.dts.
>
> also, because of that way too generic name "cm", please incorporate the
> company name in the filename as well. For the same reason we named
> the rk3568-wolfvision-pf5.dts that way ;-) [Wolfvision being the company]
>
> So maybe:
> rk3588-friendlyelec-cm3588.dtsi and rk3588-friendlyelec-cm3588-nas.dts
>

Yes, I agree that the name is very generic. I struggled with this as
well, but your suggestion sounds good!

In this case, is it also preferred to change the commit message to
include the company name event though the commit message subject exceeds
50 characters this way?
("arm64: dts: rockchip: Add FriendlyElec CM3588 NAS board")

>
>>> diff --git a/arch/arm64/boot/dts/rockchip/Makefile b/arch/arm64/boot/dts/rockchip/Makefile
>>> index c544ff507d20..f1ff58bdf2cd 100644
>>> --- a/arch/arm64/boot/dts/rockchip/Makefile
>>> +++ b/arch/arm64/boot/dts/rockchip/Makefile
>>> @@ -114,6 +114,7 @@ dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3568-wolfvision-pf5.dtb
>>>   dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3568-wolfvision-pf5-display-vz.dtbo
>>>   dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3568-wolfvision-pf5-io-expander.dtbo
>>>   dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3588-armsom-sige7.dtb
>>> +dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3588-cm3588-nas.dtb
>>>   dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3588-coolpi-cm5-evb.dtb
>>>   dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3588-edgeble-neu6a-io.dtb
>>>   dtb-$(CONFIG_ARCH_ROCKCHIP) += rk3588-edgeble-neu6a-wifi.dtbo
>>> diff --git a/arch/arm64/boot/dts/rockchip/rk3588-cm3588-nas.dts b/arch/arm64/boot/dts/rockchip/rk3588-cm3588-nas.dts
>>> new file mode 100644
>>> index 000000000000..6c45b376d001
>>> --- /dev/null
>>> +++ b/arch/arm64/boot/dts/rockchip/rk3588-cm3588-nas.dts
>>> @@ -0,0 +1,1269 @@
>>> +// SPDX-License-Identifier: (GPL-2.0+ OR MIT)
>>> +/*
>>> + * Copyright (c) 2021 Rockchip Electronics Co., Ltd.
>>> + * Copyright (c) 2023 FriendlyElec Computer Tech. Co., Ltd.
>>> + * Copyright (c) 2023 Thomas McKahan
>>> + * Copyright (c) 2024 Sebastian Kropatsch
>>> + *
>>> + */
>>> +
>>> +/dts-v1/;
>>> +
>>> +#include <dt-bindings/gpio/gpio.h>
>>> +#include <dt-bindings/input/input.h>
>>> +#include <dt-bindings/pinctrl/rockchip.h>
>>> +#include <dt-bindings/soc/rockchip,vop2.h>
>>> +#include <dt-bindings/usb/pd.h>
>>> +#include "rk3588.dtsi"
>>> +
>>> +/ {
>>> +	model = "FriendlyElec CM3588 NAS";
>>> +	compatible = "friendlyarm,cm3588-nas", "rockchip,rk3588";
>>
>> Maybe this should be something like:
>>
>>    "friendlyarm,cm3588-nas", "friendlyarm,cm3588", "rockchip,rk3588";
>
> This also needs an update of the binding document. Please use a similar
> notion as the other som + baseboard entries
> (const for the som + enum with one entry with the baseboard)
>

Yes, will do!

> [...]
>
>
>>> +/* Connected to 5V Fan */
>>> +&pwm1 {
>>> +	pinctrl-0 = <&pwm1m1_pins>;
>>
>> pinctrl-names is missing, should typically always be defined together
>> with pinctrl-X props, same for multiple nodes.
>
> A rationale being that you don't want the soc dtsi in a later stage adding
> a possible pinctrl-1 with the board only overriding the pinctrl-0.
> When you set the pinctrl-names as well, you get independent from that.
>
>
> Thanks
> Heiko
>

Thank you for exmplaining the retionale behind this! I'll add
pinctrl-names on every instance where pinctrl-0 is present.

Best regards,
Sebastian