fsl_lpuart.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_LPUART_H_
#define _FSL_LPUART_H_

#include "fsl_common.h"

/*******************************************************************************
 * Definitions
 ******************************************************************************/
#define FSL_LPUART_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) 
enum _lpuart_status
{
    kStatus_LPUART_TxBusy = MAKE_STATUS(kStatusGroup_LPUART, 0),              
    kStatus_LPUART_RxBusy = MAKE_STATUS(kStatusGroup_LPUART, 1),              
    kStatus_LPUART_TxIdle = MAKE_STATUS(kStatusGroup_LPUART, 2),              
    kStatus_LPUART_RxIdle = MAKE_STATUS(kStatusGroup_LPUART, 3),              
    kStatus_LPUART_TxWatermarkTooLarge = MAKE_STATUS(kStatusGroup_LPUART, 4), 
    kStatus_LPUART_RxWatermarkTooLarge = MAKE_STATUS(kStatusGroup_LPUART, 5), 
    kStatus_LPUART_FlagCannotClearManually =
        MAKE_STATUS(kStatusGroup_LPUART, 6),                    
    kStatus_LPUART_Error = MAKE_STATUS(kStatusGroup_LPUART, 7), 
    kStatus_LPUART_RxRingBufferOverrun =
        MAKE_STATUS(kStatusGroup_LPUART, 8), 
    kStatus_LPUART_RxHardwareOverrun = MAKE_STATUS(kStatusGroup_LPUART, 9) 
};

typedef enum _lpuart_parity_mode
{
    kLPUART_ParityDisabled = 0x0U, 
    kLPUART_ParityEven = 0x2U,     
    kLPUART_ParityOdd = 0x3U,      
} lpuart_parity_mode_t;

typedef enum _lpuart_stop_bit_count
{
    kLPUART_OneStopBit = 0U, 
    kLPUART_TwoStopBit = 1U, 
} lpuart_stop_bit_count_t;

enum _lpuart_interrupt_enable
{
#if defined(FSL_FEATURE_LPUART_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_LPUART_HAS_LIN_BREAK_DETECT
    kLPUART_LinBreakInterruptEnable = (LPUART_BAUD_LBKDIE_MASK >> 8), 
#endif
    kLPUART_RxActiveEdgeInterruptEnable = (LPUART_BAUD_RXEDGIE_MASK >> 8), 
    kLPUART_TxDataRegEmptyInterruptEnable = (LPUART_CTRL_TIE_MASK),        
    kLPUART_TransmissionCompleteInterruptEnable = (LPUART_CTRL_TCIE_MASK), 
    kLPUART_RxDataRegFullInterruptEnable = (LPUART_CTRL_RIE_MASK),         
    kLPUART_IdleLineInterruptEnable = (LPUART_CTRL_ILIE_MASK),             
    kLPUART_RxOverrunInterruptEnable = (LPUART_CTRL_ORIE_MASK),            
    kLPUART_NoiseErrorInterruptEnable = (LPUART_CTRL_NEIE_MASK),           
    kLPUART_FramingErrorInterruptEnable = (LPUART_CTRL_FEIE_MASK),         
    kLPUART_ParityErrorInterruptEnable = (LPUART_CTRL_PEIE_MASK),          
#if defined(FSL_FEATURE_LPUART_HAS_FIFO) && FSL_FEATURE_LPUART_HAS_FIFO
    kLPUART_TxFifoOverflowInterruptEnable = (LPUART_FIFO_TXOFE_MASK >> 8),  
    kLPUART_RxFifoUnderflowInterruptEnable = (LPUART_FIFO_RXUFE_MASK >> 8), 
#endif
};

enum _lpuart_flags
{
    kLPUART_TxDataRegEmptyFlag =
        (LPUART_STAT_TDRE_MASK), 
    kLPUART_TransmissionCompleteFlag =
        (LPUART_STAT_TC_MASK), 
    kLPUART_RxDataRegFullFlag =
        (LPUART_STAT_RDRF_MASK), 
    kLPUART_IdleLineFlag = (LPUART_STAT_IDLE_MASK), 
    kLPUART_RxOverrunFlag = (LPUART_STAT_OR_MASK),  
    kLPUART_NoiseErrorFlag = (LPUART_STAT_NF_MASK), 
    kLPUART_FramingErrorFlag =
        (LPUART_STAT_FE_MASK), 
    kLPUART_ParityErrorFlag = (LPUART_STAT_PF_MASK), 
#if defined(FSL_FEATURE_LPUART_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_LPUART_HAS_LIN_BREAK_DETECT
    kLPUART_LinBreakFlag = (LPUART_STAT_LBKDIF_MASK), 
#endif
    kLPUART_RxActiveEdgeFlag =
        (LPUART_STAT_RXEDGIF_MASK), 
    kLPUART_RxActiveFlag =
        (LPUART_STAT_RAF_MASK), 
#if defined(FSL_FEATURE_LPUART_HAS_ADDRESS_MATCHING) && FSL_FEATURE_LPUART_HAS_ADDRESS_MATCHING
    kLPUART_DataMatch1Flag = LPUART_STAT_MA1F_MASK, 
    kLPUART_DataMatch2Flag = LPUART_STAT_MA2F_MASK, 
#endif
#if defined(FSL_FEATURE_LPUART_HAS_EXTENDED_DATA_REGISTER_FLAGS) && FSL_FEATURE_LPUART_HAS_EXTENDED_DATA_REGISTER_FLAGS
    kLPUART_NoiseErrorInRxDataRegFlag =
        (LPUART_DATA_NOISY_MASK >> 10), 
    kLPUART_ParityErrorInRxDataRegFlag =
        (LPUART_DATA_PARITYE_MASK >> 10), 
#endif
#if defined(FSL_FEATURE_LPUART_HAS_FIFO) && FSL_FEATURE_LPUART_HAS_FIFO
    kLPUART_TxFifoEmptyFlag = (LPUART_FIFO_TXEMPT_MASK >> 16), 
    kLPUART_RxFifoEmptyFlag = (LPUART_FIFO_RXEMPT_MASK >> 16), 
    kLPUART_TxFifoOverflowFlag =
        (LPUART_FIFO_TXOF_MASK >> 16), 
    kLPUART_RxFifoUnderflowFlag =
        (LPUART_FIFO_RXUF_MASK >> 16), 
#endif
};

typedef struct _lpuart_config
{
    uint32_t baudRate_Bps;           
    lpuart_parity_mode_t parityMode; 
#if defined(FSL_FEATURE_LPUART_HAS_STOP_BIT_CONFIG_SUPPORT) && FSL_FEATURE_LPUART_HAS_STOP_BIT_CONFIG_SUPPORT
    lpuart_stop_bit_count_t stopBitCount; 
#endif
#if defined(FSL_FEATURE_LPUART_HAS_FIFO) && FSL_FEATURE_LPUART_HAS_FIFO
    uint8_t txFifoWatermark; 
    uint8_t rxFifoWatermark; 
#endif
    bool enableTx; 
    bool enableRx; 
} lpuart_config_t;

typedef struct _lpuart_transfer
{
    uint8_t *data;   
    size_t dataSize; 
} lpuart_transfer_t;

/* Forward declaration of the handle typedef. */
typedef struct _lpuart_handle lpuart_handle_t;

typedef void (*lpuart_transfer_callback_t)(LPUART_Type *base, lpuart_handle_t *handle, status_t status, void *userData);

struct _lpuart_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; 
    lpuart_transfer_callback_t callback; 
    void *userData;                      
    volatile uint8_t txState; 
    volatile uint8_t rxState; 
};

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

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

void LPUART_Init(LPUART_Type *base, const lpuart_config_t *config, uint32_t srcClock_Hz);

void LPUART_Deinit(LPUART_Type *base);

void LPUART_GetDefaultConfig(lpuart_config_t *config);

void LPUART_SetBaudRate(LPUART_Type *base, uint32_t baudRate_Bps, uint32_t srcClock_Hz);

/* @} */

uint32_t LPUART_GetStatusFlags(LPUART_Type *base);

status_t LPUART_ClearStatusFlags(LPUART_Type *base, uint32_t mask);

/* @} */

void LPUART_EnableInterrupts(LPUART_Type *base, uint32_t mask);

void LPUART_DisableInterrupts(LPUART_Type *base, uint32_t mask);

uint32_t LPUART_GetEnabledInterrupts(LPUART_Type *base);

#if defined(FSL_FEATURE_LPUART_HAS_DMA_ENABLE) && FSL_FEATURE_LPUART_HAS_DMA_ENABLE

static inline uint32_t LPUART_GetDataRegisterAddress(LPUART_Type *base)
{
    return (uint32_t) & (base->DATA);
}

static inline void LPUART_EnableTxDMA(LPUART_Type *base, bool enable)
{
    if (enable)
    {
        base->BAUD |= LPUART_BAUD_TDMAE_MASK;
        base->CTRL |= LPUART_CTRL_TIE_MASK;
    }
    else
    {
        base->BAUD &= ~LPUART_BAUD_TDMAE_MASK;
        base->CTRL &= ~LPUART_CTRL_TIE_MASK;
    }
}

static inline void LPUART_EnableRxDMA(LPUART_Type *base, bool enable)
{
    if (enable)
    {
        base->BAUD |= LPUART_BAUD_RDMAE_MASK;
        base->CTRL |= LPUART_CTRL_RIE_MASK;
    }
    else
    {
        base->BAUD &= ~LPUART_BAUD_RDMAE_MASK;
        base->CTRL &= ~LPUART_CTRL_RIE_MASK;
    }
}

/* @} */
#endif /* FSL_FEATURE_LPUART_HAS_DMA_ENABLE */

static inline void LPUART_EnableTx(LPUART_Type *base, bool enable)
{
    if (enable)
    {
        base->CTRL |= LPUART_CTRL_TE_MASK;
    }
    else
    {
        base->CTRL &= ~LPUART_CTRL_TE_MASK;
    }
}

static inline void LPUART_EnableRx(LPUART_Type *base, bool enable)
{
    if (enable)
    {
        base->CTRL |= LPUART_CTRL_RE_MASK;
    }
    else
    {
        base->CTRL &= ~LPUART_CTRL_RE_MASK;
    }
}

void LPUART_WriteBlocking(LPUART_Type *base, const uint8_t *data, size_t length);

static inline void LPUART_WriteByte(LPUART_Type *base, uint8_t data)
{
    base->DATA = data;
}

void LPUART_ReadBlocking(LPUART_Type *base, uint8_t *data, size_t length);

static inline uint8_t LPUART_ReadByte(LPUART_Type *base)
{
    return base->DATA;
}

/* @} */

void LPUART_CreateHandle(LPUART_Type *base,
                         lpuart_handle_t *handle,
                         lpuart_transfer_callback_t callback,
                         void *userData);

status_t LPUART_SendNonBlocking(LPUART_Type *base, lpuart_handle_t *handle, lpuart_transfer_t *xfer);

void LPUART_StartRingBuffer(LPUART_Type *base, lpuart_handle_t *handle, uint8_t *ringBuffer, size_t ringBufferSize);

void LPUART_StopRingBuffer(LPUART_Type *base, lpuart_handle_t *handle);

void LPUART_AbortSend(LPUART_Type *base, lpuart_handle_t *handle);

status_t LPUART_GetSendCount(LPUART_Type *base, lpuart_handle_t *handle, uint32_t *count);

status_t LPUART_ReceiveNonBlocking(LPUART_Type *base,
                                   lpuart_handle_t *handle,
                                   lpuart_transfer_t *xfer,
                                   size_t *receivedBytes);

void LPUART_AbortReceive(LPUART_Type *base, lpuart_handle_t *handle);

status_t LPUART_GetReceiveCount(LPUART_Type *base, lpuart_handle_t *handle, uint32_t *count);

void LPUART_HandleIRQ(LPUART_Type *base, lpuart_handle_t *handle);

void LPUART_HandleErrorIRQ(LPUART_Type *base, lpuart_handle_t *handle);

/* @} */

#if defined(__cplusplus)
}
#endif

#endif /* _FSL_LPUART_H_ */