Machine adc refactor

.gitattributes

@@ -5,6 +5,7 @@
 *.vcxproj text eol=crlf
 *.props text eol=crlf
 *.bat text eol=crlf
+*.cmd text eol=crlf
 
 # These are binary so should never be modified by git.
 *.a binary

.github/workflows/docs.yml

@@ -17,6 +17,8 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
     - name: Install Python packages
-      run: pip install Sphinx
+      run: |
+        pip install Sphinx
+        pip install sphinx-tabs
     - name: Build docs
       run: make -C docs/ html

.github/workflows/ports_psoc6.yml

@@ -0,0 +1,89 @@
+name: psoc6 port
+on:
+  push:
+  pull_request:
+    paths:
+      - '.github/workflows/*.yml'
+      - 'tools/**'
+      - 'py/**'
+      - 'extmod/**'
+      - 'shared/**'
+      - 'lib/**'
+      - 'drivers/**'
+      - 'ports/psoc6/**'
+
+jobs:
+  server-build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        board: [CY8CPROTO-062-4343W]
+    outputs:
+      commit_sha: ${{ steps.commit_sha.outputs.sha_short }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install packages
+        run: source tools/ci.sh && ci_psoc6_setup
+      - name: Build
+        run: source tools/ci.sh && ci_psoc6_build ${{ matrix.board }}
+
+      # Steps only relevant for Infineon fork 
+      # with self-hosted runner available
+      - name: Gets commit SHA
+        if: success() && github.repository_owner == 'infineon'
+        id: commit_sha
+        run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+      - name: Save firmware bin
+        if: success() && github.repository_owner == 'infineon'
+        uses: actions/upload-artifact@v3
+        with: 
+          name: mpy-psoc6_${{ matrix.board }}_${{ steps.commit_sha.outputs.sha_short }}
+          path: ports/psoc6/build/firmware.hex
+
+  # Jobs only relevant for Infineon fork 
+  on-target-test:
+    if: github.repository_owner == 'infineon'
+    runs-on: self-hosted
+    needs: server-build
+    strategy:
+      matrix:
+        board: [CY8CPROTO-062-4343W]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Download binaries
+      uses: actions/download-artifact@v3
+    - name: Setup device
+      run: |
+        cd tools/psoc6
+        cp ../../mpy-psoc6_${{ matrix.board }}_${{ needs.server-build.outputs.commit_sha }}/firmware.hex .
+        source mpy-psoc6.sh && openocd_download_install && openocd_board_conf_download ${{ matrix.board }} && mpy_firmware_deploy ${{ matrix.board }} firmware.hex
+        cd ../..
+    - name: Run tests
+      run: cd tests && ./run-tests.py --target psoc6 --device /dev/ttyACM0 -d psoc6
+
+  release:
+    runs-on: ubuntu-latest
+    needs: [server-build, on-target-test]
+    strategy:
+      matrix:
+        board: [CY8CPROTO-062-4343W]
+    if: startsWith(github.ref, 'refs/tags/v') && github.repository_owner == 'infineon'
+    steps:
+    - name: Download binaries
+      uses: actions/download-artifact@v3
+    - name: Prepare release assets
+      run: | 
+        cd mpy-psoc6_${{ matrix.board }}_${{ needs.server-build.outputs.commit_sha }}
+        mv firmware.hex ../mpy-psoc6_${{ matrix.board }}.hex
+    - name: Build release changelog
+      id: build_changelog
+      uses: mikepenz/release-changelog-builder-action@v3
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      with:
+        name: Micropython PSoC6 ${{  github.ref_name  }}
+        files: mpy-psoc6_${{ matrix.board }}.hex
+        body: ${{steps.build_changelog.outputs.changelog}}

README.md

@@ -114,6 +114,7 @@ In addition, the following ports are provided in this repository:
  - [nrf](ports/nrf) -- Nordic Semiconductor nRF51 and nRF52.
  - [pic16bit](ports/pic16bit) -- Microchip PIC 16-bit.
  - [powerpc](ports/powerpc) -- IBM PowerPC (including Microwatt)
+ - [psoc6](ports/psoc6) -- Infineon PSoC6.
  - [qemu-arm](ports/qemu-arm) -- QEMU-based emulated target, for testing)
  - [renesas-ra](ports/renesas-ra) -- Renesas RA family.
  - [rp2](ports/rp2) -- Raspberry Pi RP2040 (including Pico and Pico W).

docs/README.md

@@ -18,6 +18,7 @@ preferably in a virtualenv:
 
      pip install sphinx
      pip install sphinx_rtd_theme
+     pip install sphinx-tabs
 
 In `micropython/docs`, build the docs:
 

docs/conf.py

@@ -51,6 +51,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
+    'sphinx_tabs.tabs',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/index.rst

@@ -13,6 +13,7 @@ MicroPython documentation and references
     esp32/quickref.rst
     rp2/quickref.rst
     mimxrt/quickref.rst
+    psoc6/quickref.rst
     wipy/quickref.rst
     unix/quickref.rst
     zephyr/quickref.rst

docs/psoc6/feature_list.rst

@@ -0,0 +1,136 @@
+.. _psoc6_feature_list:
+
+Supported features
+==================
+The PSoC6 port is currently configured to configuration level ``MICROPY_CONFIG_ROM_LEVEL_FULL_FEATURES`` with a few additional settings applied, thus enabling most standard modules as listed in the following. 
+
+Enabled modules
+---------------
+* Python standard modules and libraries
+    * cmath
+    * gc
+    * math
+    * uarray
+    * uasyncio
+    * ubinascii
+    * ucollections
+    * uerrno
+    * uhashlib
+    * uheapq
+    * uio
+    * ujson
+    * uos
+    * urandom
+    * ure
+    * uselect
+    * usocket
+    * ussl
+    * ustruct
+    * usys
+    * utime
+    * uzlib
+
+
+* Micropython specific modules and libraries
+    * framebuf
+    * machine
+        * Pin
+        * I2C
+        * RTC
+        * SoftI2C
+    * micropython
+    * ucryptolib
+    * uctypes
+    * network
+
+
+* Port specific modules and micro-libraries
+    * psoc6 (flash support)
+
+
+Not yet enabled
+---------------
+* Python standard modules and libraries
+    * _thread
+
+* Micropython specific modules and libraries
+    * btree
+    * ubluetooth
+
+
+Table :ref:`configuration details <table_mpy_configuration>` below lists specific settings deviating from the configuration as per config level as well as functionality not yet implemented:
+
+.. _table_mpy_configuration:
+
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| Module          | Details                                                                                                              |
++=================+======================================================================================================================+
+| gc              | Option ``MICROPY_ENABLE_GC`` enabled.                                                                                |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| uhashlib        | Options ``MICROPY_PY_UHASHLIB_MD5``, ``MICROPY_PY_UHASHLIB_SHA1``, ``MICROPY_PY_UHASHLIB_SHA256`` enabled.           |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| uos             | Support for LFS2 and FAT, LFS2 enabled by default. FS mounted on external flash at "/flash".                         |
+|                 |                                                                                                                      |
+|                 | Options ``MICROPY_PY_OS_DUPTERM``, ``MICROPY_PY_UOS_GETENV_PUTENV_UNSETENV``, ``MICROPY_PY_UOS_INCLUDEFILE``,        |
+|                 | ``MICROPY_PY_UOS_SYSTEM``, ``MICROPY_PY_UOS_UNAME``, ``MICROPY_VFS_LFS2`` enabled.                                   |
+|                 |                                                                                                                      |
+|                 | Function *urandom()* not yet implemented. Requires implementing *mp_uos_urandom()* and setting option                |
+|                 | ``MICROPY_PY_UOS_URANDOM``.                                                                                          |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| urandom         | Function *seed()* not yet implemented.                                                                               |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| ure             | Options ``MICROPY_PY_URE_DEBUG``, ``MICROPY_PY_URE_MATCH_GROUPS``, ``MICROPY_PY_URE_MATCH_SPAN_START_END`` enabled.  |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| usocket         | Options ``MICROPY_PY_USOCKET`` enabled.                                                                              |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| ussl            | Options ``MICROPY_PY_USSL`` enabled. Has 2 failing tests.                                                            |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| usys            | Options ``MICROPY_PY_SYS_EXC_INFO`` enabled.                                                                         |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| utime           | Enabled through HAL functions based on machine.RTC module. Option ``MICROPY_PY_UTIME_MP_HAL`` enabled.               |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| ucryptolib      | Options ``MICROPY_PY_UCRYPTOLIB``, ``MICROPY_PY_UCRYPTOLIB_CTR``, ``MICROPY_PY_UCRYPTOLIB_CONSTS`` enabled.          |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| machine         | Functions not yet implemented: *lightsleep()*, *deepsleep()*, *wake_reason()*, *time_pulse_us()*, *rng()*.           | 
+|                 |                                                                                                                      |
+|                 | Constants not yet implemented : *WLAN_WAKE*, *PIN_WAKE*, *RTC_WAKE*, *IDLE*, *SLEEP*, *DEEPSLEEP*.                   |
+|                 |                                                                                                                      |
+|                 | Submodules/classes not yet implemented: *ADC*, *bitstream*, *mem*, *Signal*, *SD*, *SDCard*, *SoftSPI*, *SPI*,       |
+|                 | *Timer*, *UART*, *WDT*.                                                                                              |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| machine.Pin     | Functions not yet implemented: *drive()*, *irq()*, *mode()*, *pull()*.                                               |
+|                 |                                                                                                                      |
+|                 | Constants not yet implemented: *ALT*, *ALT_OPEN_DRAIN*, *PULL_UP*, *PULL_DOWN*, *PULL_HOLD*, *LOW_POWER*,            |
+|                 | *MED_POWER*, *HIGH_POWER*, *IRQ_FALLING*, *IRQ_RISING*, *IRQ_LOW_LEVEL*, *IRQ_HIGH_LEVEL*.                           |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| machine.I2C     | Option ``MICROPY_PY_MACHINE_I2C`` enabled.                                                                           |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| machine.RTC     | Functions not yet implemented: *alarm()*, *alarm_left()*, *cancel()*, *irq()*.                                       |
+|                 |                                                                                                                      |
+|                 | Constants not yet implemented: *ALARM0*.                                                                             |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| machine.SoftI2C | Option ``MICROPY_PY_MACHINE_SOFTI2C`` enabled.                                                                       |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| machine.PWM     | option ``MICROPY_PY_MACHINE_PWM`` &  ``MICROPY_PY_MACHINE_PWM_INCLUDEFILE`` enabled                                  |
+|                 |                                                                                                                      |
+|                 | option ``MICROPY_PY_MACHINE_PWM_DUTY`` is not enabled.                                                               |
++-----------------+----------------------------------------------------------------------------------------------------------------------+                                                                                                                                             
+| machine.SoftSPI | Option ``MICROPY_PY_MACHINE_SOFTSPI`` enabled.                                                                       |
++-----------------+----------------------------------------------------------------------------------------------------------------------+                                                                                                                                             
+| machine.SPI     | Option ``MICROPY_PY_MACHINE_SPI``, ``MICROPY_PY_MACHINE_SPI_MSB`` , ``MICROPY_PY_MACHINE_SPI_MSB`` enabled.          |    
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| psoc6           | Option to enable the external instead of the internal flash: ``MICROPY_ENABLE_EXT_QSPI_FLASH``.                      |
+|                 |                                                                                                                      |
+|                 | Option to enable the port specific debug logger: ``MICROPY_LOGGER_DEBUG``.                                           |
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| network         |  Option ``MICROPY_NETWORK`` enabled.                                                                                 |
+|                 |                                                                                                                      |
+|                 |  Functions not yet implemented: *phy_mode()*.                                                                        |
+|                 |                                                                                                                      |                                                                             
+|                 |  Classes not yet implemented: *LAN*.                                                                                 |                                  
++-----------------+----------------------------------------------------------------------------------------------------------------------+
+| network.WLAN    |  Mode not yet implemented: *STA_AP*.                                                                                 |                                
+|                 |                                                                                                                      |                                                                             
+|                 |  Functions not yet implemented: *config*.                                                                            |               
+|                 |                                                                                                                      |
++-----------------+----------------------------------------------------------------------------------------------------------------------+

docs/psoc6/general.rst

@@ -0,0 +1,18 @@
+.. _psoc6_general:
+
+General information about the PSoC6™ port
+=========================================
+
+The PSoC6™ port supports boards powered by the `Infineon PSoC6 family of microcontrollers <https://www.infineon.com/cms/en/product/microcontroller/32-bit-psoc-arm-cortex-microcontroller/psoc-6-32-bit-arm-cortex-m4-mcu/>`_.
+
+.. _Supported boards:
+
+Supported boards
+----------------
+
+The following boards are supported in the port:
+
+ * `CY8CPROTO-062-4343W <https://www.infineon.com/cms/en/product/evaluation-boards/cy8cproto-062-4343w/>`_
+
+Find all the information, board and microcontroller features, and technical documentation in the
+linked board product page.