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