[PATCH 1/1] doc: riscv: Update documentation for Sipeed MAIX boards
The MAIXDUINO runs fine with the sipeed_maix_bitm_defconfig but a different board id parameter should be passed to kflash.
Signed-off-by: Heinrich Schuchardt xypron.glpk@gmx.de --- doc/board/sipeed/maix.rst | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-)
diff --git a/doc/board/sipeed/maix.rst b/doc/board/sipeed/maix.rst index 06e0008b9f..120fd8e3ba 100644 --- a/doc/board/sipeed/maix.rst +++ b/doc/board/sipeed/maix.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0+ .. Copyright (C) 2020 Sean Anderson seanga2@gmail.com
-Maix Bit -======== +MAIX +====
Several of the Sipeed Maix series of boards cotain the Kendryte K210 processor, a 64-bit RISC-V CPU. This processor contains several peripherals to accelerate @@ -13,8 +13,10 @@ peripherals include 8M of SRAM (accessible with and without caching); remappable pins, including 40 GPIOs; AES, FFT, and SHA256 accelerators; a DMA controller; and I2C, I2S, and SPI controllers. Maix peripherals vary, but include spi flash; on-board usb-serial bridges; ports for cameras, displays, and sd cards; and -ESP32 chips. Currently, only the Sipeed Maix Bit V2.0 (bitm) is supported, but -the boards are fairly similar. +ESP32 chips. + +Currently, only the Sipeed MAIX BiT V2.0 (bitm) and Sipeed MAIXDUINO are +supported, but the boards are fairly similar.
Documentation for Maix boards is available from `Sipeed's website http://dl.sipeed.com/MAIX/HDK/`_. @@ -26,20 +28,38 @@ details are rather lacking, so most technical reference has been taken from the Build and boot steps --------------------
-To build u-boot, run +To build U-Boot, run
.. code-block:: none
- make sipeed_maix_bitm_defconfig + make <defconfig> make CROSS_COMPILE=<your cross compile prefix>
-To flash u-boot to a maix bit, run +To flash U-Boot, run
.. code-block:: none
- kflash -tp /dev/<your tty here> -B bit_mic u-boot-dtb.bin + kflash -tp /dev/<your tty here> -B <board_id> u-boot-dtb.bin + +The board provides two serial devices. e.g. + +* /dev/serial/by-id/usb-Kongou_Hikari_Sipeed-Debug_12345678AB-if00-port0 +* /dev/serial/by-id/usb-Kongou_Hikari_Sipeed-Debug_12345678AB-if01-port0 + +Which one is used for flashing depends on the board. + +======================== ========================== ========== ========== +Board defconfig board_id TTY device +======================== ========================== ========== ========== +Sipeed MAIX BiT bit first +Sipeed MAIX BiT with Mic sipeed_maix_bitm_defconfig bit_mic first +Sipeed MAIXDUINO sipeed_maix_bitm_defconfig maixduino first +Sipeed MAIX GO goE second +Sipeed MAIX ONE DOCK goD first +======================== ========================== ========== ==========
-Boot output should look like the following: +Flashing causes a reboot of the device. Parameter -t specifies that a console +shall be opened immediately. Boot output should look like the following:
.. code-block:: none
-- 2.27.0
On 7/28/20 11:51 AM, Heinrich Schuchardt wrote:
The MAIXDUINO runs fine with the sipeed_maix_bitm_defconfig but a different board id parameter should be passed to kflash.
Signed-off-by: Heinrich Schuchardt xypron.glpk@gmx.de
doc/board/sipeed/maix.rst | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-)
diff --git a/doc/board/sipeed/maix.rst b/doc/board/sipeed/maix.rst index 06e0008b9f..120fd8e3ba 100644 --- a/doc/board/sipeed/maix.rst +++ b/doc/board/sipeed/maix.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0+ .. Copyright (C) 2020 Sean Anderson seanga2@gmail.com
-Maix Bit
+MAIX +====
Several of the Sipeed Maix series of boards cotain the Kendryte K210 processor, a 64-bit RISC-V CPU. This processor contains several peripherals to accelerate @@ -13,8 +13,10 @@ peripherals include 8M of SRAM (accessible with and without caching); remappable pins, including 40 GPIOs; AES, FFT, and SHA256 accelerators; a DMA controller; and I2C, I2S, and SPI controllers. Maix peripherals vary, but include spi flash; on-board usb-serial bridges; ports for cameras, displays, and sd cards; and -ESP32 chips. Currently, only the Sipeed Maix Bit V2.0 (bitm) is supported, but -the boards are fairly similar. +ESP32 chips.
+Currently, only the Sipeed MAIX BiT V2.0 (bitm) and Sipeed MAIXDUINO are +supported, but the boards are fairly similar.
Documentation for Maix boards is available from `Sipeed's website http://dl.sipeed.com/MAIX/HDK/`_. @@ -26,20 +28,38 @@ details are rather lacking, so most technical reference has been taken from the Build and boot steps
-To build u-boot, run +To build U-Boot, run
.. code-block:: none
- make sipeed_maix_bitm_defconfig
- make <defconfig> make CROSS_COMPILE=<your cross compile prefix>
-To flash u-boot to a maix bit, run +To flash U-Boot, run
.. code-block:: none
- kflash -tp /dev/<your tty here> -B bit_mic u-boot-dtb.bin
- kflash -tp /dev/<your tty here> -B <board_id> u-boot-dtb.bin
+The board provides two serial devices. e.g.
+* /dev/serial/by-id/usb-Kongou_Hikari_Sipeed-Debug_12345678AB-if00-port0 +* /dev/serial/by-id/usb-Kongou_Hikari_Sipeed-Debug_12345678AB-if01-port0
+Which one is used for flashing depends on the board.
+======================== ========================== ========== ========== +Board defconfig board_id TTY device +======================== ========================== ========== ========== +Sipeed MAIX BiT bit first +Sipeed MAIX BiT with Mic sipeed_maix_bitm_defconfig bit_mic first
The bit can also probably be used with the same defconfig as the bitm. The only major difference is the lack of mic, but U-Boot doesn't care about that.
+Sipeed MAIXDUINO sipeed_maix_bitm_defconfig maixduino first
This is currently supported to the same level as the bit (e.g. nothing supported but serial), but in the future there will need to be a separate device tree for this board since the on-board peripherals are different. Until that happens, can you add some kind of note here?
+Sipeed MAIX GO goE second +Sipeed MAIX ONE DOCK goD first +======================== ========================== ========== ==========
-Boot output should look like the following: +Flashing causes a reboot of the device. Parameter -t specifies that a console +shall be opened immediately. Boot output should look like the following:
.. code-block:: none
-- 2.27.0
Other than that, LGTM
--Sean
participants (2)
-
Heinrich Schuchardt -
Sean Anderson