/* * Copyright (c) 2015-2016, Freescale Semiconductor, Inc. * Copyright 2016-2017 NXP * * 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 the copyright holder 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_LPSCI_H_ #define _FSL_LPSCI_H_ #include "fsl_common.h" /*! * @addtogroup lpsci_driver * @{ */ /******************************************************************************* * Definitions ******************************************************************************/ /*! @name Driver version */ /*@{*/ /*! @brief LPSCI driver version 2.0.3. */ #define FSL_LPSCI_DRIVER_VERSION (MAKE_VERSION(2, 0, 3)) /*@{*/ /*! @brief Error codes for the LPSCI driver. */ enum _lpsci_status { kStatus_LPSCI_TxBusy = MAKE_STATUS(kStatusGroup_LPSCI, 0), /*!< Transmitter is busy. */ kStatus_LPSCI_RxBusy = MAKE_STATUS(kStatusGroup_LPSCI, 1), /*!< Receiver is busy. */ kStatus_LPSCI_TxIdle = MAKE_STATUS(kStatusGroup_LPSCI, 2), /*!< Transmitter is idle. */ kStatus_LPSCI_RxIdle = MAKE_STATUS(kStatusGroup_LPSCI, 3), /*!< Receiver is idle. */ kStatus_LPSCI_FlagCannotClearManually = MAKE_STATUS(kStatusGroup_LPSCI, 4), /*!< Status flag can't be manually cleared. */ kStatus_LPSCI_BaudrateNotSupport = MAKE_STATUS(kStatusGroup_LPSCI, 5), /*!< Baudrate is not support in current clock source */ kStatus_LPSCI_Error = MAKE_STATUS(kStatusGroup_LPSCI, 6), /*!< Error happens on LPSCI */ kStatus_LPSCI_RxRingBufferOverrun = MAKE_STATUS(kStatusGroup_LPSCI, 7), /*!< LPSCI RX software ring buffer overrun. */ kStatus_LPSCI_RxHardwareOverrun = MAKE_STATUS(kStatusGroup_LPSCI, 8), /*!< LPSCI RX receiver overrun. */ kStatus_LPSCI_NoiseError = MAKE_STATUS(kStatusGroup_LPSCI, 9), /*!< LPSCI noise error. */ kStatus_LPSCI_FramingError = MAKE_STATUS(kStatusGroup_LPSCI, 10), /*!< LPSCI framing error. */ kStatus_LPSCI_ParityError = MAKE_STATUS(kStatusGroup_LPSCI, 11), /*!< LPSCI parity error. */ }; /*! @brief LPSCI parity mode.*/ typedef enum _lpsci_parity_mode { kLPSCI_ParityDisabled = 0x0U, /*!< Parity disabled */ kLPSCI_ParityEven = 0x2U, /*!< Parity enabled, type even, bit setting: PE|PT = 10 */ kLPSCI_ParityOdd = 0x3U, /*!< Parity enabled, type odd, bit setting: PE|PT = 11 */ } lpsci_parity_mode_t; /*! @brief LPSCI stop bit count.*/ typedef enum _lpsci_stop_bit_count { kLPSCI_OneStopBit = 0U, /*!< One stop bit */ kLPSCI_TwoStopBit = 1U, /*!< Two stop bits */ } lpsci_stop_bit_count_t; /*! * @brief LPSCI interrupt configuration structure, default settings all disabled. * * This structure contains the settings for all LPSCI interrupt configurations. */ enum _lpsci_interrupt_enable_t { #if defined(FSL_FEATURE_LPSCI_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_LPSCI_HAS_LIN_BREAK_DETECT kLPSCI_LinBreakInterruptEnable = (UART0_BDH_LBKDIE_MASK), /*!< LIN break detect interrupt. */ #endif kLPSCI_RxActiveEdgeInterruptEnable = (UART0_BDH_RXEDGIE_MASK), /*!< RX Active Edge interrupt. */ kLPSCI_TxDataRegEmptyInterruptEnable = (UART0_C2_TIE_MASK << 8), /*!< Transmit data register empty interrupt. */ kLPSCI_TransmissionCompleteInterruptEnable = (UART0_C2_TCIE_MASK << 8), /*!< Transmission complete interrupt. */ kLPSCI_RxDataRegFullInterruptEnable = (UART0_C2_RIE_MASK << 8), /*!< Receiver data register full interrupt. */ kLPSCI_IdleLineInterruptEnable = (UART0_C2_ILIE_MASK << 8), /*!< Idle line interrupt. */ kLPSCI_RxOverrunInterruptEnable = (UART0_C3_ORIE_MASK << 16), /*!< Receiver Overrun interrupt. */ kLPSCI_NoiseErrorInterruptEnable = (UART0_C3_NEIE_MASK << 16), /*!< Noise error flag interrupt. */ kLPSCI_FramingErrorInterruptEnable = (UART0_C3_FEIE_MASK << 16), /*!< Framing error flag interrupt. */ kLPSCI_ParityErrorInterruptEnable = (UART0_C3_PEIE_MASK << 16), /*!< Parity error flag interrupt. */ kLPSCI_AllInterruptsEnable = kLPSCI_RxActiveEdgeInterruptEnable | kLPSCI_TxDataRegEmptyInterruptEnable | kLPSCI_TransmissionCompleteInterruptEnable | kLPSCI_RxDataRegFullInterruptEnable | kLPSCI_IdleLineInterruptEnable | kLPSCI_RxOverrunInterruptEnable | kLPSCI_NoiseErrorInterruptEnable | kLPSCI_FramingErrorInterruptEnable | kLPSCI_ParityErrorInterruptEnable #if defined(FSL_FEATURE_LPSCI_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_LPSCI_HAS_LIN_BREAK_DETECT | kLPSCI_LinBreakInterruptEnable #endif , }; /*! * @brief LPSCI status flags. * * This provides constants for the LPSCI status flags for use in the LPSCI functions. */ enum _lpsci_status_flag_t { kLPSCI_TxDataRegEmptyFlag = (UART0_S1_TDRE_MASK), /*!< Tx data register empty flag, sets when Tx buffer is empty */ kLPSCI_TransmissionCompleteFlag = (UART0_S1_TC_MASK), /*!< Transmission complete flag, sets when transmission activity complete */ kLPSCI_RxDataRegFullFlag = (UART0_S1_RDRF_MASK), /*!< Rx data register full flag, sets when the receive data buffer is full */ kLPSCI_IdleLineFlag = (UART0_S1_IDLE_MASK), /*!< Idle line detect flag, sets when idle line detected */ kLPSCI_RxOverrunFlag = (UART0_S1_OR_MASK), /*!< Rx Overrun, sets when new data is received before data is read from receive register */ kLPSCI_NoiseErrorFlag = (UART0_S1_NF_MASK), /*!< Rx takes 3 samples of each received bit. If any of these samples differ, noise flag sets */ kLPSCI_FramingErrorFlag = (UART0_S1_FE_MASK), /*!< Frame error flag, sets if logic 0 was detected where stop bit expected */ kLPSCI_ParityErrorFlag = (UART0_S1_PF_MASK), /*!< If parity enabled, sets upon parity error detection */ #if defined(FSL_FEATURE_LPSCI_HAS_LIN_BREAK_DETECT) && FSL_FEATURE_LPSCI_HAS_LIN_BREAK_DETECT kLPSCI_LinBreakFlag = (UART0_S2_LBKDIF_MASK << 8), /*!< LIN break detect interrupt flag, sets when LIN break char detected and LIN circuit enabled */ #endif kLPSCI_RxActiveEdgeFlag = (UART0_S2_RXEDGIF_MASK << 8), /*!< Rx pin active edge interrupt flag, sets when active edge detected */ kLPSCI_RxActiveFlag = (UART0_S2_RAF_MASK << 8), /*!< Receiver Active Flag (RAF), sets at beginning of valid start bit */ #if defined(FSL_FEATURE_LPSCI_HAS_EXTENDED_DATA_REGISTER_FLAGS) && FSL_FEATURE_LPSCI_HAS_EXTENDED_DATA_REGISTER_FLAGS kLPSCI_NoiseErrorInRxDataRegFlag = (UART0_ED_NOISY_MASK << 16), /*!< NOISY bit, sets if noise detected in current data word */ kLPSCI_ParityErrorInRxDataRegFlag = (UART0_ED_PARITYE_MASK << 16), /*!< PARITYE bit, sets if noise detected in current data word */ #endif }; /*! @brief LPSCI configure structure.*/ typedef struct _lpsci_config { uint32_t baudRate_Bps; /*!< LPSCI baud rate */ lpsci_parity_mode_t parityMode; /*!< Parity mode, disabled (default), even, odd */ #if defined(FSL_FEATURE_LPSCI_HAS_STOP_BIT_CONFIG_SUPPORT) && FSL_FEATURE_LPSCI_HAS_STOP_BIT_CONFIG_SUPPORT lpsci_stop_bit_count_t stopBitCount; /*!< Number of stop bits, 1 stop bit (default) or 2 stop bits */ #endif bool enableTx; /*!< Enable TX */ bool enableRx; /*!< Enable RX */ } lpsci_config_t; /*! @brief LPSCI transfer structure. */ typedef struct _lpsci_transfer { uint8_t *data; /*!< The buffer of data to be transfer.*/ size_t dataSize; /*!< The byte count to be transfer. */ } lpsci_transfer_t; /* Forward declaration of the handle typedef. */ typedef struct _lpsci_handle lpsci_handle_t; /*! @brief LPSCI transfer callback function. */ typedef void (*lpsci_transfer_callback_t)(UART0_Type *base, lpsci_handle_t *handle, status_t status, void *userData); /*baudRate_Bps = 115200U; * lpsciConfig->parityMode = kLPSCI_ParityDisabled; * lpsciConfig->stopBitCount = kLPSCI_OneStopBit; * lpsciConfig->enableTx = false; * lpsciConfig->enableRx = false; * * @param config Pointer to configuration structure. */ void LPSCI_GetDefaultConfig(lpsci_config_t *config); /*! * @brief Sets the LPSCI instance baudrate. * * This function configures the LPSCI module baudrate. This function is used to update * the LPSCI module baudrate after the LPSCI module is initialized with the LPSCI_Init. * @code * LPSCI_SetBaudRate(UART0, 115200U, 20000000U); * @endcode * * @param base LPSCI peripheral base address. * @param baudRate_Bps LPSCI baudrate to be set. * @param srcClock_Hz LPSCI clock source frequency in HZ. * @retval kStatus_LPSCI_BaudrateNotSupport Baudrate is not supported in the current clock source. * @retval kStatus_Success Set baudrate succeed */ status_t LPSCI_SetBaudRate(UART0_Type *base, uint32_t baudRate_Bps, uint32_t srcClock_Hz); /* @} */ /*! * @name Status * @{ */ /*! * @brief Gets LPSCI status flags. * * This function gets all LPSCI status flags. The flags are returned as the logical * OR value of the enumerators @ref _lpsci_flags. To check a specific status, * compare the return value to the enumerators in @ref _LPSCI_flags. * For example, to check whether the TX is empty: * @code * if (kLPSCI_TxDataRegEmptyFlag | LPSCI_GetStatusFlags(UART0)) * { * ... * } * @endcode * * @param base LPSCI peripheral base address. * @return LPSCI status flags which are ORed by the enumerators in the _lpsci_flags. */ uint32_t LPSCI_GetStatusFlags(UART0_Type *base); /* @brief Clears status flags with a provided mask. * * This function clears the LPSCI status flags with a provided mask. Automatically cleared flag * can't be cleared by this function. * Some flags can only be cleared or set by hardware. These flags are: * kLPSCI_TxDataRegEmptyFlag,kLPSCI_TransmissionCompleteFlag,kLPSCI_RxDataRegFullFlag,kLPSCI_RxActiveFlag,kLPSCI_NoiseErrorInRxDataRegFlag * kLPSCI_ParityErrorInRxDataRegFlag,kLPSCI_TxFifoEmptyFlag,kLPSCI_RxFifoEmptyFlag * Note: This API should be called when the Tx/Rx is idle, otherwise it takes no effects. * * @param base LPSCI peripheral base address. * @param mask The status flags to be cleared, it is logical OR value of @ref _LPSCI_flagss. * @retval kStatus_LPSCI_FlagCannotClearManually can't be cleared by this function but it is cleared * automatically by hardware. * @retval kStatus_Success Status in the mask are cleared. */ status_t LPSCI_ClearStatusFlags(UART0_Type *base, uint32_t mask); /* @} */ /*! * @name Interrupts * @{ */ /*! * @brief Enables an LPSCI interrupt according to a provided mask. * * This function enables the LPSCI interrupts according to a provided mask. The mask * is a logical OR of enumeration members. See @ref _lpsci_interrupt_enable. * For example, to enable the TX empty interrupt and RX full interrupt: * @code * LPSCI_EnableInterrupts(UART0,kLPSCI_TxDataRegEmptyInterruptEnable | kLPSCI_RxDataRegFullInterruptEnable); * @endcode * * @param base LPSCI peripheral base address. * @param mask The interrupts to enable. Logical OR of @ref _lpsci_interrupt_enable. */ void LPSCI_EnableInterrupts(UART0_Type *base, uint32_t mask); /*! * @brief Disables the LPSCI interrupt according to a provided mask. * * This function disables the LPSCI interrupts according to a provided mask. The mask * is a logical OR of enumeration members. See @ref _lpsci_interrupt_enable. * For example, to disable TX empty interrupt and RX full interrupt: * @code * LPSCI_DisableInterrupts(UART0,kLPSCI_TxDataRegEmptyInterruptEnable | kLPSCI_RxDataRegFullInterruptEnable); * @endcode * * @param base LPSCI peripheral base address. * @param mask The interrupts to disable. Logical OR of @ref _LPSCI_interrupt_enable. */ void LPSCI_DisableInterrupts(UART0_Type *base, uint32_t mask); /*! * @brief Gets the enabled LPSCI interrupts. * * This function gets the enabled LPSCI interrupts, which are returned * as the logical OR value of the enumerators @ref _lpsci_interrupt_enable. To check * a specific interrupts enable status, compare the return value to the enumerators * in @ref _LPSCI_interrupt_enable. * For example, to check whether TX empty interrupt is enabled: * @code * uint32_t enabledInterrupts = LPSCI_GetEnabledInterrupts(UART0); * * if (kLPSCI_TxDataRegEmptyInterruptEnable & enabledInterrupts) * { * ... * } * @endcode * * @param base LPSCI peripheral base address. * @return LPSCI interrupt flags which are logical OR of the enumerators in @ref _LPSCI_interrupt_enable. */ uint32_t LPSCI_GetEnabledInterrupts(UART0_Type *base); /* @} */ #if defined(FSL_FEATURE_LPSCI_HAS_DMA_ENABLE) && FSL_FEATURE_LPSCI_HAS_DMA_ENABLE /*! * @name DMA Control * @{ */ /*! * @brief Gets the LPSCI data register address. * * This function returns the LPSCI data register address, which is mainly used by DMA/eDMA case. * * @param base LPSCI peripheral base address. * @return LPSCI data register address which are used both by transmitter and receiver. */ static inline uint32_t LPSCI_GetDataRegisterAddress(UART0_Type *base) { return (uint32_t) & (base->D); } /*! * @brief Enables or disable LPSCI transmitter DMA request. * * This function enables or disables the transmit data register empty flag, S1[TDRE], to generate DMA requests. * * @param base LPSCI peripheral base address. * @param enable True to enable, false to disable. */ static inline void LPSCI_EnableTxDMA(UART0_Type *base, bool enable) { if (enable) { base->C5 |= UART0_C5_TDMAE_MASK; base->C2 |= UART0_C2_TIE_MASK; } else { base->C5 &= ~UART0_C5_TDMAE_MASK; base->C2 &= ~UART0_C2_TIE_MASK; } } /*! * @brief Enables or disables the LPSCI receiver DMA. * * This function enables or disables the receiver data register full flag, S1[RDRF], to generate DMA requests. * * @param base LPSCI peripheral base address. * @param enable True to enable, false to disable. */ static inline void LPSCI_EnableRxDMA(UART0_Type *base, bool enable) { if (enable) { base->C5 |= UART0_C5_RDMAE_MASK; base->C2 |= UART0_C2_RIE_MASK; } else { base->C5 &= ~UART0_C5_RDMAE_MASK; base->C2 &= ~UART0_C2_RIE_MASK; } } /* @} */ #endif /* defined(FSL_FEATURE_LPSCI_HAS_DMA_ENABLE) && FSL_FEATURE_LPSCI_HAS_DMA_ENABLE */ /*! * @name Bus Operations * @{ */ /*! * @brief Enables or disables the LPSCI transmitter. * * This function enables or disables the LPSCI transmitter. * * @param base LPSCI peripheral base address. * @param enable True to enable, false to disable. */ static inline void LPSCI_EnableTx(UART0_Type *base, bool enable) { if (enable) { base->C2 |= UART0_C2_TE_MASK; } else { base->C2 &= ~UART0_C2_TE_MASK; } } /*! * @brief Enables or disables the LPSCI receiver. * * This function enables or disables the LPSCI receiver. * * @param base LPSCI peripheral base address. * @param enable True to enable, false to disable. */ static inline void LPSCI_EnableRx(UART0_Type *base, bool enable) { if (enable) { base->C2 |= UART0_C2_RE_MASK; } else { base->C2 &= ~UART0_C2_RE_MASK; } } /*! * @brief Writes to the TX register. * * This function writes data to the TX register directly. The upper layer must ensure * that the TX register is empty before calling this function. * * @param base LPSCI peripheral base address. * @param data Data write to TX register. */ static inline void LPSCI_WriteByte(UART0_Type *base, uint8_t data) { base->D = data; } /*! * @brief Reads the RX data register. * * This function reads data from the RX register directly. The upper layer must * ensure that the RX register is full before calling this function. * * @param base LPSCI peripheral base address. * @return Data read from RX data register. */ static inline uint8_t LPSCI_ReadByte(UART0_Type *base) { return base->D; } /*! * @brief Writes to the TX register using a blocking method. * * This function polls the TX register, waits for the TX register empty, and * writes data to the TX buffer. * * @note This function does not check whether all the data has been sent out to bus, * so before disable TX, check kLPSCI_TransmissionCompleteFlag to ensure the TX is * finished. * * @param base LPSCI peripheral base address. * @param data Start address of the data to write. * @param length Size of the data to write. */ void LPSCI_WriteBlocking(UART0_Type *base, const uint8_t *data, size_t length); /*! * @brief Reads the RX register using a blocking method. * * This function polls the RX register, waits for the RX register to be full, and * reads data from the RX register. * * @param base LPSCI peripheral base address. * @param data Start address of the buffer to store the received data. * @param length Size of the buffer. * @retval kStatus_LPSCI_RxHardwareOverrun Receiver overrun happened while receiving data. * @retval kStatus_LPSCI_NoiseError Noise error happened while receiving data. * @retval kStatus_LPSCI_FramingError Framing error happened while receiving data. * @retval kStatus_LPSCI_ParityError Parity error happened while receiving data. * @retval kStatus_Success Successfully received all data. */ status_t LPSCI_ReadBlocking(UART0_Type *base, uint8_t *data, size_t length); /* @} */ /*! * @name Transactional * @{ */ /*! * @brief Initializes the LPSCI handle. * * This function initializes the LPSCI handle, which can be used for other LPSCI * transactional APIs. Usually, for a specified LPSCI instance, * call this API once to get the initialized handle. * * LPSCI driver supports the "background" receiving, which means that the user can set up * an RX ring buffer optionally. Data received are stored into the ring buffer even when the * user doesn't call the LPSCI_TransferReceiveNonBlocking() API. If there is already data received * in the ring buffer, get the received data from the ring buffer directly. * The ring buffer is disabled if pass NULL as @p ringBuffer. * * @param handle LPSCI handle pointer. * @param base LPSCI peripheral base address. * @param ringBuffer Start address of ring buffer for background receiving. Pass NULL to disable the ring buffer. * @param ringBufferSize size of the ring buffer. */ void LPSCI_TransferCreateHandle(UART0_Type *base, lpsci_handle_t *handle, lpsci_transfer_callback_t callback, void *userData); /*! * @brief Sets up the RX ring buffer. * * This function sets up the RX ring buffer to a specific LPSCI handle. * * When the RX ring buffer is used, data received is stored into the ring buffer even when * the user doesn't call the LPSCI_TransferReceiveNonBlocking() API. If there is already data received * in the ring buffer, the user can get the received data from the ring buffer directly. * * @note When using the RX ring buffer, one byte is reserved for internal use. In other * words, if @p ringBufferSize is 32, only 31 bytes are used for saving data. * * @param base LPSCI peripheral base address. * @param handle LPSCI handle pointer. * @param ringBuffer Start address of ring buffer for background receiving. Pass NULL to disable the ring buffer. * @param ringBufferSize size of the ring buffer. */ void LPSCI_TransferStartRingBuffer(UART0_Type *base, lpsci_handle_t *handle, uint8_t *ringBuffer, size_t ringBufferSize); /*! * @brief Aborts the background transfer and uninstalls the ring buffer. * * This function aborts the background transfer and uninstalls the ringbuffer. * * @param base LPSCI peripheral base address. * @param handle LPSCI handle pointer. */ void LPSCI_TransferStopRingBuffer(UART0_Type *base, lpsci_handle_t *handle); /*! * @brief Transmits a buffer of data using the interrupt method. * * This function sends data using the interrupt method. This is a non-blocking function, which * returns directly without waiting for all data to be written to the TX register. When * all data is written to the TX register in ISR, LPSCI driver calls the callback * function and passes the @ref kStatus_LPSCI_TxIdle as status parameter. * * @note The kStatus_LPSCI_TxIdle is passed to the upper layer when all data is written * to the TX register. However, it does not ensure that all data is sent out. Before disabling the TX, * check the kLPSCI_TransmissionCompleteFlag to ensure that the TX is complete. * * @param handle LPSCI handle pointer. * @param xfer LPSCI transfer structure, refer to #LPSCI_transfer_t. * @retval kStatus_Success Successfully start the data transmission. * @retval kStatus_LPSCI_TxBusy Previous transmission still not finished, data not all written to the TX register. * @retval kStatus_InvalidArgument Invalid argument. */ status_t LPSCI_TransferSendNonBlocking(UART0_Type *base, lpsci_handle_t *handle, lpsci_transfer_t *xfer); /*! * @brief Aborts the interrupt-driven data transmit. * * This function aborts the interrupt driven data send. * * @param handle LPSCI handle pointer. */ void LPSCI_TransferAbortSend(UART0_Type *base, lpsci_handle_t *handle); /*! * @brief Get the number of bytes that have been written to LPSCI TX register. * * This function gets the number of bytes that have been written to LPSCI TX * register by interrupt method. * * @param base LPSCI peripheral base address. * @param handle LPSCI handle pointer. * @param count Send bytes count. * @retval kStatus_NoTransferInProgress No send in progress. * @retval kStatus_InvalidArgument Parameter is invalid. * @retval kStatus_Success Get successfully through the parameter \p count; */ status_t LPSCI_TransferGetSendCount(UART0_Type *base, lpsci_handle_t *handle, uint32_t *count); /*! * @brief Receives buffer of data using the interrupt method. * * This function receives data using the interrupt method. This is a non-blocking function * which returns without waiting for all data to be received. * If the RX ring buffer is used and not empty, the data in ring buffer is copied and * the parameter @p receivedBytes shows how many bytes are copied from the ring buffer. * After copying, if the data in ring buffer is not enough to read, the receive * request is saved by the LPSCI driver. When new data arrives, the receive request * is serviced first. When all data is received, the LPSCI driver notifies the upper layer * through a callback function and passes the status parameter @ref kStatus_LPSCI_RxIdle. * For example, the upper layer needs 10 bytes but there are only 5 bytes in the ring buffer. * The 5 bytes are copied to the xfer->data and the function returns with the * parameter @p receivedBytes set to 5. For the remaining 5 bytes, newly arrived data is * saved from the xfer->data[5]. When 5 bytes are received, the LPSCI driver notifies the upper layer. * If the RX ring buffer is not enabled, this function enables the RX and RX interrupt * to receive data to the xfer->data. When all data is received, the upper layer is notified. * * @param handle LPSCI handle pointer. * @param xfer lpsci transfer structure. See #lpsci_transfer_t. * @param receivedBytes Bytes received from the ring buffer directly. * @retval kStatus_Success Successfully queue the transfer into transmit queue. * @retval kStatus_LPSCI_RxBusy Previous receive request is not finished. * @retval kStatus_InvalidArgument Invalid argument. */ status_t LPSCI_TransferReceiveNonBlocking(UART0_Type *base, lpsci_handle_t *handle, lpsci_transfer_t *xfer, size_t *receivedBytes); /*! * @brief Aborts interrupt driven data receiving. * * This function aborts interrupt driven data receiving. * * @param handle LPSCI handle pointer. */ void LPSCI_TransferAbortReceive(UART0_Type *base, lpsci_handle_t *handle); /*! * @brief Get the number of bytes that have been received. * * This function gets the number of bytes that have been received. * * @param base LPSCI peripheral base address. * @param handle LPSCI handle pointer. * @param count Receive bytes count. * @retval kStatus_NoTransferInProgress No receive in progress. * @retval kStatus_InvalidArgument Parameter is invalid. * @retval kStatus_Success Get successfully through the parameter \p count; */ status_t LPSCI_TransferGetReceiveCount(UART0_Type *base, lpsci_handle_t *handle, uint32_t *count); /*! * @brief LPSCI IRQ handle function. * * This function handles the LPSCI transmit and receive IRQ request. * * @param handle LPSCI handle pointer. */ void LPSCI_TransferHandleIRQ(UART0_Type *base, lpsci_handle_t *handle); /*! * @brief LPSCI Error IRQ handle function. * * This function handle the LPSCI error IRQ request. * * @param handle LPSCI handle pointer. */ void LPSCI_TransferHandleErrorIRQ(UART0_Type *base, lpsci_handle_t *handle); /* @} */ #if defined(__cplusplus) } #endif /*! @}*/ #endif /* _FSL_LPSCI_H_ */