usart_002.h

Go to the documentation of this file.

/*
 * @brief UART/USART2 Registers and control functions
 *
 * @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 __USART_002_H_
#define __USART_002_H_

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
 __IO uint32_t  CFG;    
 __IO uint32_t  CTRL;   
 __IO uint32_t  STAT;   
 __IO uint32_t  INTENSET;  
 __O  uint32_t  INTENCLR;  
 __I  uint32_t  RXDATA;   
 __I  uint32_t  RXDATA_STAT;  
 __IO uint32_t  TXDATA;   
 __IO uint32_t  BRG;    
 __IO uint32_t  INTSTAT;   
} IP_USART_002_T;

typedef enum IP_UART_002_PARITY {
 UART_PARITY_NONE = (0x00 << 4),  
 UART_PARITY_EVEN = (0x02 << 4),  
 UART_PARITY_ODD  = (0x03 << 4)  
} IP_UART_002_PARITY_T;

typedef enum IP_UART_002_FITO_LEVEL {
 UART_FIFO_TRGLEV0 = 0, 
 UART_FIFO_TRGLEV1,  
 UART_FIFO_TRGLEV2,  
 UART_FIFO_TRGLEV3  
} IP_UART_002_FITO_LEVEL_T;

typedef enum IP_UART_002_STOPLEN {
 UART_STOPLEN_1 = (0 << 6),  
 UART_STOPLEN_2 = (1 << 6)  
} IP_UART_002_STOPLEN_T;

typedef enum IP_UART_002_DATALEN {
 UART_DATALEN_7  = (0x00 << 2), 
 UART_DATALEN_8  = (0x01 << 2), 
 UART_DATALEN_9  = (0x02 << 2) 
} IP_UART_002_DATALEN_T;

typedef enum IP_UART_002_CLKPOL {
 UART_CLKPOL_FALLING = (0 << 12),
 UART_CLKPOL_RISING = (1 << 12) 
} IP_UART_002_CLKPOL_T;

/* UART interrupt bit definitions */
#define RXRDY_INT         (0x01 << 0)  
#define TXRDY_INT         (0x01 << 2)  
#define CTS_DELTA_INT     (0x01 << 5)  
#define TXINT_DIS_INT     (0x01 << 6)  
#define OVRN_ERR_INT      (0x01 << 8)  
#define DELTA_RXBRK_INT   (0x01 << 11)  
#define START_DETECT_INT  (0x01 << 12)  
#define FRM_ERR_INT       (0x01 << 13)  
#define PAR_ERR_INT       (0x01 << 14)  
#define RXNOISE_INT       (0x01 << 15)  
/* UART status bit definitions */
#define RXRDY         (0x01 << 0)  
#define RXIDLE        (0x01 << 1)   
#define TXRDY         (0x01 << 2)   
#define TXIDLE        (0x01 << 3)   
#define CTS           (0x01 << 4)   
#define CTS_DELTA     (0x01 << 5)   
#define TXINT_DIS     (0x01 << 6)   
#define OVRN_ERR      (0x01 << 8)   
#define RXBRK         (0x01 << 10)  
#define DELTA_RXBRK   (0x01 << 11)  
#define START_DETECT  (0x01 << 12)  
#define FRM_ERR       (0x01 << 13)  
#define PAR_ERR       (0x01 << 14)  
#define RXNOISE       (0x01 << 15)  
#define UART_002_SYNCEN(n) ((n) == ENABLE ? (1 << 11) : 0)
#define UART_002_ENABLE (1UL)

STATIC INLINE void IP_UART_Init(IP_USART_002_T *pUART)
{
 pUART->CFG |= UART_002_ENABLE;
}

STATIC INLINE void IP_UART_SetBaudRate(IP_USART_002_T *pUART, uint32_t baudrate)
{
 pUART->BRG = baudrate;
}

STATIC INLINE uint32_t IP_UART_GetBaudRate(IP_USART_002_T *pUART)
{
 return pUART->BRG;
}

STATIC INLINE void IP_UART_Transmit(IP_USART_002_T *pUART, uint8_t data)
{
 pUART->TXDATA = data;
}

STATIC INLINE uint8_t IP_UART_Receive(IP_USART_002_T *pUART)
{
 return (uint8_t) (pUART->RXDATA & 0xFF);
}

STATIC INLINE uint32_t IP_UART_GetIntStatus(IP_USART_002_T *pUART)
{
 return pUART->INTSTAT;
}

STATIC INLINE uint32_t IP_UART_GetStatus(IP_USART_002_T *pUART)
{
 return pUART->STAT;
}

STATIC INLINE void IP_UART_ClearStatus(IP_USART_002_T *pUART, uint32_t StatusFlag)
{
 pUART->STAT |= StatusFlag;
}

void IP_UART_Config(IP_USART_002_T *pUART, IP_UART_002_DATALEN_T Databits,
     IP_UART_002_PARITY_T Parity, IP_UART_002_STOPLEN_T Stopbits);

void IP_UART_IntEnable(IP_USART_002_T *pUART, uint32_t UARTIntCfg, FunctionalState NewState);

#ifdef __cplusplus
}
#endif

#endif /* __USART_002_H_ */