General Project Update

- Updated CHANGELOG.md - Updated README.md - Formatting fixes -[doc] Updated tested devices & boards
stlink-org · Mar 17, 2021 · 125cb2d · 125cb2d
1 parent 9956bde
commit 125cb2d
Show file tree

Hide file tree

Showing 4 changed files with 217 additions and 219 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,7 +20,7 @@ Features:
 
 Updates & changes:
 
-- [doc] Added note on `(gdb) run` command (commit [#03793d4](https://github.com/stlink-org/stlink/commit/03793d42b6078344a9ef8ad55f1d5d0fc19e486e), [#276](https://github.com/stlink-org/stlink/pull/276))
+- [doc] Added note on `(gdb) run` command (commit [#03793d4](https://github.com/stlink-org/stlink/commit/03793d42b6078344a9ef8ad55f1d5d0fc19e486e), [#267](https://github.com/stlink-org/stlink/pull/267))
 - [doc] `st-flash --reset` parameter (one solution for #356) ([#642](https://github.com/stlink-org/stlink/pull/642))
 - [refactoring] General maintenance ([#864](https://github.com/stlink-org/stlink/pull/864), [#976](https://github.com/stlink-org/stlink/pull/976), [#978](https://github.com/stlink-org/stlink/pull/978))
 - Imported debian pkg-settings ([#986](https://github.com/stlink-org/stlink/pull/986))
@@ -42,13 +42,17 @@ Fixes:
 - Fixed `connect under reset` for `st-flash` and `st-util` ([#983](https://github.com/stlink-org/stlink/pull/983))
 - Fix for `mmap() size_t overflow` in `st-flash` ([#988](https://github.com/stlink-org/stlink/pull/988), [#989](https://github.com/stlink-org/stlink/pull/989))
 - [regression] `stlink-gui` installation issue on Ubuntu-18.04 ([#1001](https://github.com/stlink-org/stlink/pull/1001), [#1004](https://github.com/stlink-org/stlink/pull/1004), [#1006](https://github.com/stlink-org/stlink/pull/1006))
-- `st-util`: wrong register values passed to `gdb` (STLink/V2) ([#1002](https://github.com/stlink-org/stlink/pull/1002), [#1011](https://github.com/stlink-org/stlink/pull/1011), [#1026](https://github.com/stlink-org/stlink/pull/1026), [#1027](https://github.com/stlink-org/stlink/pull/1027))
+- `st-util`: wrong register values passed to `gdb` (STLink/V2) ([#1002](https://github.com/stlink-org/stlink/pull/1002), [#1011](https://github.com/stlink-org/stlink/pull/1011), [#1026](https://github.com/stlink-org/stlink/pull/1026), [#1027](https://github.com/stlink-org/stlink/pull/1027), [#1064](https://github.com/stlink-org/stlink/pull/1064), [#1065](https://github.com/stlink-org/stlink/pull/1065))
 - [doc] Fixed wrong path for `rules.d` folder ([#1020](https://github.com/stlink-org/stlink/pull/1020))
 - Use vl flashloader for all STM32F1 series ([#1041](https://github.com/stlink-org/stlink/pull/1041), [#1044](https://github.com/stlink-org/stlink/pull/1044))
+- st-util v1.6.1 does not recognize option --freq (commit [#e576768](https://github.com/stlink-org/stlink/commit/e5767681f14de9851aa970a9299930ca68b2ed92), [#1055](https://github.com/stlink-org/stlink/pull/1055))
 - Fixed `gettimeofday` for MSVC ([#1074](https://github.com/stlink-org/stlink/pull/1074))
 - Bugfixes for compilation with clang ([#1076](https://github.com/stlink-org/stlink/pull/1076), [#1078](https://github.com/stlink-org/stlink/pull/1078))
 - Fixed compilation with GCC 11 ([#1077](https://github.com/stlink-org/stlink/pull/1077))
 - [regression] Flash_loader: increased wait rounds for slow boards ([#1085](https://github.com/stlink-org/stlink/pull/1085))
+- Fixed support for writing option bytes ([#1102](https://github.com/stlink-org/stlink/pull/1102))
+- [doc] Corrected spelling mistake in bug report template ([#1103](https://github.com/stlink-org/stlink/pull/1103))
+- Fixed support for STLINK/V1 programmer ([#1045](https://github.com/stlink-org/stlink/pull/1045), [#1105](https://github.com/stlink-org/stlink/pull/1105))
 
 # v1.6.1
 
@@ -380,8 +384,10 @@ Updates and fixes:
 - Stm32l0x flash loader (Robin Kreis)
 - Use libusb synchronous api ([#194](https://github.com/stlink-org/stlink/pull/194), [#374](https://github.com/stlink-org/stlink/pull/374))
 - Fixed segfault when programmer is already busy and `NULL` pointers are in the list ([#256](https://github.com/stlink-org/stlink/pull/256), [#394](https://github.com/stlink-org/stlink/pull/394))
+- Fixed issue where "unknown chip id!" was seen every other time ([#352](https://github.com/stlink-org/stlink/pull/352), [#367](https://github.com/stlink-org/stlink/pull/367), [#381](https://github.com/stlink-org/stlink/pull/381))
 - Send F4 memory-map and features for STM32F429 ([#188](https://github.com/stlink-org/stlink/pull/188), [#196](https://github.com/stlink-org/stlink/pull/196), [#250](https://github.com/stlink-org/stlink/pull/250), [#251](https://github.com/stlink-org/stlink/pull/251)) (Release v1.1.0)
 - Added AHB3 Peripherals definition for STM32F4 ([#218](https://github.com/stlink-org/stlink/pull/218), [#288](https://github.com/stlink-org/stlink/pull/288)) (Release v1.1.0)
+- Reset: st-flash does not work when CPU is in sleep mode ([#62](https://github.com/stlink-org/stlink/pull/62)) (Release v1.0.0)
 - Corrected flash size register address for STM32F2 devices ([#278](https://github.com/stlink-org/stlink/pull/278)) (Release v1.0.0)
 
 Chip support added for:

diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Open source version of the STMicroelectronics STlink Tools
-==========================================================
+# Open source version of the STMicroelectronics STlink Tools
 
 [![BSD licensed](https://img.shields.io/badge/license-BSD-blue.svg)](https://raw.githubusercontent.com/hyperium/hyper/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/stlink-org/stlink.svg)](https://github.com/stlink-org/stlink/releases/latest)
@@ -12,42 +11,40 @@ Open source version of the STMicroelectronics STlink Tools
 
 Recent new features and bugfixes can be found in the [Changelog](CHANGELOG.md) of this software project.
 
-
 #### License
 
 The stlink library and tools are licensed under the **[BSD-3 License](LICENSE.md)**.
 
-
 ## Introduction
 
 STLink is an open source toolset to program and debug STM32 devices and boards manufactured by STMicroelectronics.
 It supports several so called STLINK programmer boards (and clones thereof) which use a microcontroller chip to translate commands from USB to JTAG/SWD. There are four generations available on the market which are _all_ supported by this toolset:
 
-* **STLINK/v1** _[obsolete as of 21-11-2019, continued support by this toolset] *)_
+- **STLINK/V1** _[obsolete as of 21-11-2019, continued support by this toolset] \*)_
   - transport layer: SCSI passthru commands over USB
   - stand-alone programmer and present on STM32VL Discovery boards
-* **STLINK/v2**
+- **STLINK/V2**
   - transport layer: raw USB commands
   - stand-alone programmer and present on STM32L Discovery and Nucleo boards
-* **STLINK/v2-1**
+- **STLINK/V2-1**
   - transport layer: raw USB commands
   - present on some STM32 Nucleo boards
-* **STLINK/v3**
+- **STLINK/V3**
   - transport layer: raw USB commands
   - stand-alone programmer
 
-_*)_ **Note: Support on macOS is limited to 10.14 - 10.15. Any later versions are no longer compatible with the STLINK/v1 due to technical reasons.**
+_\*)_ **Note: Support for the STLINK/V1 on macOS is limited to 10.14 - 10.15. Due to the deprecation and removal of macOS Kernel Extensions (KEXT) there will be no support for this programmer on macOS 11 or any later version.**
 
 On the user level there is no difference in handling or operation between these different revisions.
 
 The STlink toolset includes:
 
-* `st-info` - a programmer and chip information tool
-* `st-flash` - a flash manipulation tool
-* `st-util` - a GDB server (supported in Visual Studio Code / VSCodium via the [Cortex-Debug](https://github.com/Marus/cortex-debug) plugin)
-* `stlink-lib` - a communication library
-* `stlink-gui` - a GUI-Interface _[optional]_
-
+- `st-info` - a programmer and chip information tool
+- `st-flash` - a flash manipulation tool
+- `st-trace` - a logging tool to record information on execution
+- `st-util` - a GDB server (supported in Visual Studio Code / VSCodium via the [Cortex-Debug](https://github.com/Marus/cortex-debug) plugin)
+- `stlink-lib` - a communication library
+- `stlink-gui` - a GUI-Interface _[optional]_
 
 ## Supported operating systems and hardware combinations
 
@@ -58,12 +55,10 @@ Supported operating systems are listed in [version_support.md](doc/version_suppo
 The `stlink` toolset continues to maintain backwards compatibility with the **STLINK/v1** programmer.<br />
 Please note that on macOS this support is limited to versions 10.13 - 10.15.
 
-
 ## Tutorial & HOWTO
 
 Our [tutorial](doc/tutorial.md) may help you along with some advanced tasks and additional info.
 
-
 ## Installation
 
 **Windows**:
@@ -77,8 +72,8 @@ Alternatively one may compile and install from source as described in our [compi
 
 We recommend to install from:
 
-* [homebrew](https://formulae.brew.sh/formula/stlink) or
-* [MacPorts](https://ports.macports.org/port/stlink)
+- [homebrew](https://formulae.brew.sh/formula/stlink) or
+- [MacPorts](https://ports.macports.org/port/stlink)
 
 Alternatively one can compile and install from source as described in our [compiling manual](doc/compiling.md#macOS).
 
@@ -88,30 +83,28 @@ We recommend to install `stlink-tools` from the package repository of the used d
 
 **Note:** As packages distributed via the [Debian](https://packages.debian.org/buster/stlink-tools) and [Ubuntu](https://packages.ubuntu.com/stlink-tools) repositories differ from our self-maintained deb-package, we recommend to use the latter instead (see link below). It provides the opportunity to handle and fix user-reported package issues directly within the project and is not redundant to any limitations deriving from external maintenance guidelines.
 
-* Debian Linux: [(Link)](https://github.com/stlink-org/stlink/releases)
-* Ubuntu Linux: [(Link)](https://github.com/stlink-org/stlink/releases)
-* Arch Linux:   [(Link)](https://www.archlinux.org/packages/community/x86_64/stlink)
-* Alpine Linux: [(Link)](https://pkgs.alpinelinux.org/packages?name=stlink)
-* Fedora:       [(Link)](https://src.fedoraproject.org/rpms/stlink)
-* Gentoo Linux: [(Link)](https://packages.gentoo.org/packages/dev-embedded/stlink)
+- Debian Linux: [(Link)](https://github.com/stlink-org/stlink/releases)
+- Ubuntu Linux: [(Link)](https://github.com/stlink-org/stlink/releases)
+- Arch Linux: [(Link)](https://www.archlinux.org/packages/community/x86_64/stlink)
+- Alpine Linux: [(Link)](https://pkgs.alpinelinux.org/packages?name=stlink)
+- Fedora: [(Link)](https://src.fedoraproject.org/rpms/stlink)
+- Gentoo Linux: [(Link)](https://packages.gentoo.org/packages/dev-embedded/stlink)
 
 **Other Operating Systems**:
 
-* RedHat/CentOS 8: Users can install from [EPEL repository](https://src.fedoraproject.org/rpms/stlink/branch/epel8)
-* FreeBSD: Users can install from [freshports](https://www.freshports.org/devel/stlink)
-
+- RedHat/CentOS 8: Users can install from [EPEL repository](https://src.fedoraproject.org/rpms/stlink/branch/epel8)
+- FreeBSD: Users can install from [freshports](https://www.freshports.org/devel/stlink)
 
 ## Installation from source (advanced users)
 
 When there is no executable available for your platform or you need the latest (possible unstable) version you need to compile the toolset yourself. This procedure is explained in the [compiling manual](doc/compiling.md).
 
-
 ## Contributing and versioning
 
-* The semantic versioning scheme is used. Read more at [semver.org](http://semver.org)
-* Before creating a pull request, please _ALWAYS_ open a new issue for the discussion of the intended new features. Bugfixes don't require a discussion via a ticket-issue. However they should always be described in a few words as soon as they appear to help others as well.
-* Contributors and/or maintainers may submit comments or request changes to patch-proposals and/or pull-requests.
-* **ATTENTION: _NEVER EVER_ use the '#' character to count-up single points within a listing as '#' is _exclusively_ reserved for referencing GitHub issues and pull-requests. Otherwise you accidentally introduce false cross references within the project.**
-* Please start new forks from the develop branch, as pull requests will go into this branch as well.
+- The semantic versioning scheme is used. Read more at [semver.org](http://semver.org)
+- Before creating a pull request, please _ALWAYS_ open a new issue for the discussion of the intended new features. Bugfixes don't require a discussion via a ticket-issue. However they should always be described in a few words as soon as they appear to help others as well.
+- Contributors and/or maintainers may submit comments or request changes to patch-proposals and/or pull-requests.
+- **ATTENTION: _NEVER EVER_ use the '#' character to count-up single points within a listing as '#' is _exclusively_ reserved for referencing GitHub issues and pull-requests. Otherwise you accidentally introduce false cross references within the project.**
+- Please start new forks from the develop branch, as pull requests will go into this branch as well.
 
 Please also refer to our [Contribution Guidelines](CONTRIBUTING.md).