add generated manpages

pull/476/head
texane 2016-09-18 16:12:10 +02:00
rodzic 6dadc9faa1
commit 043a928d8f
4 zmienionych plików z 204 dodań i 1 usunięć

88
doc/man/st-flash.1 100644
Wyświetl plik

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

76
doc/man/st-info.1 100644
Wyświetl plik

@ -0,0 +1,76 @@
.TH ST-INFO 1 "Sep 2016" "Open Source STMicroelectronics Stlink Tools" "STLINK"
.SH NAME
.PP
st-info - Provides information about connected STLink and STM32 devices
.SH SYNOPSIS
.PP
\f[I]st-info\f[] [\f[I]OPTIONS\f[]]
.SH DESCRIPTION
.PP
Provides information about connected STLink programmers and STM32
devices: Serial code, openocd, flash, sram, page size, chipid,
description.
.SH OPTIONS
.TP
.B --version
Print version information
.RS
.RE
.TP
.B --flash
Display amount of flash memory available in the device
.RS
.RE
.TP
.B --sram
Display amount of sram memory available in device
.RS
.RE
.TP
.B --descr
Display textual description of the device
.RS
.RE
.TP
.B --pagesize
Display the page size of the device
.RS
.RE
.TP
.B --chipid
Display the chip ID of the device
.RS
.RE
.TP
.B --serial
Display the serial code of the device
.RS
.RE
.TP
.B --hla-serial
Display the hex escaped serial code of the device
.RS
.RE
.TP
.B --probe
Display the summarized information of the connected programmers and
devices
.RS
.RE
.SH EXAMPLES
.PP
Display information about connected programmers and devices
.IP
.nf
\f[C]
$\ st-info\ --probe
\f[]
.fi
.SH SEE ALSO
.PP
st-util(1), st-flash(1), st-term(1)
.SH COPYRIGHT
.PP
This work is copyrighted.
Stlink contributors.
See \f[I]LICENSE\f[] file in the stlink source distribution.

32
doc/man/st-term.1 100644
Wyświetl plik

@ -0,0 +1,32 @@
.TH ST-TERM 1 "Sep 2016" "Open Source STMicroelectronics Stlink Tools" "STLINK"
.SH NAME
.PP
st-term - Serial terminal interface for debugging using STLink device
only
.SH SYNOPSIS
.PP
\f[I]st-term\f[]
.SH DESCRIPTION
.PP
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.
.PP
It works by having a magic number in sram of the MCU within a structure
that serves as IO buffer.
.PP
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.
.PP
\f[C]stlinky.h\f[] and \f[C]stlinky.c\f[] are available in the Antares
build system libraries source:
https://github.com/nekromant/antares/tree/master/include/lib
.SH SEE ALSO
.PP
st-util(1), st-info(1), st-term(1)
.SH COPYRIGHT
.PP
This work is copyrighted.
Stlink contributors.
See \f[I]LICENSE\f[] file in the stlink source distribution.

Wyświetl plik

@ -1,3 +1,5 @@
.TH ST-UTIL 1 "Sep 2016" "Open Source STMicroelectronics Stlink Tools" "STLINK"
.SH NAME
.PP
st-util - Run GDB server to interact with STM32 device
.SH SYNOPSIS
@ -14,7 +16,7 @@ option, the default \f[B]4242\f[] port will be used.
Stlink version 2 is used by default unless the option
\f[B]--stlinkv1\f[] is given.
.PP
The STLINKv2 device to use can be specified in the environment variable
The STLinkV2 device to use can be specified in the environment variable
STLINK_DEVICE on the format :.
.SH OPTIONS
.TP
@ -23,6 +25,11 @@ Print this message.
.RS
.RE
.TP
.B --version
Print version information
.RS
.RE
.TP
.B -v \f[I]XX\f[], --verbose=XX
Specify a specific verbosity level (0..99)
.RS