Initial review version

.github/workflows/release.yaml

@@ -28,4 +28,4 @@ jobs:
         run: python -u scripts/keyword_replace.py "code" "_code" "thirdparty/ethernet/cyclonetcp" "cp1252"
 
       - name: Run Package Script
-        run: python -u scripts/package.py ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }}
+        run: python -u scripts/package.py ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${{ github.event.release.tag_name }}

.github/workflows/updateChangelogs.yaml

@@ -0,0 +1,39 @@
+name: Release Asset Upload
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update-changelog-files:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+          pip install chardet
+          pip install py7zr
+
+      - name: Update changelogs
+        run: |
+          python -u scripts/log_changes.py
+
+      - name: Commit and Push Changes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+          git add CHANGELOG.md
+          git commit -m "Updated main CHANGELOG.md file with latest merged release."
+          git push

CMakeLists.txt

@@ -12,9 +12,9 @@ else()
 endif()
 
 if (${TOOLCHAIN_LANGUAGE} MATCHES "MikroC")
-    project(${PROJECT_NAME_CUSTOM} VERSION 2.11.1 LANGUAGES MikroC)
+    project(${PROJECT_NAME_CUSTOM} VERSION ${MIKROSDK_CURRENT_VERSION} LANGUAGES MikroC)
 else()
-    project(${PROJECT_NAME_CUSTOM} VERSION 2.11.1 LANGUAGES C ASM)
+    project(${PROJECT_NAME_CUSTOM} VERSION ${MIKROSDK_CURRENT_VERSION} LANGUAGES C ASM)
     if(NOT ${TOOLCHAIN_ID} STREQUAL "mchp_xc8")
         add_compile_options("-fms-extensions")
     endif()

README.md

@@ -1,6 +1,6 @@
 # mikroSDK 2.0
 
-[![SDK Version](https://img.shields.io/badge/mikroSDK%20version-2.11.1-gold)](https://github.com/MikroElektronika/mikrosdk_v2/tree/mikroSDK-2.11.1)
+[![SDK Version](https://img.shields.io/badge/mikroSDK%20version-${MIKROSDK_CURRENT_VERSION}-gold)](https://github.com/MikroElektronika/mikrosdk_v2/tree/mikroSDK-${MIKROSDK_CURRENT_VERSION})
 
 ---
 ## About

REQUIREMENTS.md

@@ -15,73 +15,9 @@
 
 *Check [Chip List](./SUPPORTED_CHIP_LIST.md) for detailed information.*
 
-**SDK requirements by version:**
+**Specific SDK requirements by version (if any):**
 
-* **v2.11.1**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.11.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.10.2**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.10.1**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.10.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.9.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.8.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.7.2**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.7.1**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.7.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.6.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.5.1**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.5.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.4.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.3.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.2.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.1.1**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.1.0**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.0.3**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.0.2**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.0.1**
-  * [`FLASH1`]
-  * [`RAM1`]
-* **v2.0.0**
-  * [`FLASH1`]
-  * [`RAM1`]
+> None
+>> All specific requirements by versions shall be present here.
 
 ---

changelog/v2.0.0/changelog.md

@@ -0,0 +1,21 @@
+<p align="center">
+  <img src="http://www.mikroe.com/img/designs/beta/logo_small.png?raw=true" alt="MikroElektronika"/>
+</p>
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---
+
+# `v2.0.0`
+
++ released: 2020-10-02
+
+**`INITIAL RELEASE.`**
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---

changelog/v2.0.1/changelog.md

@@ -0,0 +1,51 @@
+<p align="center">
+  <img src="http://www.mikroe.com/img/designs/beta/logo_small.png?raw=true" alt="MikroElektronika"/>
+</p>
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---
+
+# `v2.0.1`
+
++ released: 2020-12-11
+
+## Changes
+
+- [`v2.0.1`](#v201)
+  - [Changes](#changes)
+    - [General](#general)
+    - [Fixes](#fixes)
+
+### General
+
++ Added support for **new hardware**
++ Updated relevant **manifest files**
++ Updated relevant **development kit package**
+
+**MCU CARD 11 FOR PIC** is now supported in **mikroSDK 2.0**.
+
+**Added** following **PIC chips**:
+
++ `PIC18F57K42` - [official page](https://www.mikroe.com/mcu-card-11-for-pic-pic18f57k42)
++ `PIC18F57Q43` - [official page](https://www.mikroe.com/mcu-card-11-for-pic-pic18f57q43)
+
+**Added** adequate board definition files for **MCU CARD 11 FOR PIC**.
+
+Updated **mikroSDK development kit** to follow added hardware.
+
++ `PIC18F57K42` - [official page](https://www.mikroe.com/mcu-card-11-for-pic-pic18f57k42)
++ `PIC18F57Q43` - [official page](https://www.mikroe.com/mcu-card-11-for-pic-pic18f57q43)
+
+### Fixes
+
++ HAL GPIO low level ( PIC chips )
+  + **HAL GPIO low level PIC** implementation now doesn't change previous state of **LATCH** registers.
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---

changelog/v2.0.2/changelog.md

@@ -0,0 +1,65 @@
+<p align="center">
+  <img src="http://www.mikroe.com/img/designs/beta/logo_small.png?raw=true" alt="MikroElektronika"/>
+</p>
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---
+
+# `v2.0.2`
+
++ released: 2020-12-30
+
+## Changes
+
+- [`v2.0.2`](#v202)
+  - [Changes](#changes)
+    - [General](#general)
+    - [Fixes](#fixes)
+
+### General
+
++ Added support for **new hardware**
++ Updated relevant **manifest files**
++ Updated relevant **development kit package**
+
+**Clicker 4 for STM32** is now supported in mikroSDK 2.0.
+
+**Added** adequate board definition files for **Clicker 4 for STM32**.
+
+Updated **mikroSDK development kit** to follow added hardware.
+
++ **Clicker 4 for STM32** - [official page](https://www.mikroe.com/clicker-4-for-stm32)
+
+### Fixes
+
++ `mcu_definitions` ( PIC chips )
+  + **Setting pins as digital/analog**
+  + [Documentation](https://ww1.microchip.com/downloads/en/DeviceDoc/30000575C.pdf) page 431 is at fault
+  + Changed setting ANCONx register bits appropriately
+    + RA4 pin ( ANCON1 bit 4, not ANCON1 bit 6 )
+    + RA5 pin ( ANCON1 bit 5, not ANCON1 bit 4 )
+    + RF2 pin ( ANCON1 bit 6, not ANCON1 bit 7 )
+    + RF5 pin ( ANCON2 bit 1, not ANCON2 bit 2 )
+    + RF6 pin ( ANCON2 bit 2, not ANCON2 bit 3 )
+    + RG4 pin ( ANCON2 bit 7, not ANCON3 bit 0 )
+
+Fix applied to following chips:
+
++ PIC18F97J94
++ PIC18F87J94
++ PIC18F67J94
++ PIC18F96J94
++ PIC18F86J94
++ PIC18F66J94
++ PIC18F95J94
++ PIC18F85J94
++ PIC18F65J94
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---

changelog/v2.0.3/changelog.md

@@ -0,0 +1,76 @@
+<p align="center">
+  <img src="http://www.mikroe.com/img/designs/beta/logo_small.png?raw=true" alt="MikroElektronika"/>
+</p>
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---
+
+# `v2.0.3`
+
++ released: 2021-01-28
+
+## Changes
+
+- [`v2.0.3`](#v203)
+  - [Changes](#changes)
+    - [General](#general)
+    - [Fixes](#fixes)
+    - [Improvements](#improvements)
+
+### General
+
++ Added support for **new hardware**
++ Updated relevant **manifest files**
++ Updated relevant **development kit package**
++ Updated **SPI**, **I2C** and **PPS** libraries
+
+**Curiosity HPC** is now supported in mikroSDK 2.0.
+**Clicker 2 for STM32/PIC18FJ/PIC18FK** is now supported in mikroSDK 2.0.
+
+Added support for **PIC18F47Q10** chip.
+
+**Added** adequate board definition files for **Curiosity HPC board**.
+**Added** adequate board definition files for **Clicker 2 for STM32**.
+**Added** adequate board definition files for **Clicker 2 for PIC18FJ**.
+**Added** adequate board definition files for **Clicker 2 for PIC18FK**.
+
+**Config files added for adequate `NEW` boards.**
+
+Updated **mikroSDK development kit** to follow added hardware.
+
++ **Curiosity HPC** - [official page](https://www.microchip.com/Developmenttools/ProductDetails/DM164136)
++ **Clicker 2 for STM32** - [official page](https://www.mikroe.com/clicker-2-stm32f4)
++ **Clicker 2 for PIC18FJ** - [official page](https://www.mikroe.com/clicker-2-pic18fj)
++ **Clicker 2 for PIC18FK** - [official page](https://www.mikroe.com/clicker-2-pic18fk)
+
+### Fixes
+
++ `UNI Clicker` renamed to follow naming convention
++ `low level PPS implementation` ( PIC chips )
+  + Applies to all PIC chips
+  + Updated map sizes to 2 bytes
+  + Some chips have more than 255 PPS pin functionalities, hence the map needs to be bigger
+
+**NOTE**: PPS wasn't being set correctly for PIC18xxxK40 chips. Applied PPS fix covers this issue.
+
+### Improvements
+
++ `low level SPI implementation` ( PIC chips )
+  + **Setting SCK pin as both digital input/output is required**
+  + [Documentation](https://ww1.microchip.com/downloads/en/DeviceDoc/PIC18F27-47Q10-Data-Sheet-40002043E.pdf) page 444 for more information
+  + In Master mode the clock signal output to the SCK pin is also the clock signal input to the
+  peripheral. The pin selected for output with the RxyPPS register must also be selected as the peripheral input with the SSPxCLKPPS register. The pin that is selected using the SSPxCLKPPS register should also be made a digital I/O. This is done by clearing the corresponding ANSEL bit.
+
++ `low level I2C implementation` ( PIC chips )
+  + **Bidirectional pins**
+  + [Documentation](https://ww1.microchip.com/downloads/en/DeviceDoc/PIC18F27-47Q10-Data-Sheet-40002043E.pdf) page 289 for more information
+    + PPS selections for peripherals with bidirectional signals on a single pin must be made so that the PPS input and PPS output select the same pin
+
+---
+
+**[BACK TO MAIN FILE](../../CHANGELOG.md)**
+
+---