Merge pull request #638 from grauerfuchs/master

[proxmark3-svn] / client / comms.c

diff --git a/client/comms.c b/client/comms.c
index b62f6fda47e3f94c796345e118ae052b27c323b5..2030f8f3ea6010946bbc990aa1dcbc805c9bbbfd 100644 (file)
--- a/client/comms.c
+++ b/client/comms.c
@@ -9,33 +9,42 @@
 // Code for communicating with the proxmark3 hardware.
 //-----------------------------------------------------------------------------
 
 // Code for communicating with the proxmark3 hardware.
 //-----------------------------------------------------------------------------
 

-#include <pthread.h>
-

 #include "comms.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 "util_posix.h"
 
 #include "uart.h"
 #include "ui.h"
 #include "common.h"
 #include "util_posix.h"
 

-// Declare globals.

 
 // Serial port that we are communicating with the PM3 on.
 
 // Serial port that we are communicating with the PM3 on.

-static 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;
 
 
 // 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.
 // 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})
 
 // 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;
 
 // Points to the next empty position to write to
 static int cmd_head = 0;


@@ -43,8 +52,8 @@ static int cmd_head = 0;
 // Points to the position of the last unread command
 static int cmd_tail = 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.
 
 // These wrappers are required because it is not possible to access a static
 // global variable outside of the context of a single file.


@@ -57,38 +66,6 @@ bool IsOffline() {
        return offline;
 }
 
        return offline;
 }
 

-bool OpenProxmark(char *portname, bool waitCOMPort, int timeout) {
-       if (!waitCOMPort) {
-               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");
-               return false;
-       } else if (sp == CLAIMED_SERIAL_PORT) {
-               printf("ERROR: serial port is claimed by another process\n");
-               return false;
-       } else {
-               return true;
-       }
-}
-
-void CloseProxmark(void) {
-       uart_close(sp);
-}
-

 void SendCommand(UsbCommand *c) {
        #ifdef COMMS_DEBUG
        printf("Sending %04x cmd\n", c->cmd);
 void SendCommand(UsbCommand *c) {
        #ifdef COMMS_DEBUG
        printf("Sending %04x cmd\n", c->cmd);


@@ -98,15 +75,22 @@ void SendCommand(UsbCommand *c) {
                PrintAndLog("Sending bytes to proxmark failed - offline");
                return;
     }
                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);
+       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);

 
 

-       txcmd = *c;
-       txcmd_pending = true;

 }
 
 
 }
 
 


@@ -119,18 +103,18 @@ void SendCommand(UsbCommand *c) {
 void clearCommandBuffer()
 {
        //This is a very simple operation
 void clearCommandBuffer()
 {
        //This is a very simple operation

-       pthread_mutex_lock(&cmdBufferMutex);
+       pthread_mutex_lock(&rxBufferMutex);

        cmd_tail = cmd_head;
        cmd_tail = cmd_head;

-       pthread_mutex_unlock(&cmdBufferMutex);
+       pthread_mutex_unlock(&rxBufferMutex);

 }
 
 /**
  * @brief storeCommand stores a USB command in a circular buffer
  * @param UC
  */
 }
 
 /**
  * @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
        if( (cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
        {
                // If these two are equal, we're about to overwrite in the


@@ -139,11 +123,11 @@ void storeCommand(UsbCommand *command)
        }
 
        // Store the command at the 'head' location
        }
 
        // 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
        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);

 }
 
 
 }
 
 


@@ -152,22 +136,22 @@ void storeCommand(UsbCommand *command)
  * @param response location to write command
  * @return 1 if response was returned, 0 if nothing has been received
  */
  * @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){
        //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
                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;
 
        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;
 }
 
        return 1;
 }
 


@@ -202,35 +186,54 @@ static void UsbCommandReceived(UsbCommand *UC)
 }
 
 
 }
 
 

-void
+static void

 #ifdef __has_attribute
 #if __has_attribute(force_align_arg_pointer)
 __attribute__((force_align_arg_pointer)) 
 #endif
 #endif
 #ifdef __has_attribute
 #if __has_attribute(force_align_arg_pointer)
 __attribute__((force_align_arg_pointer)) 
 #endif
 #endif

-*uart_receiver(void *targ) {
-       receiver_arg *conn = (receiver_arg*)targ;
+*uart_communication(void *targ) {
+       communication_arg_t *conn = (communication_arg_t*)targ;

        size_t rxlen;
        size_t rxlen;

-       uint8_t rx[sizeof(UsbCommand)];
-       uint8_t *prx = rx;
+       UsbCommand rx;
+       UsbCommand *prx = &rx;

 
        while (conn->run) {
                rxlen = 0;
 
        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;
                        prx += rxlen;

-                       if (prx-rx < sizeof(UsbCommand)) {
+                       if (prx-&rx < sizeof(UsbCommand)) {

                                continue;
                        }
                                continue;
                        }

-                       UsbCommandReceived((UsbCommand*)rx);
+                       UsbCommandReceived(&rx);
+                       if (rx.cmd == CMD_ACK) {
+                               ACK_received = true;
+                       }

                }
                }

-               prx = rx;
+               prx = &rx;

 
 

-               if(txcmd_pending) {
-                       if (!uart_send(sp, (uint8_t*) &txcmd, sizeof(UsbCommand))) {
+               
+               pthread_mutex_lock(&txBufferMutex);
+
+               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");
                        }
                                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);

        }
 
        pthread_exit(NULL);
        }
 
        pthread_exit(NULL);


@@ -238,7 +241,6 @@ __attribute__((force_align_arg_pointer))
 }
 
 
 }
 
 

-

 /**
  * Data transfer from Proxmark to client. This method times out after
  * ms_timeout milliseconds.
 /**
  * Data transfer from Proxmark to client. This method times out after
  * ms_timeout milliseconds.


@@ -289,6 +291,68 @@ bool GetFromBigBuf(uint8_t *dest, int bytes, int start_index, UsbCommand *respon
        return 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;
+       pthread_join(USB_communication_thread, NULL);
+
+       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;
+}
+

 
 /**
  * Waits for a certain response type. This method waits for a maximum of
 
 /**
  * Waits for a certain response type. This method waits for a maximum of