[proxmark3-svn] / client / uart.h

/*
 * Generic uart / rs232/ serial port library
 *
 * Copyright (c) 2013, Roel Verdult
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @file uart.h
 * @brief
 *
 */

#ifndef _RS232_H_
#define _RS232_H_

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>

typedef unsigned char byte_t;

// Handle platform specific includes
#ifndef _WIN32
  #include <termios.h>
  #include <sys/ioctl.h>
  #include <unistd.h>
  #include <fcntl.h>
  #include <sys/types.h>
  #include <sys/stat.h>
  #include <limits.h>
  #include <sys/time.h>
  #include <errno.h>
#else
  #include <windows.h>
#endif

typedef enum {
  SP_INVALID = 0x00, // invalid value, error occured
  SP_NONE    = 0x01, // no parity (default)
  SP_EVEN    = 0x02, // even parity
  SP_ODD     = 0x03  // odd parity
} serial_port_parity;

// Define shortcut to types to make code more readable
typedef void* serial_port;
#define INVALID_SERIAL_PORT (void*)(~1)
#define CLAIMED_SERIAL_PORT (void*)(~2)

serial_port uart_open(const char* pcPortName);
void uart_close(const serial_port sp);

bool uart_set_speed(serial_port sp, const uint32_t uiPortSpeed);
uint32_t uart_get_speed(const serial_port sp);

bool uart_set_parity(serial_port sp, serial_port_parity spp);
serial_port_parity uart_get_parity(const serial_port sp);

bool uart_receive(const serial_port sp, byte_t* pbtRx, size_t* pszRxLen);
bool uart_send(const serial_port sp, const byte_t* pbtTx, const size_t szTxLen);

#endif // _PROXMARK3_RS232_H_
Commit	Line	Data
5bcc76c4	1	/*
13dbdd6b	2	* Generic uart / rs232/ serial port library
5bcc76c4	3	*
13dbdd6b	4	* Copyright (c) 2013, Roel Verdult
5bcc76c4	5	* All rights reserved.
	6	*
	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions are met:
	9	* 1. Redistributions of source code must retain the above copyright
	10	* notice, this list of conditions and the following disclaimer.
	11	* 2. Redistributions in binary form must reproduce the above copyright
	12	* notice, this list of conditions and the following disclaimer in the
	13	* documentation and/or other materials provided with the distribution.
	14	* 3. Neither the name of the copyright holders nor the
	15	* names of its contributors may be used to endorse or promote products
	16	* derived from this software without specific prior written permission.
	17	*
	18	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
	19	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	20	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	21	* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
	22	* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	23	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	24	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	25	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	26	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	27	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	28	*
	29	* @file uart.h
	30	* @brief
	31	*
	32	*/
	33
13dbdd6b	34	#ifndef _RS232_H_
13dbdd6b	35	#define _RS232_H_
5bcc76c4	36
	37	#include <stdio.h>
	38	#include <string.h>
	39	#include <stdlib.h>
5bcc76c4	40	#include <stdint.h>
	41	#include <stdbool.h>
	42
	43	typedef unsigned char byte_t;
	44
	45	// Handle platform specific includes
	46	#ifndef _WIN32
	47	#include <termios.h>
	48	#include <sys/ioctl.h>
	49	#include <unistd.h>
	50	#include <fcntl.h>
	51	#include <sys/types.h>
	52	#include <sys/stat.h>
	53	#include <limits.h>
	54	#include <sys/time.h>
13dbdd6b	55	#include <errno.h>
5bcc76c4	56	#else
	57	#include <windows.h>
	58	#endif
	59
62ee4fed	60	typedef enum {
	61	SP_INVALID = 0x00, // invalid value, error occured
	62	SP_NONE = 0x01, // no parity (default)
	63	SP_EVEN = 0x02, // even parity
	64	SP_ODD = 0x03 // odd parity
	65	} serial_port_parity;
	66
5bcc76c4	67	// Define shortcut to types to make code more readable
	68	typedef void* serial_port;
	69	#define INVALID_SERIAL_PORT (void*)(~1)
	70	#define CLAIMED_SERIAL_PORT (void*)(~2)
	71
	72	serial_port uart_open(const char* pcPortName);
	73	void uart_close(const serial_port sp);
	74
13dbdd6b	75	bool uart_set_speed(serial_port sp, const uint32_t uiPortSpeed);
5bcc76c4	76	uint32_t uart_get_speed(const serial_port sp);
5bcc76c4	77
62ee4fed	78	bool uart_set_parity(serial_port sp, serial_port_parity spp);
	79	serial_port_parity uart_get_parity(const serial_port sp);
	80
5bcc76c4	81	bool uart_receive(const serial_port sp, byte_t* pbtRx, size_t* pszRxLen);
	82	bool uart_send(const serial_port sp, const byte_t* pbtTx, const size_t szTxLen);
	83
	84	#endif // _PROXMARK3_RS232_H_
	85
	86