uart_17xx_40xx.h

Go to the documentation of this file.

/*
 * @brief LPC17xx/40xx UART chip driver
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __UART_17XX_40XX_H_
#define __UART_17XX_40XX_H_

#ifdef __cplusplus
extern "C" {
#endif

STATIC INLINE void Chip_UART_ConfigData(LPC_USART_T *pUART,
          IP_UART_DATABIT_T Databits,
          IP_UART_PARITY_T Parity,
          IP_UART_STOPBIT_T Stopbits)
{
 IP_UART_ConfigData(pUART, Databits, Parity, Stopbits);
}

STATIC INLINE uint32_t Chip_UART_Send(LPC_USART_T *pUART, uint8_t *txbuf, uint32_t buflen, TRANSFER_BLOCK_T flag)
{
 return IP_UART_Send(pUART, txbuf, buflen, flag);
}

STATIC INLINE uint32_t Chip_UART_Receive(LPC_USART_T *pUART,
           uint8_t *rxbuf,
           uint32_t buflen,
           TRANSFER_BLOCK_T flag)
{
 return IP_UART_Receive(pUART, rxbuf, buflen, flag);
}

/* UART FIFO functions ----------------------------------------------------------*/
STATIC INLINE void Chip_UART_FIFOConfig(LPC_USART_T *pUART, UART_FIFO_CFG_T *FIFOCfg)
{
 IP_UART_FIFOConfig(pUART, FIFOCfg);
}

STATIC INLINE void Chip_UART_FIFOConfigStructInit(LPC_USART_T *pUART, UART_FIFO_CFG_T *UART_FIFOInitStruct)
{
 IP_UART_FIFOConfigStructInit(UART_FIFOInitStruct);
}

/* UART operate functions -------------------------------------------------------*/
STATIC INLINE void Chip_UART_IntConfig(LPC_USART_T *pUART, IP_UART_INT_T UARTIntCfg, FunctionalState NewState)
{
 IP_UART_IntConfig(pUART, UARTIntCfg, NewState);
}

STATIC INLINE uint32_t Chip_UART_IntGetStatus(LPC_USART_T *pUART)
{
 return IP_UART_IntGetStatus(pUART);
}

STATIC INLINE uint8_t Chip_UART_GetLineStatus(LPC_USART_T *pUART)
{
 return IP_UART_GetLineStatus(pUART);
}

STATIC INLINE FlagStatus Chip_UART_CheckBusy(LPC_USART_T *pUART)
{
 return IP_UART_CheckBusy(pUART);
}

STATIC INLINE void Chip_UART_ForceBreak(LPC_USART_T *pUART)
{
 IP_UART_ForceBreak(pUART);
}

STATIC INLINE Status Chip_UART_SendByte(LPC_USART_T *pUART, uint8_t data)
{
 return IP_UART_SendByte(pUART, data);
}

STATIC INLINE Status Chip_UART_ReceiveByte(LPC_USART_T *pUART, uint8_t *Data)
{
 return IP_UART_ReceiveByte(pUART, Data);
}

STATIC INLINE void Chip_UART_ABCmd(LPC_USART_T *pUART, UART_AB_CFG_T *ABConfigStruct, FunctionalState NewState)
{
 IP_UART_ABCmd(pUART, ABConfigStruct, NewState);
}

STATIC INLINE void Chip_UART_ABClearIntPending(LPC_USART_T *pUART, IP_UART_INT_STATUS_T ABIntType)
{
 IP_UART_ABClearIntPending(pUART, ABIntType);
}

void Chip_UART_Init(LPC_USART_T *pUART);

void Chip_UART_DeInit(LPC_USART_T *pUART);

Status Chip_UART_SetBaud(LPC_USART_T *pUART, uint32_t baudrate);

void Chip_UART_TxCmd(LPC_USART_T *pUART, FunctionalState NewState);

IP_UART_INT_STATUS_T Chip_UART_GetIntStatus(LPC_USART_T *pUART);

void Chip_UART_Interrupt_Handler (LPC_USART_T *pUART);

uint32_t Chip_UART_Interrupt_Transmit(LPC_USART_T *pUART, uint8_t *txbuf, uint8_t buflen);

uint32_t Chip_UART_Interrupt_Receive(LPC_USART_T *pUART, uint8_t *rxbuf, uint8_t buflen);

void Chip_UART_InitRingBuffer(LPC_USART_T *pUART);

// FIXME - this function is probably not interrupt related and needs a DoxyGen header
/* UART interrupt service routine */
FlagStatus Chip_UART_GetABEOStatus(LPC_USART_T *pUART);

#ifdef __cplusplus
}
#endif
#endif /* __UART_17XX_40XX_H_ */