Merge pull request #467 from alx741/manpages

Man pages

doc/man/CMakeLists.txt

@@ -1,5 +1,8 @@
 set(MANPAGES
 	st-util
+	st-flash
+	st-info
+	st-term
 )
 
 # Only generate manpages with pandoc in Debug builds

doc/man/st-flash.md

@@ -0,0 +1,70 @@
+% ST-FLASH(1) Open Source STMicroelectronics Stlink Tools  | STLINK
+%
+% Sep 2016
+
+
+# NAME
+st-flash - Flash binary files to STM32 device
+
+
+# SYNOPSIS
+*st-flash* \[*OPTIONS*\] \{read|write|erase\} \[*FILE*\] \<ADDR\> \<SIZE\>
+
+
+# DESCRIPTION
+Flash binary files to arbitrary sections of memory, or read arbitrary addresses
+of memory out to a binary file.
+
+You can use this instead of st-util(1) if you prefer, but remember to use the
+**.bin** image, rather than the **.elf** file.
+
+Use hexadecimal format for the *ADDR* and *SIZE*.
+
+
+# COMMANDS
+
+write *FILE* *ADDR*
+:   Write firmware *FILE* to device starting from *ADDR*
+
+read *FILE* *ADDR* *SIZE*
+:   Read firmware from device starting from *ADDR* up to *SIZE* bytes to *FILE*
+
+erase
+:   Perform a mass erasing of the device firmware
+
+
+# OPTIONS
+
+--debug
+:   TODO
+
+--reset
+:   TODO
+
+--serial *iSerial*
+:   TODO
+
+
+# EXAMPLES
+Flash `firmware.bin` to device
+
+    $ st-flash write firmware.bin 0x8000000
+
+
+Read firmware from device (4096 bytes)
+
+    $ st-flash read firmware.bin 0x8000000 4096
+
+
+Erase firmware from device
+
+    $ st-flash erase
+
+
+# SEE ALSO
+st-util(1), st-info(1), st-term(1)
+
+
+# COPYRIGHT
+This work is copyrighted. Stlink contributors.
+See *LICENSE* file in the stlink source distribution.

doc/man/st-info.md

@@ -0,0 +1,58 @@
+% ST-INFO(1) Open Source STMicroelectronics Stlink Tools  | STLINK
+%
+% Sep 2016
+
+
+# NAME
+st-info - Provides information about connected STLink and STM32 devices
+
+
+# SYNOPSIS
+*st-info* \[*OPTIONS*\]
+
+
+# DESCRIPTION
+Provides information about connected STLink programmers and STM32 devices:
+Serial code, openocd, flash, sram, page size, chipid, description.
+
+
+# OPTIONS
+
+--flash
+:   Display amount of flash memory available in the device
+
+--sram
+:   Display amount of sram memory available in device
+
+--descr
+:   Display textual description of the device
+
+--pagesize
+:   Display the page size of the device
+
+--chipid
+:   Display the chip ID of the device
+
+--serial
+:   Display the serial code of the device
+
+--hla-serial
+:   Display the hex escaped serial code of the device
+
+--probe
+:   Display the summarized information of the connected programmers and devices
+
+
+# EXAMPLES
+Display information about connected programmers and devices
+
+    $ st-info --probe
+
+
+# SEE ALSO
+st-util(1), st-flash(1), st-term(1)
+
+
+# COPYRIGHT
+This work is copyrighted. Stlink contributors.
+See *LICENSE* file in the stlink source distribution.

doc/man/st-term.md

@@ -0,0 +1,36 @@
+% ST-TERM(1) Open Source STMicroelectronics Stlink Tools  | STLINK
+%
+% Sep 2016
+
+
+# NAME
+st-term - Serial terminal interface for debugging using STLink device only
+
+
+# SYNOPSIS
+*st-term*
+
+
+# DESCRIPTION
+Provides a serial terminal that works through the STLink device, allowing to do
+the kind of debugging you would do using the UART of the STM32 device without
+having to connect a UART-USB serial adapter dongle.
+
+It works by having a magic number in sram of the MCU within a structure that
+serves as IO buffer.
+
+The required setup consist of some code that establishes the magic number,
+buffer structure and helper functions for actual data transmission between host
+and MCU.
+
+`stlinky.h` and `stlinky.c` are available in the Antares build system libraries
+source: https://github.com/nekromant/antares/tree/master/include/lib
+
+
+# SEE ALSO
+st-util(1), st-info(1), st-term(1)
+
+
+# COPYRIGHT
+This work is copyrighted. Stlink contributors.
+See *LICENSE* file in the stlink source distribution.

doc/man/st-util.md

@@ -20,7 +20,7 @@ default **4242** port will be used.
 
 Stlink version 2 is used by default unless the option **--stlinkv1** is given.
 
-The STLINKv2 device to use can be specified in the environment
+The STLinkV2 device to use can be specified in the environment
 variable STLINK_DEVICE on the format <USB_BUS>:<USB_ADDR>.