tinySA/os/hal/include/uart.h

/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT 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.

    ChibiOS/RT 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 should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    uart.h
 * @brief   UART Driver macros and structures.
 *
 * @addtogroup UART
 * @{
 */

#ifndef _UART_H_
#define _UART_H_

#if CH_HAL_USE_UART || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

/** @brief No pending conditions.*/
#define UART_NO_ERROR           0
/** @brief Parity error happened.*/
#define UART_PARITY_ERROR       4
/** @brief Framing error happened.*/
#define UART_FRAMING_ERROR      8
/** @brief Overflow happened.*/
#define UART_OVERRUN_ERROR      16
/** @brief Noise on the line.*/
#define UART_NOISE_ERROR        32
/** @brief Break detected.*/
#define UART_BREAK_DETECTED     64

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   Driver state machine possible states.
 */
typedef enum {
  UART_UNINIT = 0,                  /**< @brief Not initialized.            */
  UART_STOP = 1,                    /**< @brief Stopped.                    */
  UART_READY = 2                    /**< @brief Ready.                      */
} uartstate_t;

/**
 * @brief   Transmitter state machine states.
 */
typedef enum {
  UART_TX_IDLE = 0,                 /**< @brief Not transmitting.           */
  UART_TX_ACTIVE = 1,               /**< @brief Transmitting.               */
  UART_TX_COMPLETE = 2              /**< @brief Buffer complete.            */
} uarttxstate_t;

/**
 * @brief   Receiver state machine states.
 */
typedef enum {
  UART_RX_IDLE = 0,                 /**< @brief Not receiving.              */
  UART_RX_ACTIVE = 1,               /**< @brief Receiving.                  */
  UART_RX_COMPLETE = 2              /**< @brief Buffer complete.            */
} uartrxstate_t;

#include "uart_lld.h"

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void uartInit(void);
  void uartObjectInit(UARTDriver *uartp);
  void uartStart(UARTDriver *uartp, const UARTConfig *config);
  void uartStop(UARTDriver *uartp);
  void uartStartSend(UARTDriver *uartp, size_t n, const void *txbuf);
  void uartStartSendI(UARTDriver *uartp, size_t n, const void *txbuf);
  size_t uartStopSend(UARTDriver *uartp);
  size_t uartStopSendI(UARTDriver *uartp);
  void uartStartReceive(UARTDriver *uartp, size_t n, void *rxbuf);
  void uartStartReceiveI(UARTDriver *uartp, size_t n, void *rxbuf);
  size_t uartStopReceive(UARTDriver *uartp);
  size_t uartStopReceiveI(UARTDriver *uartp);
#ifdef __cplusplus
}
#endif

#endif /* CH_HAL_USE_UART */

#endif /* _UART_H_ */

/** @} */