Debug/cli/cli.h

   1 /* Copyright (C) 2014 by Jacob Alexander
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #ifndef cli_h__
  23 #define cli_h__
  24
  25 // ----- Includes -----
  26
  27 // Compiler Includes
  28 #include <Lib/MainLib.h>
  29
  30 // Project Includes
  31 #include <output_com.h>
  32
  33
  34 // ----- Defines -----
  35
  36 #define CLILineBufferMaxSize 100
  37 #define CLIMaxDictionaries   5
  38 #define CLIEntryTabAlign     12
  39
  40
  41 // ----- Structs -----
  42
  43 // Each item has a name, description, and function pointer with an argument for arguments
  44 typedef struct CLIDictItem {
  45         char*  name;
  46         char*  description;
  47         void (*function)(char*);
  48 } CLIDictItem;
  49
  50
  51
  52 // ----- Variables -----
  53
  54 char    CLILineBuffer[CLILineBufferMaxSize+1]; // +1 for an additional NULL
  55 uint8_t CLILineBufferCurrent;
  56
  57 // Main command dictionary
  58 CLIDictItem *CLIDict[CLIMaxDictionaries];
  59 uint8_t CLIDictionariesUsed;
  60
  61 uint8_t CLILEDState;
  62 uint8_t CLIHexDebugMode;
  63
  64
  65
  66 // ----- Functions and Corresponding Function Aliases -----
  67
  68 void init_cli();
  69 void process_cli();
  70 void registerDictionary_cli( CLIDictItem *cmdDict );
  71 void argumentIsolation_cli( char* string, char** first, char** second );
  72
  73 void commandLookup_cli();
  74
  75 // CLI Command Functions
  76 void cliFunc_arch    ( char* args );
  77 void cliFunc_chip    ( char* args );
  78 void cliFunc_cliDebug( char* args );
  79 void cliFunc_device  ( char* args );
  80 void cliFunc_help    ( char* args );
  81 void cliFunc_led     ( char* args );
  82 void cliFunc_reload  ( char* args );
  83 void cliFunc_reset   ( char* args );
  84 void cliFunc_restart ( char* args );
  85 void cliFunc_version ( char* args );
  86
  87
  88 #endif
  89