747c0f26a3ee34e0d1fd60c2b6a2bc991e4b2f56
[proxmark3-svn] / client / uart.h
1 /*
2 * Generic uart / rs232/ serial port library
3 *
4 * Copyright (c) 2013, Roel Verdult
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
34 #ifndef _RS232_H_
35 #define _RS232_H_
36
37 #include <stdio.h>
38 #include <string.h>
39 #include <stdlib.h>
40
41 #include <stdint.h>
42 #include <stdbool.h>
43
44 typedef unsigned char byte_t;
45
46 // Handle platform specific includes
47 #ifndef _WIN32
48 #include <termios.h>
49 #include <sys/ioctl.h>
50 #include <unistd.h>
51 #include <fcntl.h>
52 #include <sys/types.h>
53 #include <sys/stat.h>
54 #include <limits.h>
55 #include <sys/time.h>
56 #include <errno.h>
57 #else
58 #include <windows.h>
59 #endif
60
61 typedef enum {
62 SP_INVALID = 0x00, // invalid value, error occured
63 SP_NONE = 0x01, // no parity (default)
64 SP_EVEN = 0x02, // even parity
65 SP_ODD = 0x03 // odd parity
66 } serial_port_parity;
67
68 // Define shortcut to types to make code more readable
69 typedef void* serial_port;
70 #define INVALID_SERIAL_PORT (void*)(~1)
71 #define CLAIMED_SERIAL_PORT (void*)(~2)
72
73 serial_port uart_open(const char* pcPortName);
74 void uart_close(const serial_port sp);
75
76 bool uart_set_speed(serial_port sp, const uint32_t uiPortSpeed);
77 uint32_t uart_get_speed(const serial_port sp);
78
79 bool uart_set_parity(serial_port sp, serial_port_parity spp);
80 serial_port_parity uart_get_parity(const serial_port sp);
81
82 bool uart_receive(const serial_port sp, byte_t* pbtRx, size_t* pszRxLen);
83 bool uart_send(const serial_port sp, const byte_t* pbtTx, const size_t szTxLen);
84
85 #endif // _PROXMARK3_RS232_H_
86
87
Impressum, Datenschutz