+//-----------------------------------------------------------------------------
+// Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
+//
+// This code is licensed to you under the terms of the GNU GPL, version 2 or,
+// at your option, any later version. See the LICENSE.txt file for the text of
+// the license.
+//-----------------------------------------------------------------------------
+// Main command parser entry point
+//-----------------------------------------------------------------------------
+
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "sleep.h"
#include "cmdparser.h"
+#include "proxmark3.h"
#include "data.h"
#include "usb_cmd.h"
#include "ui.h"
#include "cmdhw.h"
#include "cmdlf.h"
#include "cmdmain.h"
+#include "util.h"
+#include "cmdscript.h"
+
unsigned int current_command = CMD_UNKNOWN;
-unsigned int received_command = CMD_UNKNOWN;
static int CmdHelp(const char *Cmd);
static int CmdQuit(const char *Cmd);
+//For storing command that are received from the device
+#define CMD_BUFFER_SIZE 50
+static UsbCommand cmdBuffer[CMD_BUFFER_SIZE];
+//Points to the next empty position to write to
+static int cmd_head;//Starts as 0
+//Points to the position of the last unread command
+static int cmd_tail;//Starts as 0
+
static command_t CommandTable[] =
{
- {"help", CmdHelp, 1, "This help. Use '<command> help' for details of the following commands:\n"},
- {"data", CmdData, 1, "{ Plot window / data buffer manipulation... }"},
- {"exit", CmdQuit, 1, "Exit program"},
- {"hf", CmdHF, 1, "{ HF commands... }"},
- {"hw", CmdHW, 1, "{ Hardware commands... }"},
- {"lf", CmdLF, 1, "{ LF commands... }"},
- {"quit", CmdQuit, 1, "Quit program"},
- {NULL, NULL, 0, NULL}
+ {"help", CmdHelp, 1, "This help. Use '<command> help' for details of a particular command."},
+ {"data", CmdData, 1, "{ Plot window / data buffer manipulation... }"},
+ {"hf", CmdHF, 1, "{ High Frequency commands... }"},
+ {"hw", CmdHW, 1, "{ Hardware commands... }"},
+ {"lf", CmdLF, 1, "{ Low Frequency commands... }"},
+ {"script", CmdScript, 1, "{ Scripting commands }"},
+ {"quit", CmdQuit, 1, "Exit program"},
+ {"exit", CmdQuit, 1, "Exit program"},
+ {NULL, NULL, 0, NULL}
};
+command_t* getTopLevelCommandTable()
+{
+ return CommandTable;
+}
int CmdHelp(const char *Cmd)
{
CmdsHelp(CommandTable);
int CmdQuit(const char *Cmd)
{
- exit(0);
- return 0;
+ return 99;
+}
+/**
+ * @brief This method should be called when sending a new command to the pm3. In case any old
+ * responses from previous commands are stored in the buffer, a call to this method should clear them.
+ * A better method could have been to have explicit command-ACKS, so we can know which ACK goes to which
+ * operation. Right now we'll just have to live with this.
+ */
+void clearCommandBuffer()
+{
+ //This is a very simple operation
+ cmd_tail = cmd_head;
}
-void WaitForResponse(uint32_t response_type)
+/**
+ * @brief storeCommand stores a USB command in a circular buffer
+ * @param UC
+ */
+void storeCommand(UsbCommand *command)
{
- while (received_command != response_type) {
-#ifdef WIN32
- // FIXME: Do we really need this under windows or is it
- // just some historical code?
- // pthread seems to be availabe for win32 nowadays
- // so we should be able to port the code and get rid
- // of this part.
- UsbCommand c;
- if (ReceiveCommandPoll(&c))
- UsbCommandReceived(&c);
-#endif
- msleep(10); // XXX ugh
- }
- received_command = CMD_UNKNOWN;
+ if( ( cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
+ {
+ //If these two are equal, we're about to overwrite in the
+ // circular buffer.
+ PrintAndLog("WARNING: Command buffer about to overwrite command! This needs to be fixed!");
+ }
+ //Store the command at the 'head' location
+ UsbCommand* destination = &cmdBuffer[cmd_head];
+ memcpy(destination, command, sizeof(UsbCommand));
+
+ cmd_head = (cmd_head +1) % CMD_BUFFER_SIZE; //increment head and wrap
}
+
+/**
+ * @brief getCommand gets a command from an internal circular buffer.
+ * @param response location to write command
+ * @return 1 if response was returned, 0 if nothing has been received
+ */
+int getCommand(UsbCommand* response)
+{
+ //If head == tail, there's nothing to read, or if we just got initialized
+ if(cmd_head == cmd_tail){
+ return 0;
+ }
+ //Pick out the next unread command
+ UsbCommand* last_unread = &cmdBuffer[cmd_tail];
+ memcpy(response, last_unread, sizeof(UsbCommand));
+ //Increment tail - this is a circular buffer, so modulo buffer size
+ cmd_tail = (cmd_tail +1 ) % CMD_BUFFER_SIZE;
+
+ return 1;
+}
+
+
+/**
+ * Waits for a certain response type. This method waits for a maximum of
+ * ms_timeout milliseconds for a specified response command.
+ *@brief WaitForResponseTimeout
+ * @param cmd command to wait for
+ * @param response struct to copy received command into.
+ * @param ms_timeout
+ * @return true if command was returned, otherwise false
+ */
+bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
+
+ UsbCommand resp;
+
+ if (response == NULL) {
+ response = &resp;
+ }
+
+ // Wait until the command is received
+ for(size_t dm_seconds=0; dm_seconds < ms_timeout/10; dm_seconds++) {
+ while(getCommand(response)) {
+ if(response->cmd == cmd){
+ return true;
+ }
+ }
+ msleep(10); // XXX ugh
+ if (dm_seconds == 200) { // Two seconds elapsed
+ PrintAndLog("Waiting for a response from the proxmark...");
+ PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
+ }
+ }
+ return false;
+}
+
+
+bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
+ return WaitForResponseTimeout(cmd,response,-1);
+}
+
+
//-----------------------------------------------------------------------------
// Entry point into our code: called whenever the user types a command and
// then presses Enter, which the full command line that they typed.
//-----------------------------------------------------------------------------
-void CommandReceived(char *Cmd)
-{
- CmdsParse(CommandTable, Cmd);
+int CommandReceived(char *Cmd) {
+ return CmdsParse(CommandTable, Cmd);
}
+
//-----------------------------------------------------------------------------
// Entry point into our code: called whenever we received a packet over USB
// that we weren't necessarily expecting, for example a debug print.
//-----------------------------------------------------------------------------
void UsbCommandReceived(UsbCommand *UC)
{
- // printf("%s(%x) current cmd = %x\n", __FUNCTION__, c->cmd, current_command);
- /* If we recognize a response, return to avoid further processing */
- switch(UC->cmd) {
- case CMD_DEBUG_PRINT_STRING: {
- char s[100];
- if(UC->arg[0] > 70 || UC->arg[0] < 0) {
- UC->arg[0] = 0;
- }
- memcpy(s, UC->d.asBytes, UC->arg[0]);
- s[UC->arg[0]] = '\0';
- PrintAndLog("#db# %s", s);
- return;
- }
+ switch(UC->cmd) {
+ // First check if we are handling a debug message
+ case CMD_DEBUG_PRINT_STRING: {
+ char s[USB_CMD_DATA_SIZE+1] = {0x00};
+ size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
+ memcpy(s,UC->d.asBytes,len);
+ PrintAndLog("#db# %s ", s);
+ return;
+ } break;
+
+ case CMD_DEBUG_PRINT_INTEGERS: {
+ PrintAndLog("#db# %08x, %08x, %08x \r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
+ return;
+ } break;
+
+ case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K: {
+ memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
+ return;
+ } break;
+
+ default:
+ storeCommand(UC);
+ break;
+ }
- case CMD_DEBUG_PRINT_INTEGERS:
- PrintAndLog("#db# %08x, %08x, %08x\r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
- return;
-
- case CMD_MEASURED_ANTENNA_TUNING: {
- int peakv, peakf;
- int vLf125, vLf134, vHf;
- vLf125 = UC->arg[0] & 0xffff;
- vLf134 = UC->arg[0] >> 16;
- vHf = UC->arg[1] & 0xffff;;
- peakf = UC->arg[2] & 0xffff;
- peakv = UC->arg[2] >> 16;
- PrintAndLog("");
- PrintAndLog("");
- PrintAndLog("# LF antenna: %5.2f V @ 125.00 kHz", vLf125/1000.0);
- PrintAndLog("# LF antenna: %5.2f V @ 134.00 kHz", vLf134/1000.0);
- PrintAndLog("# LF optimal: %5.2f V @%9.2f kHz", peakv/1000.0, 12000.0/(peakf+1));
- PrintAndLog("# HF antenna: %5.2f V @ 13.56 MHz", vHf/1000.0);
- if (peakv<2000)
- PrintAndLog("# Your LF antenna is unusable.");
- else if (peakv<10000)
- PrintAndLog("# Your LF antenna is marginal.");
- if (vHf<2000)
- PrintAndLog("# Your HF antenna is unusable.");
- else if (vHf<5000)
- PrintAndLog("# Your HF antenna is marginal.");
- return;
- }
- default:
- break;
- }
- /* Maybe it's a response: */
- switch(current_command) {
- case CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K:
- if (UC->cmd != CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K) goto unexpected_response;
- int i;
- for(i=0; i<48; i++) sample_buf[i] = UC->d.asBytes[i];
- received_command = UC->cmd;
- return;
- case CMD_ACQUIRE_RAW_ADC_SAMPLES_125K:
- case CMD_DOWNLOADED_SIM_SAMPLES_125K:
- if (UC->cmd != CMD_ACK) goto unexpected_response;
- // got ACK
- received_command = UC->cmd;
- return;
- default:
- unexpected_response:
- PrintAndLog("unrecognized command %08x\n", UC->cmd);
- break;
- }
}
+
projects / proxmark3-svn / blobdiff