uart_nrf.h

Go to the documentation of this file.

#ifndef NRF_UART_H
#define NRF_UART_H
/**********************************************************************/
/*
 * Copyright (c) 2013-2017, Jetro AS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Driver for the NRF's UART block(s).
 *
 * This driver provides interface to the NRF's UART block(s).
 *
 * @author PE, DT, SE, Jetro AS
 */ /******************************************************************/

#include <hal/nrf_uarte.h>
#include <dev/uart.h>

/**
 * \defgroup nrf_uart nRF52 UART driver
 * \ingroup uart
 * \ingroup nrf52
 * \{
 *
 * This driver provides interface to the NRF's UART block(s).
 */

/***********************************************************************
 * Global defines
***********************************************************************/
extern const struct uart_api_t NrfUartFunc;


/** Interrupt sources */
enum nrf_uart_interrupt_source_t
{
  UART_INTERRUPT_SOURCE_UART,     //!< UART interrupt
  UART_INTERRUPT_SOURCE_ACTIVITY, //!< Activity on RX pin detected
  UART_INTERRUPT_SOURCE_TIMEOUT,  //!< Timeout after last word received
};

/**
 * UART driver run-time state
 */
struct nrf_uart_state_t
{
};

/**
 * UART driver configuration data
 */
struct nrf_uart_t
{
  NRF_UARTE_Type *Dev;                       /**< Address to UART device to use. */
  uint32_t IrqPriority;                      /**< HW IRQ priority (see enum EVE_IRQ_PRIORITIES) */
  struct nrf_uart_state_t *State;            /**< Address to struct with RAM variables used by the uart driver */
  NRF_TIMER_Type *Timer;                     /**< Timer used for detection of timeouts */
  uint8_t PPI_ID;                            /**< PPI ID used for detection of timeouts */
  uint8_t GPIOTE_ID;                         /**< GPIOTE ID used for detection of timeouts */

  struct
  {
    uint8_t Rts;                             /**< Location of the Rts pin */
    uint8_t Txd;                             /**< Location of the Txd pin */
    uint8_t Cts;                             /**< Location of the Cts pin */
    uint8_t Rxd;                             /**< Location of the Rxd pin */
  } Location;
};

/******************************************************************************
 * PUBLIC FUNCTIONS
 ******************************************************************************/

void NrfUartInit(const struct uart_t *Uart);
void NrfUartDisable(const struct uart_t *Uart);
void NrfUartStartBasicTx(const struct uart_t *Uart, uint8_t *DataSrc, uint16_t DataSize, uart_tx_callback_t Callback, void *CallbackData);
void NrfUartStartPingPongTx(const struct uart_t *Uart, uint8_t *PrimDataSrc, uint16_t PrimDataSize, uint8_t *AltDataSrc, uint16_t AltDataSize, uart_tx_callback_t Callback, void *CallbackData);
void NrfUartRefreshPingPongTx(const struct uart_t *Uart, uint8_t *DataSrc, uint16_t DataSize, bool Stop);
void NrfUartCancelTx(const struct uart_t *Uart);
bool NrfUartIsBusyTx(const struct uart_t *Uart);
void NrfUartStartBasicRx(const struct uart_t *Uart, uint8_t *DataDest, uint16_t DataSize, uart_rx_callback_t Callback, void *CallbackData);
void NrfUartStartPingPongRx(const struct uart_t *Uart, uint8_t *PrimDataSrc, uint16_t PrimDataSize, uint8_t *AltDataSrc, uint16_t AltDataSize,uart_rx_callback_t Callback, void *CallbackData);
void NrfUartRefreshPingPongRx(const struct uart_t *Uart, uint8_t *DataDest, uint16_t DataSize, bool Stop);
void NrfUartCancelRx(const struct uart_t *Uart);
bool NrfUartIsBusyRx(const struct uart_t *Uart);
void NrfUartSetBaudrate(const struct uart_t *Uart);
void NrfUartSetRxTimeouts(const struct uart_t *Uart, uint32_t RxStartTimeoutUs, uint32_t RxStopTimeoutUs);
void NrfUartSendBreak(const struct uart_t *Uart, uart_break_callback_t Callback, void *CallbackData);
void NrfUartSetRts(const struct uart_t *Uart, bool Active);
void NrfUartInterruptHandler(const struct uart_t *Uart, enum nrf_uart_interrupt_source_t Source);


/** @} nrf_uart */

#endif //NRF_UART