]> git.zerfleddert.de Git - proxmark3-svn/blobdiff - client/cmdmain.c
Fixes to implement generation of markdown auto-generated documentation
[proxmark3-svn] / client / cmdmain.c
index 434f9e6e0f47bd72b48dad5896f7534af68e2f5d..fa358fac8b2211b0ae27eb1e32a746830303807b 100644 (file)
 #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;
-UsbCommand current_response;
-UsbCommand current_response_user;
+//unsigned int received_command = CMD_UNKNOWN;
+//UsbCommand current_response;
+//UsbCommand current_response_user;
 
 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"},
+  {"help",  CmdHelp,  1, "This help. Use '<command> help' for details of a particular command."},
   {"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"},
+  {"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);
@@ -55,30 +71,92 @@ int CmdQuit(const char *Cmd)
   exit(0);
   return 0;
 }
+/**
+ * @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;
+}
 
-bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
+/**
+ * @brief storeCommand stores a USB command in a circular buffer
+ * @param UC
+ */
+void storeCommand(UsbCommand *command)
+{
+    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));
 
-       // Wait until the command is received
-  for(size_t i=0; received_command != cmd && i < ms_timeout/10; i++) {
-               msleep(10); // XXX ugh
-    if (i == 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");
+    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;
     }
-       }
-       
-  // Check if timeout occured
-  if(received_command != cmd) return false;
+    //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;
 
-       // Copy the received response (if supplied)
-  if (response) {
-    memcpy(response, &current_response, sizeof(UsbCommand));
+    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) {
+  
+  if (response == NULL) {
+    UsbCommand resp;
+    response = &resp;
   }
 
-       // Reset the received command
-  received_command = CMD_UNKNOWN;
+  // 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){
+          //We got what we expected
+          return true;
+          }
 
-       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) {
@@ -99,17 +177,25 @@ void CommandReceived(char *Cmd) {
 //-----------------------------------------------------------------------------
 void UsbCommandReceived(UsbCommand *UC)
 {
+  /*
+  //  Debug
+  printf("UsbCommand length[len=%zd]\n",sizeof(UsbCommand));
+  printf("  cmd[len=%zd]: %"llx"\n",sizeof(UC->cmd),UC->cmd);
+  printf(" arg0[len=%zd]: %"llx"\n",sizeof(UC->arg[0]),UC->arg[0]);
+  printf(" arg1[len=%zd]: %"llx"\n",sizeof(UC->arg[1]),UC->arg[1]);
+  printf(" arg2[len=%zd]: %"llx"\n",sizeof(UC->arg[2]),UC->arg[2]);
+  printf(" data[len=%zd]: %02x%02x%02x...\n",sizeof(UC->d.asBytes),UC->d.asBytes[0],UC->d.asBytes[1],UC->d.asBytes[2]);
+  */
+
   //   printf("%s(%x) current cmd = %x\n", __FUNCTION__, c->cmd, current_command);
-  /* If we recognize a response, return to avoid further processing */
+  // If we recognize a response, return to avoid further processing
   switch(UC->cmd) {
-    // First check if we are handling a debug message
+      // First check if we are handling a debug message
     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';
+      char s[USB_CMD_DATA_SIZE+1];
+      size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
+      memcpy(s,UC->d.asBytes,len);
+      s[len] = 0x00;
       PrintAndLog("#db# %s       ", s);
       return;
     } break;
@@ -157,6 +243,7 @@ void UsbCommandReceived(UsbCommand *UC)
 
     default: {
       // Maybe it's a response
+      /*
       switch(current_command) {
         case CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K: {
           if (UC->cmd != CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K) {
@@ -168,43 +255,17 @@ void UsbCommandReceived(UsbCommand *UC)
           memcpy(sample_buf+UC->arg[0],UC->d.asBytes,48);
           sample_buf_len += 48;
 //          for(i=0; i<48; i++) sample_buf[i] = UC->d.asBytes[i];
-          received_command = UC->cmd;
+          //received_command = UC->cmd;
         } break;
 
         default: {
         } break;
-      }
-//      // Store the last received command
-//      memcpy(&current_response, UC, sizeof(UsbCommand));
-//      received_command = UC->cmd;
-    } break;
-  }
-  // Store the last received command
-  memcpy(&current_response, UC, sizeof(UsbCommand));
-  received_command = UC->cmd;
-/*
-  // 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:
-
-       if(UC->cmd != CMD_ACK)
-               PrintAndLog("unrecognized command %08x       \n", UC->cmd);
-       else
-               memcpy(&current_response, UC, sizeof(UsbCommand));
-       received_command = UC->cmd;
+      }*/
+    }
+      break;
   }
- */
+
+  storeCommand(UC);
+
 }
+
Impressum, Datenschutz