restore #755 reverted after #757 (#761)
[proxmark3-svn] / uart / uart_posix.c
CommitLineData
5bcc76c4 1/*
13dbdd6b 2 * Generic uart / rs232/ serial port library
5bcc76c4 3 *
13dbdd6b 4 * Copyright (c) 2013, Roel Verdult
d664113a 5 * Copyright (c) 2018 Google
5bcc76c4 6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the copyright holders nor the
16 * names of its contributors may be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
067bfc8b 30 * @file uart_posix.c
5bcc76c4 31 *
067bfc8b
MF
32 * This version of the library has functionality removed which was not used by
33 * proxmark3 project.
5bcc76c4 34 */
35
067bfc8b 36// Test if we are dealing with posix operating systems
5bcc76c4 37#ifndef _WIN32
d664113a
VS
38#define _DEFAULT_SOURCE
39
40#include "uart.h"
41
5bcc76c4 42#include <termios.h>
067bfc8b
MF
43#include <sys/ioctl.h>
44#include <unistd.h>
45#include <fcntl.h>
46#include <sys/types.h>
47#include <sys/stat.h>
48#include <limits.h>
49#include <sys/time.h>
50#include <errno.h>
d664113a
VS
51#include <sys/types.h>
52#include <sys/socket.h>
53#include <netinet/in.h>
54#include <netinet/tcp.h>
55#include <arpa/inet.h>
56#include <netdb.h>
067bfc8b 57
a015ef37
JMP
58// Fix missing definition on OS X.
59// Taken from https://github.com/unbit/uwsgi/commit/b608eb1772641d525bfde268fe9d6d8d0d5efde7
60#ifndef SOL_TCP
61#define SOL_TCP IPPROTO_TCP
62#endif
63
5bcc76c4 64typedef struct termios term_info;
65typedef struct {
66 int fd; // Serial port file descriptor
67 term_info tiOld; // Terminal info before using the port
68 term_info tiNew; // Terminal info during the transaction
69} serial_port_unix;
70
71// Set time-out on 30 miliseconds
13dbdd6b 72const struct timeval timeout = {
5bcc76c4 73 .tv_sec = 0, // 0 second
d664113a 74 .tv_usec = 300000 // 300000 micro seconds
5bcc76c4 75};
76
5bcc76c4 77serial_port uart_open(const char* pcPortName)
78{
79 serial_port_unix* sp = malloc(sizeof(serial_port_unix));
5bcc76c4 80 if (sp == 0) return INVALID_SERIAL_PORT;
13dbdd6b 81
d664113a
VS
82 if (memcmp(pcPortName, "tcp:", 4) == 0) {
83 struct addrinfo *addr, *rp;
84 char *addrstr = strdup(pcPortName + 4);
85 if (addrstr == NULL) {
86 printf("Error: strdup\n");
87 return INVALID_SERIAL_PORT;
88 }
89 char *colon = strrchr(addrstr, ':');
90 char *portstr;
91 if (colon) {
92 portstr = colon + 1;
93 *colon = '\0';
94 } else
95 portstr = "7901";
96
97 int s = getaddrinfo(addrstr, portstr, NULL, &addr);
98 if (s != 0) {
99 printf("Error: getaddrinfo: %s\n", gai_strerror(s));
100 return INVALID_SERIAL_PORT;
101 }
102
103 int sfd;
104 for (rp = addr; rp != NULL; rp = rp->ai_next) {
105 sfd = socket(rp->ai_family, rp->ai_socktype,
106 rp->ai_protocol);
107 if (sfd == -1)
108 continue;
109
110 if (connect(sfd, rp->ai_addr, rp->ai_addrlen) != -1)
111 break;
112
113 close(sfd);
114 }
115
116 if (rp == NULL) { /* No address succeeded */
117 printf("Error: Could not connect\n");
118 return INVALID_SERIAL_PORT;
119 }
120
121 freeaddrinfo(addr);
122 free(addrstr);
123
124 sp->fd = sfd;
125
126 int one = 1;
127 setsockopt(sp->fd, SOL_TCP, TCP_NODELAY, &one, sizeof(one));
128 return sp;
129 }
130
5bcc76c4 131 sp->fd = open(pcPortName, O_RDWR | O_NOCTTY | O_NDELAY | O_NONBLOCK);
62ee4fed 132 if(sp->fd == -1) {
5bcc76c4 133 uart_close(sp);
134 return INVALID_SERIAL_PORT;
135 }
62ee4fed 136
137 // Finally figured out a way to claim a serial port interface under unix
138 // We just try to set a (advisory) lock on the file descriptor
139 struct flock fl;
140 fl.l_type = F_WRLCK;
141 fl.l_whence = SEEK_SET;
142 fl.l_start = 0;
143 fl.l_len = 0;
144 fl.l_pid = getpid();
13dbdd6b 145
62ee4fed 146 // Does the system allows us to place a lock on this file descriptor
147 if (fcntl(sp->fd, F_SETLK, &fl) == -1) {
148 // A conflicting lock is held by another process
ca4714cd 149 free(sp);
62ee4fed 150 return CLAIMED_SERIAL_PORT;
5bcc76c4 151 }
62ee4fed 152
153 // Try to retrieve the old (current) terminal info struct
154 if(tcgetattr(sp->fd,&sp->tiOld) == -1) {
5bcc76c4 155 uart_close(sp);
62ee4fed 156 return INVALID_SERIAL_PORT;
5bcc76c4 157 }
13dbdd6b 158
62ee4fed 159 // Duplicate the (old) terminal info struct
5bcc76c4 160 sp->tiNew = sp->tiOld;
13dbdd6b 161
62ee4fed 162 // Configure the serial port
5bcc76c4 163 sp->tiNew.c_cflag = CS8 | CLOCAL | CREAD;
62ee4fed 164 sp->tiNew.c_iflag = IGNPAR;
5bcc76c4 165 sp->tiNew.c_oflag = 0;
166 sp->tiNew.c_lflag = 0;
62ee4fed 167
168 // Block until n bytes are received
169 sp->tiNew.c_cc[VMIN] = 0;
170 // Block until a timer expires (n * 100 mSec.)
171 sp->tiNew.c_cc[VTIME] = 0;
0a24369c 172
62ee4fed 173 // Try to set the new terminal info struct
174 if(tcsetattr(sp->fd,TCSANOW,&sp->tiNew) == -1) {
5bcc76c4 175 uart_close(sp);
176 return INVALID_SERIAL_PORT;
177 }
13dbdd6b 178
62ee4fed 179 // Flush all lingering data that may exist
0a24369c 180 tcflush(sp->fd, TCIOFLUSH);
62ee4fed 181
5bcc76c4 182 return sp;
183}
184
62ee4fed 185void uart_close(const serial_port sp) {
186 serial_port_unix* spu = (serial_port_unix*)sp;
187 tcflush(spu->fd,TCIOFLUSH);
188 tcsetattr(spu->fd,TCSANOW,&(spu->tiOld));
189 struct flock fl;
190 fl.l_type = F_UNLCK;
191 fl.l_whence = SEEK_SET;
192 fl.l_start = 0;
193 fl.l_len = 0;
194 fl.l_pid = getpid();
195 fcntl(spu->fd, F_SETLK, &fl);
196 close(spu->fd);
197 free(sp);
198}
199
f5ecd97b 200bool uart_receive(const serial_port sp, uint8_t* pbtRx, size_t pszMaxRxLen, size_t* pszRxLen) {
5bcc76c4 201 int res;
202 int byteCount;
203 fd_set rfds;
204 struct timeval tv;
13dbdd6b 205
206 // Reset the output count
5bcc76c4 207 *pszRxLen = 0;
13dbdd6b 208
5bcc76c4 209 do {
210 // Reset file descriptor
211 FD_ZERO(&rfds);
212 FD_SET(((serial_port_unix*)sp)->fd,&rfds);
213 tv = timeout;
214 res = select(((serial_port_unix*)sp)->fd+1, &rfds, NULL, NULL, &tv);
13dbdd6b 215
5bcc76c4 216 // Read error
217 if (res < 0) {
5bcc76c4 218 return false;
219 }
babfcaa0 220
5bcc76c4 221 // Read time-out
222 if (res == 0) {
223 if (*pszRxLen == 0) {
224 // Error, we received no data
5bcc76c4 225 return false;
226 } else {
227 // We received some data, but nothing more is available
228 return true;
229 }
230 }
babfcaa0 231
5bcc76c4 232 // Retrieve the count of the incoming bytes
233 res = ioctl(((serial_port_unix*)sp)->fd, FIONREAD, &byteCount);
234 if (res < 0) return false;
067bfc8b
MF
235
236 // Cap the number of bytes, so we don't overrun the buffer
237 if (pszMaxRxLen - (*pszRxLen) < byteCount) {
238 byteCount = pszMaxRxLen - (*pszRxLen);
239 }
babfcaa0 240
5bcc76c4 241 // There is something available, read the data
067bfc8b 242 res = read(((serial_port_unix*)sp)->fd, pbtRx+(*pszRxLen), byteCount);
babfcaa0 243
5bcc76c4 244 // Stop if the OS has some troubles reading the data
245 if (res <= 0) return false;
babfcaa0 246
5bcc76c4 247 *pszRxLen += res;
babfcaa0 248
067bfc8b
MF
249 if (*pszRxLen == pszMaxRxLen) {
250 // We have all the data we wanted.
251 return true;
252 }
13dbdd6b 253
5bcc76c4 254 } while (byteCount);
babfcaa0 255
5bcc76c4 256 return true;
257}
258
f5ecd97b 259bool uart_send(const serial_port sp, const uint8_t* pbtTx, const size_t szTxLen) {
5bcc76c4 260 int32_t res;
261 size_t szPos = 0;
262 fd_set rfds;
263 struct timeval tv;
13dbdd6b 264
62ee4fed 265 while (szPos < szTxLen) {
5bcc76c4 266 // Reset file descriptor
267 FD_ZERO(&rfds);
268 FD_SET(((serial_port_unix*)sp)->fd,&rfds);
269 tv = timeout;
270 res = select(((serial_port_unix*)sp)->fd+1, NULL, &rfds, NULL, &tv);
13dbdd6b 271
5bcc76c4 272 // Write error
273 if (res < 0) {
5bcc76c4 274 return false;
275 }
13dbdd6b 276
5bcc76c4 277 // Write time-out
278 if (res == 0) {
5bcc76c4 279 return false;
280 }
13dbdd6b 281
5bcc76c4 282 // Send away the bytes
283 res = write(((serial_port_unix*)sp)->fd,pbtTx+szPos,szTxLen-szPos);
284
285 // Stop if the OS has some troubles sending the data
286 if (res <= 0) return false;
13dbdd6b 287
5bcc76c4 288 szPos += res;
289 }
290 return true;
291}
292
13dbdd6b 293bool uart_set_speed(serial_port sp, const uint32_t uiPortSpeed) {
067bfc8b
MF
294 const serial_port_unix* spu = (serial_port_unix*)sp;
295 speed_t stPortSpeed;
296 switch (uiPortSpeed) {
297 case 0: stPortSpeed = B0; break;
298 case 50: stPortSpeed = B50; break;
299 case 75: stPortSpeed = B75; break;
300 case 110: stPortSpeed = B110; break;
301 case 134: stPortSpeed = B134; break;
302 case 150: stPortSpeed = B150; break;
303 case 300: stPortSpeed = B300; break;
304 case 600: stPortSpeed = B600; break;
305 case 1200: stPortSpeed = B1200; break;
306 case 1800: stPortSpeed = B1800; break;
307 case 2400: stPortSpeed = B2400; break;
308 case 4800: stPortSpeed = B4800; break;
309 case 9600: stPortSpeed = B9600; break;
310 case 19200: stPortSpeed = B19200; break;
311 case 38400: stPortSpeed = B38400; break;
312# ifdef B57600
313 case 57600: stPortSpeed = B57600; break;
314# endif
315# ifdef B115200
316 case 115200: stPortSpeed = B115200; break;
317# endif
318# ifdef B230400
319 case 230400: stPortSpeed = B230400; break;
320# endif
321# ifdef B460800
322 case 460800: stPortSpeed = B460800; break;
323# endif
324# ifdef B921600
325 case 921600: stPortSpeed = B921600; break;
326# endif
327 default: return false;
328 };
329 struct termios ti;
330 if (tcgetattr(spu->fd,&ti) == -1) return false;
331 // Set port speed (Input and Output)
332 cfsetispeed(&ti,stPortSpeed);
333 cfsetospeed(&ti,stPortSpeed);
334 return (tcsetattr(spu->fd,TCSANOW,&ti) != -1);
5bcc76c4 335}
336
13dbdd6b 337uint32_t uart_get_speed(const serial_port sp) {
067bfc8b
MF
338 struct termios ti;
339 uint32_t uiPortSpeed;
340 const serial_port_unix* spu = (serial_port_unix*)sp;
341 if (tcgetattr(spu->fd,&ti) == -1) return 0;
342 // Set port speed (Input)
343 speed_t stPortSpeed = cfgetispeed(&ti);
344 switch (stPortSpeed) {
345 case B0: uiPortSpeed = 0; break;
346 case B50: uiPortSpeed = 50; break;
347 case B75: uiPortSpeed = 75; break;
348 case B110: uiPortSpeed = 110; break;
349 case B134: uiPortSpeed = 134; break;
350 case B150: uiPortSpeed = 150; break;
351 case B300: uiPortSpeed = 300; break;
352 case B600: uiPortSpeed = 600; break;
353 case B1200: uiPortSpeed = 1200; break;
354 case B1800: uiPortSpeed = 1800; break;
355 case B2400: uiPortSpeed = 2400; break;
356 case B4800: uiPortSpeed = 4800; break;
357 case B9600: uiPortSpeed = 9600; break;
358 case B19200: uiPortSpeed = 19200; break;
359 case B38400: uiPortSpeed = 38400; break;
360# ifdef B57600
361 case B57600: uiPortSpeed = 57600; break;
362# endif
363# ifdef B115200
364 case B115200: uiPortSpeed = 115200; break;
365# endif
366# ifdef B230400
367 case B230400: uiPortSpeed = 230400; break;
368# endif
369# ifdef B460800
370 case B460800: uiPortSpeed = 460800; break;
371# endif
372# ifdef B921600
373 case B921600: uiPortSpeed = 921600; break;
374# endif
375 default: return 0;
376 };
377 return uiPortSpeed;
5bcc76c4 378}
379
380#endif
067bfc8b 381
Impressum, Datenschutz