Update README.md

[proxmark3-svn] / uart / uart_posix.c

/*\r
 * Generic uart / rs232/ serial port library\r
 *\r
 * Copyright (c) 2013, Roel Verdult\r
 * Copyright (c) 2018 Google\r
 * All rights reserved.\r
 *\r
 * Redistribution and use in source and binary forms, with or without\r
 * modification, are permitted provided that the following conditions are met:\r
 * 1. Redistributions of source code must retain the above copyright\r
 * notice, this list of conditions and the following disclaimer.\r
 * 2. Redistributions in binary form must reproduce the above copyright\r
 * notice, this list of conditions and the following disclaimer in the\r
 * documentation and/or other materials provided with the distribution.\r
 * 3. Neither the name of the copyright holders nor the\r
 * names of its contributors may be used to endorse or promote products\r
 * derived from this software without specific prior written permission.\r
 *\r
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY\r
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY\r
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
 *\r
 * @file uart_posix.c\r
 *\r
 * This version of the library has functionality removed which was not used by\r
 * proxmark3 project.\r
 */\r
\r
// Test if we are dealing with posix operating systems\r
#ifndef _WIN32\r
#define _DEFAULT_SOURCE\r
\r
#include "uart.h"\r
\r
#include <stdlib.h>\r
#include <stdio.h>\r
#include <string.h>\r
#include <stdbool.h>\r
#include <termios.h>\r
#include <sys/ioctl.h>\r
#include <unistd.h>\r
#include <fcntl.h>\r
#include <sys/types.h>\r
#include <sys/stat.h>\r
#include <sys/socket.h>\r
#include <netinet/tcp.h>\r
#include <netdb.h>\r
#include <sys/time.h>\r
#include <errno.h>\r
\r
// Fix missing definition on OS X.\r
// Taken from https://github.com/unbit/uwsgi/commit/b608eb1772641d525bfde268fe9d6d8d0d5efde7\r
#ifndef SOL_TCP\r
#define SOL_TCP IPPROTO_TCP\r
#endif\r
\r
typedef struct termios term_info;\r
typedef struct {\r
	int fd;           // Serial port file descriptor\r
	term_info tiOld;  // Terminal info before using the port\r
	term_info tiNew;  // Terminal info during the transaction\r
} serial_port_unix;\r
\r
// Set time-out on 30 miliseconds\r
static struct timeval timeout = {\r
	.tv_sec  =     0, // 0 second\r
	.tv_usec = 30000  // 30000 micro seconds\r
};\r
\r
\r
void uart_close(const serial_port sp) {\r
	serial_port_unix* spu = (serial_port_unix*)sp;\r
	tcflush(spu->fd, TCIOFLUSH);\r
	tcsetattr(spu->fd, TCSANOW, &(spu->tiOld));\r
	struct flock fl;\r
	fl.l_type   = F_UNLCK;\r
	fl.l_whence = SEEK_SET;\r
	fl.l_start  = 0;\r
	fl.l_len    = 0;\r
	fl.l_pid    = getpid();\r
	fcntl(spu->fd, F_SETLK, &fl);\r
	close(spu->fd);\r
	free(sp);\r
}\r
\r
\r
serial_port uart_open(const char* pcPortName) {\r
\r
	serial_port_unix* sp = malloc(sizeof(serial_port_unix));\r
	if (sp == 0) return INVALID_SERIAL_PORT;\r
\r
	if (memcmp(pcPortName, "tcp:", 4) == 0) {\r
		struct addrinfo *addr = NULL, *rp;\r
		char *addrstr = strdup(pcPortName + 4);\r
		if (addrstr == NULL) {\r
			printf("Error: strdup\n");\r
			return INVALID_SERIAL_PORT;\r
		}\r
		char *colon = strrchr(addrstr, ':');\r
		char *portstr;\r
\r
		// Set time-out to 300 milliseconds only for TCP port\r
		timeout.tv_usec = 300000;\r
\r
		if (colon) {\r
			portstr = colon + 1;\r
			*colon = '\0';\r
		} else {\r
			portstr = "7901";\r
		}\r
\r
		struct addrinfo info;\r
\r
		memset(&info, 0, sizeof(info));\r
\r
		info.ai_socktype = SOCK_STREAM;\r
\r
		int s = getaddrinfo(addrstr, portstr, &info, &addr);\r
		if (s != 0) {\r
			printf("Error: getaddrinfo: %s\n", gai_strerror(s));\r
			return INVALID_SERIAL_PORT;\r
		}\r
\r
		int sfd;\r
		for (rp = addr; rp != NULL; rp = rp->ai_next) {\r
			sfd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);\r
			if (sfd == -1)\r
				continue;\r
			if (connect(sfd, rp->ai_addr, rp->ai_addrlen) != -1)\r
				break;\r
			close(sfd);\r
		}\r
\r
		if (rp == NULL) {               /* No address succeeded */\r
			printf("Error: Could not connect\n");\r
			return INVALID_SERIAL_PORT;\r
		}\r
\r
		freeaddrinfo(addr);\r
		free(addrstr);\r
\r
		sp->fd = sfd;\r
\r
		int one = 1;\r
		setsockopt(sp->fd, SOL_TCP, TCP_NODELAY, &one, sizeof(one));\r
		return sp;\r
	}\r
\r
	sp->fd = open(pcPortName, O_RDWR | O_NOCTTY | O_NDELAY | O_NONBLOCK);\r
	if (sp->fd == -1) {\r
		uart_close(sp);\r
		return INVALID_SERIAL_PORT;\r
	}\r
\r
	// Finally figured out a way to claim a serial port interface under unix\r
	// We just try to set a (advisory) lock on the file descriptor\r
	struct flock fl;\r
	fl.l_type   = F_WRLCK;\r
	fl.l_whence = SEEK_SET;\r
	fl.l_start  = 0;\r
	fl.l_len    = 0;\r
	fl.l_pid    = getpid();\r
\r
	// Does the system allows us to place a lock on this file descriptor\r
	if (fcntl(sp->fd, F_SETLK, &fl) == -1) {\r
		// A conflicting lock is held by another process\r
		free(sp);\r
		return CLAIMED_SERIAL_PORT;\r
	}\r
\r
	// Try to retrieve the old (current) terminal info struct\r
	if (tcgetattr(sp->fd,&sp->tiOld) == -1) {\r
		uart_close(sp);\r
		return INVALID_SERIAL_PORT;\r
	}\r
\r
	// Duplicate the (old) terminal info struct\r
	sp->tiNew = sp->tiOld;\r
\r
	// Configure the serial port\r
	sp->tiNew.c_cflag &= ~(CSIZE | PARENB);\r
	sp->tiNew.c_cflag |= (CS8 | CLOCAL | CREAD);\r
	sp->tiNew.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IXON);\r
	sp->tiNew.c_iflag |= IGNPAR;\r
	sp->tiNew.c_oflag &= ~OPOST;\r
	sp->tiNew.c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);\r
\r
\r
	// Try to set the new terminal info struct\r
	if (tcsetattr(sp->fd, TCSANOW, &sp->tiNew) == -1) {\r
		uart_close(sp);\r
		return INVALID_SERIAL_PORT;\r
	}\r
\r
	// Flush all lingering data that may exist\r
	tcflush(sp->fd, TCIOFLUSH);\r
\r
	return sp;\r
}\r
\r
\r
bool uart_receive(const serial_port sp, uint8_t* pbtRx, size_t szMaxRxLen, size_t* pszRxLen) {\r
\r
	*pszRxLen = 0;\r
\r
	if (szMaxRxLen == 0) return true;\r
\r
	struct timeval t_current;\r
	gettimeofday(&t_current, NULL);\r
	struct timeval t_end;\r
	timeradd(&t_current, &timeout, &t_end);\r
\r
	while (true) {\r
		int res = read(((serial_port_unix*)sp)->fd, pbtRx, szMaxRxLen - *pszRxLen);\r
		if (res < 0 && errno != EAGAIN && errno != EWOULDBLOCK) return false;\r
		if (res > 0) {\r
			*pszRxLen += res;\r
			pbtRx += res;\r
		}\r
		if (*pszRxLen == szMaxRxLen) return true; // we could read all requested bytes in time\r
		gettimeofday(&t_current, NULL);\r
		if (timercmp(&t_current, &t_end, >)) return true; // timeout\r
		// set next select timeout\r
		struct timeval t_remains;\r
		timersub(&t_end, &t_current, &t_remains);\r
		// Set the file descriptor set\r
		fd_set rfds;\r
		FD_ZERO(&rfds);\r
		FD_SET(((serial_port_unix*)sp)->fd, &rfds);\r
		// wait for more bytes available\r
		res = select(((serial_port_unix*)sp)->fd+1, &rfds, NULL, NULL, &t_remains);\r
		if (res < 0) return false;\r
		if (res == 0) return true; // timeout\r
	}\r
	return true; // should never come here\r
}\r
\r
\r
bool uart_send(const serial_port sp, const uint8_t* pbtTx, const size_t szTxLen) {\r
\r
	if (szTxLen == 0) return true;\r
\r
	size_t bytes_written = 0;\r
\r
	struct timeval t_current;\r
	gettimeofday(&t_current, NULL);\r
	struct timeval t_end;\r
	timeradd(&t_current, &timeout, &t_end);\r
\r
	while (true) {\r
		int res = write(((serial_port_unix*)sp)->fd, pbtTx, szTxLen - bytes_written);\r
		if (res < 0 && res != EAGAIN && res != EWOULDBLOCK) return false;\r
		if (res > 0) {\r
			pbtTx += res;\r
			bytes_written += res;\r
		}\r
		if (bytes_written == szTxLen) return true; // we could write all bytes\r
		gettimeofday(&t_current, NULL);\r
		if (timercmp(&t_current, &t_end, >)) return false; // timeout\r
		// set next select timeout\r
		struct timeval t_remains;\r
		timersub(&t_end, &t_current, &t_remains);\r
		// Set the file descriptor set\r
		fd_set wfds;\r
		FD_ZERO(&wfds);\r
		FD_SET(((serial_port_unix*)sp)->fd, &wfds);\r
		// wait until more bytes can be written\r
		res = select(((serial_port_unix*)sp)->fd+1, NULL, &wfds, NULL, &t_remains);\r
		if (res < 0) return false;  // error\r
		if (res == 0) return false; // timeout\r
	}\r
	return true;\r
}\r
\r
\r
bool uart_set_speed(serial_port sp, const uint32_t uiPortSpeed) {\r
	const serial_port_unix* spu = (serial_port_unix*)sp;\r
	speed_t stPortSpeed;\r
	switch (uiPortSpeed) {\r
		case 0: stPortSpeed = B0; break;\r
		case 50: stPortSpeed = B50; break;\r
		case 75: stPortSpeed = B75; break;\r
		case 110: stPortSpeed = B110; break;\r
		case 134: stPortSpeed = B134; break;\r
		case 150: stPortSpeed = B150; break;\r
		case 300: stPortSpeed = B300; break;\r
		case 600: stPortSpeed = B600; break;\r
		case 1200: stPortSpeed = B1200; break;\r
		case 1800: stPortSpeed = B1800; break;\r
		case 2400: stPortSpeed = B2400; break;\r
		case 4800: stPortSpeed = B4800; break;\r
		case 9600: stPortSpeed = B9600; break;\r
		case 19200: stPortSpeed = B19200; break;\r
		case 38400: stPortSpeed = B38400; break;\r
#  ifdef B57600\r
		case 57600: stPortSpeed = B57600; break;\r
#  endif\r
#  ifdef B115200\r
		case 115200: stPortSpeed = B115200; break;\r
#  endif\r
#  ifdef B230400\r
		case 230400: stPortSpeed = B230400; break;\r
#  endif\r
#  ifdef B460800\r
		case 460800: stPortSpeed = B460800; break;\r
#  endif\r
#  ifdef B921600\r
		case 921600: stPortSpeed = B921600; break;\r
#  endif\r
		default: return false;\r
	};\r
	struct termios ti;\r
	if (tcgetattr(spu->fd, &ti) == -1) return false;\r
	// Set port speed (Input and Output)\r
	cfsetispeed(&ti,stPortSpeed);\r
	cfsetospeed(&ti,stPortSpeed);\r
	return (tcsetattr(spu->fd, TCSANOW, &ti) != -1);\r
}\r
\r
uint32_t uart_get_speed(const serial_port sp) {\r
	struct termios ti;\r
	uint32_t uiPortSpeed;\r
	const serial_port_unix* spu = (serial_port_unix*)sp;\r
	if (tcgetattr(spu->fd, &ti) == -1) return 0;\r
	// Set port speed (Input)\r
	speed_t stPortSpeed = cfgetispeed(&ti);\r
	switch (stPortSpeed) {\r
		case B0: uiPortSpeed = 0; break;\r
		case B50: uiPortSpeed = 50; break;\r
		case B75: uiPortSpeed = 75; break;\r
		case B110: uiPortSpeed = 110; break;\r
		case B134: uiPortSpeed = 134; break;\r
		case B150: uiPortSpeed = 150; break;\r
		case B300: uiPortSpeed = 300; break;\r
		case B600: uiPortSpeed = 600; break;\r
		case B1200: uiPortSpeed = 1200; break;\r
		case B1800: uiPortSpeed = 1800; break;\r
		case B2400: uiPortSpeed = 2400; break;\r
		case B4800: uiPortSpeed = 4800; break;\r
		case B9600: uiPortSpeed = 9600; break;\r
		case B19200: uiPortSpeed = 19200; break;\r
		case B38400: uiPortSpeed = 38400; break;\r
#  ifdef B57600\r
		case B57600: uiPortSpeed = 57600; break;\r
#  endif\r
#  ifdef B115200\r
		case B115200: uiPortSpeed = 115200; break;\r
#  endif\r
#  ifdef B230400\r
		case B230400: uiPortSpeed = 230400; break;\r
#  endif\r
#  ifdef B460800\r
		case B460800: uiPortSpeed = 460800; break;\r
#  endif\r
#  ifdef B921600\r
		case B921600: uiPortSpeed = 921600; break;\r
#  endif\r
		default: return 0;\r
	};\r
	return uiPortSpeed;\r
}\r
\r
#endif\r