LPC1700CMSIS Standard Peripheral Firmware Library: UART_Public_Types

LPC1700CMSIS

previous page next page

UART_Public_Types
[UART]


Data Structures

struct  UART_AB_CFG_Type
 Auto Baudrate mode configuration type definition. More...
struct  UART_CFG_Type
 UART Configuration Structure definition. More...
struct  UART_FIFO_CFG_Type
 UART FIFO Configuration Structure definition. More...
struct  UART1_RS485_CTRLCFG_Type
 UART1 Full modem - RS485 Control configuration type. More...

Defines

#define PARAM_UART_DATABIT(databit)
#define PARAM_UART_STOPBIT(stopbit)   ((stopbit==UART_STOPBIT_1) || (stopbit==UART_STOPBIT_2))
#define PARAM_UART_PARITY(parity)
#define PARAM_UART_FIFO_LEVEL(fifo)
#define PARAM_UART_INTCFG(IntCfg)
#define PARAM_UART1_INTCFG(IntCfg)   ((IntCfg==UART1_INTCFG_MS) || (IntCfg==UART1_INTCFG_CTS))
#define PARAM_UART_AUTOBAUD_MODE(ABmode)   ((ABmode==UART_AUTOBAUD_MODE0) || (ABmode==UART_AUTOBAUD_MODE1))
#define PARAM_UART_AUTOBAUD_INTSTAT(ABIntStat)   ((ABIntStat==UART_AUTOBAUD_INTSTAT_ABEO) || (ABIntStat==UART_AUTOBAUD_INTSTAT_ABTO))
#define PARAM_UART_IrDA_PULSEDIV(PulseDiv)
#define PARAM_UART1_SIGNALSTATE(x)   ((x==INACTIVE) || (x==ACTIVE))
#define PARAM_UART1_MODEM_PIN(x)   ((x==UART1_MODEM_PIN_DTR) || (x==UART1_MODEM_PIN_RTS))
#define PARAM_UART1_MODEM_MODE(x)
#define PARAM_UART_RS485_DIRCTRL_PIN(x)   ((x==UART1_RS485_DIRCTRL_RTS) || (x==UART1_RS485_DIRCTRL_DTR))

Typedefs

typedef void( fnRxCbs_Type )(void)
typedef void( fnTxCbs_Type )(void)
typedef void( fnABCbs_Type )(uint32_t bABIntType)
typedef void( fnErrCbs_Type )(uint8_t bError)
typedef void( fnModemCbs_Type )(uint8_t ModemStatus)

Enumerations

enum  UART_DATABIT_Type { UART_DATABIT_5 = 0, UART_DATABIT_6, UART_DATABIT_7, UART_DATABIT_8 }
 UART Databit type definitions. More...
enum  UART_STOPBIT_Type { UART_STOPBIT_1 = (0), UART_STOPBIT_2 }
 UART Stop bit type definitions. More...
enum  UART_PARITY_Type {
  UART_PARITY_NONE = 0, UART_PARITY_ODD, UART_PARITY_EVEN, UART_PARITY_SP_1,
  UART_PARITY_SP_0
}
 UART Parity type definitions. More...
enum  UART_FITO_LEVEL_Type { UART_FIFO_TRGLEV0 = 0, UART_FIFO_TRGLEV1, UART_FIFO_TRGLEV2, UART_FIFO_TRGLEV3 }
 FIFO Level type definitions. More...
enum  UART_INT_Type {
  UART_INTCFG_RBR = 0, UART_INTCFG_THRE, UART_INTCFG_RLS, UART1_INTCFG_MS,
  UART1_INTCFG_CTS, UART_INTCFG_ABEO, UART_INTCFG_ABTO
}
 UART Interrupt Type definitions. More...
enum  UART_LS_Type {
  UART_LINESTAT_RDR = UART_LSR_RDR, UART_LINESTAT_OE = UART_LSR_OE, UART_LINESTAT_PE = UART_LSR_PE, UART_LINESTAT_FE = UART_LSR_FE,
  UART_LINESTAT_BI = UART_LSR_BI, UART_LINESTAT_THRE = UART_LSR_THRE, UART_LINESTAT_TEMT = UART_LSR_TEMT, UART_LINESTAT_RXFE = UART_LSR_RXFE
}
 UART Line Status Type definition. More...
enum  UART_AB_MODE_Type { UART_AUTOBAUD_MODE0 = 0, UART_AUTOBAUD_MODE1 }
 UART Auto-baudrate mode type definition. More...
enum  UART_ABEO_Type { UART_AUTOBAUD_INTSTAT_ABEO = UART_IIR_ABEO_INT, UART_AUTOBAUD_INTSTAT_ABTO = UART_IIR_ABTO_INT }
 UART End of Auto-baudrate type definition. More...
enum  UART_IrDA_PULSE_Type {
  UART_IrDA_PULSEDIV2 = 0, UART_IrDA_PULSEDIV4, UART_IrDA_PULSEDIV8, UART_IrDA_PULSEDIV16,
  UART_IrDA_PULSEDIV32, UART_IrDA_PULSEDIV64, UART_IrDA_PULSEDIV128, UART_IrDA_PULSEDIV256
}
enum  UART1_SignalState { INACTIVE = 0, ACTIVE = !INACTIVE }
 UART1 Full modem - Signal states definition. More...
enum  UART_MODEM_STAT_type {
  UART1_MODEM_STAT_DELTA_CTS = UART1_MSR_DELTA_CTS, UART1_MODEM_STAT_DELTA_DSR = UART1_MSR_DELTA_DSR, UART1_MODEM_STAT_LO2HI_RI = UART1_MSR_LO2HI_RI, UART1_MODEM_STAT_DELTA_DCD = UART1_MSR_DELTA_DCD,
  UART1_MODEM_STAT_CTS = UART1_MSR_CTS, UART1_MODEM_STAT_DSR = UART1_MSR_DSR, UART1_MODEM_STAT_RI = UART1_MSR_RI, UART1_MODEM_STAT_DCD = UART1_MSR_DCD
}
 UART modem status type definition. More...
enum  UART_MODEM_PIN_Type { UART1_MODEM_PIN_DTR = 0, UART1_MODEM_PIN_RTS }
 Modem output pin type definition. More...
enum  UART_MODEM_MODE_Type { UART1_MODEM_MODE_LOOPBACK = 0, UART1_MODEM_MODE_AUTO_RTS, UART1_MODEM_MODE_AUTO_CTS }
 UART Modem mode type definition. More...
enum  UART_RS485_DIRCTRL_PIN_Type { UART1_RS485_DIRCTRL_RTS = 0, UART1_RS485_DIRCTRL_DTR }
 UART Direction Control Pin type definition. More...

Define Documentation

#define PARAM_UART1_INTCFG ( IntCfg   )     ((IntCfg==UART1_INTCFG_MS) || (IntCfg==UART1_INTCFG_CTS))

Macro to check the input UART1_INTCFG parameters - expansion input parameter for UART1

Definition at line 300 of file lpc17xx_uart.h.

#define PARAM_UART1_MODEM_MODE ( x   ) 

Value:

((x==UART1_MODEM_MODE_LOOPBACK) || (x==UART1_MODEM_MODE_AUTO_RTS) \
|| (x==UART1_MODEM_MODE_AUTO_CTS))
Macro to check the input PARAM_UART1_MODEM_MODE parameters

Definition at line 425 of file lpc17xx_uart.h.

#define PARAM_UART1_MODEM_PIN ( x   )     ((x==UART1_MODEM_PIN_DTR) || (x==UART1_MODEM_PIN_RTS))

Macro to check the input PARAM_UART1_MODEM_PIN parameters

Definition at line 412 of file lpc17xx_uart.h.

#define PARAM_UART1_SIGNALSTATE ( x   )     ((x==INACTIVE) || (x==ACTIVE))

Definition at line 387 of file lpc17xx_uart.h.

#define PARAM_UART_AUTOBAUD_INTSTAT ( ABIntStat   )     ((ABIntStat==UART_AUTOBAUD_INTSTAT_ABEO) || (ABIntStat==UART_AUTOBAUD_INTSTAT_ABTO))

Macro to check the input UART_AUTOBAUD_INTSTAT parameters

Definition at line 347 of file lpc17xx_uart.h.

#define PARAM_UART_AUTOBAUD_MODE ( ABmode   )     ((ABmode==UART_AUTOBAUD_MODE0) || (ABmode==UART_AUTOBAUD_MODE1))

Macro to check the input UART_AUTOBAUD_MODE parameters

Definition at line 327 of file lpc17xx_uart.h.

#define PARAM_UART_DATABIT ( databit   ) 

Value:

((databit==UART_DATABIT_5) || (databit==UART_DATABIT_6)\
|| (databit==UART_DATABIT_7) || (databit==UART_DATABIT_8))
Macro to check the input UART_DATABIT parameters

Definition at line 236 of file lpc17xx_uart.h.

#define PARAM_UART_FIFO_LEVEL ( fifo   ) 

Value:

((fifo==UART_FIFO_TRGLEV0) \
|| (fifo==UART_FIFO_TRGLEV1) || (fifo==UART_FIFO_TRGLEV2) \
|| (fifo==UART_FIFO_TRGLEV3))
Macro to check the input UART_FIFO parameters

Definition at line 277 of file lpc17xx_uart.h.

#define PARAM_UART_INTCFG ( IntCfg   ) 

Value:

((IntCfg==UART_INTCFG_RBR) || (IntCfg==UART_INTCFG_THRE) \
|| (IntCfg==UART_INTCFG_RLS) || (IntCfg==UART_INTCFG_ABEO) \
|| (IntCfg==UART_INTCFG_ABTO))
Macro to check the input UART_INTCFG parameters

Definition at line 295 of file lpc17xx_uart.h.

#define PARAM_UART_IrDA_PULSEDIV ( PulseDiv   ) 

Value:

((PulseDiv==UART_IrDA_PULSEDIV2) || (PulseDiv==UART_IrDA_PULSEDIV4) \
|| (PulseDiv==UART_IrDA_PULSEDIV8) || (PulseDiv==UART_IrDA_PULSEDIV16) \
|| (PulseDiv==UART_IrDA_PULSEDIV32) || (PulseDiv==UART_IrDA_PULSEDIV64) \
|| (PulseDiv==UART_IrDA_PULSEDIV128) || (PulseDiv==UART_IrDA_PULSEDIV256))
Macro to check the input UART_IrDA_PULSEDIV parameters

Definition at line 373 of file lpc17xx_uart.h.

#define PARAM_UART_PARITY ( parity   ) 

Value:

((parity==UART_PARITY_NONE) || (parity==UART_PARITY_ODD) \
|| (parity==UART_PARITY_EVEN) || (parity==UART_PARITY_SP_1) \
|| (parity==UART_PARITY_SP_0))
Macro to check the input UART_PARITY parameters

Definition at line 262 of file lpc17xx_uart.h.

#define PARAM_UART_RS485_DIRCTRL_PIN ( x   )     ((x==UART1_RS485_DIRCTRL_RTS) || (x==UART1_RS485_DIRCTRL_DTR))

Macro to check the direction control pin type

Definition at line 438 of file lpc17xx_uart.h.

#define PARAM_UART_STOPBIT ( stopbit   )     ((stopbit==UART_STOPBIT_1) || (stopbit==UART_STOPBIT_2))

Macro to check the input UART_STOPBIT parameters

Definition at line 248 of file lpc17xx_uart.h.

Typedef Documentation

typedef void( fnABCbs_Type)(uint32_t bABIntType)

UART Auto-Baudrate Call-back function type

Definition at line 529 of file lpc17xx_uart.h.

typedef void( fnErrCbs_Type)(uint8_t bError)

UART Error Call-back function type

Definition at line 531 of file lpc17xx_uart.h.

typedef void( fnModemCbs_Type)(uint8_t ModemStatus)

UART1 modem status interrupt callback type

Definition at line 533 of file lpc17xx_uart.h.

typedef void( fnRxCbs_Type)(void)

UART Receive Call-back function type

Definition at line 525 of file lpc17xx_uart.h.

typedef void( fnTxCbs_Type)(void)

UART Transmit Call-back function type

Definition at line 527 of file lpc17xx_uart.h.

Enumeration Type Documentation

enum UART1_SignalState

UART1 Full modem - Signal states definition.

Enumerator:
INACTIVE 
ACTIVE 

Definition at line 381 of file lpc17xx_uart.h.

enum UART_AB_MODE_Type

UART Auto-baudrate mode type definition.

Enumerator:
UART_AUTOBAUD_MODE0  UART Auto baudrate Mode 0
UART_AUTOBAUD_MODE1  UART Auto baudrate Mode 1

Definition at line 321 of file lpc17xx_uart.h.

enum UART_ABEO_Type

UART End of Auto-baudrate type definition.

Enumerator:
UART_AUTOBAUD_INTSTAT_ABEO  UART End of auto-baud interrupt
UART_AUTOBAUD_INTSTAT_ABTO  UART Auto-baud time-out interrupt

Definition at line 341 of file lpc17xx_uart.h.

enum UART_DATABIT_Type

UART Databit type definitions.

Enumerator:
UART_DATABIT_5  UART 5 bit data mode
UART_DATABIT_6  UART 6 bit data mode
UART_DATABIT_7  UART 7 bit data mode
UART_DATABIT_8  UART 8 bit data mode

Definition at line 228 of file lpc17xx_uart.h.

enum UART_FITO_LEVEL_Type

FIFO Level type definitions.

Enumerator:
UART_FIFO_TRGLEV0  UART FIFO trigger level 0: 1 character
UART_FIFO_TRGLEV1  UART FIFO trigger level 1: 4 character
UART_FIFO_TRGLEV2  UART FIFO trigger level 2: 8 character
UART_FIFO_TRGLEV3  UART FIFO trigger level 3: 14 character

Definition at line 269 of file lpc17xx_uart.h.

enum UART_INT_Type

UART Interrupt Type definitions.

Enumerator:
UART_INTCFG_RBR  RBR Interrupt enable
UART_INTCFG_THRE  THR Interrupt enable
UART_INTCFG_RLS  RX line status interrupt enable
UART1_INTCFG_MS  Modem status interrupt enable (UART1 only)
UART1_INTCFG_CTS  CTS1 signal transition interrupt enable (UART1 only)
UART_INTCFG_ABEO  Enables the end of auto-baud interrupt
UART_INTCFG_ABTO  Enables the auto-baud time-out interrupt

Definition at line 284 of file lpc17xx_uart.h.

enum UART_IrDA_PULSE_Type

UART IrDA Control type Definition

Enumerator:
UART_IrDA_PULSEDIV2  Pulse width = 2 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV4  Pulse width = 4 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV8  Pulse width = 8 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV16  Pulse width = 16 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV32  Pulse width = 32 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV64  Pulse width = 64 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV128  Pulse width = 128 * Tpclk
  • Configures the pulse when FixPulseEn = 1
UART_IrDA_PULSEDIV256  Pulse width = 256 * Tpclk
  • Configures the pulse when FixPulseEn = 1

Definition at line 352 of file lpc17xx_uart.h.

enum UART_LS_Type

UART Line Status Type definition.

Enumerator:
UART_LINESTAT_RDR  Line status register: Receive data ready
UART_LINESTAT_OE  Line status register: Overrun error
UART_LINESTAT_PE  Line status register: Parity error
UART_LINESTAT_FE  Line status register: Framing error
UART_LINESTAT_BI  Line status register: Break interrupt
UART_LINESTAT_THRE  Line status register: Transmit holding register empty
UART_LINESTAT_TEMT  Line status register: Transmitter empty
UART_LINESTAT_RXFE  Error in RX FIFO

Definition at line 306 of file lpc17xx_uart.h.

enum UART_MODEM_MODE_Type

UART Modem mode type definition.

Enumerator:
UART1_MODEM_MODE_LOOPBACK  Loop back mode select
UART1_MODEM_MODE_AUTO_RTS  Enable Auto RTS flow-control
UART1_MODEM_MODE_AUTO_CTS  Enable Auto CTS flow-control

Definition at line 418 of file lpc17xx_uart.h.

enum UART_MODEM_PIN_Type

Modem output pin type definition.

Enumerator:
UART1_MODEM_PIN_DTR  Source for modem output pin DTR
UART1_MODEM_PIN_RTS  Source for modem output pin RTS

Definition at line 406 of file lpc17xx_uart.h.

enum UART_MODEM_STAT_type

UART modem status type definition.

Enumerator:
UART1_MODEM_STAT_DELTA_CTS  Set upon state change of input CTS
UART1_MODEM_STAT_DELTA_DSR  Set upon state change of input DSR
UART1_MODEM_STAT_LO2HI_RI  Set upon low to high transition of input RI
UART1_MODEM_STAT_DELTA_DCD  Set upon state change of input DCD
UART1_MODEM_STAT_CTS  Clear To Send State
UART1_MODEM_STAT_DSR  Data Set Ready State
UART1_MODEM_STAT_RI  Ring Indicator State
UART1_MODEM_STAT_DCD  Data Carrier Detect State

Definition at line 392 of file lpc17xx_uart.h.

enum UART_PARITY_Type

UART Parity type definitions.

Enumerator:
UART_PARITY_NONE  No parity
UART_PARITY_ODD  Odd parity
UART_PARITY_EVEN  Even parity
UART_PARITY_SP_1  Forced "1" stick parity
UART_PARITY_SP_0  Forced "0" stick parity

Definition at line 253 of file lpc17xx_uart.h.

enum UART_RS485_DIRCTRL_PIN_Type

UART Direction Control Pin type definition.

Enumerator:
UART1_RS485_DIRCTRL_RTS  Pin RTS is used for direction control
UART1_RS485_DIRCTRL_DTR  Pin DTR is used for direction control

Definition at line 432 of file lpc17xx_uart.h.

enum UART_STOPBIT_Type

UART Stop bit type definitions.

Enumerator:
UART_STOPBIT_1  UART 1 Stop Bits Select
UART_STOPBIT_2  UART Two Stop Bits Select

Definition at line 242 of file lpc17xx_uart.h.

Generated on Mon Feb 8 10:01:48 2010 for LPC1700CMSIS Standard Peripheral Firmware Library by  doxygen 1.5.9
previous page start next page