refactor

Author: davidflowers

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/main.c

@@ -22,44 +22,41 @@
 /*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 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 "icsp_inhibit.h"
+#include "terminal.h"
+
+#include <stdio.h>
+#include <string.h>
+#include <stdbool.h>
 
 #define USER_INPUT_BUFFER_SIZE 50
 #define UNLOCK_COMMAND "LOCKDEVICE"
 #define MATCHES 0
 #define ENTER '\r'
 
 // Function prototypes
-static void ClearTerminalScreen(void);
-static void ClearTerminalLine(void);
-static void MoveCursor(int row);
-static void EnableCursor(bool enable);
 static void PrintWarning(void);
 static uint32_t GetResetAddress();
 static bool WasLoadedByBootloader();
 static void PrintBootloaderRequired(void);
 static char* ScanINPUT(void);
 static void DisableProgrammingPort(void);
-static void InvalidKeyword(void);
+static void PrintErrorMessage(char* error);
 static void PrintProgrammingDisabled(void);
 
 // Local Variables
 static char userInput[USER_INPUT_BUFFER_SIZE] = {0};
-static bool ICSP_INHIBIT_IsEnabled(void);   //temp stub - replace with real version
-static bool ICSP_INHIBIT_Enable();          //temp stub - replace with real version
 static bool errorPresent = false;
-static bool icspEnabled = false;
-
 
 int main(void)
 {
+    const char* keyword = "LOCKDEVICE";
+
     SYSTEM_Initialize();
-        
+    
 //    if(WasLoadedByBootloader() == false)
 //    {
 //        PrintBootloaderRequired();
@@ -68,44 +65,44 @@ int main(void)
 //        {
 //        }
 //    }
-//    else
+    
+    if(ICSP_INHIBIT_IsEnabled())
     {
-        const char* keyword = "LOCKDEVICE";
-        
-        PrintWarning();
+        PrintProgrammingDisabled();
 
-        while (1)
+        while(1)
         {
-            char* userInput;
-                     
-            if(ICSP_INHIBIT_IsEnabled())
-            {
-                PrintProgrammingDisabled();
-                
-                while(1)
-                {
-                }
-            }
-            
-            userInput = ScanINPUT();
+        }
+    }
 
-            if(strcmp(userInput, keyword) == MATCHES)
-            {
-                DisableProgrammingPort();
-            }
-            else
+    PrintWarning();
+
+    while (1)
+    {
+        char* userInput = ScanINPUT();
+
+        if(strcmp(userInput, keyword) == MATCHES)
+        {
+            DisableProgrammingPort();
+
+            PrintProgrammingDisabled();
+
+            while(1)
             {
-                InvalidKeyword();
             }
         }
+        else
+        {
+            PrintErrorMessage("Invalid keyword entered. Try again.");
+        }
     }
 }
 
 static void PrintProgrammingDisabled(void)
 {
-    EnableCursor(false);
-    MoveCursor(1);
-    ClearTerminalScreen();
+    TERMINAL_EnableCursor(false);
+    TERMINAL_MoveCursor(1);
+    TERMINAL_ClearScreen();
 
     printf("\r\n");
     printf("\r\n");
@@ -115,53 +112,56 @@ static void PrintProgrammingDisabled(void)
     printf("Use the bootloader to load all future applications into this board.");
 }
 
-//temp stub - replace with real version
-static bool ICSP_INHIBIT_IsEnabled(void)
+static void DisableProgrammingPort(void)
 {
-    return icspEnabled;
+    ICSP_INHIBIT_Enable();
 }
 
-static bool ICSP_INHIBIT_Enable()
+static void ClearErrorMessage(void)
 {
-    icspEnabled = true;
+    TERMINAL_MoveCursor(7);
+    TERMINAL_ClearLine();
+        
+    errorPresent = false;
 }
 
-static void InvalidKeyword(void)
+static void ResetPrompt(void)
 {
-    MoveCursor(7);
-    ClearTerminalLine();
-    printf("Invalid keyword entered. Try again.");
-    errorPresent = true;
-    
-    MoveCursor(5);
-    ClearTerminalLine();
+    TERMINAL_MoveCursor(5);
+    TERMINAL_ClearLine();
     printf(">> ");
+}
+
+static void PrintErrorMessage(char* errorMessage)
+{
+    ClearErrorMessage();
 
+    printf("%s", errorMessage);
+    errorPresent = true;
+    
+    ResetPrompt();
 }
 
-static void DisableProgrammingPort(void)
+static void ClearUserInput(void)
 {
-    ICSP_INHIBIT_Enable();
+    memset(userInput, 0, sizeof(userInput));
 }
 
 static char* ScanINPUT(void)
 {
     uint8_t offset = 0;
     char key;
 
-    memset(userInput, 0, sizeof(userInput));
+    ClearUserInput();
 
     do
     {     
         key = UART1_Read();
 
         if(errorPresent)
         {
-            MoveCursor(7);
-            ClearTerminalLine();
-            MoveCursor(5);
-            printf(">> ");
-            errorPresent = false;
+            ClearErrorMessage();
+            ResetPrompt();
         }
 
         if(key != ENTER)
@@ -175,51 +175,26 @@ static char* ScanINPUT(void)
     return userInput;
 }
 
-static void ClearTerminalScreen(void)
-{
-    printf("\033[2J");
-}
-
-static void ClearTerminalLine(void)
-{
-    printf("\33[2K\r");
-}
-
-static void MoveCursor(int row)
-{
-    printf("\033[%d;0f", row);
-}
-
-
-/*
- * "\033[?25h" for cursor enable
- * "\033[?25l" for cursor disable
- */
-static void EnableCursor(bool enable)
-{
-    printf("\033[?25%c", enable ? 'h' : 'l');
-}
-
 static void PrintWarning(void)
 {
-    EnableCursor(false);
-    MoveCursor(1);
-    ClearTerminalScreen();
+    TERMINAL_EnableCursor(false);
+    TERMINAL_MoveCursor(1);
+    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(">> ");
 
-    EnableCursor(true);
+    TERMINAL_EnableCursor(true);
 }
 
 static void PrintBootloaderRequired(void)
 {
-    EnableCursor(false);
-    MoveCursor(1);
-    ClearTerminalScreen();
+    TERMINAL_EnableCursor(false);
+    TERMINAL_MoveCursor(1);
+    TERMINAL_ClearScreen();
 
     printf("NO BOOTLOADER DETECTED!\r\n");
     printf("\r\n");

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/nbproject/configurations.xml

@@ -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"/>

secure_boot_and_secure_firmware_upgrade_over_canfd/icsp_inhibit.X/nbproject/project.xml

@@ -8,7 +8,9 @@
             <make-project-type>0</make-project-type>
             <sourceEncoding>ISO-8859-1</sourceEncoding>
             <make-dep-projects/>
-            <sourceRootList/>
+            <sourceRootList>
+                <sourceRootElem>.</sourceRootElem>
+            </sourceRootList>
             <confList>
                 <confElem>
                     <name>default</name>