Pull request #97: Fix the entry address for CC16BOOT-8527 and CC16BOOT-8526

Merge in MCU16CE/dspic33-dsc-bootloader-code-examples from ~C74569/dspic33-dsc-bootloader-code-examples:bugfix/CC16BOOT-8528-fix-address to develop

* commit '58a46e330241b56c282ecd94d6f05746f3818a9a':
  Fix MISRA violations and add comments
  Fix MISRA violation and add comments for required violations
  Fix MISRA violation and add comments for required violations
  Fix the entry address for CC16BOOT-8527 and CC16BOOT-8526

Author: aiwyatt787

.main-meta/main.json

@@ -4,7 +4,7 @@
    "content": {
       "metaDataVersion": "1.3.0",
       "name": "com.microchip.mplabx.project.dspic33-dsc-bootloader-code-examples",
-      "version": "1.2.3",
+      "version": "1.2.4",
       "displayName": "dsPIC33 DSC Bootloader Code Examples",
       "projectName": "dspic33-dsc-bootloader-code-examples",
       "shortDescription": "dsPIC33 DSC Bootloader Code Examples",

changelog.md

@@ -1,3 +1,10 @@
+# dsPIC33 DSC Bootloader Code Examples v1.2.4
+### Release Highlights
+* Corrected application/executable entry address in dspic33a_bootloader_and_firmware_upgrade_demo and dspic33a_secure_boot.
+
+### Features Added\Updated
+* Corrected application/executable entry address in dspic33a_bootloader_and_firmware_upgrade_demo and dspic33a_secure_boot.
+
 # dsPIC33 DSC Bootloader Code Examples v1.2.3
 ### Release Highlights
 * Updated instances of "dsPIC33a" to "dsPIC33A".

dspic33a_bootloader_and_firmware_upgrade_demo/.main-meta/main.json

@@ -4,7 +4,7 @@
    "content": {
       "metaDataVersion": "1.3.0",
       "name": "com.microchip.mplabx.project.dspic33a-bootloader-and-firmware-upgrade-demo",
-      "version": "1.2.3",
+      "version": "1.2.4",
       "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.",

dspic33a_bootloader_and_firmware_upgrade_demo/boot.X/mdfu/mdfu_firmware_update.c

@@ -93,15 +93,27 @@ bool MDFU_FirmwareUpdateVerifyImage(void)
 }
 
 void MDFU_FirmwareUpdateStartApplication(void)
-{
-    int (*user_application)(void);
+{   
+    /* 
+     * Declare a file-scoped, constant, volatile function pointer named 
+     * 'user_application'. This pointer is set to the program memory (flash) 
+     * address defined by MDFU_CONFIG_APPLICATION_RESET_ADDRESS, which is the 
+     * entry point (reset vector) of the user application.
+     * The 'space(prog)' attribute specifies that the pointer refers to program 
+     * memory (flash), not data memory (RAM).
+     * The 'noload' attribute instructs the linker not to initialize this 
+     * variable at startup.
+     * 
+     * By calling 'user_application()', the bootloader transfers execution to the 
+     * user application.
+     */
+    static void (* volatile const user_application)(void) __attribute__((address(MDFU_CONFIG_APPLICATION_RESET_ADDRESS), space(prog), noload));
 
     /* This is probably being replaced at some point by __builtin__setIVTBASE() but is not currently supported */
     /* This also assumes that the first block of memory in the application is the reset/ivt table which may not always be true if there is an application header */
     PACCON1bits.IVTBASEWR = 1;
     IVTBASE = MDFU_CONFIG_APPLICATION_RESET_ADDRESS;
     PACCON1bits.IVTBASEWR = 0;
 
-    user_application = (int(*)(void))MDFU_CONFIG_APPLICATION_RESET_ADDRESS;
-    user_application();  
+    user_application();
 }

dspic33a_secure_boot/.main-meta/main.json

@@ -4,7 +4,7 @@
    "content": {
       "metaDataVersion": "1.3.0",
       "name": "com.microchip.mplabx.project.dspic33a-secure-boot-and-secure-firmware-upgrade-demo",
-      "version": "1.2.3",
+      "version": "1.2.4",
       "displayName": "dsPIC33A Secure Boot and Secure Firmware Upgrade Demo",
       "projectName": "dspic33a-secure-boot-and-secure-firmware-upgrade-demo",
       "shortDescription": "This MPLAB® X IDE example demonstrates how to perform secure boot authentication and secure firmware upgrade via UART with Microchip Device Firmware Update Protocol (M-DFU) and ECDSA with P-384 verification within MCC Melody.",

dspic33a_secure_boot/boot.X/mdfu/mdfu_partition_executable.c

@@ -210,7 +210,7 @@ static void CacheInvalidate(void)
 */
 static enum MDFU_PARTITION_STATUS Run(void)
 {    
-     /* NOTE: Before starting the executable, all interrupts used
+    /* NOTE: Before starting the executable, all interrupts used
     * by the bootloader must be disabled. Add code here to return
     * the peripherals/interrupts to the reset state before starting
     * the executable code. */
@@ -226,17 +226,20 @@ static enum MDFU_PARTITION_STATUS Run(void)
     IVTBASE = MDFU_CONFIG_EXECUTABLE_DATA_ORIGIN;
     PACCON1bits.IVTBASEWR = 0;
 
-    /* cppcheck-suppress misra-c2012-11.6
+    /* 
+     * Declare a file-scoped, constant, volatile function pointer named 
+     * 'user_executable'. This pointer is set to the program memory (flash) 
+     * address defined by MDFU_CONFIG_EXECUTABLE_DATA_ORIGIN, which is the entry 
+     * point of the executable partition.
+     * The 'space(prog)' attribute specifies that the pointer refers to program 
+     * memory (flash), not data memory (RAM).
+     * The 'noload' attribute instructs the linker not to initialize this 
+     * variable at startup.
      * 
-     *  (Rule 11.6) REQUIRED: Required: A cast shall not be performed between 
-     *  pointer to void and an arithmetic type
-     * 
-     *  Reasoning: This function represents a jump between the boot code and the
-     *  user code. Because the address of the jump lives outside of boot space,
-     *  there is no way to create an object at that address to references so
-     *  an integer address is used for the pre-defined executable entry point.
+     * By calling 'user_executable()', the bootloader transfers execution to the 
+     * user application.
      */
-    void (*user_executable)(void) = (void(*)(void))MDFU_CONFIG_EXECUTABLE_DATA_ORIGIN;
+    static void (* volatile const user_executable)(void) __attribute__((address(MDFU_CONFIG_EXECUTABLE_DATA_ORIGIN), space(prog), noload));
 
      /* Disable IRT access before transferring control to the executable.
       *