]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Debug/cli/cli.c
Write whole debug cli command to history
[kiibohd-controller.git] / Debug / cli / cli.c
index fcee021eba86eaffd36731baaef75e39cf756f01..5c83ee64c98ce4bf60a39c01b80d1f76a8110020 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 2014 by Jacob Alexander
+/* Copyright (C) 2014-2015 by Jacob Alexander
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
 
 // ----- Includes -----
 
-// Compiler Includes
-//#include <stdarg.h>
-
 // Project Includes
 #include <buildvars.h>
 #include "cli.h"
 #include <led.h>
 #include <print.h>
+#include <kll_defs.h>
 
 
 
 // ----- Variables -----
 
 // Basic command dictionary
-const char basicCLIDictName[] = "General Commands";
-const CLIDictItem basicCLIDict[] = {
-       { "cliDebug", "Enables/Disables hex output of the most recent cli input.", cliFunc_cliDebug },
-       { "help",     "You're looking at it :P", cliFunc_help },
-       { "led",      "Enables/Disables indicator LED. Try a couple times just in case the LED is in an odd state.\r\n\t\t\033[33mWarning\033[0m: May adversely affect some modules...", cliFunc_led },
-       { "reload",   "Signals microcontroller to reflash/reload.", cliFunc_reload },
-       { "reset",    "Resets the terminal back to initial settings.", cliFunc_reset },
-       { "restart",  "Sends a software restart, should be similar to powering on the device.", cliFunc_restart },
-       { "version",  "Version information about this firmware.", cliFunc_version },
+CLIDict_Entry( clear, "Clear the screen.");
+CLIDict_Entry( cliDebug, "Enables/Disables hex output of the most recent cli input." );
+CLIDict_Entry( help,     "You're looking at it :P" );
+CLIDict_Entry( led,      "Enables/Disables indicator LED. Try a couple times just in case the LED is in an odd state.\r\n\t\t\033[33mWarning\033[0m: May adversely affect some modules..." );
+CLIDict_Entry( reload,   "Signals microcontroller to reflash/reload." );
+CLIDict_Entry( reset,    "Resets the terminal back to initial settings." );
+CLIDict_Entry( restart,  "Sends a software restart, should be similar to powering on the device." );
+CLIDict_Entry( version,  "Version information about this firmware." );
+
+CLIDict_Def( basicCLIDict, "General Commands" ) = {
+       CLIDict_Item( clear ),
+       CLIDict_Item( cliDebug ),
+       CLIDict_Item( help ),
+       CLIDict_Item( led ),
+       CLIDict_Item( reload ),
+       CLIDict_Item( reset ),
+       CLIDict_Item( restart ),
+       CLIDict_Item( version ),
        { 0, 0, 0 } // Null entry for dictionary end
 };
 
@@ -63,6 +70,11 @@ inline void CLI_init()
        // Reset the Line Buffer
        CLILineBufferCurrent = 0;
 
+       // History starts empty
+       CLIHistoryHead = 0;
+       CLIHistoryCurrent = 0;
+       CLIHistoryTail = 0;
+
        // Set prompt
        prompt();
 
@@ -135,15 +147,38 @@ void CLI_process()
                // Check for control characters
                switch ( CLILineBuffer[prev_buf_pos] )
                {
-               case 0x0D: // Enter
+               // Enter
+               case 0x0A: // LF
+               case 0x0D: // CR
                        CLILineBuffer[CLILineBufferCurrent - 1] = ' '; // Replace Enter with a space (resolves a bug in args)
 
                        // Remove the space if there is no command
                        if ( CLILineBufferCurrent == 1 )
+                       {
                                CLILineBufferCurrent--;
+                       }
+                       else
+                       {
+                               // Add the command to the history
+                               CLI_saveHistory( CLILineBuffer );
+
+                               // Process the current line buffer
+                               CLI_commandLookup();
 
-                       // Process the current line buffer
-                       CLI_commandLookup();
+                               // Keep the array circular, discarding the older entries
+                               if ( CLIHistoryTail < CLIHistoryHead )
+                                       CLIHistoryHead = ( CLIHistoryHead + 1 ) % CLIMaxHistorySize;
+                               CLIHistoryTail++;
+                               if ( CLIHistoryTail == CLIMaxHistorySize )
+                               {
+                                       CLIHistoryTail = 0;
+                                       CLIHistoryHead = 1;
+                               }
+
+                               CLIHistoryCurrent = CLIHistoryTail; // 'Up' starts at the last item
+                               CLI_saveHistory( NULL ); // delete the old temp buffer
+
+                       }
 
                        // Reset the buffer
                        CLILineBufferCurrent = 0;
@@ -166,9 +201,38 @@ void CLI_process()
                        //     Doesn't look like it will happen *that* often, so not handling it for now -HaaTa
                        return;
 
-               case 0x1B: // Esc
-                       // Check for escape sequence
-                       // TODO
+               case 0x1B: // Esc / Escape codes
+                       // Check for other escape sequence
+
+                       // \e[ is an escape code in vt100 compatible terminals
+                       if ( CLILineBufferCurrent >= prev_buf_pos + 3
+                               && CLILineBuffer[ prev_buf_pos ] == 0x1B
+                               && CLILineBuffer[ prev_buf_pos + 1] == 0x5B )
+                       {
+                               // Arrow Keys: A (0x41) = Up, B (0x42) = Down, C (0x43) = Right, D (0x44) = Left
+
+                               if ( CLILineBuffer[ prev_buf_pos + 2 ] == 0x41 ) // Hist prev
+                               {
+                                       if ( CLIHistoryCurrent == CLIHistoryTail )
+                                       {
+                                               // Is first time pressing arrow. Save the current buffer
+                                               CLILineBuffer[ prev_buf_pos ] = '\0';
+                                               CLI_saveHistory( CLILineBuffer );
+                                       }
+
+                                       // Grab the previus item from the history if there is one
+                                       if ( RING_PREV( CLIHistoryCurrent ) != RING_PREV( CLIHistoryHead ) )
+                                               CLIHistoryCurrent = RING_PREV( CLIHistoryCurrent );
+                                       CLI_retreiveHistory( CLIHistoryCurrent );
+                               }
+                               if ( CLILineBuffer[ prev_buf_pos + 2 ] == 0x42 ) // Hist next
+                               {
+                                       // Grab the next item from the history if it exists
+                                       if ( RING_NEXT( CLIHistoryCurrent ) != RING_NEXT( CLIHistoryTail ) )
+                                               CLIHistoryCurrent = RING_NEXT( CLIHistoryCurrent );
+                                       CLI_retreiveHistory( CLIHistoryCurrent );
+                               }
+                       }
                        return;
 
                case 0x08:
@@ -250,11 +314,11 @@ void CLI_commandLookup()
                for ( uint8_t cmd = 0; CLIDict[dict][cmd].name != 0; cmd++ )
                {
                        // Compare the first argument and each command entry
-                       if ( eqStr( cmdPtr, CLIDict[dict][cmd].name ) == -1 )
+                       if ( eqStr( cmdPtr, (char*)CLIDict[dict][cmd].name ) == -1 )
                        {
                                // Run the specified command function pointer
                                //   argPtr is already pointing at the first character of the arguments
-                               (*CLIDict[dict][cmd].function)( argPtr );
+                               (*(void (*)(char*))CLIDict[dict][cmd].function)( argPtr );
 
                                return;
                        }
@@ -310,11 +374,11 @@ inline void CLI_tabCompletion()
                        // NOTE: To save on processing, we only care about the commands and ignore the arguments
                        //       If there are arguments, and a valid tab match is found, buffer is cleared (args lost)
                        //       Also ignores full matches
-                       if ( eqStr( cmdPtr, CLIDict[dict][cmd].name ) == 0 )
+                       if ( eqStr( cmdPtr, (char*)CLIDict[dict][cmd].name ) == 0 )
                        {
                                // TODO Make list of commands if multiple matches
                                matches++;
-                               tabMatch = CLIDict[dict][cmd].name;
+                               tabMatch = (char*)CLIDict[dict][cmd].name;
                        }
                }
        }
@@ -339,10 +403,68 @@ inline void CLI_tabCompletion()
        }
 }
 
+inline int CLI_wrap( int kX, int const kLowerBound, int const kUpperBound )
+{
+       int range_size = kUpperBound - kLowerBound + 1;
+
+       if ( kX < kLowerBound )
+               kX += range_size * ((kLowerBound - kX) / range_size + 1);
+
+       return kLowerBound + (kX - kLowerBound) % range_size;
+}
+
+inline void CLI_saveHistory( char *buff )
+{
+       if ( buff == NULL )
+       {
+               //clear the item
+               CLIHistoryBuffer[ CLIHistoryTail ][ 0 ] = '\0';
+               return;
+       }
+
+        // Don't write empty lines to the history
+        const char *cursor = buff;
+        while (*cursor == ' ') { cursor++; } // advance past the leading whitespace
+        if (*cursor == '\0') { return ; }
+
+       // Copy the line to the history
+       int i;
+       for (i = 0; i < CLILineBufferCurrent; i++)
+       {
+               CLIHistoryBuffer[ CLIHistoryTail ][ i ] = CLILineBuffer[ i ];
+       }
+}
+
+void CLI_retreiveHistory( int index )
+{
+       char *histMatch = CLIHistoryBuffer[ index ];
+
+       // Reset the buffer
+       CLILineBufferCurrent = 0;
+
+       // Reprint the prompt (automatically clears the line)
+       prompt();
+
+       // Display the command
+       dPrint( histMatch );
+
+       // There are no index counts, so just copy the whole string to the input buffe
+       CLILineBufferCurrent = 0;
+       while ( *histMatch != '\0' )
+       {
+               CLILineBuffer[ CLILineBufferCurrent++ ] = *histMatch++;
+       }
+}
+
 
 
 // ----- CLI Command Functions -----
 
+void cliFunc_clear( char* args)
+{
+       print("\033[2J\033[H\r"); // Erases the whole screen
+}
+
 void cliFunc_cliDebug( char* args )
 {
        // Toggle Hex Debug Mode
@@ -367,7 +489,9 @@ void cliFunc_help( char* args )
        for ( uint8_t dict = 0; dict < CLIDictionariesUsed; dict++ )
        {
                // Print the name of each dictionary as a title
-               dPrintStrsNL( NL, "\033[1;32m", CLIDictNames[dict], "\033[0m" );
+               print( NL "\033[1;32m" );
+               _print( CLIDictNames[dict] ); // This print is requride by AVR (flash)
+               print( "\033[0m" NL );
 
                // Parse each cmd/description until a null command entry is found
                for ( uint8_t cmd = 0; CLIDict[dict][cmd].name != 0; cmd++ )
@@ -375,11 +499,12 @@ void cliFunc_help( char* args )
                        dPrintStrs(" \033[35m", CLIDict[dict][cmd].name, "\033[0m");
 
                        // Determine number of spaces to tab by the length of the command and TabAlign
-                       uint8_t padLength = CLIEntryTabAlign - lenStr( CLIDict[dict][cmd].name );
+                       uint8_t padLength = CLIEntryTabAlign - lenStr( (char*)CLIDict[dict][cmd].name );
                        while ( padLength-- > 0 )
                                print(" ");
 
-                       dPrintStrNL( CLIDict[dict][cmd].description );
+                       _print( CLIDict[dict][cmd].description ); // This print is required by AVR (flash)
+                       print( NL );
                }
        }
 }
@@ -392,6 +517,14 @@ void cliFunc_led( char* args )
 
 void cliFunc_reload( char* args )
 {
+       if ( flashModeEnabled_define == 0 )
+       {
+               print( NL );
+               warn_print("flashModeEnabled not set, cancelling firmware reload...");
+               info_msg("Set flashModeEnabled to 1 in your kll configuration.");
+               return;
+       }
+
        // Request to output module to be set into firmware reload mode
        Output_firmwareReload();
 }
@@ -412,7 +545,7 @@ void cliFunc_version( char* args )
        print( NL );
        print( " \033[1mRevision:\033[0m      " CLI_Revision       NL );
        print( " \033[1mBranch:\033[0m        " CLI_Branch         NL );
-       print( " \033[1mTree Status:\033[0m   " CLI_ModifiedStatus NL );
+       print( " \033[1mTree Status:\033[0m   " CLI_ModifiedStatus CLI_ModifiedFiles NL );
        print( " \033[1mRepo Origin:\033[0m   " CLI_RepoOrigin     NL );
        print( " \033[1mCommit Date:\033[0m   " CLI_CommitDate     NL );
        print( " \033[1mCommit Author:\033[0m " CLI_CommitAuthor   NL );
@@ -423,5 +556,15 @@ void cliFunc_version( char* args )
        print( " \033[1mCPU:\033[0m           " CLI_CPU            NL );
        print( " \033[1mDevice:\033[0m        " CLI_Device         NL );
        print( " \033[1mModules:\033[0m       " CLI_Modules        NL );
+#if defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
+       print( " \033[1mUnique Id:\033[0m     " );
+       printHex32_op( SIM_UIDH, 4 );
+       printHex32_op( SIM_UIDMH, 4 );
+       printHex32_op( SIM_UIDML, 4 );
+       printHex32_op( SIM_UIDL, 4 );
+#elif defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
+#else
+#error "No unique id defined."
+#endif
 }