From 8c5377810f48eeacef47981f32efbf0fc0b97c7f Mon Sep 17 00:00:00 2001 From: Tim L Date: Fri, 16 Feb 2024 22:22:28 +1100 Subject: [PATCH] Add documentation for ODROID-M1S (#3179) --- Documentation/boards/README.md | 2 + Documentation/boards/hardkernel/odroid-m1s.md | 50 +++++++++++++++++++ Documentation/kernel.md | 1 + 3 files changed, 53 insertions(+) create mode 100644 Documentation/boards/hardkernel/odroid-m1s.md diff --git a/Documentation/boards/README.md b/Documentation/boards/README.md index cd485915a..ff613805a 100644 --- a/Documentation/boards/README.md +++ b/Documentation/boards/README.md @@ -13,6 +13,7 @@ The following boards/devices are supported: - [ODROID-C2](https://www.hardkernel.com/shop/odroid-c2/) (discontinued) - [ODROID-C4](https://www.hardkernel.com/shop/odroid-c4/) - [ODROID-M1](https://www.hardkernel.com/shop/odroid-m1/) + - ODROID-M1S [4 GB](https://www.hardkernel.com/shop/odroid-m1s-with-4gbyte-ram/) or [8 GB](https://www.hardkernel.com/shop/odroid-m1s-with-8gbyte-ram/) - [ODROID-N2](https://www.hardkernel.com/shop/odroid-n2/) (discontinued) - ODROID-N2+ [2 GB](https://www.hardkernel.com/shop/odroid-n2-with-2gbyte-ram-2/) or [4 GB](https://www.hardkernel.com/shop/odroid-n2-with-4gbyte-ram-2/) - [ODROID-XU4](https://www.hardkernel.com/shop/odroid-xu4-special-price/) @@ -47,6 +48,7 @@ Notes: |ODROID-C2 |`make odroid_c2` |[odroid_c2](../../buildroot-external/configs/odroid_c2_defconfig)|[hardkernel](./hardkernel/)| |ODROID-C4 |`make odroid_c4` |[odroid_c4](../../buildroot-external/configs/odroid_c4_defconfig)|[hardkernel](./hardkernel/)| |ODROID-M1 |`make odroid_m1` |[odroid_m1](../../buildroot-external/configs/odroid_m1_defconfig)|[hardkernel](./hardkernel/)| +|ODROID-M1S |`make odroid_m1s` |[odroid_m1s](../../buildroot-external/configs/odroid_m1s_defconfig)|[hardkernel](./hardkernel/)| |ODROID-N2/N2+ |`make odroid_n2` |[odroid_n2](../../buildroot-external/configs/odroid_n2_defconfig)|[hardkernel](./hardkernel/)| |ODROID-XU4 |`make odroid_xu4` |[odroid_xu4](../../buildroot-external/configs/odroid_xu4_defconfig)|[hardkernel](./hardkernel/)| |Tinker Board |`make tinker` |[tinker](../../buildroot-external/configs/tinker_defconfig)|[asus](./asus/)| diff --git a/Documentation/boards/hardkernel/odroid-m1s.md b/Documentation/boards/hardkernel/odroid-m1s.md new file mode 100644 index 000000000..295dbd141 --- /dev/null +++ b/Documentation/boards/hardkernel/odroid-m1s.md @@ -0,0 +1,50 @@ +# ODROID-M1S + +Home Assistant OS 12 and newer support the ODROID-M1S board. + +## SD-card + +SD-card boot is supported only if you have erased Petitboot from eMMC. + +## eMMC + +To install to eMMC via on-board Petitboot bootloader: + +1. Download [`ODROID-M1S_EMMC2UMS.img`][1] +2. Use balenaEtcher or another tool to flash the UMS utility onto an SD card. +3. Plug-in that SD card to your ODROID-M1S and boot it. Connect your PC to the Micro USB OTG port. +4. The eMMC will show as a drive on your PC and you can directly flash the HAOS image with balenaEther. + +Installing HAOS erases Petitboot, if you wish to return to any official Hardkernel images then short the maskRom pads near +the 40pin connector while booting from a [Hardkernel recovery image][2]. + +## NVMe + +Booting directly from NVMe is not supported. The NVMe card can be used as a data disk. + +## Technical notes on boot flow + +The Home Assistant OS image is bootable by the SoC directly. This means that no help from the Hardkernel provided and pre-installed bootloader Petitboot is necessary. Petitboot is stored on the eMMC and will be erased when installing HAOS. + +## Console + +By default, console access is available on the serial header (UART) and on HDMI. +The serial console's baudrate is 1500000 by default. + +The systemd startup messages will only appear on the serial console by default. +To show the messages on the HDMI console instead, add the console manually +to the `cmdline.txt` file on the boot partition (e.g. `console=tty0`). + +## GPIO + +Odroid-M1S introduces a new 14pin expansion header. Refer to [the odroid wiki][3]. +At this point not all functionality is supported by the upstream kernel used by Home Assistant OS. +Supported modules include: +- UPS +- Internal USB +- Mini IO board (partial support) + + +[1]: https://dn.odroid.com/RK3566/ODROID-M1S/Installer/ODROID-M1S_EMMC2UMS.img +[2]: https://wiki.odroid.com/odroid-m1s/getting_started/os_installation_guide +[3]: https://wiki.odroid.com/odroid-m1s/hardware/expansion_connectors \ No newline at end of file diff --git a/Documentation/kernel.md b/Documentation/kernel.md index 98d79ac9b..7c2c6dc3d 100644 --- a/Documentation/kernel.md +++ b/Documentation/kernel.md @@ -18,6 +18,7 @@ Default Kernel tree: 6.1 | ODROID-C2 | 6.6.16 | | ODROID-C4 | 6.6.16 | | ODROID-M1 | 6.6.16 | +| ODROID-M1S | 6.6.16 | | ODROID-N2 | 6.6.16 | | ODROID-XU4 | 6.6.16 | | Generic aarch64 | 6.6.16 |