git.zerfleddert.de Git - proxmark3-svn/blob - client/cmdmain.c

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
   3 //
   4 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
   5 // at your option, any later version. See the LICENSE.txt file for the text of
   6 // the license.
   7 //-----------------------------------------------------------------------------
   8 // Main command parser entry point
   9 //-----------------------------------------------------------------------------
  10
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <unistd.h>
  14 #include <string.h>
  15 #include "sleep.h"
  16 #include "cmdparser.h"
  17 #include "proxmark3.h"
  18 #include "data.h"
  19 #include "usb_cmd.h"
  20 #include "ui.h"
  21 #include "cmdhf.h"
  22 #include "cmddata.h"
  23 #include "cmdhw.h"
  24 #include "cmdlf.h"
  25 #include "cmdmain.h"
  26 #include "util.h"
  27 #include "cmdscript.h"
  28 #include "cmdcrc.h"
  29
  30
  31 unsigned int current_command = CMD_UNKNOWN;
  32
  33 static int CmdHelp(const char *Cmd);
  34 static int CmdQuit(const char *Cmd);
  35 static int CmdRev(const char *Cmd);
  36
  37 //For storing command that are received from the device
  38 #define CMD_BUFFER_SIZE 50
  39 static UsbCommand cmdBuffer[CMD_BUFFER_SIZE];
  40 //Points to the next empty position to write to
  41 static int cmd_head;//Starts as 0
  42 //Points to the position of the last unread command
  43 static int cmd_tail;//Starts as 0
  44
  45 static command_t CommandTable[] =
  46 {
  47         {"help",        CmdHelp,        1, "This help. Use '<command> help' for details of a particular command."},
  48         {"data",        CmdData,        1, "{ Plot window / data buffer manipulation... }"},
  49         {"hf",          CmdHF,          1, "{ High Frequency commands... }"},
  50         {"hw",          CmdHW,          1, "{ Hardware commands... }"},
  51         {"lf",          CmdLF,          1, "{ Low Frequency commands... }"},
  52         {"reveng",      CmdRev,         1, "Crc calculations from the software reveng 1.30"},
  53         {"script",      CmdScript,      1, "{ Scripting commands }"},
  54         {"quit",        CmdQuit,        1, "Exit program"},
  55         {"exit",        CmdQuit,        1, "Exit program"},
  56         {NULL, NULL, 0, NULL}
  57 };
  58
  59 command_t* getTopLevelCommandTable()
  60 {
  61   return CommandTable;
  62 }
  63 int CmdHelp(const char *Cmd)
  64 {
  65   CmdsHelp(CommandTable);
  66   return 0;
  67 }
  68
  69 int CmdQuit(const char *Cmd)
  70 {
  71   return 99;
  72 }
  73
  74 int CmdRev(const char *Cmd)
  75 {
  76   CmdCrc(Cmd);
  77   return 0;
  78 }
  79 /**
  80  * @brief This method should be called when sending a new command to the pm3. In case any old
  81  *  responses from previous commands are stored in the buffer, a call to this method should clear them.
  82  *  A better method could have been to have explicit command-ACKS, so we can know which ACK goes to which
  83  *  operation. Right now we'll just have to live with this.
  84  */
  85 void clearCommandBuffer()
  86 {
  87     //This is a very simple operation
  88     cmd_tail = cmd_head;
  89 }
  90
  91 /**
  92  * @brief storeCommand stores a USB command in a circular buffer
  93  * @param UC
  94  */
  95 void storeCommand(UsbCommand *command)
  96 {
  97     if( ( cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
  98     {
  99         //If these two are equal, we're about to overwrite in the
 100         // circular buffer.
 101         PrintAndLog("WARNING: Command buffer about to overwrite command! This needs to be fixed!");
 102     }
 103     //Store the command at the 'head' location
 104     UsbCommand* destination = &cmdBuffer[cmd_head];
 105     memcpy(destination, command, sizeof(UsbCommand));
 106
 107     cmd_head = (cmd_head +1) % CMD_BUFFER_SIZE; //increment head and wrap
 108
 109 }
 110 /**
 111  * @brief getCommand gets a command from an internal circular buffer.
 112  * @param response location to write command
 113  * @return 1 if response was returned, 0 if nothing has been received
 114  */
 115 int getCommand(UsbCommand* response)
 116 {
 117     //If head == tail, there's nothing to read, or if we just got initialized
 118     if(cmd_head == cmd_tail)  return 0;
 119
 120     //Pick out the next unread command
 121     UsbCommand* last_unread = &cmdBuffer[cmd_tail];
 122     memcpy(response, last_unread, sizeof(UsbCommand));
 123     //Increment tail - this is a circular buffer, so modulo buffer size
 124     cmd_tail = (cmd_tail +1 ) % CMD_BUFFER_SIZE;
 125
 126     return 1;
 127 }
 128
 129 /**
 130  * Waits for a certain response type. This method waits for a maximum of
 131  * ms_timeout milliseconds for a specified response command.
 132  *@brief WaitForResponseTimeout
 133  * @param cmd command to wait for
 134  * @param response struct to copy received command into.
 135  * @param ms_timeout
 136  * @return true if command was returned, otherwise false
 137  */
 138 bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
 139
 140         UsbCommand resp;
 141
 142         if (response == NULL)
 143                 response = &resp;
 144
 145         // Wait until the command is received
 146         for ( size_t dm_seconds = 0; dm_seconds < ms_timeout/10; dm_seconds++ ) {
 147
 148                 while( getCommand(response) ) {
 149                         if(response->cmd == cmd){
 150                                 return true;
 151                         }
 152                 }
 153                 msleep(10); // XXX ugh
 154                 if (dm_seconds == 200) { // Two seconds elapsed
 155                         PrintAndLog("Waiting for a response from the proxmark...");
 156                         PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
 157                 }
 158         }
 159         return false;
 160 }
 161
 162 bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
 163         return WaitForResponseTimeout(cmd, response, -1);
 164 }
 165
 166 //-----------------------------------------------------------------------------
 167 // Entry point into our code: called whenever the user types a command and
 168 // then presses Enter, which the full command line that they typed.
 169 //-----------------------------------------------------------------------------
 170 int CommandReceived(char *Cmd) {
 171         return CmdsParse(CommandTable, Cmd);
 172 }
 173
 174 //-----------------------------------------------------------------------------
 175 // Entry point into our code: called whenever we received a packet over USB
 176 // that we weren't necessarily expecting, for example a debug print.
 177 //-----------------------------------------------------------------------------
 178 void UsbCommandReceived(UsbCommand *UC)
 179 {
 180         switch(UC->cmd) {
 181                 // First check if we are handling a debug message
 182                 case CMD_DEBUG_PRINT_STRING: {
 183                         char s[USB_CMD_DATA_SIZE+1];
 184                         memset(s, 0x00, sizeof(s));
 185                         size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
 186                         memcpy(s, UC->d.asBytes, len);
 187                         PrintAndLog("#db# %s", s);
 188                         return;
 189                 } break;
 190
 191                 case CMD_DEBUG_PRINT_INTEGERS: {
 192                         PrintAndLog("#db# %08x, %08x, %08x       \r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
 193                         return;
 194                 } break;
 195
 196                 case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K: {
 197                         memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
 198                         return;
 199                 } break;
 200
 201                 default: {
 202                         storeCommand(UC);
 203                         break;
 204                 }
 205         }
 206 }
 207