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.

Sign up for GitHub

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

Jump to bottom

New python mpy-psoc6 script and kitprog check install option #106

Merged
merged 9 commits into from
Nov 23, 2023
Merged

New python mpy-psoc6 script and kitprog check install option #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2f28933
tools/psoc6/mpy-psoc6.py: Added python install utility.
jaenrig-ifx Nov 15, 2023
46271b3
tools/psoc6/mpy-psoc6.py: WIP Adding fwloader kitprog3 fw update.
jaenrig-ifx Nov 21, 2023
d93926b
tools/psoc6/mpy-psoc6.py: Added kitprog3 update option in device-setup.
jaenrig-ifx Nov 22, 2023
fa16087
tools/psoc6/mpy-psoc6.py: Added extended help in main parser.
jaenrig-ifx Nov 22, 2023
be877f3
tools/psoc6/mpy-psoc6.py: Added colouring to progress messages.
jaenrig-ifx Nov 22, 2023
84781a4
tools/psoc6/mpy-psoc6.py: Fixed terminal coloring in windows.
jaenrig-ifx Nov 22, 2023
787e583
tools/psoc6/mpy-psoc6.py: Added script version.
jaenrig-ifx Nov 22, 2023
5d4ced8
tools/psoc6/mpy-psoc6.py: Added openocd fw-loader error handling.
jaenrig-ifx Nov 22, 2023
5e69743
docs/psoc6: Added python utility docs to installation.
jaenrig-ifx Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 92 additions & 10 deletions docs/psoc6/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,23 @@ Installing MicroPython
======================

To support the MicroPython PSoC6™ port installation the ``mpy-psoc6`` utility script is provided for Windows and
Linux.
You can easily download from your OS terminal with the following command:
Linux. Additionally, a python script is available also cross-platform for Linux and Windows.


.. warning::

The plan is to replace the native bash and cmd line scripts for Linux and Windows by executable programs generated for each OS (including MacOS) from the python script in future releases.
New features in the installation utility will be only added to the executable and python script versions, as the native OS scripts will be deprecated in the future.


You can easily download them terminal with the following command:

.. tabs::

.. group-tab:: Linux

Download the mpy-psoc6 utility script:

.. code-block:: bash

curl -s -L https://raw.githubusercontent.com/infineon/micropython/ports-psoc6-main/tools/psoc6/mpy-psoc6.sh > mpy-psoc6.sh
Expand All @@ -29,6 +39,21 @@ You can easily download from your OS terminal with the following command:

curl.exe -s -L https://raw.githubusercontent.com/infineon/micropython/ports-psoc6-main/tools/psoc6/mpy-psoc6.cmd > mpy-psoc6.cmd

.. group-tab:: Python

Download the mpy-psoc6 utility script:

.. code-block:: bash

curl.exe -s -L https://raw.githubusercontent.com/infineon/micropython/ports-psoc6-main/tools/psoc6/mpy-psoc6.py > mpy-psoc6.py

Make sure you have a recent version on `Python3.x <https://www.python.org/downloads/>`_ installed and the `pip <https://pip.pypa.io/en/stable/installation/>`_ package installer.
Then install the following packages:

.. code-block:: bash

pip install requests


Find all the available commands and options by running the script with the command help:

Expand All @@ -44,7 +69,13 @@ Find all the available commands and options by running the script with the comma

.. code-block:: bash

mpy-psoc6.cmd help
.\mpy-psoc6.cmd help

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py --help

.. _psoc6_quick_start:

Expand All @@ -66,7 +97,13 @@ micropython is to run the ``quick-start`` command of the script:

.. code-block:: bash

mpy-psoc6.cmd quick-start
.\mpy-psoc6.cmd quick-start

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py quick-start

The command will take care of the following:

Expand Down Expand Up @@ -97,7 +134,13 @@ MicropPython firmware version:

.. code-block:: bash

mpy-psoc6.cmd device-setup
.\mpy-psoc6.cmd device-setup

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py device-setup


You can run any command any time you want to upgrade to the latest MicroPython firmware version.
Expand Down Expand Up @@ -127,16 +170,43 @@ version need to be passed as arguments.

.. code-block:: bash

mpy-psoc6.cmd device-setup CY8CPROTO-062-4343W v0.1.1
.\mpy-psoc6.cmd device-setup CY8CPROTO-062-4343W v0.1.1

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py device-setup -b CY8CPROTO-062-4343W -v v0.1.1

.. warning::

Be sure to provide the board name as shown in the ``device-setup`` command when run in interactive mode.
Equally, provide a valid tag existing in the release section with the format *v.x.y.z*.
No fail safe mechanisms or error verifications are (yet) implemented on the ``mpy-psoc6`` utility, and the script will fail to retrieve the necessary firmware file.

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.

.. tabs::

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py device-setup -u


.. warning::

This option is only available in the python script utility.

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.
Expand All @@ -157,10 +227,16 @@ The board needs to be specified, and the path and name of the ``.hex`` file:

.. code-block:: bash

mpy-psoc6.cmd firmware-deploy CY8CPROTO-062-4343W pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex
.\mpy-psoc6.cmd firmware-deploy CY8CPROTO-062-4343W pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py firmware-deploy -b CY8CPROTO-062-4343W -f pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex

Erasing the device (external) file system
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-----------------------------------------

Some PSoC6™ boards include an external flash memory which is used by the MicroPython file system. This memory will not be erased when
reprogramming or erasing MicroPython firmware via ``device-setup`` or ``firmware-deploy``.
Expand All @@ -178,7 +254,13 @@ Use the ``device-erase`` command to erase of the external memory of your PSoC6

.. code-block:: bash

mpy-psoc6.cmd device-erase
.\mpy-psoc6.cmd device-erase

.. group-tab:: Python

.. code-block:: bash

python mpy-psoc6.py device-erase

.. warning::

Expand Down
2 changes: 0 additions & 2 deletions docs/psoc6/quickref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,6 @@ SCK P9_2 P6_2 P10_2
===== =========== ============ ============

..
TODO: This is only applicable to the CY8CPROTO-062-4343W. This does not belong here.
TODO: Define approach on how the user gets to know the pinout diagram, alternate function of each board
- From board manual?
Expand Down Expand Up @@ -510,7 +509,6 @@ PSoC6 supports only 1 12-bit SAR ADC with the following channel to pin mapping a
+---------+-------+

..
TODO: This is only applicable to the CY8CPROTO-062-4343W. This does not belong here.
TODO: Define approach on how the user gets to know the pinout diagram, alternate function of each board
- From board manual?
Expand Down
Loading
Loading