openblt/Host/Source/SerialBoot/xcptpuart.h

67 lines
2.9 KiB
C

/************************************************************************************//**
* \file xcptpuart.h
* \brief XCP transport layer module for UART header file.
* \ingroup SerialBoot
* \internal
*----------------------------------------------------------------------------------------
* C O P Y R I G H T
*----------------------------------------------------------------------------------------
* Copyright (c) 2017 by Feaser http://www.feaser.com All rights reserved
*
*----------------------------------------------------------------------------------------
* L I C E N S E
*----------------------------------------------------------------------------------------
* This file is part of OpenBLT. OpenBLT is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* OpenBLT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You have received a copy of the GNU General Public License along with OpenBLT. It
* should be located in ".\Doc\license.html". If not, contact Feaser to obtain a copy.
*
* \endinternal
****************************************************************************************/
#ifndef XCPTPUART_H
#define XCPTPUART_H
#ifdef __cplusplus
extern "C" {
#endif
/****************************************************************************************
* Include files
****************************************************************************************/
#include "xcploader.h" /* XCP loader module */
#include "serialport.h" /* serial port module */
/***************************************************************************************
* Type definitions
****************************************************************************************/
/** \brief Layout of structure with settings specific to the XCP transport layer module
* for UART.
*/
typedef struct t_xcp_tp_uart_settings
{
tSerialPortBaudrate baudrate; /**< UART communication speed. */
char *portname; /**< interface port name, i.e. /dev/ttyUSB0. */
} tXcpTpUartSettings;
/***************************************************************************************
* Function prototypes
****************************************************************************************/
tXcpTransport const * const XcpTpUartGetTransport(void);
#ifdef __cplusplus
}
#endif
#endif /* XCPTPUART_H */
/********************************* end of xcptpuart.h **********************************/