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 #define CMD_BUFFER_SIZE 50
  40 static UsbCommand cmdBuffer[CMD_BUFFER_SIZE];
  41 //Points to the next empty position to write to
  42 static int cmd_head;//Starts as 0
  43 //Points to the position of the last unread command
  44 static int cmd_tail;//Starts as 0
  45
  46 static command_t CommandTable[] =
  47 {
  48         {"help",        CmdHelp,        1, "This help. Use '<command> help' for details of a particular command."},
  49         {"ls",          CmdLS,          1, "list commands"},
  50         {"data",        CmdData,        1, "{ Plot window / data buffer manipulation... }"},
  51         {"hf",          CmdHF,          1, "{ High Frequency commands... }"},
  52         {"hw",          CmdHW,          1, "{ Hardware commands... }"},
  53         {"lf",          CmdLF,          1, "{ Low Frequency commands... }"},
  54         {"reveng",      CmdRev,         1, "Crc calculations from the software reveng 1.30"},
  55         {"script",      CmdScript,      1, "{ Scripting commands }"},
  56         {"quit",        CmdQuit,        1, "Exit program"},
  57         {"exit",        CmdQuit,        1, "Exit program"},
  58         {NULL, NULL, 0, NULL}
  59 };
  60
  61 command_t* getTopLevelCommandTable()
  62 {
  63   return CommandTable;
  64 }
  65 int CmdHelp(const char *Cmd)
  66 {
  67   CmdsHelp(CommandTable);
  68   return 0;
  69 }
  70 int CmdLS(const char *Cmd){
  71         CmdsLS(CommandTable);
  72         return 0;
  73 }
  74
  75 int CmdQuit(const char *Cmd)
  76 {
  77   exit(0);
  78   return 0;
  79 }
  80
  81 int CmdRev(const char *Cmd)
  82 {
  83   CmdCrc(Cmd);
  84   return 0;
  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)  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  * Waits for a certain response type. This method waits for a maximum of
 138  * ms_timeout milliseconds for a specified response command.
 139  *@brief WaitForResponseTimeout
 140  * @param cmd command to wait for
 141  * @param response struct to copy received command into.
 142  * @param ms_timeout
 143  * @return true if command was returned, otherwise false
 144  */
 145 bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
 146
 147         UsbCommand resp;
 148
 149         if (response == NULL)
 150                 response = &resp;
 151
 152         // Wait until the command is received
 153         for ( size_t dm_seconds = 0; dm_seconds < ms_timeout/10; dm_seconds++ ) {
 154
 155                 while( getCommand(response) ) {
 156                         if(response->cmd == cmd){
 157                                 return true;
 158                         }
 159                 }
 160                 msleep(10); // XXX ugh
 161                 if (dm_seconds == 200) { // Two seconds elapsed
 162                         PrintAndLog("Waiting for a response from the proxmark...");
 163                         PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
 164                 }
 165         }
 166         return false;
 167 }
 168
 169 bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
 170         return WaitForResponseTimeout(cmd, response, -1);
 171 }
 172
 173 //-----------------------------------------------------------------------------
 174 // Entry point into our code: called whenever the user types a command and
 175 // then presses Enter, which the full command line that they typed.
 176 //-----------------------------------------------------------------------------
 177 void CommandReceived(char *Cmd) {
 178   CmdsParse(CommandTable, Cmd);
 179 }
 180
 181 //-----------------------------------------------------------------------------
 182 // Entry point into our code: called whenever we received a packet over USB
 183 // that we weren't necessarily expecting, for example a debug print.
 184 //-----------------------------------------------------------------------------
 185 void UsbCommandReceived(UsbCommand *UC)
 186 {
 187         switch(UC->cmd) {
 188                 // First check if we are handling a debug message
 189                 case CMD_DEBUG_PRINT_STRING: {
 190                         char s[USB_CMD_DATA_SIZE+1] = {0x00};
 191                         size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
 192                         memcpy(s,UC->d.asBytes,len);
 193                         PrintAndLog("#db# %s       ", s);
 194                         return;
 195                 } break;
 196
 197                 case CMD_DEBUG_PRINT_INTEGERS: {
 198                         PrintAndLog("#db# %08x, %08x, %08x       \r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
 199                         return;
 200                 } break;
 201
 202                 case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K: {
 203                         memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
 204                         return;
 205                 } break;
 206
 207                 default: {
 208                         storeCommand(UC);
 209                         break;
 210                 }
 211         }
 212
 213 }
 214