uartd_8xx.h

Go to the documentation of this file.

/*
 * @brief LPC8xx UART ROM API declarations and 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 __UARTD_8XX_H_
#define __UARTD_8XX_H_

#ifdef __cplusplus
extern "C" {
#endif

#define ERR_NO_ERROR                            (0x00000000UL) 
#define ERR_UART_RXD_BUSY                       (0x00080001UL) 
#define ERR_UART_TXD_BUSY                       (0x00080002UL) 
#define ERR_UART_OVERRUN_FRAME_PARITY_NOISE     (0x00080003UL) 
#define ERR_UART_UNDERRUN                       (0x00080004UL) 
#define ERR_UART_PARAM                          (0x00080005UL) 
#define OVERRUN_ERR_EN                          (1 << 0) 
#define UNDERRUN_ERR_EN                         (1 << 1) 
#define FRAME_ERR_EN                            (1 << 2) 
#define PARITY_ERR_EN                           (1 << 3) 
#define RXNOISE_ERR_EN                          (1 << 4) 
#define ALL_ERR_EN                              (OVERRUN_ERR_EN | UNDERRUN_ERR_EN | FRAME_ERR_EN | PARITY_ERR_EN | \
             RXNOISE_ERR_EN)

#define NO_ERR_EN                               (0)

#define UART_ROM_MEM_SIZE                       (0x20UL)

#define TX_MODE_BUF_EMPTY                       (0x00)
#define RX_MODE_BUF_FULL                        (0x00)

#define TX_MODE_SZERO_SEND_CRLF                 (0x01)
#define RX_MODE_CRLF_RECVD                      (0x01)

#define TX_MODE_SZERO_SEND_LF                   (0x02)
#define RX_MODE_LF_RECVD                        (0x02)

#define TX_MODE_SZERO                           (0x03)

#define DRIVER_MODE_POLLING                     (0x00) 
#define DRIVER_MODE_INTERRUPT                   (0x01) 
#define DRIVER_MODE_DMA                         (0x02) 
typedef void UART_HANDLE_T;
typedef void (*UART_CALLBK_T)(uint32_t err_code, uint32_t n);
typedef void (*UART_DMA_REQ_T)(uint32_t src_adr, uint32_t dst_adr, uint32_t size);

typedef struct {
 uint32_t sys_clk_in_hz;  
 uint32_t baudrate_in_hz; 
 uint8_t  config;   
 uint8_t sync_mod;   
 uint16_t error_en;   
} UART_CONFIG_T;

typedef struct {
 uint8_t      *buffer;  
 uint32_t     size;   
 uint16_t     transfer_mode; 
 uint16_t       driver_mode; 
 UART_CALLBK_T  callback_func_pt; 
 UART_DMA_REQ_T dma_req_func_pt;  
} UART_PARAM_T;

typedef struct UARTD_API {
 uint32_t       (*uart_get_mem_size)(void); 
 UART_HANDLE_T * (*uart_setup)(uint32_t base_addr, uint8_t * ram); 
 uint32_t       (*uart_init)(UART_HANDLE_T *handle, UART_CONFIG_T *set); 
 uint8_t        (*uart_get_char)(UART_HANDLE_T *handle); 
 void           (*uart_put_char)(UART_HANDLE_T *handle, uint8_t data); 
 uint32_t       (*uart_get_line)(UART_HANDLE_T *handle, UART_PARAM_T *param);
 uint32_t       (*uart_put_line)(UART_HANDLE_T *handle, UART_PARAM_T *param);
 void           (*uart_isr)(UART_HANDLE_T *handle); 
} UARTD_API_T;

#ifdef __cplusplus
}
#endif

#endif /* __UARTD_8XX_H_ */