]>
cvs.zerfleddert.de Git - proxmark3-svn/blob - uart/uart_posix.c
2 * Generic uart / rs232/ serial port library
4 * Copyright (c) 2013, Roel Verdult
5 * Copyright (c) 2018 Google
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.
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.
32 * This version of the library has functionality removed which was not used by
36 // Test if we are dealing with posix operating systems
38 #define _DEFAULT_SOURCE
43 #include <sys/ioctl.h>
46 #include <sys/types.h>
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>
58 // Fix missing definition on OS X.
59 // Taken from https://github.com/unbit/uwsgi/commit/b608eb1772641d525bfde268fe9d6d8d0d5efde7
61 #define SOL_TCP IPPROTO_TCP
64 typedef struct termios term_info
;
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
71 // Set time-out on 30 miliseconds
72 struct timeval timeout
= {
73 .tv_sec
= 0, // 0 second
74 .tv_usec
= 30000 // 30000 micro seconds
77 serial_port
uart_open(const char* pcPortName
)
79 serial_port_unix
* sp
= malloc(sizeof(serial_port_unix
));
80 if (sp
== 0) return INVALID_SERIAL_PORT
;
82 if (memcmp(pcPortName
, "tcp:", 4) == 0) {
83 struct addrinfo
*addr
= NULL
, *rp
;
84 char *addrstr
= strdup(pcPortName
+ 4);
85 if (addrstr
== NULL
) {
86 printf("Error: strdup\n");
87 return INVALID_SERIAL_PORT
;
89 char *colon
= strrchr(addrstr
, ':');
92 // Set time-out to 300 miliseconds only for TCP port
93 timeout
.tv_usec
= 300000;
101 struct addrinfo info
;
103 memset (&info
, 0, sizeof(info
));
105 info
.ai_socktype
= SOCK_STREAM
;
107 int s
= getaddrinfo(addrstr
, portstr
, &info
, &addr
);
109 printf("Error: getaddrinfo: %s\n", gai_strerror(s
));
110 return INVALID_SERIAL_PORT
;
114 for (rp
= addr
; rp
!= NULL
; rp
= rp
->ai_next
) {
115 sfd
= socket(rp
->ai_family
, rp
->ai_socktype
,
120 if (connect(sfd
, rp
->ai_addr
, rp
->ai_addrlen
) != -1)
126 if (rp
== NULL
) { /* No address succeeded */
127 printf("Error: Could not connect\n");
128 return INVALID_SERIAL_PORT
;
137 setsockopt(sp
->fd
, SOL_TCP
, TCP_NODELAY
, &one
, sizeof(one
));
141 sp
->fd
= open(pcPortName
, O_RDWR
| O_NOCTTY
| O_NDELAY
| O_NONBLOCK
);
144 return INVALID_SERIAL_PORT
;
147 // Finally figured out a way to claim a serial port interface under unix
148 // We just try to set a (advisory) lock on the file descriptor
151 fl
.l_whence
= SEEK_SET
;
156 // Does the system allows us to place a lock on this file descriptor
157 if (fcntl(sp
->fd
, F_SETLK
, &fl
) == -1) {
158 // A conflicting lock is held by another process
160 return CLAIMED_SERIAL_PORT
;
163 // Try to retrieve the old (current) terminal info struct
164 if(tcgetattr(sp
->fd
,&sp
->tiOld
) == -1) {
166 return INVALID_SERIAL_PORT
;
169 // Duplicate the (old) terminal info struct
170 sp
->tiNew
= sp
->tiOld
;
172 // Configure the serial port
173 sp
->tiNew
.c_cflag
= CS8
| CLOCAL
| CREAD
;
174 sp
->tiNew
.c_iflag
= IGNPAR
;
175 sp
->tiNew
.c_oflag
= 0;
176 sp
->tiNew
.c_lflag
= 0;
178 // Block until n bytes are received
179 sp
->tiNew
.c_cc
[VMIN
] = 0;
180 // Block until a timer expires (n * 100 mSec.)
181 sp
->tiNew
.c_cc
[VTIME
] = 0;
183 // Try to set the new terminal info struct
184 if(tcsetattr(sp
->fd
,TCSANOW
,&sp
->tiNew
) == -1) {
186 return INVALID_SERIAL_PORT
;
189 // Flush all lingering data that may exist
190 tcflush(sp
->fd
, TCIOFLUSH
);
195 void uart_close(const serial_port sp
) {
196 serial_port_unix
* spu
= (serial_port_unix
*)sp
;
197 tcflush(spu
->fd
,TCIOFLUSH
);
198 tcsetattr(spu
->fd
,TCSANOW
,&(spu
->tiOld
));
201 fl
.l_whence
= SEEK_SET
;
205 fcntl(spu
->fd
, F_SETLK
, &fl
);
210 bool uart_receive(const serial_port sp
, uint8_t* pbtRx
, size_t pszMaxRxLen
, size_t* pszRxLen
) {
216 // Reset the output count
220 // Reset file descriptor
222 FD_SET(((serial_port_unix
*)sp
)->fd
,&rfds
);
224 res
= select(((serial_port_unix
*)sp
)->fd
+1, &rfds
, NULL
, NULL
, &tv
);
233 if (*pszRxLen
== 0) {
234 // Error, we received no data
237 // We received some data, but nothing more is available
242 // Retrieve the count of the incoming bytes
243 res
= ioctl(((serial_port_unix
*)sp
)->fd
, FIONREAD
, &byteCount
);
244 if (res
< 0) return false;
246 // Cap the number of bytes, so we don't overrun the buffer
247 if (pszMaxRxLen
- (*pszRxLen
) < byteCount
) {
248 byteCount
= pszMaxRxLen
- (*pszRxLen
);
251 // There is something available, read the data
252 res
= read(((serial_port_unix
*)sp
)->fd
, pbtRx
+(*pszRxLen
), byteCount
);
254 // Stop if the OS has some troubles reading the data
255 if (res
<= 0) return false;
259 if (*pszRxLen
== pszMaxRxLen
) {
260 // We have all the data we wanted.
269 bool uart_send(const serial_port sp
, const uint8_t* pbtTx
, const size_t szTxLen
) {
275 while (szPos
< szTxLen
) {
276 // Reset file descriptor
278 FD_SET(((serial_port_unix
*)sp
)->fd
,&rfds
);
280 res
= select(((serial_port_unix
*)sp
)->fd
+1, NULL
, &rfds
, NULL
, &tv
);
292 // Send away the bytes
293 res
= write(((serial_port_unix
*)sp
)->fd
,pbtTx
+szPos
,szTxLen
-szPos
);
295 // Stop if the OS has some troubles sending the data
296 if (res
<= 0) return false;
303 bool uart_set_speed(serial_port sp
, const uint32_t uiPortSpeed
) {
304 const serial_port_unix
* spu
= (serial_port_unix
*)sp
;
306 switch (uiPortSpeed
) {
307 case 0: stPortSpeed
= B0
; break;
308 case 50: stPortSpeed
= B50
; break;
309 case 75: stPortSpeed
= B75
; break;
310 case 110: stPortSpeed
= B110
; break;
311 case 134: stPortSpeed
= B134
; break;
312 case 150: stPortSpeed
= B150
; break;
313 case 300: stPortSpeed
= B300
; break;
314 case 600: stPortSpeed
= B600
; break;
315 case 1200: stPortSpeed
= B1200
; break;
316 case 1800: stPortSpeed
= B1800
; break;
317 case 2400: stPortSpeed
= B2400
; break;
318 case 4800: stPortSpeed
= B4800
; break;
319 case 9600: stPortSpeed
= B9600
; break;
320 case 19200: stPortSpeed
= B19200
; break;
321 case 38400: stPortSpeed
= B38400
; break;
323 case 57600: stPortSpeed
= B57600
; break;
326 case 115200: stPortSpeed
= B115200
; break;
329 case 230400: stPortSpeed
= B230400
; break;
332 case 460800: stPortSpeed
= B460800
; break;
335 case 921600: stPortSpeed
= B921600
; break;
337 default: return false;
340 if (tcgetattr(spu
->fd
,&ti
) == -1) return false;
341 // Set port speed (Input and Output)
342 cfsetispeed(&ti
,stPortSpeed
);
343 cfsetospeed(&ti
,stPortSpeed
);
344 return (tcsetattr(spu
->fd
,TCSANOW
,&ti
) != -1);
347 uint32_t uart_get_speed(const serial_port sp
) {
349 uint32_t uiPortSpeed
;
350 const serial_port_unix
* spu
= (serial_port_unix
*)sp
;
351 if (tcgetattr(spu
->fd
,&ti
) == -1) return 0;
352 // Set port speed (Input)
353 speed_t stPortSpeed
= cfgetispeed(&ti
);
354 switch (stPortSpeed
) {
355 case B0
: uiPortSpeed
= 0; break;
356 case B50
: uiPortSpeed
= 50; break;
357 case B75
: uiPortSpeed
= 75; break;
358 case B110
: uiPortSpeed
= 110; break;
359 case B134
: uiPortSpeed
= 134; break;
360 case B150
: uiPortSpeed
= 150; break;
361 case B300
: uiPortSpeed
= 300; break;
362 case B600
: uiPortSpeed
= 600; break;
363 case B1200
: uiPortSpeed
= 1200; break;
364 case B1800
: uiPortSpeed
= 1800; break;
365 case B2400
: uiPortSpeed
= 2400; break;
366 case B4800
: uiPortSpeed
= 4800; break;
367 case B9600
: uiPortSpeed
= 9600; break;
368 case B19200
: uiPortSpeed
= 19200; break;
369 case B38400
: uiPortSpeed
= 38400; break;
371 case B57600
: uiPortSpeed
= 57600; break;
374 case B115200
: uiPortSpeed
= 115200; break;
377 case B230400
: uiPortSpeed
= 230400; break;
380 case B460800
: uiPortSpeed
= 460800; break;
383 case B921600
: uiPortSpeed
= 921600; break;