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