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