Pull request #64: Release dsPIC33A CRC bootloader example

Merge in MCU16CE/dspic33-dsc-bootloader-code-examples from develop to master

* commit 'fea4f79acd59e0bcd31264370a8f0bada4c7f181':
  change per input from build team.
  Remove reference to 16 bit bootloader and fix mdfu spelling
  Pull request #59: Feature/CC16BOOT-8082 create an engineering release of dspic33a m dfu bootloader with basic uart

Author: davidflowers

.citd/Jenkinsfilek8s

@@ -75,7 +75,7 @@ pipeline {
                 script {                    
                     mplabxProjectConfigUpdate(
                         sourceFilePath: "${env.MPLABX_PROJECT_SOURCE}",
-						dfpUpdate: false,
+						dfpUpdate: true,
 						dfpInternal: false
                     )
                 }
@@ -85,6 +85,7 @@ pipeline {
         stage('Build') {
             steps {
                 script {  
+                    sh("find . -type f -name postBuild.sh -exec chmod +x {} \\;")
                     mplabxProjectBuild(
                         sourceFilePath: "${env.MPLABX_PROJECT_SOURCE}"
                     )

.gitattributes

@@ -0,0 +1,7 @@
+src/test/firmware/*.jar filter=lfs diff=lfs merge=lfs -text
+
+ # Ensure .sh files use LF (Unix-style) line endings
+ *.sh text eol=lf
+
+ # Ensure .bat files use CRLF (Windows-style) line endings
+ *.bat text eol=crlf

README.md

@@ -4,17 +4,36 @@
     <img alt="Microchip Logo." src="images/microchip_logo_black_red.png">
 </picture>
 
-## dsPIC33 CAN/CAN-FD Bootloader Demo
-
-## Summary
-An example bootloader using the 16-bit MCC bootloader and the CAN or CAN-FD peripheral. 
-
-## Related Documentation
-https://www.microchip.com/16-bit-bootloader
-
-## Setup And Operation
-
-See the README files associated with each folder that describe the required hardware, software, and setup instructions. 
-
-
+## <u>dsPIC33 CAN/CAN-FD Bootloader Demo</u>
+
+### Summary
+An example bootloader using the 16-bit MCC bootloader and the CAN or CAN-FD peripheral on the dsPIC33 Touch CAN LIN Curiosity Development board demonstrating the following: 
+* Immutable secure boot via CodeGuard
+* A/B type bootloading with Flash partitioning to support two firmware images and anti-roll back
+* Secure boot authentication via ECDSA signature verification
+* Secure firmware update via CAN-FD
+* Crypto acceleration via TA100
+* (Optional) Permanent flash memory locking via ICSP inhibit 
+
+### Related Documentation
+* [16bit MCC Bootloader](https://www.microchip.com/16-bit-bootloader)
+* [dsPIC33C Touch-CAN-LIN Curiosity Development Board (EV97U97A)](https://www.microchip.com/en-us/development-tool/EV97U97A)
+
+### Setup And Operation
+See [secure_boot_and_secure_firmware_upgrade_over_canfd](secure_boot_and_secure_firmware_upgrade_over_canfd/) and the associated [README.md](secure_boot_and_secure_firmware_upgrade_over_canfd/README.md) files for details on the required hardware, software, setup, and how to run the demo. 
+
+## <u>dsPIC33a Bootloader and Firmware Upgrade Demo</u>
+
+### Summary
+An example bootloader using the Microchip Device Firmware Update (MDFU) protocol and UART peripheral on the dsPIC33A Curiosity Platform Development Board with a dsPIC33AK128MC106 DIM demonstrating the following: 
+* Secure firmware update via UART using Microchip Device Firmware Update (MDFU) protocol 
+* Application verification checking using a 32-bit CRC-32Q signature  
+
+### Related Documentation
+* [dsPIC33AK128MC106 DIM (EV02G02A)](https://www.microchip.com/en-us/development-tool/ev02g02a)
+* [dsPIC33A Curiosity Platform Development Board (EV74H48A)](https://www.microchip.com/en-us/development-tool/ev74h48a)
+* [MDFU Protocol](https://ww1.microchip.com/downloads/aemDocuments/documents/DEV/ProductDocuments/SupportingCollateral/Microchip-Device-Firmware-Update-MDFU-Protocol-DS50003743.pdf)
+
+### Setup And Operation
+See [dspic33a_bootloader_and_firmware_upgrade_demo](dspic33a_bootloader_and_firmware_upgrade_demo/) and the associated [README.md](dspic33a_bootloader_and_firmware_upgrade_demo/README.md) files for details on the required hardware, software, setup, and how to run the demo.
 

changelog.md

@@ -5,5 +5,14 @@
 ### Features Added\Updated
 * Initial Release  
 
+# dsPIC33a Bootloader and Firmware Upgrade Demo v1.0.0*
+### Release Highlights
+* Initial Release - Refer to the README.md for a summary and execution procedure
+
+### Features Added\Updated
+* Initial Release  
+
+\* **NOTE**: THIS DEMO IS AN ENGINEERING RELEASE TO DEMONSTRATE DSPIC33A BOOTLOADER FUNCTIONALITY AND SHOULD BE USED FOR REFERENCE ONLY. THIS CODE IS NOT INTENDED FOR USE IN PRODUCTION.
+
 
 

dspic33a_bootloader_and_firmware_upgrade_demo/.main-meta/main.json

@@ -0,0 +1,61 @@
+{
+   "metaDataVersion": "1.0.0",
+   "category": "com.microchip.ide.project",
+   "content": {
+      "metaDataVersion": "1.3.0",
+      "name": "com.microchip.mplabx.project.dspic33a-bootloader-and-firmware-upgrade-demo",
+      "version": "1.0.0",
+      "displayName": "dsPIC33a Bootloader and Firmware Upgrade Demo",
+      "projectName": "dspic33a-bootloader-and-firmware-upgrade-demo",
+      "shortDescription": "This MPLAB® X IDE example demonstrates how to perform secure boot authentication and firmware upgrade via UART with Microchip Device Firmware Update Protocol (M-DFU) and CRC32 verification within MCC Melody.",
+      "ide": {
+         "name": "MPLABX",
+         "semverRange": ">=6.20.0"
+      },
+      "compiler": {
+         "name": "XCDSC",
+         "semverRange": "^3.10"
+      },
+      "dfp": {
+         "name": "dsPIC33AK-MC_DFP",
+         "semverRange": ">=1.0.33"
+      },
+      "configurator": {
+         "name": "MCC",
+         "semverRange": ">=5.6.1"
+      },
+      "device": {
+         "metaDataVersion": "1.0.0",
+         "category": "com.microchip.portal.contentRef",
+         "content": {
+            "metaDataVersion": "1.0.0",
+            "category": "com.microchip.device",
+            "name": " dsPIC33AK128MC106",
+            "versionRange": "*"
+         }
+      },
+      "keywords": [
+         "Board",
+         "Bootloader",
+         "Bootloader Client",
+         "Communication",
+         "Communication Module",
+         "Configurator",
+         "Curiosity",
+         "Development Tool",
+         "Firmware",
+         "Firmware Upgrade",
+         "FTP",
+         "Harmony",
+         "MDFU",
+         "Memory",
+         "Memory Module",
+         "Serial Communication",
+         "Software",
+         "UART",
+         "UART Protocol",
+         "Virtual COM Port",
+         "Wired"
+      ]
+   }
+}