Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mpy install script bugs improvements #108

Merged
merged 9 commits into from
Jan 17, 2024
15 changes: 5 additions & 10 deletions docs/psoc6/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ MicropPython firmware version:
You can run any command any time you want to upgrade to the latest MicroPython firmware version.
This command will take care of the following steps:

* Download and install fw-loader, which will be used to update the board flasher firmware.
* Download and install openocd, which is the software required to deploy a firmware file on PSoC6™ controllers
* Download the latest ``.hex`` file for your select board
* Deploy the latest version of MicroPython firmware on your board
Expand Down Expand Up @@ -190,15 +191,16 @@ Updating the flasher firmware
The evaluation PSoC6™ boards include an integrated hardware programmer tool using `KitProg <https://www.infineon.com/cms/en/design-support/tools/programming-testing/psoc-programming-solutions/#collapse-703c72c0-50f2-11ec-9758-005056945905-3>`_ firmware.
Some older boards will come preflashed with KitProg version 2. In MicroPython PSoC6™ port it is required to use KitProg version 3, and the setup process will fail for version 2.

If you need to update the KitProg firmware, you can use the flag ``-u`` for updating the firmware version in the MicropPython device setup process.
By default, the device setup automatically updates the flasher firmware, ensuring compatibility with the rest of the flashing tools.
If you want to skip the KitProg firmware update step, you can use the flag ``-s`` or ``--skip-fw-update`` during the ``device-setup`` process.

.. tabs::

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py device-setup -u
python mpy-psoc6.py device-setup -s


.. warning::
Expand All @@ -208,11 +210,7 @@ If you need to update the KitProg firmware, you can use the flag ``-u`` for upda
Direct binary flashing
----------------------

Another alternative to program the board is to directly provide the binary file. The ``firmware-deploy`` command is providing this option.
This commands is skipping all the tools download and installation, neither download the MicoPython firmware.
Therefore, it requires that `openocd <https://www.infineon.com/cms/en/design-support/software/free-and-open-source-software-foss/modustoolbox-foss-packages/?searchTerm=~%27openocd#!designsupport>`_ is already installed and available in the system path.
In exchange, it will be faster for batch flashing, or any situation where subsequent binary flashing needs to be performed.

Another alternative to program the board is to directly provide the binary file. The ``firmware-deploy`` command is enabling this option.
The board needs to be specified, and the path and name of the ``.hex`` file:

.. tabs::
Expand Down Expand Up @@ -304,6 +302,3 @@ Programmer User Guide
<https://www.infineon.com/dgdl/Infineon-Infineon_Programmer_4.0_GUI_User_Guide-Software-v01_00-EN.pdf?fileId=8ac78c8c7e7124d1017ed9abca6e365c>`_.





Loading
Loading