osx: disable app-nap during serial comm (#687)
[proxmark3-svn] / client / comms.c
1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2009 Michael Gernoth <michael at gernoth.net>
3 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
4 //
5 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
6 // at your option, any later version. See the LICENSE.txt file for the text of
7 // the license.
8 //-----------------------------------------------------------------------------
9 // Code for communicating with the proxmark3 hardware.
10 //-----------------------------------------------------------------------------
11
12 #include "comms.h"
13
14 #include <pthread.h>
15 #if defined(__linux__) && !defined(NO_UNLINK)
16 #include <unistd.h> // for unlink()
17 #endif
18 #include "uart.h"
19 #include "ui.h"
20 #include "common.h"
21 #include "util_darwin.h"
22 #include "util_posix.h"
23
24
25 // Serial port that we are communicating with the PM3 on.
26 static serial_port sp = NULL;
27 static char *serial_port_name = NULL;
28
29 // If TRUE, then there is no active connection to the PM3, and we will drop commands sent.
30 static bool offline;
31
32 typedef struct {
33 bool run; // If TRUE, continue running the uart_communication thread
34 bool block_after_ACK; // if true, block after receiving an ACK package
35 } communication_arg_t;
36
37 static communication_arg_t conn;
38 static pthread_t USB_communication_thread;
39
40 // Transmit buffer.
41 static UsbCommand txBuffer;
42 static bool txBuffer_pending = false;
43 static pthread_mutex_t txBufferMutex = PTHREAD_MUTEX_INITIALIZER;
44 static pthread_cond_t txBufferSig = PTHREAD_COND_INITIALIZER;
45
46 // Used by UsbReceiveCommand as a ring buffer for messages that are yet to be
47 // processed by a command handler (WaitForResponse{,Timeout})
48 static UsbCommand rxBuffer[CMD_BUFFER_SIZE];
49
50 // Points to the next empty position to write to
51 static int cmd_head = 0;
52
53 // Points to the position of the last unread command
54 static int cmd_tail = 0;
55
56 // to lock rxBuffer operations from different threads
57 static pthread_mutex_t rxBufferMutex = PTHREAD_MUTEX_INITIALIZER;
58
59 // These wrappers are required because it is not possible to access a static
60 // global variable outside of the context of a single file.
61
62 void SetOffline(bool new_offline) {
63 offline = new_offline;
64 }
65
66 bool IsOffline() {
67 return offline;
68 }
69
70 void SendCommand(UsbCommand *c) {
71 #ifdef COMMS_DEBUG
72 printf("Sending %04x cmd\n", c->cmd);
73 #endif
74
75 if (offline) {
76 PrintAndLog("Sending bytes to proxmark failed - offline");
77 return;
78 }
79
80 pthread_mutex_lock(&txBufferMutex);
81 /**
82 This causes hangups at times, when the pm3 unit is unresponsive or disconnected. The main console thread is alive,
83 but comm thread just spins here. Not good.../holiman
84 **/
85 while (txBuffer_pending) {
86 pthread_cond_wait(&txBufferSig, &txBufferMutex); // wait for communication thread to complete sending a previous commmand
87 }
88
89 txBuffer = *c;
90 txBuffer_pending = true;
91 pthread_cond_signal(&txBufferSig); // tell communication thread that a new command can be send
92
93 pthread_mutex_unlock(&txBufferMutex);
94
95 }
96
97
98 /**
99 * @brief This method should be called when sending a new command to the pm3. In case any old
100 * responses from previous commands are stored in the buffer, a call to this method should clear them.
101 * A better method could have been to have explicit command-ACKS, so we can know which ACK goes to which
102 * operation. Right now we'll just have to live with this.
103 */
104 void clearCommandBuffer()
105 {
106 //This is a very simple operation
107 pthread_mutex_lock(&rxBufferMutex);
108 cmd_tail = cmd_head;
109 pthread_mutex_unlock(&rxBufferMutex);
110 }
111
112 /**
113 * @brief storeCommand stores a USB command in a circular buffer
114 * @param UC
115 */
116 static void storeCommand(UsbCommand *command)
117 {
118 pthread_mutex_lock(&rxBufferMutex);
119 if( (cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
120 {
121 // If these two are equal, we're about to overwrite in the
122 // circular buffer.
123 PrintAndLog("WARNING: Command buffer about to overwrite command! This needs to be fixed!");
124 }
125
126 // Store the command at the 'head' location
127 UsbCommand* destination = &rxBuffer[cmd_head];
128 memcpy(destination, command, sizeof(UsbCommand));
129
130 cmd_head = (cmd_head +1) % CMD_BUFFER_SIZE; //increment head and wrap
131 pthread_mutex_unlock(&rxBufferMutex);
132 }
133
134
135 /**
136 * @brief getCommand gets a command from an internal circular buffer.
137 * @param response location to write command
138 * @return 1 if response was returned, 0 if nothing has been received
139 */
140 static int getCommand(UsbCommand* response)
141 {
142 pthread_mutex_lock(&rxBufferMutex);
143 //If head == tail, there's nothing to read, or if we just got initialized
144 if (cmd_head == cmd_tail){
145 pthread_mutex_unlock(&rxBufferMutex);
146 return 0;
147 }
148
149 //Pick out the next unread command
150 UsbCommand* last_unread = &rxBuffer[cmd_tail];
151 memcpy(response, last_unread, sizeof(UsbCommand));
152 //Increment tail - this is a circular buffer, so modulo buffer size
153 cmd_tail = (cmd_tail + 1) % CMD_BUFFER_SIZE;
154
155 pthread_mutex_unlock(&rxBufferMutex);
156 return 1;
157 }
158
159
160 //----------------------------------------------------------------------------------
161 // Entry point into our code: called whenever we received a packet over USB.
162 // Handle debug commands directly, store all other commands in circular buffer.
163 //----------------------------------------------------------------------------------
164 static void UsbCommandReceived(UsbCommand *UC)
165 {
166 switch(UC->cmd) {
167 // First check if we are handling a debug message
168 case CMD_DEBUG_PRINT_STRING: {
169 char s[USB_CMD_DATA_SIZE+1];
170 memset(s, 0x00, sizeof(s));
171 size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
172 memcpy(s,UC->d.asBytes,len);
173 PrintAndLog("#db# %s", s);
174 return;
175 } break;
176
177 case CMD_DEBUG_PRINT_INTEGERS: {
178 PrintAndLog("#db# %08x, %08x, %08x \r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
179 return;
180 } break;
181
182 default:
183 storeCommand(UC);
184 break;
185 }
186
187 }
188
189
190 static void
191 #ifdef __has_attribute
192 #if __has_attribute(force_align_arg_pointer)
193 __attribute__((force_align_arg_pointer))
194 #endif
195 #endif
196 *uart_communication(void *targ) {
197 communication_arg_t *conn = (communication_arg_t*)targ;
198 size_t rxlen;
199 UsbCommand rx;
200 UsbCommand *prx = &rx;
201
202 #if defined(__MACH__) && defined(__APPLE__)
203 disableAppNap("Proxmark3 polling UART");
204 #endif
205
206 while (conn->run) {
207 rxlen = 0;
208 bool ACK_received = false;
209 if (uart_receive(sp, (uint8_t *)prx, sizeof(UsbCommand) - (prx-&rx), &rxlen) && rxlen) {
210 prx += rxlen;
211 if (prx-&rx < sizeof(UsbCommand)) {
212 continue;
213 }
214 UsbCommandReceived(&rx);
215 if (rx.cmd == CMD_ACK) {
216 ACK_received = true;
217 }
218 }
219 prx = &rx;
220
221
222 pthread_mutex_lock(&txBufferMutex);
223
224 if (conn->block_after_ACK) {
225 // if we just received an ACK, wait here until a new command is to be transmitted
226 if (ACK_received) {
227 while (!txBuffer_pending) {
228 pthread_cond_wait(&txBufferSig, &txBufferMutex);
229 }
230 }
231 }
232
233 if(txBuffer_pending) {
234 if (!uart_send(sp, (uint8_t*) &txBuffer, sizeof(UsbCommand))) {
235 PrintAndLog("Sending bytes to proxmark failed");
236 }
237 txBuffer_pending = false;
238 pthread_cond_signal(&txBufferSig); // tell main thread that txBuffer is empty
239 }
240
241 pthread_mutex_unlock(&txBufferMutex);
242 }
243
244 #if defined(__MACH__) && defined(__APPLE__)
245 enableAppNap();
246 #endif
247
248 pthread_exit(NULL);
249 return NULL;
250 }
251
252
253 /**
254 * Data transfer from Proxmark to client. This method times out after
255 * ms_timeout milliseconds.
256 * @brief GetFromBigBuf
257 * @param dest Destination address for transfer
258 * @param bytes number of bytes to be transferred
259 * @param start_index offset into Proxmark3 BigBuf[]
260 * @param response struct to copy last command (CMD_ACK) into
261 * @param ms_timeout timeout in milliseconds
262 * @param show_warning display message after 2 seconds
263 * @return true if command was returned, otherwise false
264 */
265 bool GetFromBigBuf(uint8_t *dest, int bytes, int start_index, UsbCommand *response, size_t ms_timeout, bool show_warning)
266 {
267 UsbCommand c = {CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K, {start_index, bytes, 0}};
268 SendCommand(&c);
269
270 uint64_t start_time = msclock();
271
272 UsbCommand resp;
273 if (response == NULL) {
274 response = &resp;
275 }
276
277 int bytes_completed = 0;
278 while(true) {
279 if (getCommand(response)) {
280 if (response->cmd == CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K) {
281 int copy_bytes = MIN(bytes - bytes_completed, response->arg[1]);
282 memcpy(dest + response->arg[0], response->d.asBytes, copy_bytes);
283 bytes_completed += copy_bytes;
284 } else if (response->cmd == CMD_ACK) {
285 return true;
286 }
287 }
288
289 if (msclock() - start_time > ms_timeout) {
290 break;
291 }
292
293 if (msclock() - start_time > 2000 && show_warning) {
294 PrintAndLog("Waiting for a response from the proxmark...");
295 PrintAndLog("You can cancel this operation by pressing the pm3 button");
296 show_warning = false;
297 }
298 }
299
300 return false;
301 }
302
303
304 bool OpenProxmark(void *port, bool wait_for_port, int timeout, bool flash_mode) {
305 char *portname = (char *)port;
306 if (!wait_for_port) {
307 sp = uart_open(portname);
308 } else {
309 printf("Waiting for Proxmark to appear on %s ", portname);
310 fflush(stdout);
311 int openCount = 0;
312 do {
313 sp = uart_open(portname);
314 msleep(1000);
315 printf(".");
316 fflush(stdout);
317 } while(++openCount < timeout && (sp == INVALID_SERIAL_PORT || sp == CLAIMED_SERIAL_PORT));
318 printf("\n");
319 }
320
321 // check result of uart opening
322 if (sp == INVALID_SERIAL_PORT) {
323 printf("ERROR: invalid serial port\n");
324 sp = NULL;
325 serial_port_name = NULL;
326 return false;
327 } else if (sp == CLAIMED_SERIAL_PORT) {
328 printf("ERROR: serial port is claimed by another process\n");
329 sp = NULL;
330 serial_port_name = NULL;
331 return false;
332 } else {
333 // start the USB communication thread
334 serial_port_name = portname;
335 conn.run = true;
336 conn.block_after_ACK = flash_mode;
337 pthread_create(&USB_communication_thread, NULL, &uart_communication, &conn);
338 return true;
339 }
340 }
341
342
343 void CloseProxmark(void) {
344 conn.run = false;
345
346 #ifdef __BIONIC__
347 // In Android O and later, if an invalid pthread_t is passed to pthread_join, it calls fatal().
348 // https://github.com/aosp-mirror/platform_bionic/blob/ed16b344e75f422fb36fbfd91fb30de339475880/libc/bionic/pthread_internal.cpp#L116-L128
349 //
350 // In Bionic libc, pthread_t is an integer.
351
352 if (USB_communication_thread != 0) {
353 pthread_join(USB_communication_thread, NULL);
354 }
355 #else
356 // pthread_t is a struct on other libc, treat as an opaque memory reference
357 pthread_join(USB_communication_thread, NULL);
358 #endif
359
360 if (sp) {
361 uart_close(sp);
362 }
363
364 #if defined(__linux__) && !defined(NO_UNLINK)
365 // Fix for linux, it seems that it is extremely slow to release the serial port file descriptor /dev/*
366 //
367 // This may be disabled at compile-time with -DNO_UNLINK (used for a JNI-based serial port on Android).
368 if (serial_port_name) {
369 unlink(serial_port_name);
370 }
371 #endif
372
373 // Clean up our state
374 sp = NULL;
375 serial_port_name = NULL;
376 #ifdef __BIONIC__
377 memset(&USB_communication_thread, 0, sizeof(pthread_t));
378 #endif
379 }
380
381
382 /**
383 * Waits for a certain response type. This method waits for a maximum of
384 * ms_timeout milliseconds for a specified response command.
385 *@brief WaitForResponseTimeout
386 * @param cmd command to wait for, or CMD_UNKNOWN to take any command.
387 * @param response struct to copy received command into.
388 * @param ms_timeout
389 * @param show_warning display message after 2 seconds
390 * @return true if command was returned, otherwise false
391 */
392 bool WaitForResponseTimeoutW(uint32_t cmd, UsbCommand* response, size_t ms_timeout, bool show_warning) {
393
394 UsbCommand resp;
395
396 #ifdef COMMS_DEBUG
397 printf("Waiting for %04x cmd\n", cmd);
398 #endif
399
400 if (response == NULL) {
401 response = &resp;
402 }
403
404 uint64_t start_time = msclock();
405
406 // Wait until the command is received
407 while (true) {
408 while(getCommand(response)) {
409 if (cmd == CMD_UNKNOWN || response->cmd == cmd) {
410 return true;
411 }
412 }
413
414 if (msclock() - start_time > ms_timeout) {
415 break;
416 }
417
418 if (msclock() - start_time > 2000 && show_warning) {
419 // 2 seconds elapsed (but this doesn't mean the timeout was exceeded)
420 PrintAndLog("Waiting for a response from the proxmark...");
421 PrintAndLog("You can cancel this operation by pressing the pm3 button");
422 show_warning = false;
423 }
424 }
425 return false;
426 }
427
428
429 bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
430 return WaitForResponseTimeoutW(cmd, response, ms_timeout, true);
431 }
432
433 bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
434 return WaitForResponseTimeoutW(cmd, response, -1, true);
435 }
436
Impressum, Datenschutz