]> git.zerfleddert.de Git - proxmark3-svn/blob - uart/uart.h
fixing iso15693
[proxmark3-svn] / uart / 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 */
31
32 #ifndef PM3_UART_H__
33 #define PM3_UART_H__
34
35 #include <stdlib.h>
36 #include <stdint.h>
37 #include <stdbool.h>
38
39 /* Used to substitute for an example serial port path on each platform.
40 */
41 #ifdef _WIN32
42 #define SERIAL_PORT_H "com3"
43 #elif __APPLE__
44 #define SERIAL_PORT_H "/dev/tty.usbmodem*"
45 #else
46 #define SERIAL_PORT_H "/dev/ttyACM0"
47 #endif
48
49 /* serial_port is declared as a void*, which you should cast to whatever type
50 * makes sense to your connection method. Both the posix and win32
51 * implementations define their own structs in place.
52 */
53 typedef void* serial_port;
54
55 /* Returned by uart_open if the serial port specified was invalid.
56 */
57 #define INVALID_SERIAL_PORT (void*)(~1)
58
59 /* Returned by uart_open if the serial port specified is in use by another
60 * process.
61 */
62 #define CLAIMED_SERIAL_PORT (void*)(~2)
63
64 /* Given a user-specified port name, connect to the port and return a structure
65 * used for future references to that port.
66 *
67 * On errors, this method returns INVALID_SERIAL_PORT or CLAIMED_SERIAL_PORT.
68 */
69 extern serial_port uart_open(const char* pcPortName);
70
71 /* Closes the given port.
72 */
73 extern void uart_close(const serial_port sp);
74
75 /* Reads from the given serial port for up to 30ms.
76 * pbtRx: A pointer to a buffer for the returned data to be written to.
77 * pszMaxRxLen: The maximum data size we want to be sent.
78 * pszRxLen: The number of bytes that we were actually sent.
79 *
80 * Returns TRUE if any data was fetched, even if it was less than pszMaxRxLen.
81 *
82 * Returns FALSE if there was an error reading from the device. Note that a
83 * partial read may have completed into the buffer by the corresponding
84 * implementation, so pszRxLen should be checked to see if any data was written.
85 */
86 extern bool uart_receive(const serial_port sp, uint8_t* pbtRx, size_t pszMaxRxLen, size_t* pszRxLen);
87
88 /* Sends a buffer to a given serial port.
89 * pbtTx: A pointer to a buffer containing the data to send.
90 * szTxLen: The amount of data to be sent.
91 *
92 * Returns TRUE if all data could be sent within 30ms.
93 */
94 extern bool uart_send(const serial_port sp, const uint8_t* pbtTx, const size_t szTxLen);
95
96 /* Sets the current speed of the serial port, in baud.
97 */
98 bool uart_set_speed(serial_port sp, const uint32_t uiPortSpeed);
99
100 /* Gets the current speed of the serial port, in baud.
101 */
102 extern uint32_t uart_get_speed(const serial_port sp);
103
104 #endif // PM3_UART_H__
105
Impressum, Datenschutz