fsl_uart.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
 */
#ifndef _FSL_UART_H_
#define _FSL_UART_H_

#include "fsl_common.h"

/*******************************************************************************
 * Definitions
 ******************************************************************************/
#define FSL_UART_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) 
enum _uart_status
{
    kStatus_UART_TxBusy = MAKE_STATUS(kStatusGroup_UART, 0),              
    kStatus_UART_RxBusy = MAKE_STATUS(kStatusGroup_UART, 1),              
    kStatus_UART_TxIdle = MAKE_STATUS(kStatusGroup_UART, 2),              
    kStatus_UART_RxIdle = MAKE_STATUS(kStatusGroup_UART, 3),              
    kStatus_UART_TxWatermarkTooLarge = MAKE_STATUS(kStatusGroup_UART, 4), 
    kStatus_UART_RxWatermarkTooLarge = MAKE_STATUS(kStatusGroup_UART, 5), 
    kStatus_UART_FlagCannotClearManually =
        MAKE_STATUS(kStatusGroup_UART, 6),                                
    kStatus_UART_Error = MAKE_STATUS(kStatusGroup_UART, 7),               
    kStatus_UART_RxRingBufferOverrun = MAKE_STATUS(kStatusGroup_UART, 8), 
    kStatus_UART_RxHardwareOverrun = MAKE_STATUS(kStatusGroup_UART, 9)    
};

typedef enum _uart_parity_mode
{
    kUART_ParityDisabled = 0x0U, 
    kUART_ParityEven = 0x2U,     
    kUART_ParityOdd = 0x3U,      
} uart_parity_mode_t;

typedef enum _uart_stop_bit_count
{
    kUART_OneStopBit = 0U, 
    kUART_TwoStopBit = 1U, 
} uart_stop_bit_count_t;

enum _uart_interrupt_enable
{
#if defined(FSL_FEATURE_UART_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_UART_HAS_LIN_BREAK_DETECT
    kUART_LinBreakInterruptEnable = (UART_BDH_LBKDIE_MASK), 
#endif
    kUART_RxActiveEdgeInterruptEnable = (UART_BDH_RXEDGIE_MASK),   
    kUART_TxDataRegEmptyInterruptEnable = (UART_C2_TIE_MASK << 8), 
    kUART_TransmissionCompleteInterruptEnable = (UART_C2_TCIE_MASK << 8), 
    kUART_RxDataRegFullInterruptEnable = (UART_C2_RIE_MASK << 8),         
    kUART_IdleLineInterruptEnable = (UART_C2_ILIE_MASK << 8),             
    kUART_RxOverrunInterruptEnable = (UART_C3_ORIE_MASK << 16),           
    kUART_NoiseErrorInterruptEnable = (UART_C3_NEIE_MASK << 16),          
    kUART_FramingErrorInterruptEnable = (UART_C3_FEIE_MASK << 16),        
    kUART_ParityErrorInterruptEnable = (UART_C3_PEIE_MASK << 16),         
#if defined(FSL_FEATURE_UART_HAS_FIFO) && FSL_FEATURE_UART_HAS_FIFO
    kUART_RxFifoOverflowInterruptEnable = (UART_CFIFO_TXOFE_MASK << 24),  
    kUART_TxFifoOverflowInterruptEnable = (UART_CFIFO_RXUFE_MASK << 24),  
    kUART_RxFifoUnderflowInterruptEnable = (UART_CFIFO_RXUFE_MASK << 24), 
#endif
};

enum _uart_flags
{
    kUART_TxDataRegEmptyFlag = (UART_S1_TDRE_MASK),     
    kUART_TransmissionCompleteFlag = (UART_S1_TC_MASK), 
    kUART_RxDataRegFullFlag = (UART_S1_RDRF_MASK),      
    kUART_IdleLineFlag = (UART_S1_IDLE_MASK),           
    kUART_RxOverrunFlag = (UART_S1_OR_MASK),            
    kUART_NoiseErrorFlag = (UART_S1_NF_MASK),           
    kUART_FramingErrorFlag = (UART_S1_FE_MASK),         
    kUART_ParityErrorFlag = (UART_S1_PF_MASK),          
#if defined(FSL_FEATURE_UART_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_UART_HAS_LIN_BREAK_DETECT
    kUART_LinBreakFlag = (UART_S2_LBKDIF_MASK << 8), 
#endif
    kUART_RxActiveEdgeFlag = (UART_S2_RXEDGIF_MASK << 8), 
    kUART_RxActiveFlag = (UART_S2_RAF_MASK << 8),         
#if defined(FSL_FEATURE_UART_HAS_EXTENDED_DATA_REGISTER_FLAGS) && FSL_FEATURE_UART_HAS_EXTENDED_DATA_REGISTER_FLAGS
    kUART_NoiseErrorInRxDataRegFlag = (UART_ED_NOISY_MASK << 16),    
    kUART_ParityErrorInRxDataRegFlag = (UART_ED_PARITYE_MASK << 16), 
#endif
#if defined(FSL_FEATURE_UART_HAS_FIFO) && FSL_FEATURE_UART_HAS_FIFO
    kUART_TxFifoEmptyFlag = (UART_SFIFO_TXEMPT_MASK << 24),   
    kUART_RxFifoEmptyFlag = (UART_SFIFO_RXEMPT_MASK << 24),   
    kUART_TxFifoOverflowFlag = (UART_SFIFO_TXOF_MASK << 24),  
    kUART_RxFifoOverflowFlag = (UART_SFIFO_RXOF_MASK << 24),  
    kUART_RxFifoUnderflowFlag = (UART_SFIFO_RXUF_MASK << 24), 
#endif
};

typedef struct _uart_config
{
    uint32_t baudRate_Bps;         
    uart_parity_mode_t parityMode; 
#if defined(FSL_FEATURE_UART_HAS_STOP_BIT_CONFIG_SUPPORT) && FSL_FEATURE_UART_HAS_STOP_BIT_CONFIG_SUPPORT
    uart_stop_bit_count_t stopBitCount; 
#endif
#if defined(FSL_FEATURE_UART_HAS_FIFO) && FSL_FEATURE_UART_HAS_FIFO
    uint8_t txFifoWatermark; 
    uint8_t rxFifoWatermark; 
#endif
    bool enableTx; 
    bool enableRx; 
} uart_config_t;

typedef struct _uart_transfer
{
    uint8_t *data;   
    size_t dataSize; 
} uart_transfer_t;

/* Forward declaration of the handle typedef. */
typedef struct _uart_handle uart_handle_t;

typedef void (*uart_transfer_callback_t)(UART_Type *base, uart_handle_t *handle, status_t status, void *userData);

struct _uart_handle
{
    uint8_t *volatile txData;   
    volatile size_t txDataSize; 
    size_t txDataSizeAll;       
    uint8_t *volatile rxData;   
    volatile size_t rxDataSize; 
    size_t rxDataSizeAll;       
    uint8_t *rxRingBuffer;              
    size_t rxRingBufferSize;            
    volatile uint16_t rxRingBufferHead; 
    volatile uint16_t rxRingBufferTail; 
    uart_transfer_callback_t callback; 
    void *userData;                    
    volatile uint8_t txState; 
    volatile uint8_t rxState; 
};

/*******************************************************************************
 * API
 ******************************************************************************/

#if defined(__cplusplus)
extern "C" {
#endif /* _cplusplus */

void UART_Init(UART_Type *base, const uart_config_t *config, uint32_t srcClock_Hz);

void UART_Deinit(UART_Type *base);

void UART_GetDefaultConfig(uart_config_t *config);

void UART_SetBaudRate(UART_Type *base, uint32_t baudRate_Bps, uint32_t srcClock_Hz);

/* @} */

uint32_t UART_GetStatusFlags(UART_Type *base);

status_t UART_ClearStatusFlags(UART_Type *base, uint32_t mask);

/* @} */

void UART_EnableInterrupts(UART_Type *base, uint32_t mask);

void UART_DisableInterrupts(UART_Type *base, uint32_t mask);

uint32_t UART_GetEnabledInterrupts(UART_Type *base);

/* @} */

#if defined(FSL_FEATURE_UART_HAS_DMA_SELECT) && FSL_FEATURE_UART_HAS_DMA_SELECT

static inline uint32_t UART_GetDataRegisterAddress(UART_Type *base)
{
    return (uint32_t) & (base->D);
}

static inline void UART_EnableTxDMA(UART_Type *base, bool enable)
{
    if (enable)
    {
#if (defined(FSL_FEATURE_UART_IS_SCI) && FSL_FEATURE_UART_IS_SCI)
        base->C4 |= UART_C4_TDMAS_MASK;
#else
        base->C5 |= UART_C5_TDMAS_MASK;
#endif
        base->C2 |= UART_C2_TIE_MASK;
    }
    else
    {
#if (defined(FSL_FEATURE_UART_IS_SCI) && FSL_FEATURE_UART_IS_SCI)
        base->C4 &= ~UART_C4_TDMAS_MASK;
#else
        base->C5 &= ~UART_C5_TDMAS_MASK;
#endif
        base->C2 &= ~UART_C2_TIE_MASK;
    }
}

static inline void UART_EnableRxDMA(UART_Type *base, bool enable)
{
    if (enable)
    {
#if (defined(FSL_FEATURE_UART_IS_SCI) && FSL_FEATURE_UART_IS_SCI)
        base->C4 |= UART_C4_RDMAS_MASK;
#else
        base->C5 |= UART_C5_RDMAS_MASK;
#endif
        base->C2 |= UART_C2_RIE_MASK;
    }
    else
    {
#if (defined(FSL_FEATURE_UART_IS_SCI) && FSL_FEATURE_UART_IS_SCI)
        base->C4 &= ~UART_C4_RDMAS_MASK;
#else
        base->C5 &= ~UART_C5_RDMAS_MASK;
#endif
        base->C2 &= ~UART_C2_RIE_MASK;
    }
}

/* @} */
#endif /* FSL_FEATURE_UART_HAS_DMA_SELECT */

static inline void UART_EnableTx(UART_Type *base, bool enable)
{
    if (enable)
    {
        base->C2 |= UART_C2_TE_MASK;
    }
    else
    {
        base->C2 &= ~UART_C2_TE_MASK;
    }
}

static inline void UART_EnableRx(UART_Type *base, bool enable)
{
    if (enable)
    {
        base->C2 |= UART_C2_RE_MASK;
    }
    else
    {
        base->C2 &= ~UART_C2_RE_MASK;
    }
}

void UART_WriteBlocking(UART_Type *base, const uint8_t *data, size_t length);

static inline void UART_WriteByte(UART_Type *base, uint8_t data)
{
    base->D = data;
}

void UART_ReadBlocking(UART_Type *base, uint8_t *data, size_t length);

static inline uint8_t UART_ReadByte(UART_Type *base)
{
    return base->D;
}

/* @} */

void UART_CreateHandle(UART_Type *base, uart_handle_t *handle, uart_transfer_callback_t callback, void *userData);

void UART_StartRingBuffer(UART_Type *base, uart_handle_t *handle, uint8_t *ringBuffer, size_t ringBufferSize);

void UART_StopRingBuffer(UART_Type *base, uart_handle_t *handle);

status_t UART_SendNonBlocking(UART_Type *base, uart_handle_t *handle, uart_transfer_t *xfer);

void UART_AbortSend(UART_Type *base, uart_handle_t *handle);

status_t UART_GetSendCount(UART_Type *base, uart_handle_t *handle, uint32_t *count);

status_t UART_ReceiveNonBlocking(UART_Type *base, uart_handle_t *handle, uart_transfer_t *xfer, size_t *receivedBytes);

void UART_AbortReceive(UART_Type *base, uart_handle_t *handle);

status_t UART_GetReceiveCount(UART_Type *base, uart_handle_t *handle, uint32_t *count);

void UART_HandleIRQ(UART_Type *base, uart_handle_t *handle);

void UART_HandleErrorIRQ(UART_Type *base, uart_handle_t *handle);

/* @} */

#if defined(__cplusplus)
}
#endif

#endif /* _FSL_UART_H_ */