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