]> git.zerfleddert.de Git - proxmark3-svn/blobdiff - client/comms.c
fix hf mf sim (#812)
[proxmark3-svn] / client / comms.c
index 2dd5534ce7ed53e4c608292d94cef90d4f0aa261..5af53715e9fa27470ca934dae87e968553ae0a2a 100644 (file)
@@ -9,34 +9,43 @@
 // Code for communicating with the proxmark3 hardware.
 //-----------------------------------------------------------------------------
 
-#include <pthread.h>
-
 #include "comms.h"
+
+#include <pthread.h>
+#if defined(__linux__) && !defined(NO_UNLINK)
+#include <unistd.h>            // for unlink()
+#endif
 #include "uart.h"
 #include "ui.h"
 #include "common.h"
-#include "data.h"
+#include "util_darwin.h"
 #include "util_posix.h"
 
-// Declare globals.
 
 // Serial port that we are communicating with the PM3 on.
-serial_port sp;
+static serial_port sp = NULL;
+static char *serial_port_name = NULL;
 
 // If TRUE, then there is no active connection to the PM3, and we will drop commands sent.
 static bool offline;
 
+typedef struct {
+       bool run; // If TRUE, continue running the uart_communication thread
+       bool block_after_ACK; // if true, block after receiving an ACK package
+} communication_arg_t;
+
+static communication_arg_t conn;
+static pthread_t USB_communication_thread;
+
 // Transmit buffer.
-// TODO: Use locks and execute this on the main thread, rather than the receiver
-// thread.  Running on the main thread means we need to be careful in the
-// flasher, as it means SendCommand is no longer async, and can't be used as a
-// buffer for a pending command when the connection is re-established.
-static UsbCommand txcmd;
-volatile static bool txcmd_pending = false;
+static UsbCommand txBuffer;
+static bool txBuffer_pending = false;
+static pthread_mutex_t txBufferMutex = PTHREAD_MUTEX_INITIALIZER;
+static pthread_cond_t txBufferSig = PTHREAD_COND_INITIALIZER;
 
 // Used by UsbReceiveCommand as a ring buffer for messages that are yet to be
 // processed by a command handler (WaitForResponse{,Timeout})
-static UsbCommand cmdBuffer[CMD_BUFFER_SIZE];
+static UsbCommand rxBuffer[CMD_BUFFER_SIZE];
 
 // Points to the next empty position to write to
 static int cmd_head = 0;
@@ -44,8 +53,8 @@ static int cmd_head = 0;
 // Points to the position of the last unread command
 static int cmd_tail = 0;
 
-// to lock cmdBuffer operations from different threads
-static pthread_mutex_t cmdBufferMutex = PTHREAD_MUTEX_INITIALIZER;
+// to lock rxBuffer operations from different threads
+static pthread_mutex_t rxBufferMutex = PTHREAD_MUTEX_INITIALIZER;
 
 // These wrappers are required because it is not possible to access a static
 // global variable outside of the context of a single file.
@@ -67,14 +76,22 @@ void SendCommand(UsbCommand *c) {
                PrintAndLog("Sending bytes to proxmark failed - offline");
                return;
     }
+
+       pthread_mutex_lock(&txBufferMutex);
        /**
-       The while-loop below causes hangups at times, when the pm3 unit is unresponsive
-       or disconnected. The main console thread is alive, but comm thread just spins here.
-       Not good.../holiman
+       This causes hangups at times, when the pm3 unit is unresponsive or disconnected. The main console thread is alive, 
+       but comm thread just spins here. Not good.../holiman
        **/
-       while(txcmd_pending);
-       txcmd = *c;
-       txcmd_pending = true;
+       while (txBuffer_pending) {
+               pthread_cond_wait(&txBufferSig, &txBufferMutex); // wait for communication thread to complete sending a previous commmand
+       }
+
+       txBuffer = *c;
+       txBuffer_pending = true;
+       pthread_cond_signal(&txBufferSig); // tell communication thread that a new command can be send
+
+       pthread_mutex_unlock(&txBufferMutex);
+
 }
 
 
@@ -87,18 +104,18 @@ void SendCommand(UsbCommand *c) {
 void clearCommandBuffer()
 {
        //This is a very simple operation
-       pthread_mutex_lock(&cmdBufferMutex);
+       pthread_mutex_lock(&rxBufferMutex);
        cmd_tail = cmd_head;
-       pthread_mutex_unlock(&cmdBufferMutex);
+       pthread_mutex_unlock(&rxBufferMutex);
 }
 
 /**
  * @brief storeCommand stores a USB command in a circular buffer
  * @param UC
  */
-void storeCommand(UsbCommand *command)
+static void storeCommand(UsbCommand *command)
 {
-       pthread_mutex_lock(&cmdBufferMutex);
+       pthread_mutex_lock(&rxBufferMutex);
        if( (cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
        {
                // If these two are equal, we're about to overwrite in the
@@ -107,11 +124,11 @@ void storeCommand(UsbCommand *command)
        }
 
        // Store the command at the 'head' location
-       UsbCommand* destination = &cmdBuffer[cmd_head];
+       UsbCommand* destination = &rxBuffer[cmd_head];
        memcpy(destination, command, sizeof(UsbCommand));
 
        cmd_head = (cmd_head +1) % CMD_BUFFER_SIZE; //increment head and wrap
-       pthread_mutex_unlock(&cmdBufferMutex);
+       pthread_mutex_unlock(&rxBufferMutex);
 }
 
 
@@ -120,31 +137,31 @@ void storeCommand(UsbCommand *command)
  * @param response location to write command
  * @return 1 if response was returned, 0 if nothing has been received
  */
-int getCommand(UsbCommand* response)
+static int getCommand(UsbCommand* response)
 {
-       pthread_mutex_lock(&cmdBufferMutex);
+       pthread_mutex_lock(&rxBufferMutex);
        //If head == tail, there's nothing to read, or if we just got initialized
        if (cmd_head == cmd_tail){
-               pthread_mutex_unlock(&cmdBufferMutex);
+               pthread_mutex_unlock(&rxBufferMutex);
                return 0;
        }
 
        //Pick out the next unread command
-       UsbCommand* last_unread = &cmdBuffer[cmd_tail];
+       UsbCommand* last_unread = &rxBuffer[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;
 
-       pthread_mutex_unlock(&cmdBufferMutex);
+       pthread_mutex_unlock(&rxBufferMutex);
        return 1;
 }
 
 
-//-----------------------------------------------------------------------------
-// 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)
+//----------------------------------------------------------------------------------
+// Entry point into our code: called whenever we received a packet over USB.
+// Handle debug commands directly, store all other commands in circular buffer.
+//----------------------------------------------------------------------------------
+static void UsbCommandReceived(UsbCommand *UC)
 {
        switch(UC->cmd) {
                // First check if we are handling a debug message
@@ -162,57 +179,239 @@ void UsbCommandReceived(UsbCommand *UC)
                        return;
                } break;
 
-               case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K: {
-                       // FIXME: This does unsanitised copies into memory when we don't know
-                       // the size of the buffer.
-                       memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
-                       return;
-               } break;
-
                default:
-                       storeCommand(UC);
+                       storeCommand(UC);
                        break;
        }
 
 }
 
 
-void
+static void
 #ifdef __has_attribute
 #if __has_attribute(force_align_arg_pointer)
 __attribute__((force_align_arg_pointer)) 
 #endif
 #endif
-*uart_receiver(void *targ) {
-       receiver_arg *arg = (receiver_arg*)targ;
+*uart_communication(void *targ) {
+       communication_arg_t *conn = (communication_arg_t*)targ;
        size_t rxlen;
-       uint8_t rx[sizeof(UsbCommand)];
-       uint8_t *prx = rx;
+       UsbCommand rx;
+       UsbCommand *prx = &rx;
+
+#if defined(__MACH__) && defined(__APPLE__)
+       disableAppNap("Proxmark3 polling UART");
+#endif
 
-       while (arg->run) {
+       while (conn->run) {
                rxlen = 0;
-               if (uart_receive(sp, prx, sizeof(UsbCommand) - (prx-rx), &rxlen) && rxlen) {
+               bool ACK_received = false;
+               if (uart_receive(sp, (uint8_t *)prx, sizeof(UsbCommand) - (prx-&rx), &rxlen) && rxlen) {
                        prx += rxlen;
-                       if (prx-rx < sizeof(UsbCommand)) {
+                       if (prx-&rx < sizeof(UsbCommand)) {
                                continue;
                        }
-                       UsbCommandReceived((UsbCommand*)rx);
+                       UsbCommandReceived(&rx);
+                       if (rx.cmd == CMD_ACK) {
+                               ACK_received = true;
+                       }
                }
-               prx = rx;
+               prx = &rx;
+
+               
+               pthread_mutex_lock(&txBufferMutex);
 
-               if(txcmd_pending) {
-                       if (!uart_send(sp, (uint8_t*) &txcmd, sizeof(UsbCommand))) {
+               if (conn->block_after_ACK) {
+                       // if we just received an ACK, wait here until a new command is to be transmitted
+                       if (ACK_received) {
+                               while (!txBuffer_pending) {
+                                       pthread_cond_wait(&txBufferSig, &txBufferMutex);
+                               }
+                       }
+               }
+                               
+               if(txBuffer_pending) {
+                       if (!uart_send(sp, (uint8_t*) &txBuffer, sizeof(UsbCommand))) {
                                PrintAndLog("Sending bytes to proxmark failed");
                        }
-                       txcmd_pending = false;
+                       txBuffer_pending = false;
+                       pthread_cond_signal(&txBufferSig); // tell main thread that txBuffer is empty
                }
+
+               pthread_mutex_unlock(&txBufferMutex);
        }
 
+#if defined(__MACH__) && defined(__APPLE__)
+       enableAppNap();
+#endif
+
        pthread_exit(NULL);
        return NULL;
 }
 
 
+/**
+ * Data transfer from Proxmark to client. This method times out after
+ * ms_timeout milliseconds.
+ * @brief GetFromBigBuf
+ * @param dest Destination address for transfer
+ * @param bytes number of bytes to be transferred
+ * @param start_index offset into Proxmark3 BigBuf[]
+ * @param response struct to copy last command (CMD_ACK) into
+ * @param ms_timeout timeout in milliseconds
+ * @param show_warning display message after 2 seconds
+ * @return true if command was returned, otherwise false
+ */
+bool GetFromBigBuf(uint8_t *dest, int bytes, int start_index, UsbCommand *response, size_t ms_timeout, bool show_warning)
+{
+       UsbCommand c = {CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K, {start_index, bytes, 0}};
+       SendCommand(&c);
+
+       uint64_t start_time = msclock();
+
+       UsbCommand resp;
+       if (response == NULL) {
+               response = &resp;
+       }
+
+       int bytes_completed = 0;
+       while(true) {
+               if (getCommand(response)) {
+                       if (response->cmd == CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K) {
+                               int copy_bytes = MIN(bytes - bytes_completed, response->arg[1]);
+                               memcpy(dest + response->arg[0], response->d.asBytes, copy_bytes);
+                               bytes_completed += copy_bytes;
+                       } else if (response->cmd == CMD_ACK) {
+                               return true;
+                       }
+               }
+
+               if (msclock() - start_time > ms_timeout) {
+                       break;
+               }
+
+               if (msclock() - start_time > 2000 && show_warning) {
+                       PrintAndLog("Waiting for a response from the proxmark...");
+                       PrintAndLog("You can cancel this operation by pressing the pm3 button");
+                       show_warning = false;
+               }
+       }
+
+       return false;
+}
+
+       
+bool GetFromFpgaRAM(uint8_t *dest, int bytes)
+{
+       UsbCommand c = {CMD_HF_PLOT, {0, 0, 0}};
+       SendCommand(&c);
+
+       uint64_t start_time = msclock();
+
+       UsbCommand response;
+       
+       int bytes_completed = 0;
+       bool show_warning = true;
+       while(true) {
+               if (getCommand(&response)) {
+                       if (response.cmd == CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K) {
+                               int copy_bytes = MIN(bytes - bytes_completed, response.arg[1]);
+                               memcpy(dest + response.arg[0], response.d.asBytes, copy_bytes);
+                               bytes_completed += copy_bytes;
+                       } else if (response.cmd == CMD_ACK) {
+                               return true;
+                       }
+               }
+
+               if (msclock() - start_time > 2000 && show_warning) {
+                       PrintAndLog("Waiting for a response from the proxmark...");
+                       PrintAndLog("You can cancel this operation by pressing the pm3 button");
+                       show_warning = false;
+               }
+       }
+
+       return false;
+}
+
+
+bool OpenProxmark(void *port, bool wait_for_port, int timeout, bool flash_mode) {
+       char *portname = (char *)port;
+       if (!wait_for_port) {
+               sp = uart_open(portname);
+       } else {
+               printf("Waiting for Proxmark to appear on %s ", portname);
+               fflush(stdout);
+               int openCount = 0;
+               do {
+                       sp = uart_open(portname);
+                       msleep(1000);
+                       printf(".");
+                       fflush(stdout);
+               } while(++openCount < timeout && (sp == INVALID_SERIAL_PORT || sp == CLAIMED_SERIAL_PORT));
+               printf("\n");
+       }
+
+       // check result of uart opening
+       if (sp == INVALID_SERIAL_PORT) {
+               printf("ERROR: invalid serial port\n");
+               sp = NULL;
+               serial_port_name = NULL;
+               return false;
+       } else if (sp == CLAIMED_SERIAL_PORT) {
+               printf("ERROR: serial port is claimed by another process\n");
+               sp = NULL;
+               serial_port_name = NULL;
+               return false;
+       } else {
+               // start the USB communication thread
+               serial_port_name = portname;
+               conn.run = true;
+               conn.block_after_ACK = flash_mode;
+               pthread_create(&USB_communication_thread, NULL, &uart_communication, &conn);
+               return true;
+       }
+}
+
+
+void CloseProxmark(void) {
+       conn.run = false;
+
+#ifdef __BIONIC__
+       // In Android O and later, if an invalid pthread_t is passed to pthread_join, it calls fatal().
+       // https://github.com/aosp-mirror/platform_bionic/blob/ed16b344e75f422fb36fbfd91fb30de339475880/libc/bionic/pthread_internal.cpp#L116-L128
+       //
+       // In Bionic libc, pthread_t is an integer.
+
+       if (USB_communication_thread != 0) {
+               pthread_join(USB_communication_thread, NULL);
+       }
+#else
+       // pthread_t is a struct on other libc, treat as an opaque memory reference
+       pthread_join(USB_communication_thread, NULL);
+#endif
+
+       if (sp) {
+               uart_close(sp);
+       }
+
+#if defined(__linux__) && !defined(NO_UNLINK)
+       // Fix for linux, it seems that it is extremely slow to release the serial port file descriptor /dev/*
+       //
+       // This may be disabled at compile-time with -DNO_UNLINK (used for a JNI-based serial port on Android).
+       if (serial_port_name) {
+               unlink(serial_port_name);
+       }
+#endif
+
+       // Clean up our state
+       sp = NULL;
+       serial_port_name = NULL;
+#ifdef __BIONIC__
+       memset(&USB_communication_thread, 0, sizeof(pthread_t));
+#endif
+}
+
+
 /**
  * Waits for a certain response type. This method waits for a maximum of
  * ms_timeout milliseconds for a specified response command.
@@ -220,7 +419,7 @@ __attribute__((force_align_arg_pointer))
  * @param cmd command to wait for, or CMD_UNKNOWN to take any command.
  * @param response struct to copy received command into.
  * @param ms_timeout
- * @param show_warning
+ * @param show_warning display message after 2 seconds
  * @return true if command was returned, otherwise false
  */
 bool WaitForResponseTimeoutW(uint32_t cmd, UsbCommand* response, size_t ms_timeout, bool show_warning) {
Impressum, Datenschutz