182 lines
5.5 KiB
C
182 lines
5.5 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file uart_lld.h
|
|
* @brief PLATFORM UART subsystem low level driver header.
|
|
*
|
|
* @addtogroup UART
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _UART_LLD_H_
|
|
#define _UART_LLD_H_
|
|
|
|
#if HAL_USE_UART || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name PLATFORM configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief UART driver enable switch.
|
|
* @details If set to @p TRUE the support for UART1 is included.
|
|
*/
|
|
#if !defined(PLATFORM_UART_USE_UART1) || defined(__DOXYGEN__)
|
|
#define PLATFORM_UART_USE_UART1 FALSE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief UART driver condition flags type.
|
|
*/
|
|
typedef uint32_t uartflags_t;
|
|
|
|
/**
|
|
* @brief Type of structure representing an UART driver.
|
|
*/
|
|
typedef struct UARTDriver UARTDriver;
|
|
|
|
/**
|
|
* @brief Generic UART notification callback type.
|
|
*
|
|
* @param[in] uartp pointer to the @p UARTDriver object
|
|
*/
|
|
typedef void (*uartcb_t)(UARTDriver *uartp);
|
|
|
|
/**
|
|
* @brief Character received UART notification callback type.
|
|
*
|
|
* @param[in] uartp pointer to the @p UARTDriver object triggering the
|
|
* callback
|
|
* @param[in] c received character
|
|
*/
|
|
typedef void (*uartccb_t)(UARTDriver *uartp, uint16_t c);
|
|
|
|
/**
|
|
* @brief Receive error UART notification callback type.
|
|
*
|
|
* @param[in] uartp pointer to the @p UARTDriver object triggering the
|
|
* callback
|
|
* @param[in] e receive error mask
|
|
*/
|
|
typedef void (*uartecb_t)(UARTDriver *uartp, uartflags_t e);
|
|
|
|
/**
|
|
* @brief Driver configuration structure.
|
|
* @note Implementations may extend this structure to contain more,
|
|
* architecture dependent, fields.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief End of transmission buffer callback.
|
|
*/
|
|
uartcb_t txend1_cb;
|
|
/**
|
|
* @brief Physical end of transmission callback.
|
|
*/
|
|
uartcb_t txend2_cb;
|
|
/**
|
|
* @brief Receive buffer filled callback.
|
|
*/
|
|
uartcb_t rxend_cb;
|
|
/**
|
|
* @brief Character received while out if the @p UART_RECEIVE state.
|
|
*/
|
|
uartccb_t rxchar_cb;
|
|
/**
|
|
* @brief Receive error callback.
|
|
*/
|
|
uartecb_t rxerr_cb;
|
|
/* End of the mandatory fields.*/
|
|
} UARTConfig;
|
|
|
|
/**
|
|
* @brief Structure representing an UART driver.
|
|
* @note Implementations may extend this structure to contain more,
|
|
* architecture dependent, fields.
|
|
*/
|
|
struct UARTDriver {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
uartstate_t state;
|
|
/**
|
|
* @brief Transmitter state.
|
|
*/
|
|
uarttxstate_t txstate;
|
|
/**
|
|
* @brief Receiver state.
|
|
*/
|
|
uartrxstate_t rxstate;
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const UARTConfig *config;
|
|
#if defined(UART_DRIVER_EXT_FIELDS)
|
|
UART_DRIVER_EXT_FIELDS
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
};
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if PLATFORM_UART_USE_UART1 && !defined(__DOXYGEN__)
|
|
extern UARTDriver UARTD1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void uart_lld_init(void);
|
|
void uart_lld_start(UARTDriver *uartp);
|
|
void uart_lld_stop(UARTDriver *uartp);
|
|
void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf);
|
|
size_t uart_lld_stop_send(UARTDriver *uartp);
|
|
void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf);
|
|
size_t uart_lld_stop_receive(UARTDriver *uartp);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_UART */
|
|
|
|
#endif /* _UART_LLD_H_ */
|
|
|
|
/** @} */
|