refactor and enable bootloader detection

Author: davidflowers

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/icsp_inhibit.c

@@ -0,0 +1,35 @@
+/*
+© [2024] Microchip Technology Inc. and its subsidiaries.
+
+    Subject to your compliance with these terms, you may use Microchip 
+    software and any derivatives exclusively with Microchip products. 
+    You are responsible for complying with 3rd party license terms  
+    applicable to your use of 3rd party software (including open source  
+    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
+    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
+    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
+    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
+    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
+    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
+    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
+    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
+    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
+    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
+    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
+    THIS SOFTWARE.
+*/
+
+#include <stdbool.h>
+
+static bool icspEnabled = false;
+
+//temp stubs - replace with real implementation
+bool ICSP_INHIBIT_IsEnabled(void)
+{
+    return icspEnabled;
+}
+
+bool ICSP_INHIBIT_Enable()
+{
+    icspEnabled = true;
+}

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/icsp_inhibit.h

@@ -0,0 +1,30 @@
+/*
+© [2024] Microchip Technology Inc. and its subsidiaries.
+
+    Subject to your compliance with these terms, you may use Microchip 
+    software and any derivatives exclusively with Microchip products. 
+    You are responsible for complying with 3rd party license terms  
+    applicable to your use of 3rd party software (including open source  
+    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
+    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
+    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
+    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
+    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
+    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
+    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
+    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
+    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
+    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
+    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
+    THIS SOFTWARE.
+*/
+
+#ifndef ICSP_INHIBIT_H
+#define ICSP_INHIBIT_H
+
+#include <stdbool.h>
+
+bool ICSP_INHIBIT_IsEnabled(void);
+bool ICSP_INHIBIT_Enable(void);
+
+#endif

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/main.c

@@ -25,6 +25,8 @@
 #include "mcc_generated_files/flash/flash.h"
 #include "mcc_generated_files/flash/flash_types.h"
 #include "mcc_generated_files/boot/boot_config.h"
+#include "mcc_generated_files/uart/uart1.h"
+#include "mcc_generated_files/system/system.h"
 #include "icsp_inhibit.h"
 #include "terminal.h"
 
@@ -34,18 +36,23 @@
 
 #define USER_INPUT_BUFFER_SIZE 50
 #define UNLOCK_COMMAND "LOCKDEVICE"
-#define MATCHES 0
+#define STRCMP_MATCHES 0
 #define ENTER '\r'
+#define TERMINAL_LINE_ERROR 7
+#define TERMINAL_LINE_INPUT 5
+#define TERMINAL_LINE_HOME 1
 
 // Function prototypes
 static void PrintWarning(void);
 static uint32_t GetResetAddress();
 static bool WasLoadedByBootloader();
 static void PrintBootloaderRequired(void);
-static char* ScanINPUT(void);
-static void DisableProgrammingPort(void);
+static char* ScanInput(void);
 static void PrintErrorMessage(char* error);
 static void PrintProgrammingDisabled(void);
+static void ClearUserInput(void);
+static void ClearErrorMessage(void);
+static void ResetPrompt(void);
 
 // Local Variables
 static char userInput[USER_INPUT_BUFFER_SIZE] = {0};
@@ -57,14 +64,14 @@ int main(void)
 
     SYSTEM_Initialize();
 
-//    if(WasLoadedByBootloader() == false)
-//    {
-//        PrintBootloaderRequired();
-//        
-//        while(1)
-//        {
-//        }
-//    }
+    if(WasLoadedByBootloader() == false)
+    {
+        PrintBootloaderRequired();
+        
+        while(1)
+        {
+        }
+    }
 
     if(ICSP_INHIBIT_IsEnabled())
     {
@@ -79,11 +86,11 @@ int main(void)
 
     while (1)
     {
-        char* userInput = ScanINPUT();
+        char* userInput = ScanInput();
 
-        if(strcmp(userInput, keyword) == MATCHES)
+        if(strcmp(userInput, keyword) == STRCMP_MATCHES)
         {
-            DisableProgrammingPort();
+            ICSP_INHIBIT_Enable();
 
             PrintProgrammingDisabled();
 
@@ -98,10 +105,40 @@ int main(void)
     }
 }
 
+static char* ScanInput(void)
+{
+    uint8_t userInputOffset = 0;
+    char key;
+    
+    ClearUserInput();
+    
+    do
+    {     
+        key = UART1_Read();
+        
+        /* If there is still an error message after the first user key press,
+         * clear the error and reset the prompt before printing their input. */
+        if(errorPresent)
+        {
+            ClearErrorMessage();
+            ResetPrompt();
+        }
+        
+        if((key != ENTER) && (userInputOffset < sizeof(userInput)))
+        {
+            userInput[userInputOffset++] = key;
+            printf("%c", key);
+        }
+    }
+    while(key != ENTER);
+
+    return userInput;
+}
+
 static void PrintProgrammingDisabled(void)
 {
     TERMINAL_EnableCursor(false);
-    TERMINAL_MoveCursor(1);
+    TERMINAL_MoveCursor(TERMINAL_LINE_HOME);
     TERMINAL_ClearScreen();
 
     printf("\r\n");
@@ -112,22 +149,17 @@ static void PrintProgrammingDisabled(void)
     printf("Use the bootloader to load all future applications into this board.");
 }
 
-static void DisableProgrammingPort(void)
-{
-    ICSP_INHIBIT_Enable();
-}
-
 static void ClearErrorMessage(void)
 {
-    TERMINAL_MoveCursor(7);
+    TERMINAL_MoveCursor(TERMINAL_LINE_ERROR);
     TERMINAL_ClearLine();
 
     errorPresent = false;
 }
 
 static void ResetPrompt(void)
 {
-    TERMINAL_MoveCursor(5);
+    TERMINAL_MoveCursor(TERMINAL_LINE_INPUT);
     TERMINAL_ClearLine();
     printf(">> ");
 }
@@ -147,38 +179,10 @@ static void ClearUserInput(void)
     memset(userInput, 0, sizeof(userInput));
 }
 
-static char* ScanINPUT(void)
-{
-    uint8_t offset = 0;
-    char key;
-    
-    ClearUserInput();
-    
-    do
-    {     
-        key = UART1_Read();
-        
-        if(errorPresent)
-        {
-            ClearErrorMessage();
-            ResetPrompt();
-        }
-        
-        if(key != ENTER)
-        {
-            userInput[offset++] = key;
-            printf("%c", key);
-        }
-    }
-    while((key != ENTER) && (offset < sizeof(userInput)));
-
-    return userInput;
-}
-
 static void PrintWarning(void)
 {
     TERMINAL_EnableCursor(false);
-    TERMINAL_MoveCursor(1);
+    TERMINAL_MoveCursor(TERMINAL_LINE_HOME);
     TERMINAL_ClearScreen();
 
     printf("Type LOCKDEVICE (plus ENTER) to enable the ICSP Inhibit feature.\r\n");
@@ -193,7 +197,7 @@ static void PrintWarning(void)
 static void PrintBootloaderRequired(void)
 {
     TERMINAL_EnableCursor(false);
-    TERMINAL_MoveCursor(1);
+    TERMINAL_MoveCursor(TERMINAL_LINE_HOME);
     TERMINAL_ClearScreen();
 
     printf("NO BOOTLOADER DETECTED!\r\n");

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/terminal.c

@@ -0,0 +1,46 @@
+/*
+© [2024] Microchip Technology Inc. and its subsidiaries.
+
+    Subject to your compliance with these terms, you may use Microchip 
+    software and any derivatives exclusively with Microchip products. 
+    You are responsible for complying with 3rd party license terms  
+    applicable to your use of 3rd party software (including open source  
+    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
+    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
+    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
+    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
+    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
+    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
+    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
+    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
+    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
+    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
+    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
+    THIS SOFTWARE.
+*/
+
+#include <stdbool.h>
+
+void TERMINAL_ClearScreen(void)
+{
+    printf("\033[2J");
+}
+
+void TERMINAL_ClearLine(void)
+{
+    printf("\33[2K\r");
+}
+
+void TERMINAL_MoveCursor(int row)
+{
+    printf("\033[%d;0f", row);
+}
+
+/*
+ * "\033[?25h" for cursor enable
+ * "\033[?25l" for cursor disable
+ */
+void TERMINAL_EnableCursor(bool enable)
+{
+    printf("\033[?25%c", enable ? 'h' : 'l');
+}

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/terminal.h

@@ -0,0 +1,37 @@
+/* Microchip Technology Inc. and its subsidiaries.  You may use this software 
+ * and any derivatives exclusively with Microchip products. 
+ * 
+ * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS".  NO WARRANTIES, WHETHER 
+ * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED 
+ * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A 
+ * PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION 
+ * WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION. 
+ *
+ * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
+ * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND 
+ * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS 
+ * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE.  TO THE 
+ * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS 
+ * IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF 
+ * ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
+ *
+ * MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE 
+ * TERMS. 
+ */
+
+#ifndef TERMINAL_H
+#define TERMINAL_H
+
+#include <stdbool.h>
+
+void TERMINAL_ClearScreen(void);
+void TERMINAL_ClearLine(void);
+void TERMINAL_MoveCursor(int row);
+
+/*
+ * "\033[?25h" for cursor enable
+ * "\033[?25l" for cursor disable
+ */
+void TERMINAL_EnableCursor(bool enable);
+
+#endif