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