Pull request #40: Feature/MCU16GITHUB-957 improve the icsp inhibit ui ux

Merge in MCU16CE/dspic33-dsc-bootloader-code-examples from ~C12109/dspic33-dsc-bootloader-code-examples:feature/MCU16GITHUB-957-improve-the-icsp-inhibit-ui-ux to feature/MCU16GITHUB-842-add-the-icsp-inhibit-feature

* commit '7f93c5d2a9d8eb1eb4a3c9842cf671567d8f6452':
  Select correct debugging port.
  remove .yml files.  Add *.yml to gitignore.
  only allow alphanumeric input keys.
  disable the ICSP enable for safety during development of demo.
  refactor and enable bootloader detection
  refactor
  update functionality
  updated, but not working completely.
  block ICSP inhibit when programmed directly: MCU16GITHUB-959

Author: davidflowers

.gitignore

@@ -9,6 +9,7 @@
 *.ko
 *.obj
 *.elf
+*.yml
 
 # Excluding documentation output directories
 #docs/

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/icsp_inhibit.mc3

@@ -18,123 +18,194 @@
     EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
     THIS SOFTWARE.
 */
+
+/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!*/
 #warning "!!RUNNING THIS PROGRAM AND FOLLOWING THE STEPS OUTLINED IN THE CONSOLE WILL PERMANENTLY DISABLE DIRECT PROGRAMMING OF THE BOARD. FOR ADDITIONAL INFORMATION, SEE THE README.MD INCLUDED WITH THIS PROJECT AND THE FAMILY DATA SHEET LOCATED AT https://ww1.microchip.com/downloads/aemDocuments/documents/MCU16/ProductDocuments/DataSheets/dsPIC33CK1024MP710-Family-Data-Sheet-DS70005496.pdf"
 
-#include <stdio.h>
-#include <string.h>
-#include <stdbool.h>
 #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"
+
+#include <stdio.h>
+#include <string.h>
+#include <stdbool.h>
+#include <ctype.h>
 
-#define WINDOW_SIZE 10
+#define USER_INPUT_BUFFER_SIZE 50
 #define UNLOCK_COMMAND "LOCKDEVICE"
+#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 ClearTerminalScreen(void);
-static void ClearTerminalLine(void);
-static void MoveCursor(int row);
-static void HideCursor(void);
 static void PrintWarning(void);
-static void AppendCharToWindow(char receivedChar, char *window, int *windowIndex);
-static void ProcessReceivedChar(char receivedChar, char *window, int *windowIndex);
-static void ResetWindowOnMismatch(char *window, int *windowIndex);
-static void CheckForUnlockCommand(char *window, int *windowIndex);
 static uint32_t GetResetAddress();
 static bool WasLoadedByBootloader();
+static void PrintBootloaderRequired(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};
+static bool errorPresent = false;
 
 int main(void)
 {
-    char window[WINDOW_SIZE + 1] = {0};
-    int windowIndex = 0;
+    const char* keyword = "LOCKDEVICE";
 
     SYSTEM_Initialize();
-    ClearTerminalScreen();
+    
+    if(WasLoadedByBootloader() == false)
+    {
+        PrintBootloaderRequired();
+        
+        while(1)
+        {
+        }
+    }
+    
+    if(ICSP_INHIBIT_IsEnabled())
+    {
+        PrintProgrammingDisabled();
+
+        while(1)
+        {
+        }
+    }
+            
     PrintWarning();
-    while (1)
+
+    while(1)
     {
-        if (UART1_IsRxReady())
+        char* userInput = ScanInput();
+
+        if(strcmp(userInput, keyword) == STRCMP_MATCHES)
+        {
+            //ICSP_INHIBIT_Enable();        //Disable during development for safety
+
+            PrintProgrammingDisabled();
+
+            while(1)
+            {
+            }
+        }
+        else
         {
-            char receivedChar = UART1_Read();
-            ProcessReceivedChar(receivedChar, window, &windowIndex);
-            CheckForUnlockCommand(window, &windowIndex);
+            PrintErrorMessage("Invalid keyword entered. Try again.");
         }
     }
 }
 
-static void ClearTerminalScreen(void)
+static char* ScanInput(void)
 {
-    printf("\033[2J");
-}
+    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(isalnum(key) && (userInputOffset < sizeof(userInput)))
+        {
+            userInput[userInputOffset++] = key;
+            printf("%c", key);
+        }
+    }
+    while(key != ENTER);
 
-static void ClearTerminalLine(void)
-{
-    printf("\33[2K\r");
+    return userInput;
 }
 
-static void MoveCursor(int row)
+static void PrintProgrammingDisabled(void)
 {
-    printf("\033[%d;0f", row);
+    TERMINAL_EnableCursor(false);
+    TERMINAL_MoveCursor(TERMINAL_LINE_HOME);
+    TERMINAL_ClearScreen();
+            
+    printf("\r\n");
+    printf("\r\n");
+    printf("\r\n");
+    printf("*** ICSP Programming/Debugging permanently disabled. ***\r\n");
+    printf("\r\n");
+    printf("Use the bootloader to load all future applications into this board.");
 }
 
-static void HideCursor(void)
+static void ClearErrorMessage(void)
 {
-    printf("\033[?25l");
+    TERMINAL_MoveCursor(TERMINAL_LINE_ERROR);
+    TERMINAL_ClearLine();
+        
+    errorPresent = false;
 }
 
-static void PrintWarning(void)
+static void ResetPrompt(void)
 {
-    MoveCursor(1);
-    printf("Type LOCKDEVICE to enable the ICSP Inhibit feature.");
-    MoveCursor(3);
-    printf("WARNING: THIS PERMANENTLY DISABLES DIRECT PROGRAMMING OF THE BOARD.");
+    TERMINAL_MoveCursor(TERMINAL_LINE_INPUT);
+    TERMINAL_ClearLine();
+    printf(">> ");
 }
 
-static void ProcessReceivedChar(char receivedChar, char *window, int *windowIndex)
+static void PrintErrorMessage(char* errorMessage)
 {
-    bool isCharValid = (*windowIndex < strlen(UNLOCK_COMMAND)) && (receivedChar == UNLOCK_COMMAND[*windowIndex]);
+    ClearErrorMessage();
 
-    if (isCharValid)
-    {
-        AppendCharToWindow(receivedChar, window, windowIndex);
-        MoveCursor(10);
-        printf("%s", window);
-    }
-    else
-    {
-        ResetWindowOnMismatch(window, windowIndex);
-    }
+    printf("%s", errorMessage);
+    errorPresent = true;
+    
+    ResetPrompt();
 }
 
-static void AppendCharToWindow(char receivedChar, char *window, int *windowIndex)
+static void ClearUserInput(void)
 {
-    window[(*windowIndex)++] = receivedChar;
-    window[*windowIndex] = '\0';
+    memset(userInput, 0, sizeof(userInput));
 }
 
-static void ResetWindowOnMismatch(char *window, int *windowIndex)
+static void PrintWarning(void)
 {
-    MoveCursor(10);
-    ClearTerminalLine();
-    MoveCursor(5);
-    ClearTerminalLine();
-    printf("Invalid character entered. Try again.");
-    *windowIndex = 0;
-    memset(window, 0, WINDOW_SIZE + 1); 
+    TERMINAL_EnableCursor(false);
+    TERMINAL_MoveCursor(TERMINAL_LINE_HOME);
+    TERMINAL_ClearScreen();
+    
+    printf("Type LOCKDEVICE (plus ENTER) to enable the ICSP Inhibit feature.\r\n");
+    printf("\r\n");
+    printf("WARNING: THIS PERMANENTLY DISABLES DIRECT PROGRAMMING OF THE BOARD.\r\n");
+    printf("\r\n");
+    printf(">> ");
+    
+    TERMINAL_EnableCursor(true);
 }
 
-static void CheckForUnlockCommand(char *window, int *windowIndex)
+static void PrintBootloaderRequired(void)
 {
-    if (strncmp(window, UNLOCK_COMMAND, *windowIndex) == 0 && *windowIndex == strlen(UNLOCK_COMMAND))
-    {
-        MoveCursor(5);
-        ClearTerminalLine();
-        printf("ICSP Programming/Debugging permanently disabled. \n");
-        MoveCursor(10);
-        ClearTerminalLine();
-        *windowIndex = 0;
-        memset(window, 0, WINDOW_SIZE + 1);
-    }
+    TERMINAL_EnableCursor(false);
+    TERMINAL_MoveCursor(TERMINAL_LINE_HOME);
+    TERMINAL_ClearScreen();
+    
+    printf("NO BOOTLOADER DETECTED!\r\n");
+    printf("\r\n");
+    printf("Because programming will be permanently disabled, \r\n");
+    printf("a bootloader is required to run this demo. \r\n");
+    printf("Please see the readme.md for more information.\r\n");
 }
 
 /* The following code finds the address used by GOTO instruction programmed 

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/main.c

@@ -74,7 +74,7 @@
 #pragma config BISTDIS = DISABLED    //Memory BIST Feature Disable->mBIST on reset feature disabled
 
 // FICD
-#pragma config ICS = PGD1    //ICD Communication Channel Select bits->Communicate on PGC1 and PGD1
+#pragma config ICS = PGD3    //ICD Communication Channel Select bits->Communicate on PGC3 and PGD3
 #pragma config JTAGEN = OFF    //JTAG Enable bit->JTAG is disabled
 #pragma config NOBTSWP = DISABLED    //BOOTSWP instruction disable bit->BOOTSWP instruction is disabled
 

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/mcc_generated_files/system/src/config_bits.c

@@ -98,7 +98,7 @@ void PINS_Initialize(void)
      * Setting the Analog/Digital Configuration SFR(s)
      ***************************************************************************/
     ANSELA = 0x001F;
-    ANSELB = 0x009E;
+    ANSELB = 0x039E;
     ANSELC = 0x00CF;
     ANSELD = 0x2C00;
     ANSELE = 0x000F;

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/mcc_generated_files/system/src/pins.c

@@ -35,6 +35,8 @@
           <itemPath>mcc_generated_files/uart/uart1.h</itemPath>
         </logicalFolder>
       </logicalFolder>
+      <itemPath>icsp_inhibit.h</itemPath>
+      <itemPath>terminal.h</itemPath>
     </logicalFolder>
     <logicalFolder name="ExternalFiles"
                    displayName="Important Files"
@@ -95,8 +97,13 @@
         </logicalFolder>
       </logicalFolder>
       <itemPath>main.c</itemPath>
+      <itemPath>icsp_inhibit.c</itemPath>
+      <itemPath>terminal.c</itemPath>
     </logicalFolder>
   </logicalFolder>
+  <sourceRootList>
+    <Elem>.</Elem>
+  </sourceRootList>
   <projectmakefile>Makefile</projectmakefile>
   <confs>
     <conf name="default" type="2">
@@ -453,6 +460,8 @@
                   value="${memories.instruction.ram.ranges}"/>
         <property key="memories.programmemory" value="true"/>
         <property key="memories.programmemory.ranges" value="0-afeff"/>
+        <property key="programmerToGoFilePath"
+                  value="C:/work/repos/dspic33-dsc-bootloader-code-examples/secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/debug/default/icsp_inhibit_ptg"/>
         <property key="programoptions.donoteraseauxmem" value="false"/>
         <property key="programoptions.eraseb4program" value="true"/>
         <property key="programoptions.pgmentry.voltage" value="low"/>