//----------------------------------------------------------------------------- // Copyright (C) 2009 Michael Gernoth // Copyright (C) 2010 iZsh // // 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. //----------------------------------------------------------------------------- // Code for communicating with the proxmark3 hardware. //----------------------------------------------------------------------------- #include "comms.h" #include "crc16.h" #if defined(__linux__) || (__APPLE__) #include #include #endif //#define COMMS_DEBUG //#define COMMS_DEBUG_RAW // Serial port that we are communicating with the PM3 on. static serial_port sp = NULL; communication_arg_t conn; capabilities_t pm3_capabilities; static pthread_t communication_thread; static bool comm_thread_dead = false; // Transmit buffer. static PacketCommandOLD txBuffer; static PacketCommandNGRaw txBufferNG; size_t txBufferNGLen; static bool txBuffer_pending = false; static pthread_mutex_t txBufferMutex = PTHREAD_MUTEX_INITIALIZER; static pthread_cond_t txBufferSig = PTHREAD_COND_INITIALIZER; // Used by PacketResponseReceived as a ring buffer for messages that are yet to be // processed by a command handler (WaitForResponse{,Timeout}) static PacketResponseNG rxBuffer[CMD_BUFFER_SIZE]; // Points to the next empty position to write to static int cmd_head = 0; // Points to the position of the last unread command static int cmd_tail = 0; // to lock rxBuffer operations from different threads static pthread_mutex_t rxBufferMutex = PTHREAD_MUTEX_INITIALIZER; // Global start time for WaitForResponseTimeout & dl_it, so we can reset timeout when we get packets // as sending lot of these packets can slow down things wuite a lot on slow links (e.g. hw status or lf read at 9600) static uint64_t timeout_start_time; static bool dl_it(uint8_t *dest, uint32_t bytes, uint32_t start_index, PacketResponseNG *response, size_t ms_timeout, bool show_warning, uint32_t rec_cmd); // Simple alias to track usages linked to the Bootloader, these commands must not be migrated. // - commands sent to enter bootloader mode as we might have to talk to old firmwares // - commands sent to the bootloader as it only supports OLD frames (which will always be the case for old BL) void SendCommandBL(uint64_t cmd, uint64_t arg0, uint64_t arg1, uint64_t arg2, void *data, size_t len) { SendCommandOLD(cmd, arg0, arg1, arg2, data, len); } void SendCommandOLD(uint64_t cmd, uint64_t arg0, uint64_t arg1, uint64_t arg2, void *data, size_t len) { PacketCommandOLD c = {CMD_UNKNOWN, {0, 0, 0}, {{0}}}; c.cmd = cmd; c.arg[0] = arg0; c.arg[1] = arg1; c.arg[2] = arg2; if (len && data) memcpy(&c.d, data, len); #ifdef COMMS_DEBUG PrintAndLogEx(NORMAL, "Sending %s", "OLD"); #endif #ifdef COMMS_DEBUG_RAW print_hex_break((uint8_t *)&c.cmd, sizeof(c.cmd), 32); print_hex_break((uint8_t *)&c.arg, sizeof(c.arg), 32); print_hex_break((uint8_t *)&c.d, sizeof(c.d), 32); #endif if (!session.pm3_present) { PrintAndLogEx(WARNING, "Sending bytes to Proxmark3 failed." _YELLOW_("offline")); return; } pthread_mutex_lock(&txBufferMutex); /** 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 (txBuffer_pending) { // wait for communication thread to complete sending a previous commmand pthread_cond_wait(&txBufferSig, &txBufferMutex); } txBuffer = c; txBuffer_pending = true; // tell communication thread that a new command can be send pthread_cond_signal(&txBufferSig); pthread_mutex_unlock(&txBufferMutex); //__atomic_test_and_set(&txcmd_pending, __ATOMIC_SEQ_CST); } static void SendCommandNG_internal(uint16_t cmd, uint8_t *data, size_t len, bool ng) { #ifdef COMMS_DEBUG PrintAndLogEx(NORMAL, "Sending %s", ng ? "NG" : "MIX"); #endif if (!session.pm3_present) { PrintAndLogEx(NORMAL, "Sending bytes to proxmark failed - offline"); return; } if (len > PM3_CMD_DATA_SIZE) { PrintAndLogEx(WARNING, "Sending %d bytes of payload is too much, abort", len); return; } PacketCommandNGPostamble *tx_post = (PacketCommandNGPostamble *)((uint8_t *)&txBufferNG + sizeof(PacketCommandNGPreamble) + len); pthread_mutex_lock(&txBufferMutex); /** 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 (txBuffer_pending) { // wait for communication thread to complete sending a previous commmand pthread_cond_wait(&txBufferSig, &txBufferMutex); } txBufferNG.pre.magic = COMMANDNG_PREAMBLE_MAGIC; txBufferNG.pre.ng = ng; txBufferNG.pre.length = len; txBufferNG.pre.cmd = cmd; memcpy(&txBufferNG.data, data, len); if ((conn.send_via_fpc_usart && conn.send_with_crc_on_fpc) || ((!conn.send_via_fpc_usart) && conn.send_with_crc_on_usb)) { uint8_t first, second; compute_crc(CRC_14443_A, (uint8_t *)&txBufferNG, sizeof(PacketCommandNGPreamble) + len, &first, &second); tx_post->crc = (first << 8) + second; } else { tx_post->crc = COMMANDNG_POSTAMBLE_MAGIC; } txBufferNGLen = sizeof(PacketCommandNGPreamble) + len + sizeof(PacketCommandNGPostamble); #ifdef COMMS_DEBUG_RAW print_hex_break((uint8_t *)&txBufferNG.pre, sizeof(PacketCommandNGPreamble), 32); if (ng) { print_hex_break((uint8_t *)&txBufferNG.data, len, 32); } else { print_hex_break((uint8_t *)&txBufferNG.data, 3 * sizeof(uint64_t), 32); print_hex_break((uint8_t *)&txBufferNG.data + 3 * sizeof(uint64_t), len - 3 * sizeof(uint64_t), 32); } print_hex_break((uint8_t *)tx_post, sizeof(PacketCommandNGPostamble), 32); #endif txBuffer_pending = true; // tell communication thread that a new command can be send pthread_cond_signal(&txBufferSig); pthread_mutex_unlock(&txBufferMutex); //__atomic_test_and_set(&txcmd_pending, __ATOMIC_SEQ_CST); } void SendCommandNG(uint16_t cmd, uint8_t *data, size_t len) { SendCommandNG_internal(cmd, data, len, true); } void SendCommandMIX(uint64_t cmd, uint64_t arg0, uint64_t arg1, uint64_t arg2, void *data, size_t len) { uint64_t arg[3] = {arg0, arg1, arg2}; if (len > PM3_CMD_DATA_SIZE_MIX) { PrintAndLogEx(WARNING, "Sending %d bytes of payload is too much for MIX frames, abort", len); return; } uint8_t cmddata[PM3_CMD_DATA_SIZE]; memcpy(cmddata, arg, sizeof(arg)); if (len && data) memcpy(cmddata + sizeof(arg), data, len); SendCommandNG_internal(cmd, cmddata, len + sizeof(arg), false); } /** * @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 pthread_mutex_lock(&rxBufferMutex); cmd_tail = cmd_head; pthread_mutex_unlock(&rxBufferMutex); } /** * @brief storeCommand stores a USB command in a circular buffer * @param UC */ static void storeReply(PacketResponseNG *packet) { 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 // circular buffer. PrintAndLogEx(FAILED, "WARNING: Command buffer about to overwrite command! This needs to be fixed!"); fflush(stdout); } //Store the command at the 'head' location PacketResponseNG *destination = &rxBuffer[cmd_head]; memcpy(destination, packet, sizeof(PacketResponseNG)); //increment head and wrap cmd_head = (cmd_head + 1) % CMD_BUFFER_SIZE; pthread_mutex_unlock(&rxBufferMutex); } /** * @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 */ static int getReply(PacketResponseNG *packet) { 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(&rxBufferMutex); return 0; } //Pick out the next unread command memcpy(packet, &rxBuffer[cmd_tail], sizeof(PacketResponseNG)); //Increment tail - this is a circular buffer, so modulo buffer size cmd_tail = (cmd_tail + 1) % CMD_BUFFER_SIZE; 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. //----------------------------------------------------------------------------- static void PacketResponseReceived(PacketResponseNG *packet) { // PrintAndLogEx(NORMAL, "RECV %s magic %08x length %04x status %04x crc %04x cmd %04x", // packet->ng ? "NG" : "OLD", packet->magic, packet->length, packet->status, packet->crc, packet->cmd); // we got a packet, reset WaitForResponseTimeout timeout __atomic_store_n(&timeout_start_time, msclock(), __ATOMIC_SEQ_CST); switch (packet->cmd) { // First check if we are handling a debug message case CMD_DEBUG_PRINT_STRING: { char s[PM3_CMD_DATA_SIZE + 1]; memset(s, 0x00, sizeof(s)); size_t len; uint16_t flag; if (packet->ng) { struct d { uint16_t flag; uint8_t buf[PM3_CMD_DATA_SIZE - sizeof(uint16_t)]; } PACKED; struct d *data = (struct d *)&packet->data.asBytes; len = packet->length - sizeof(data->flag); flag = data->flag; memcpy(s, data->buf, len); } else { len = MIN(packet->oldarg[0], PM3_CMD_DATA_SIZE); flag = packet->oldarg[1]; memcpy(s, packet->data.asBytes, len); } if (flag & FLAG_LOG) { PrintAndLogEx(NORMAL, "#db# %s", s); } else { if (flag & FLAG_INPLACE) printf("\r"); printf("%s", s); if (flag & FLAG_NEWLINE) printf("\r\n"); } fflush(stdout); break; } case CMD_DEBUG_PRINT_INTEGERS: { PrintAndLogEx(NORMAL, "#db# %" PRIx64 ", %" PRIx64 ", %" PRIx64 "", packet->oldarg[0], packet->oldarg[1], packet->oldarg[2]); break; } // iceman: hw status - down the path on device, runs printusbspeed which starts sending a lot of // CMD_DOWNLOAD_BIGBUF packages which is not dealt with. I wonder if simply ignoring them will // work. lets try it. default: { storeReply(packet); break; } } } // The communications thread. // signals to main thread when a response is ready to process. // static void #ifdef __has_attribute #if __has_attribute(force_align_arg_pointer) __attribute__((force_align_arg_pointer)) #endif #endif *uart_communication(void *targ) { communication_arg_t *connection = (communication_arg_t *)targ; uint32_t rxlen; bool commfailed = false; PacketResponseNG rx; PacketResponseNGRaw rx_raw; #if defined(__MACH__) && defined(__APPLE__) disableAppNap("Proxmark3 polling UART"); #endif // is this connection->run a cross thread call? while (connection->run) { rxlen = 0; bool ACK_received = false; bool error = false; int res; // Signal to main thread that communications seems off. // main thread will kill and restart this thread. if (commfailed) { if (conn.last_command != CMD_HARDWARE_RESET) { PrintAndLogEx(WARNING, "Communicating with Proxmark3 device " _RED_("failed")); } __atomic_test_and_set(&comm_thread_dead, __ATOMIC_SEQ_CST); break; } res = uart_receive(sp, (uint8_t *)&rx_raw.pre, sizeof(PacketResponseNGPreamble), &rxlen); if ((res == PM3_SUCCESS) && (rxlen == sizeof(PacketResponseNGPreamble))) { rx.magic = rx_raw.pre.magic; uint16_t length = rx_raw.pre.length; rx.ng = rx_raw.pre.ng; rx.status = rx_raw.pre.status; rx.cmd = rx_raw.pre.cmd; if (rx.magic == RESPONSENG_PREAMBLE_MAGIC) { // New style NG reply if (length > PM3_CMD_DATA_SIZE) { PrintAndLogEx(WARNING, "Received packet frame with incompatible length: 0x%04x", length); error = true; } if ((!error) && (length > 0)) { // Get the variable length payload res = uart_receive(sp, (uint8_t *)&rx_raw.data, length, &rxlen); if ((res != PM3_SUCCESS) || (rxlen != length)) { PrintAndLogEx(WARNING, "Received packet frame error variable part too short? %d/%d", rxlen, length); error = true; } else { if (rx.ng) { // Received a valid NG frame memcpy(&rx.data, &rx_raw.data, length); rx.length = length; if ((rx.cmd == conn.last_command) && (rx.status == PM3_SUCCESS)) { ACK_received = true; } } else { uint64_t arg[3]; if (length < sizeof(arg)) { PrintAndLogEx(WARNING, "Received MIX packet frame with incompatible length: 0x%04x", length); error = true; } if (!error) { // Received a valid MIX frame memcpy(arg, &rx_raw.data, sizeof(arg)); rx.oldarg[0] = arg[0]; rx.oldarg[1] = arg[1]; rx.oldarg[2] = arg[2]; memcpy(&rx.data, ((uint8_t *)&rx_raw.data) + sizeof(arg), length - sizeof(arg)); rx.length = length - sizeof(arg); if (rx.cmd == CMD_ACK) { ACK_received = true; } } } } } if (!error) { // Get the postamble res = uart_receive(sp, (uint8_t *)&rx_raw.foopost, sizeof(PacketResponseNGPostamble), &rxlen); if ((res != PM3_SUCCESS) || (rxlen != sizeof(PacketResponseNGPostamble))) { PrintAndLogEx(WARNING, "Received packet frame error fetching postamble"); error = true; } } if (!error) { // Check CRC, accept MAGIC as placeholder rx.crc = rx_raw.foopost.crc; if (rx.crc != RESPONSENG_POSTAMBLE_MAGIC) { uint8_t first, second; compute_crc(CRC_14443_A, (uint8_t *)&rx_raw, sizeof(PacketResponseNGPreamble) + length, &first, &second); if ((first << 8) + second != rx.crc) { PrintAndLogEx(WARNING, "Received packet frame CRC error %02X%02X <> %04X", first, second, rx.crc); error = true; } } } if (!error) { // Received a valid OLD frame #ifdef COMMS_DEBUG PrintAndLogEx(NORMAL, "Receiving %s:", rx.ng ? "NG" : "MIX"); #endif #ifdef COMMS_DEBUG_RAW print_hex_break((uint8_t *)&rx_raw.pre, sizeof(PacketResponseNGPreamble), 32); print_hex_break((uint8_t *)&rx_raw.data, rx_raw.pre.length, 32); print_hex_break((uint8_t *)&rx_raw.foopost, sizeof(PacketResponseNGPostamble), 32); #endif PacketResponseReceived(&rx); } } else { // Old style reply PacketResponseOLD rx_old; memcpy(&rx_old, &rx_raw.pre, sizeof(PacketResponseNGPreamble)); res = uart_receive(sp, ((uint8_t *)&rx_old) + sizeof(PacketResponseNGPreamble), sizeof(PacketResponseOLD) - sizeof(PacketResponseNGPreamble), &rxlen); if ((res != PM3_SUCCESS) || (rxlen != sizeof(PacketResponseOLD) - sizeof(PacketResponseNGPreamble))) { PrintAndLogEx(WARNING, "Received packet OLD frame payload error too short? %d/%d", rxlen, sizeof(PacketResponseOLD) - sizeof(PacketResponseNGPreamble)); error = true; } if (!error) { #ifdef COMMS_DEBUG PrintAndLogEx(NORMAL, "Receiving OLD:"); #endif #ifdef COMMS_DEBUG_RAW print_hex_break((uint8_t *)&rx_old.cmd, sizeof(rx_old.cmd), 32); print_hex_break((uint8_t *)&rx_old.arg, sizeof(rx_old.arg), 32); print_hex_break((uint8_t *)&rx_old.d, sizeof(rx_old.d), 32); #endif rx.ng = false; rx.magic = 0; rx.status = 0; rx.crc = 0; rx.cmd = rx_old.cmd; rx.oldarg[0] = rx_old.arg[0]; rx.oldarg[1] = rx_old.arg[1]; rx.oldarg[2] = rx_old.arg[2]; rx.length = PM3_CMD_DATA_SIZE; memcpy(&rx.data, &rx_old.d, rx.length); PacketResponseReceived(&rx); if (rx.cmd == CMD_ACK) { ACK_received = true; } } } } else { if (rxlen > 0) { PrintAndLogEx(WARNING, "Received packet frame preamble too short: %d/%d", rxlen, sizeof(PacketResponseNGPreamble)); error = true; } if (res == PM3_ENOTTY) { commfailed = true; } } // TODO if error, shall we resync ? pthread_mutex_lock(&txBufferMutex); if (connection->block_after_ACK) { // if we just received an ACK, wait here until a new command is to be transmitted // This is only working on OLD frames, and only used by flasher and flashmem if (ACK_received) { #ifdef COMMS_DEBUG PrintAndLogEx(NORMAL, "Received ACK, fast TX mode: ignoring other RX till TX"); #endif while (!txBuffer_pending) { pthread_cond_wait(&txBufferSig, &txBufferMutex); } } } if (txBuffer_pending) { if (txBufferNGLen) { // NG packet res = uart_send(sp, (uint8_t *) &txBufferNG, txBufferNGLen); if (res == PM3_EIO) { commfailed = true; } conn.last_command = txBufferNG.pre.cmd; txBufferNGLen = 0; } else { res = uart_send(sp, (uint8_t *) &txBuffer, sizeof(PacketCommandOLD)); if (res == PM3_EIO) { commfailed = true; } conn.last_command = txBuffer.cmd; } txBuffer_pending = false; // main thread doesn't know send failed... // tell main thread that txBuffer is empty pthread_cond_signal(&txBufferSig); } pthread_mutex_unlock(&txBufferMutex); } // when thread dies, we close the serial port. uart_close(sp); sp = NULL; #if defined(__MACH__) && defined(__APPLE__) enableAppNap(); #endif pthread_exit(NULL); return NULL; } bool IsCommunicationThreadDead(void) { bool ret = __atomic_load_n(&comm_thread_dead, __ATOMIC_SEQ_CST); return ret; } bool OpenProxmark(void *port, bool wait_for_port, int timeout, bool flash_mode, uint32_t speed) { char *portname = (char *)port; if (!wait_for_port) { PrintAndLogEx(INFO, "Using UART port " _YELLOW_("%s"), portname); sp = uart_open(portname, speed); } else { PrintAndLogEx(SUCCESS, "Waiting for Proxmark3 to appear on " _YELLOW_("%s"), portname); fflush(stdout); int openCount = 0; do { sp = uart_open(portname, speed); msleep(500); printf("."); fflush(stdout); } while (++openCount < timeout && (sp == INVALID_SERIAL_PORT || sp == CLAIMED_SERIAL_PORT)); } // check result of uart opening if (sp == INVALID_SERIAL_PORT) { PrintAndLogEx(WARNING, "\n" _RED_("ERROR:") "invalid serial port " _YELLOW_("%s"), portname); sp = NULL; return false; } else if (sp == CLAIMED_SERIAL_PORT) { PrintAndLogEx(WARNING, "\n" _RED_("ERROR:") "serial port " _YELLOW_("%s") " is claimed by another process", portname); sp = NULL; return false; } else { // start the communication thread if (portname != (char *)conn.serial_port_name) { uint16_t len = MIN(strlen(portname), FILE_PATH_SIZE - 1); memset(conn.serial_port_name, 0, FILE_PATH_SIZE); memcpy(conn.serial_port_name, portname, len); } conn.run = true; conn.block_after_ACK = flash_mode; // Flags to tell where to add CRC on sent replies conn.send_with_crc_on_usb = false; conn.send_with_crc_on_fpc = true; // "Session" flag, to tell via which interface next msgs should be sent: USB or FPC USART conn.send_via_fpc_usart = false; pthread_create(&communication_thread, NULL, &uart_communication, &conn); __atomic_clear(&comm_thread_dead, __ATOMIC_SEQ_CST); session.pm3_present = true; fflush(stdout); return true; } } // check if we can communicate with Pm3 int TestProxmark(void) { PacketResponseNG resp; uint16_t len = 32; uint8_t data[len]; for (uint16_t i = 0; i < len; i++) data[i] = i & 0xFF; clearCommandBuffer(); SendCommandNG(CMD_PING, data, len); uint32_t timeout = 1000; #ifdef USART_SLOW_LINK // 10s timeout for slow FPC, e.g. over BT // as this is the very first command sent to the pm3 // that initiates the BT connection timeout = 10000; #endif if (WaitForResponseTimeoutW(CMD_PING, &resp, timeout, false) == 0) { return PM3_ETIMEOUT; } bool error = false; if (len) error = memcmp(data, resp.data.asBytes, len) != 0; if (error) return PM3_EIO; SendCommandNG(CMD_CAPABILITIES, NULL, 0); if (WaitForResponseTimeoutW(CMD_CAPABILITIES, &resp, 1000, false) == 0) { return PM3_ETIMEOUT; } if ((resp.length != sizeof(pm3_capabilities)) || (resp.data.asBytes[0] != CAPABILITIES_VERSION)) { PrintAndLogEx(ERR, _RED_("Capabilities structure version sent by Proxmark3 is not the same as the one used by the client!")); PrintAndLogEx(ERR, _RED_("Please flash the Proxmark with the same version as the client.")); return PM3_EDEVNOTSUPP; } memcpy(&pm3_capabilities, resp.data.asBytes, MIN(sizeof(capabilities_t), resp.length)); conn.send_via_fpc_usart = pm3_capabilities.via_fpc; conn.uart_speed = pm3_capabilities.baudrate; PrintAndLogEx(INFO, "Communicating with PM3 over %s", conn.send_via_fpc_usart ? _YELLOW_("FPC UART") : _YELLOW_("USB-CDC")); if (conn.send_via_fpc_usart) { PrintAndLogEx(INFO, "PM3 UART serial baudrate: " _YELLOW_("%u") "\n", conn.uart_speed); } else { int res = uart_reconfigure_timeouts(UART_USB_CLIENT_RX_TIMEOUT_MS); if (res != PM3_SUCCESS) { return res; } } return PM3_SUCCESS; } void CloseProxmark(void) { conn.run = false; #ifdef __BIONIC__ if (communication_thread != 0) { pthread_join(communication_thread, NULL); } #else pthread_join(communication_thread, NULL); #endif if (sp) { uart_close(sp); } // Clean up our state sp = NULL; memset(&communication_thread, 0, sizeof(pthread_t)); session.pm3_present = false; } // Gives a rough estimate of the communication delay based on channel & baudrate // Max communication delay is when sending largest frame and receiving largest frame // Empirical measures on FTDI with physical cable: // "hw pingng 512" // usb -> 6..32ms // 460800 -> 40..70ms // 9600 -> 1100..1150ms // ~ = 12000000 / USART_BAUD_RATE // Let's take 2x (maybe we need more for BT link?) static size_t communication_delay(void) { if (conn.send_via_fpc_usart) // needed also for Windows USB USART?? return 2 * (12000000 / conn.uart_speed); return 100; } /** * @brief Waits for a certain response type. This method waits for a maximum of * ms_timeout milliseconds for a specified response command. * @param cmd command to wait for, or CMD_UNKNOWN to take any command. * @param response struct to copy received command into. * @param ms_timeout display message after 3 seconds * @param show_warning display message after 3 seconds * @return true if command was returned, otherwise false */ bool WaitForResponseTimeoutW(uint32_t cmd, PacketResponseNG *response, size_t ms_timeout, bool show_warning) { PacketResponseNG resp; if (response == NULL) response = &resp; // Add delay depending on the communication channel & speed if (ms_timeout != (size_t) -1) ms_timeout += communication_delay(); __atomic_store_n(&timeout_start_time, msclock(), __ATOMIC_SEQ_CST); uint64_t tmp_clk; // Wait until the command is received while (true) { while (getReply(response)) { if (cmd == CMD_UNKNOWN || response->cmd == cmd) { return true; } } tmp_clk = __atomic_load_n(&timeout_start_time, __ATOMIC_SEQ_CST); if ((ms_timeout != (size_t) -1) && (msclock() - tmp_clk > ms_timeout)) break; if (msclock() - tmp_clk > 3000 && show_warning) { // 3 seconds elapsed (but this doesn't mean the timeout was exceeded) // PrintAndLogEx(INFO, "Waiting for a response from the Proxmark3..."); PrintAndLogEx(INFO, "You can cancel this operation by pressing the pm3 button"); show_warning = false; } } return false; } bool WaitForResponseTimeout(uint32_t cmd, PacketResponseNG *response, size_t ms_timeout) { return WaitForResponseTimeoutW(cmd, response, ms_timeout, true); } bool WaitForResponse(uint32_t cmd, PacketResponseNG *response) { return WaitForResponseTimeoutW(cmd, response, -1, true); } /** * Data transfer from Proxmark to client. This method times out after * ms_timeout milliseconds. * @brief GetFromDevice * @param memtype Type of memory to download from proxmark * @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 GetFromDevice(DeviceMemType_t memtype, uint8_t *dest, uint32_t bytes, uint32_t start_index, PacketResponseNG *response, size_t ms_timeout, bool show_warning) { if (dest == NULL) return false; if (bytes == 0) return true; PacketResponseNG resp; if (response == NULL) response = &resp; // clear clearCommandBuffer(); switch (memtype) { case BIG_BUF: { SendCommandMIX(CMD_DOWNLOAD_BIGBUF, start_index, bytes, 0, NULL, 0); return dl_it(dest, bytes, start_index, response, ms_timeout, show_warning, CMD_DOWNLOADED_BIGBUF); } case BIG_BUF_EML: { SendCommandMIX(CMD_DOWNLOAD_EML_BIGBUF, start_index, bytes, 0, NULL, 0); return dl_it(dest, bytes, start_index, response, ms_timeout, show_warning, CMD_DOWNLOADED_EML_BIGBUF); } case FLASH_MEM: { SendCommandMIX(CMD_FLASHMEM_DOWNLOAD, start_index, bytes, 0, NULL, 0); return dl_it(dest, bytes, start_index, response, ms_timeout, show_warning, CMD_FLASHMEM_DOWNLOADED); } case SIM_MEM: { //SendCommandMIX(CMD_DOWNLOAD_SIM_MEM, start_index, bytes, 0, NULL, 0); //return dl_it(dest, bytes, start_index, response, ms_timeout, show_warning, CMD_DOWNLOADED_SIMMEM); return false; } } return false; } static bool dl_it(uint8_t *dest, uint32_t bytes, uint32_t start_index, PacketResponseNG *response, size_t ms_timeout, bool show_warning, uint32_t rec_cmd) { uint32_t bytes_completed = 0; __atomic_store_n(&timeout_start_time, msclock(), __ATOMIC_SEQ_CST); uint64_t tmp_clk; // Add delay depending on the communication channel & speed if (ms_timeout != (size_t) -1) ms_timeout += communication_delay(); while (true) { if (getReply(response)) { // sample_buf is a array pointer, located in data.c // arg0 = offset in transfer. Startindex of this chunk // arg1 = length bytes to transfer // arg2 = bigbuff tracelength (?) if (response->cmd == rec_cmd) { uint32_t offset = response->oldarg[0]; uint32_t copy_bytes = MIN(bytes - bytes_completed, response->oldarg[1]); //uint32_t tracelen = response->oldarg[2]; // extended bounds check1. upper limit is PM3_CMD_DATA_SIZE // shouldn't happen copy_bytes = MIN(copy_bytes, PM3_CMD_DATA_SIZE); // extended bounds check2. if (offset + copy_bytes > bytes) { PrintAndLogEx(FAILED, "ERROR: Out of bounds when downloading from device, offset %u | len %u | total len %u > buf_size %u", offset, copy_bytes, offset + copy_bytes, bytes); break; } memcpy(dest + offset, response->data.asBytes, copy_bytes); bytes_completed += copy_bytes; } else if (response->cmd == CMD_ACK) { return true; } } tmp_clk = __atomic_load_n(&timeout_start_time, __ATOMIC_SEQ_CST); if (msclock() - tmp_clk > ms_timeout) { PrintAndLogEx(FAILED, "Timed out while trying to download data from device"); break; } if (msclock() - tmp_clk > 3000 && show_warning) { // 3 seconds elapsed (but this doesn't mean the timeout was exceeded) PrintAndLogEx(NORMAL, "Waiting for a response from the Proxmark3..."); PrintAndLogEx(NORMAL, "You can cancel this operation by pressing the pm3 button"); show_warning = false; } } return false; }