Skip to content

Commit

Permalink
Update readme.md and release.md for release 3.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
MarianSavchuk committed Oct 4, 2022
1 parent af29334 commit 8a657f6
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 42 deletions.
18 changes: 11 additions & 7 deletions README.md
Expand Up @@ -4,7 +4,7 @@ Firmware-loader
### Overview

FW-loader is a cross-platform command line tool you can use to upgrade the KitProg3 FW on Cypress kits or MiniProg4.
[Download the latest release](https://github.com/cypresssemiconductorco/Firmware-loader/releases) which includes KitProg3 v2.30.XXXX.
[Download the latest release](https://github.com/Infineon/Firmware-loader/releases) which includes KitProg3 v2.40.1241.

There is a package for each of the following operating systems:

Expand All @@ -27,17 +27,21 @@ On the Catalina version of macOS and later, you may see a dialog what Apple cann
**--help (or no arguments)** - Displays the list of supported commands with
their descriptions.

**--device-list** – Displays the list of connected devices.
**--device-list** – Displays the list of connected supported KitProg3-based devices.

**--update-kp3 [device-name]**Update the firmware of the specified device to KitProg3.
**--update-kp3 [device-name]**Updates the Firmware of the KitProg-based device to KitProg3.

**--update-kp2 [device-name]**Downgrades the firmware of the specified device to KitProg2.
**--update-kp2 [device-name]**Updates the Firmware of the KitProg-based device to KitProg2.

**--mode <mode> [device-name]** – Switches KitProg3 mode of the specific device. Supported modes are: 'kp3-hid', 'kp3-bulk', 'kp3-bootloader', 'kp3-daplink'.
**--mode <mode> [device-name]** – Switches KitProg3 mode of the specific device. Supported modes are: 'kp3-hid', 'kp3-bulk', 'kp3-bootloader', 'kp3-daplink', 'kp3-dualuart'.
On Windows hosts ‘kp3-bulk’ mode cannot support simultaneous I2C/SPI bridging (e.g. for CapSense tuning) - switch to ‘kp3-hid’ instead.

**--info [device-name]** – Displays the device information. Device information is displayed only for KitProg3 devices which support KitProg3 Unique ID Record.

**--set-kp3-gpio-pin <pin_number> <pin_mode> <state>** - Sets desired operational mode and state on GPIO pin of KitProg3-based device

**--read-kp3-gpio-pin <pin_number>** - Displays the current state of GPIO pin of KitProg3-based device

If you have only one device attached, the [device-name] is optional. Where a device name is required, use the device name from the "--device-list" command. To update firmware of all the connected KitProg3 devices use 'all' specifier.

**Mode switching in KitProg3**
Expand Down Expand Up @@ -87,8 +91,8 @@ Perform the "--update-kp3" command as described above.

**FOSS Packages**

FW-Loader uses some Open Source packages. FOSS Packages are located on the https://www.cypress.com/documentation/software-and-drivers/modustoolbox-foss-packages
FW-Loader uses some Open Source packages. FOSS Packages are located on the https://www.infineon.com/cms/en/design-support/software/free-and-open-source-software-foss/modustoolbox-foss-packages/

### More Information

[Fw-loader Release Notes](https://github.com/cypresssemiconductorco/Firmware-loader/blob/master/RELEASE.MD)
[Fw-loader Release Notes](https://github.com/Infineon/Firmware-loader/blob/master/RELEASE.MD)
69 changes: 34 additions & 35 deletions RELEASE.MD
@@ -1,35 +1,34 @@
### fw-loader v3.3.0 Release Notes

The Firmware Loader (fw-loader) is a cross-platform command line tool you can use to upgrade the KitProg3 firmware on our kits or MiniProg4. Please refer to the README file for a complete description of the fw-loader tool.

### New Features

- Delivers KitProg3 v2.30 firmware.
- Improves KitProg3 firmware delivering across several tools in ModusToolbox™. As result, moved KitProg3 instance out of fw-loader/bin folder into kp-firmware.
- Adds "--info" command to display the device information. Note: This works only for KitProg3 devices that support KitProg3 Unique ID Record.
- Extends "--device-list" command to check out-of-date KitProg3 firmware on the connected kit and show the appropriate message.
- Bug fixing.

### Known Issues
None

### More information

- [fw-loader
README.md](https://github.com/cypresssemiconductorco/Firmware-loader/blob/master/README.md)

- [Kitprog3 User
Guide](https://www.cypress.com/documentation/development-kitsboards/kitprog-user-guide)

- [KitProg Host Protocol Interface](https://www.cypress.com/file/520056/download)

- [ModusToolbox™ Software Environment, Quick Start Guide, Documentation, and
Videos](https://www.cypress.com/products/modustoolbox-software-environment)

- [ModusToolbox™ Device Configurator Tool
Guide](https://www.cypress.com/ModusToolboxDeviceConfig)

- [Cypress Semiconductor, an Infineon Technologies Company](http://www.cypress.com)

© Cypress Semiconductor Corporation, 2019-2021. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, and its affiliates ("Cypress").

### fw-loader v3.4.0 Release Notes

The Firmware Loader (fw-loader) is a cross-platform command line tool you can use to upgrade the KitProg3 firmware on our kits or MiniProg4. Please refer to the README file for a complete description of the fw-loader tool.

### New Features

- Delivers KitProg3 v2.40 firmware.
- Adds "--set-kp3-gpio-pin" and "--read-kp3-gpio-pin" commands to work with KitProg3 GPIO pins. Note: This works only for KitProg3 devices that support KitProg3 GPIO Bridging.
- Adds device specification by device's serial number command for all supported commands.
- Bug fixing.

### Known Issues
None

### More information

- [fw-loader
README.md](https://github.com/cypresssemiconductorco/Firmware-loader/blob/master/README.md)

- [Kitprog3 User
Guide](https://www.cypress.com/documentation/development-kitsboards/kitprog-user-guide)

- [KitProg Host Protocol Interface](https://www.cypress.com/file/520056/download)

- [ModusToolbox™ Software Environment, Quick Start Guide, Documentation, and
Videos](https://www.cypress.com/products/modustoolbox-software-environment)

- [ModusToolbox™ Device Configurator Tool
Guide](https://www.cypress.com/ModusToolboxDeviceConfig)

- [Cypress Semiconductor, an Infineon Technologies Company](http://www.cypress.com)

© Cypress Semiconductor Corporation, 2019-2022. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, and its affiliates ("Cypress").

0 comments on commit 8a657f6

Please sign in to comment.