Skip to content

Commit d1911cc

Browse files
fpistmkbumsik
andcommitted
[STM32MP157_DK] Update README.md
Co-Authored-By: Bumsik Kim <[email protected]> Signed-off-by: Frederic Pillon <[email protected]>
1 parent 76383da commit d1911cc

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

variants/STM32MP157_DK/README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ Because every OS may have different software configurations (especially Device T
1313
* [STM32 MPU OpenSTLinux Distribution]
1414
* [Balena OS]
1515

16-
Note that the first two OSes should select `stm32mp157c-dk2-m4-examples-sdcard` boot mode (or device tree configuration) on boot time. `stm32mp157c-dk2-sdcard` boot mode is also known to work but it is not guaranteed. See [ST Wiki page on boot mode] for more detail. If you are using it for your own OS, see the [Linux Device Tree considerations](#Linux-Device-Tree-considerations) section.
16+
#### Note
17+
* Other distributions not listed here may run Arduino firmware but they are not tested.
18+
* __The first two OSes should select `stm32mp157c-dk2-m4-examples-sdcard` boot mode (or device tree configuration) on boot time.__
19+
* `stm32mp157c-dk2-sdcard` boot mode is also known to work but it is not guaranteed. See [ST Wiki page on boot mode] for more detail. If you are using it for your own OS, see the [Linux Device Tree considerations](#Linux-Device-Tree-considerations) section.
1720

1821
## How to use
1922

@@ -29,7 +32,8 @@ In this example, the user **must** upload `<Arduino build output path>/run_ardui
2932

3033
After uploading the user can use `sh run_arduino.sh start` in the console of host Linux via either SSH or Serial Console, to run the Arduino firmware.
3134

32-
Note: `sh run_arduino.sh start` is a one-shot command: the Arduino firmware only runs for the current boot. If you want to make it run after reboot, you need to use `sh run_arduino.sh install` command.
35+
#### Note
36+
* `sh run_arduino.sh start` is a one-shot command, the Arduino firmware only runs for the current boot. If you want to make it run after reboot, you need to use `sh run_arduino.sh install` command.
3337

3438
`run_arduino.sh` help page summary:
3539

@@ -55,7 +59,9 @@ Note: `sh run_arduino.sh start` is a one-shot command: the Arduino firmware only
5559
sh run_arduino.sh restart
5660
Restart the coprocessor.
5761

58-
See the source code for the full help page and the more details about [run_arduino.sh].
62+
See the source code [run_arduino_gen.sh] for the full help page and the more details about the `run_arduino.sh` generated.
63+
64+
[run_arduino_gen.sh] is the shell script that produces a copy of the script called `run_arduino.sh` but with the sketch binary self-contained.
5965

6066
## Pin mapping
6167

@@ -96,7 +102,7 @@ There are additional pins for LEDs and buttons.
96102

97103
## Uploading
98104

99-
As mentioned above `run_arduino.sh` file should be uploaded manually in order to work. There are many ways to upload the file.
105+
As mentioned above `run_arduino.sh` file have to be uploaded manually from the PC to the board's Linux file system in order to be executed on the board directly through the board's Linux console. There are many ways to upload the file.
100106

101107
### Over Network
102108

@@ -152,7 +158,7 @@ And then the Device Tree should enable TIM1 for the coprocessor, although this d
152158
[Balena OS]: https://github.com/kbumsik/balena-st-stm32mp
153159
[ST Wiki page on boot mode]: https://wiki.st.com/stm32mpu/wiki/STM32CubeMP1_Package#Getting_started_with_STM32CubeMP1_Package
154160

155-
[run_arduino.sh]: https://github.com/stm32duino/Arduino_Tools/blob/master/linux/run_arduino_gen.sh
161+
[run_arduino_gen.sh]: https://github.com/stm32duino/Arduino_Tools/blob/master/run_arduino_gen.sh
156162

157163
[The ST Wiki page on C-Kermit]: https://wiki.st.com/stm32mpu/wiki/How_to_transfer_a_file_over_serial_console
158164
[a bug in OpenSTLinux]: https://community.st.com/s/question/0D50X0000B9vHa4/cannot-get-download-a-file-using-kermit

0 commit comments

Comments
 (0)