Quellcode durchsuchen

List all host and target microcontrollers

Add accidentally deleted lines
Tomas Borcin vor 3 Jahren
Ursprung
Commit
ca509bb023
1 geänderte Dateien mit 35 neuen und 17 gelöschten Zeilen
  1. 35 17
      README.md

+ 35 - 17
README.md

@@ -2,24 +2,40 @@
 
 ## Overview
 
-Serial flasher component provides portable library for flashing Espressif SoCs (`ESP32`, `ESP32-S2`, `ESP8266`) from other host microcontroller. Espressif SoCs are normally programmed via serial interface (UART). Port layer for given host microcontroller has to be implemented, if not available. Details can be found in section below.
+Serial flasher component provides portable library for flashing Espressif SoCs from other host microcontroller. Espressif SoCs are normally programmed via serial interface (UART). Port layer for given host microcontroller has to be implemented, if not available. Details can be found in section below.
+
+Supported **host** microcontrollers:
+
+- STM32
+- Raspberry Pi
+- ESP32
+
+Supported **target** microcontrollers:
+
+- ESP32
+- ESP8266
+- ESP32-S2
+- ESP32-S3
+- ESP32-C3
+- ESP32-C2
+- ESP32-H2 (Beta1 and Beta2)
 
 ## Supporting new host target
 
 In order to support new target, following function has to be implemented by user:
 
-* loader_port_serial_read()
-* loader_port_serial_write()
-* loader_port_enter_bootloader()
-* loader_port_delay_ms()
-* loader_port_start_timer()
-* loader_port_remaining_time()
+- loader_port_serial_read()
+- loader_port_serial_write()
+- loader_port_enter_bootloader()
+- loader_port_delay_ms()
+- loader_port_start_timer()
+- loader_port_remaining_time()
 
-Following functions are part of serial_io.h header for convenience, however, user does not have to strictly follow function signatures, as there are not called directly from library. 
+Following functions are part of serial_io.h header for convenience, however, user does not have to strictly follow function signatures, as there are not called directly from library.
 
-* loader_port_change_baudrate()
-* loader_port_reset_target()
-* loader_port_debug_print()
+- loader_port_change_baudrate()
+- loader_port_reset_target()
+- loader_port_debug_print()
 
 Prototypes of all function mentioned above can be found in [serial_io.h](include/serial_io.h).
 Please refer to ports in `port` directory. Currently, only ports for [ESP32 port](port/esp32_port.c) and [STM32 port](port/stm32_port.c) are available.
@@ -44,23 +60,25 @@ STM32 port make use of STM32 HAL libraries, that does not come with CMake suppor
 git clone --recursive https://github.com/espressif/esp-serial-flasher.git
 ```
 
-If you have cloned this repository without the `--recursive` flag, you can initialize the  submodule using the following command:
+If you have cloned this repository without the `--recursive` flag, you can initialize the submodule using the following command:
 
 ```
 git submodule update --init
 ```
 
 In addition to configuration parameters mentioned above, following definitions has to be set:
-* TOOLCHAIN_PREFIX: path to arm toolchain (i.e /home/user/gcc-arm-none-eabi-9-2019-q4-major)
-* STM32Cube_DIR:    path to STM32 Cube libraries  (i.e /home/user/STM32Cube/Repository/STM32Cube_FW_F4_V1.25.0)
-* STM32_CHIP:       name of STM32 for which project should be compiled  (i.e STM32F407VG)
-* PORT:             STM32
+
+- TOOLCHAIN_PREFIX: path to arm toolchain (i.e /home/user/gcc-arm-none-eabi-9-2019-q4-major)
+- STM32Cube_DIR: path to STM32 Cube libraries (i.e /home/user/STM32Cube/Repository/STM32Cube_FW_F4_V1.25.0)
+- STM32_CHIP: name of STM32 for which project should be compiled (i.e STM32F407VG)
+- PORT: STM32
 
 This can be achieved by passing definition to command line, such as:
 
 ```
 cmake -DTOOLCHAIN_PREFIX="/path_to_toolchain" -DSTM32Cube_DIR="path_to_stm32Cube" -DSTM32_CHIP="STM32F407VG" -DPORT="STM32" .. && cmake --build .
 ```
+
 Alternatively, set those variables in top level `cmake` directory:
 
 ```
@@ -76,4 +94,4 @@ Code is distributed under Apache 2.0 license.
 
 ## Known limitations
 
-Size of new binary image has to be known before flashing.
+Size of new binary image has to be known before flashing.