Nut/OS  5.0.5
API Reference
_USARTDCB Struct Reference

USART device low level information structure. More...

#include <dev/usart.h>

Collaboration diagram for _USARTDCB:
[legend]

Data Fields

uint32_t dcb_modeflags
 Mode flags.
uint32_t dcb_statusflags
 Status flags.
uint32_t dcb_rtimeout
 Read timeout.
uint32_t dcb_wtimeout
 Write timeout.
RINGBUF dcb_tx_rbf
 Output ring buffer.
RINGBUF dcb_rx_rbf
 Input ring buffer.
uint8_t dcb_last_eol
 Last EOL character.
int(* dcb_init )(void)
 Driver control initialization.
int(* dcb_deinit )(void)
 Driver control de-initialization.
void(* dcb_tx_start )(void)
 Driver control write notification.
void(* dcb_rx_start )(void)
 Driver control read notification.
int(* dcb_set_flow_control )(uint32_t flags)
 Set handshake mode.
uint32_t(* dcb_get_flow_control )(void)
 Get handshake mode.
int(* dcb_set_speed )(uint32_t rate)
 Set hardware speed.
uint32_t(* dcb_get_speed )(void)
 Get hardware speed.
int(* dcb_set_data_bits )(uint8_t bits)
 Set hardware data bits.
uint8_t(* dcb_get_data_bits )(void)
 Get hardware data bits.
int(* dcb_set_parity )(uint8_t bits)
 Set hardware parity mode.
uint8_t(* dcb_get_parity )(void)
 Get hardware parity mode.
int(* dcb_set_stop_bits )(uint8_t bits)
 Set hardware stop bits.
uint8_t(* dcb_get_stop_bits )(void)
 Get hardware stop bits.
int(* dcb_set_status )(uint32_t flags)
 Set hardware status.
uint32_t(* dcb_get_status )(void)
 Get hardware status.
int(* dcb_set_clock_mode )(uint8_t mode)
 Set clock mode.
uint8_t(* dcb_get_clock_mode )(void)
 Get clock mode.

Detailed Description

USART device low level information structure.


Field Documentation

Read timeout.

Referenced by UsartIOCtl(), and UsartRead().

Write timeout.

Referenced by UsartIOCtl().

Last EOL character.

Referenced by UsartRead().

Driver control initialization.

Referenced by UsartInit().

int(* _USARTDCB::dcb_deinit)(void)

Driver control de-initialization.

void(* _USARTDCB::dcb_tx_start)(void)

Driver control write notification.

void(* _USARTDCB::dcb_rx_start)(void)

Driver control read notification.

Referenced by UsartIOCtl(), UsartOpen(), and UsartRead().

Set handshake mode.

Referenced by UsartIOCtl().

Get handshake mode.

Referenced by UsartIOCtl().

Set hardware speed.

Referenced by UsartInit(), and UsartIOCtl().

Get hardware speed.

Referenced by UsartIOCtl().

Set hardware data bits.

Referenced by UsartIOCtl().

Get hardware data bits.

Referenced by UsartIOCtl().

Set hardware parity mode.

Referenced by UsartIOCtl().

Get hardware parity mode.

Referenced by UsartIOCtl().

Set hardware stop bits.

Referenced by UsartIOCtl().

Get hardware stop bits.

Referenced by UsartIOCtl().

Set hardware status.

Referenced by UsartClose(), and UsartIOCtl().

Get hardware status.

Referenced by UsartIOCtl().

Set clock mode.

Referenced by UsartIOCtl().

Get clock mode.

Referenced by UsartIOCtl().


The documentation for this struct was generated from the following file: