Skip to content

Commit

Permalink
Add st-term man page
Browse files Browse the repository at this point in the history
  • Loading branch information
alx741 committed Sep 15, 2016
1 parent 759f423 commit 3c28cf1
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/man/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ set(MANPAGES
st-util
st-flash
st-info
st-term
)

# Only generate manpages with pandoc in Debug builds
Expand Down
36 changes: 36 additions & 0 deletions doc/man/st-term.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3c28cf1

Please sign in to comment.