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