µOS++ IIIe Reference 7.0.0
The third edition of µOS++, a POSIX inspired open source framework, written in C++
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions | Variables
os::driver::serial Namespace Reference

Classes

class  Capabilities
 Serial device driver capabilities. More...
 
class  Modem_status
 Serial modem status More...
 
class  Status
 Serial port status More...
 

Typedefs

using bit_number_t = uint32_t
 
using config_arg_t = uint32_t
 
using config_t = uint32_t
 
using control_arg_t = uint32_t
 
using control_t = uint32_t
 
using modem_config_t = uint32_t
 

Enumerations

enum  Control : control_t {
  enable_tx = (0x15UL << CONFIG_Pos) ,
  enable_rx = (0x16UL << CONFIG_Pos) ,
  enable_break = (0x17UL << CONFIG_Pos) ,
  abort_send = (0x18UL << CONFIG_Pos) ,
  abort_receive = (0x19UL << CONFIG_Pos) ,
  abort_transfer = (0x1AUL << CONFIG_Pos) ,
  disable_tx = (0x25UL << CONFIG_Pos) ,
  disable_rx = (0x26UL << CONFIG_Pos) ,
  disable_break = (0x27UL << CONFIG_Pos)
}
 
enum  Event : event_t {
  send_complete = (1UL << 0) ,
  receive_complete = (1UL << 1) ,
  transfer_complete = (1UL << 2) ,
  tx_complete = (1UL << 3) ,
  tx_underflow = (1UL << 4) ,
  rx_overflow = (1UL << 5) ,
  rx_timeout = (1UL << 6) ,
  rx_break = (1UL << 7) ,
  rx_framing_error = (1UL << 8) ,
  rx_parity_error = (1UL << 9) ,
  cts = (1UL << 10) ,
  dsr = (1UL << 11) ,
  dcd = (1UL << 12) ,
  ri = (1UL << 13)
}
 Serial Events. More...
 
enum class  Modem_control : modem_config_t {
  clear_rts ,
  set_rts ,
  clear_dtr ,
  set_dtr
}
 Configuration to change the serial modem lines. More...
 

Functions

constexpr config_t CONFIG_Msk (0xFFUL<< CONFIG_Pos)
 

Variables

constexpr bit_number_t CONFIG_Pos = 0
 
constexpr config_t CPHA0 = (0UL << CPHA_Pos)
 CPHA = 0 = (default);.
 
constexpr config_t CPHA1 = (1UL << CPHA_Pos)
 CPHA = 1.
 
constexpr config_t CPHA_Msk = (1UL << CPHA_Pos)
 
constexpr bit_number_t CPHA_Pos = 19
 
constexpr config_t CPOL0 = (0UL << CPOL_Pos)
 CPOL = 0 = (default);.
 
constexpr config_t CPOL1 = (1UL << CPOL_Pos)
 CPOL = 1.
 
constexpr config_t CPOL_Msk = (1UL << CPOL_Pos)
 
constexpr bit_number_t CPOL_Pos = 18
 
constexpr config_t DATA_BITS_5 = (5UL << DATA_BITS_Pos)
 5 Data bits.
 
constexpr config_t DATA_BITS_6 = (6UL << DATA_BITS_Pos)
 6 Data bit.
 
constexpr config_t DATA_BITS_7 = (7UL << DATA_BITS_Pos)
 7 Data bits.
 
constexpr config_t DATA_BITS_8 = (0UL << DATA_BITS_Pos)
 8 Data bits = (default);.
 
constexpr config_t DATA_BITS_9 = (1UL << DATA_BITS_Pos)
 9 Data bits.
 
constexpr config_t DATA_BITS_Msk = (7UL << DATA_BITS_Pos)
 
constexpr bit_number_t DATA_BITS_Pos = 8
 
constexpr config_t DEFAULT_TX_VALUE = (0x10UL << CONFIG_Pos)
 Set default Transmit value = (Synchronous Receive only); arg = value.
 
constexpr return_t ERROR_BAUDRATE = ERROR_SPECIFIC - 2
 Specified baudrate not supported.
 
constexpr return_t ERROR_CPHA = ERROR_SPECIFIC - 8
 Specified Clock Phase not supported.
 
constexpr return_t ERROR_CPOL = ERROR_SPECIFIC - 7
 Specified Clock Polarity not supported.
 
constexpr return_t ERROR_DATA_BITS = ERROR_SPECIFIC - 3
 Specified number of Data bits not supported.
 
constexpr return_t ERROR_FLOW_CONTROL = ERROR_SPECIFIC - 6
 Specified Flow Control not supported.
 
constexpr return_t ERROR_MODE = ERROR_SPECIFIC - 1
 Specified Mode not supported.
 
constexpr return_t ERROR_PARITY = ERROR_SPECIFIC - 4
 Specified Parity not supported.
 
constexpr return_t ERROR_STOP_BITS = ERROR_SPECIFIC - 5
 Specified number of Stop bits not supported.
 
constexpr bit_number_t FLOW_CONFIG_Pos = 16
 
constexpr config_t FLOW_CONTROL_CTS = (2UL << FLOW_CONFIG_Pos)
 CTS Flow Control.
 
constexpr config_t FLOW_CONTROL_Msk = (3UL << FLOW_CONFIG_Pos)
 
constexpr config_t FLOW_CONTROL_NONE = (0UL << FLOW_CONFIG_Pos)
 No Flow Control = (default);.
 
constexpr config_t FLOW_CONTROL_RTS = (1UL << FLOW_CONFIG_Pos)
 RTS Flow Control.
 
constexpr config_t FLOW_CONTROL_RTS_CTS = (3UL << FLOW_CONFIG_Pos)
 RTS/CTS Flow Control.
 
constexpr config_t IRDA_PULSE = (0x11UL << CONFIG_Pos)
 Set IrDA Pulse in ns; arg: 0=3/16 of bit period.
 
constexpr config_t MODE_ASYNCHRONOUS = (0x01UL << CONFIG_Pos)
 UART = (Asynchronous);; arg = Baudrate.
 
constexpr config_t MODE_IRDA = (0x05UL << CONFIG_Pos)
 UART IrDA; arg = Baudrate.
 
constexpr config_t MODE_SINGLE_WIRE = (0x04UL << CONFIG_Pos)
 UART Single-wire = (half-duplex);; arg = Baudrate.
 
constexpr config_t MODE_SMART_CARD = (0x06UL << CONFIG_Pos)
 UART Smart Card; arg = Baudrate.
 
constexpr config_t MODE_SYNCHRONOUS_MASTER = (0x02UL << CONFIG_Pos)
 Synchronous Master = (generates clock signal); arg = Baudrate.
 
constexpr config_t MODE_SYNCHRONOUS_SLAVE = (0x03UL << CONFIG_Pos)
 Synchronous Slave = (external clock signal);.
 
constexpr config_t PARITY_EVEN = (1UL << PARITY_Pos)
 Even Parity.
 
constexpr config_t PARITY_Msk = (3UL << PARITY_Pos)
 
constexpr config_t PARITY_NONE = (0UL << PARITY_Pos)
 No Parity = (default);.
 
constexpr config_t PARITY_ODD = (2UL << PARITY_Pos)
 Odd Parity.
 
constexpr bit_number_t PARITY_Pos = 12
 
constexpr config_t SMART_CARD_CLOCK = (0x13UL << CONFIG_Pos)
 Set Smart Card Clock in Hz; arg: 0=Clock not generated.
 
constexpr config_t SMART_CARD_GUARD_TIME = (0x12UL << CONFIG_Pos)
 Set Smart Card Guard Time; arg = number of bit periods.
 
constexpr config_t SMART_CARD_NACK = (0x14UL << CONFIG_Pos)
 Smart Card NACK generation; arg: 0=disabled, 1=enabled.
 
constexpr config_t STOP_BITS_0_5 = (3UL << STOP_BITS_Pos)
 0.5 Stop bits.
 
constexpr config_t STOP_BITS_1 = (0UL << STOP_BITS_Pos)
 1 Stop bit = (default);.
 
constexpr config_t STOP_BITS_1_5 = (2UL << STOP_BITS_Pos)
 1.5 Stop bits.
 
constexpr config_t STOP_BITS_2 = (1UL << STOP_BITS_Pos)
 2 Stop bits.
 
constexpr config_t STOP_BITS_Msk = (3UL << STOP_BITS_Pos)
 
constexpr bit_number_t STOP_BITS_Pos = 14
 

Typedef Documentation

◆ bit_number_t

using os::driver::serial::bit_number_t = typedef uint32_t

Definition at line 49 of file serial.h.

◆ config_arg_t

using os::driver::serial::config_arg_t = typedef uint32_t

Definition at line 51 of file serial.h.

◆ config_t

using os::driver::serial::config_t = typedef uint32_t

Definition at line 50 of file serial.h.

◆ control_arg_t

using os::driver::serial::control_arg_t = typedef uint32_t

Definition at line 53 of file serial.h.

◆ control_t

using os::driver::serial::control_t = typedef uint32_t

Definition at line 52 of file serial.h.

◆ modem_config_t

using os::driver::serial::modem_config_t = typedef uint32_t

Definition at line 320 of file serial.h.

Enumeration Type Documentation

◆ Control

enum os::driver::serial::Control : control_t
Enumerator
enable_tx 

Enable Transmitter.

enable_rx 

Enable Receiver.

enable_break 

Enable Continuous Break transmission.

abort_send 

Abort Serial::send().

abort_receive 

Abort Serial::receive().

abort_transfer 

Abort Serial::transfer().

disable_tx 

Disable Transmitter.

disable_rx 

Disable Receiver.

disable_break 

Disable Continuous Break transmission;.

Definition at line 187 of file serial.h.

188 {
189 //
191 enable_tx = (0x15UL << CONFIG_Pos),
192
194 enable_rx = (0x16UL << CONFIG_Pos),
195
197 enable_break = (0x17UL << CONFIG_Pos),
198
200 abort_send = (0x18UL << CONFIG_Pos),
201
203 abort_receive = (0x19UL << CONFIG_Pos),
204
206 abort_transfer = (0x1AUL << CONFIG_Pos),
207
209 disable_tx = (0x25UL << CONFIG_Pos),
210
212 disable_rx = (0x26UL << CONFIG_Pos),
213
215 disable_break = (0x27UL << CONFIG_Pos)
216 };
os::driver::serial::CONFIG_Pos
constexpr bit_number_t CONFIG_Pos
Definition serial.h:57
os::driver::serial::abort_receive
@ abort_receive
Abort Serial::receive().
Definition serial.h:203
os::driver::serial::enable_break
@ enable_break
Enable Continuous Break transmission.
Definition serial.h:197
os::driver::serial::disable_break
@ disable_break
Disable Continuous Break transmission;.
Definition serial.h:215
os::driver::serial::disable_tx
@ disable_tx
Disable Transmitter.
Definition serial.h:209
os::driver::serial::enable_tx
@ enable_tx
Enable Transmitter.
Definition serial.h:191

◆ Event

enum os::driver::serial::Event : event_t
Enumerator
send_complete 

Send completed; however USART may still transmit data.

receive_complete 

Receive completed.

transfer_complete 

Transfer completed.

tx_complete 

Transmit completed (optional).

tx_underflow 

Transmit data not available (Synchronous Slave).

rx_overflow 

Receive data overflow.

rx_timeout 

Receive character timeout (optional).

rx_break 

Break detected on receive.

rx_framing_error 

Framing error detected on receive.

rx_parity_error 

Parity error detected on receive.

cts 

CTS state changed (optional).

dsr 

DSR state changed (optional).

dcd 

DCD state changed (optional).

ri 

RI state changed (optional).

Definition at line 395 of file serial.h.

396 {
397 //
398
400 send_complete = (1UL << 0),
401
403 receive_complete = (1UL << 1),
404
406 transfer_complete = (1UL << 2),
407
409 tx_complete = (1UL << 3),
410
412 tx_underflow = (1UL << 4),
413
415 rx_overflow = (1UL << 5),
416
418 rx_timeout = (1UL << 6),
419
421 rx_break = (1UL << 7),
422
424 rx_framing_error = (1UL << 8),
425
427 rx_parity_error = (1UL << 9),
428
430 cts = (1UL << 10),
431
433 dsr = (1UL << 11),
434
436 dcd = (1UL << 12),
437
439 ri = (1UL << 13)
440 };
os::driver::serial::cts
@ cts
CTS state changed (optional).
Definition serial.h:430
os::driver::serial::rx_framing_error
@ rx_framing_error
Framing error detected on receive.
Definition serial.h:424
os::driver::serial::transfer_complete
@ transfer_complete
Transfer completed.
Definition serial.h:406
os::driver::serial::tx_underflow
@ tx_underflow
Transmit data not available (Synchronous Slave).
Definition serial.h:412
os::driver::serial::dcd
@ dcd
DCD state changed (optional).
Definition serial.h:436
os::driver::serial::rx_timeout
@ rx_timeout
Receive character timeout (optional).
Definition serial.h:418
os::driver::serial::send_complete
@ send_complete
Send completed; however USART may still transmit data.
Definition serial.h:400

◆ Modem_control

enum class os::driver::serial::Modem_control : modem_config_t
strong
Enumerator
clear_rts 

Deactivate RTS.

set_rts 

Activate RTS.

clear_dtr 

Deactivate DTR.

set_dtr 

Activate DTR.

Definition at line 325 of file serial.h.

326 {
327 //
328
330 clear_rts,
331
333 set_rts,
334
336 clear_dtr,
337
339 set_dtr
340 };

Function Documentation

◆ CONFIG_Msk()

constexpr config_t os::driver::serial::CONFIG_Msk ( 0xFFUL<<  CONFIG_Pos)
constexpr

Variable Documentation

◆ CONFIG_Pos

constexpr bit_number_t os::driver::serial::CONFIG_Pos = 0
constexpr

Definition at line 57 of file serial.h.

◆ CPHA0

constexpr config_t os::driver::serial::CPHA0 = (0UL << CPHA_Pos)
constexpr

Definition at line 161 of file serial.h.

◆ CPHA1

constexpr config_t os::driver::serial::CPHA1 = (1UL << CPHA_Pos)
constexpr

Definition at line 164 of file serial.h.

◆ CPHA_Msk

constexpr config_t os::driver::serial::CPHA_Msk = (1UL << CPHA_Pos)
constexpr

Definition at line 158 of file serial.h.

◆ CPHA_Pos

constexpr bit_number_t os::driver::serial::CPHA_Pos = 19
constexpr

Definition at line 157 of file serial.h.

◆ CPOL0

constexpr config_t os::driver::serial::CPOL0 = (0UL << CPOL_Pos)
constexpr

Definition at line 150 of file serial.h.

◆ CPOL1

constexpr config_t os::driver::serial::CPOL1 = (1UL << CPOL_Pos)
constexpr

Definition at line 153 of file serial.h.

◆ CPOL_Msk

constexpr config_t os::driver::serial::CPOL_Msk = (1UL << CPOL_Pos)
constexpr

Definition at line 147 of file serial.h.

◆ CPOL_Pos

constexpr bit_number_t os::driver::serial::CPOL_Pos = 18
constexpr

Definition at line 146 of file serial.h.

◆ DATA_BITS_5

constexpr config_t os::driver::serial::DATA_BITS_5 = (5UL << DATA_BITS_Pos)
constexpr

Definition at line 85 of file serial.h.

◆ DATA_BITS_6

constexpr config_t os::driver::serial::DATA_BITS_6 = (6UL << DATA_BITS_Pos)
constexpr

Definition at line 88 of file serial.h.

◆ DATA_BITS_7

constexpr config_t os::driver::serial::DATA_BITS_7 = (7UL << DATA_BITS_Pos)
constexpr

Definition at line 91 of file serial.h.

◆ DATA_BITS_8

constexpr config_t os::driver::serial::DATA_BITS_8 = (0UL << DATA_BITS_Pos)
constexpr

Definition at line 94 of file serial.h.

Referenced by os::posix::device_serial_buffered< CS >::do_vopen().

◆ DATA_BITS_9

constexpr config_t os::driver::serial::DATA_BITS_9 = (1UL << DATA_BITS_Pos)
constexpr

Definition at line 97 of file serial.h.

◆ DATA_BITS_Msk

constexpr config_t os::driver::serial::DATA_BITS_Msk = (7UL << DATA_BITS_Pos)
constexpr

Definition at line 82 of file serial.h.

◆ DATA_BITS_Pos

constexpr bit_number_t os::driver::serial::DATA_BITS_Pos = 8
constexpr

Definition at line 81 of file serial.h.

◆ DEFAULT_TX_VALUE

constexpr config_t os::driver::serial::DEFAULT_TX_VALUE = (0x10UL << CONFIG_Pos)
constexpr

Definition at line 170 of file serial.h.

◆ ERROR_BAUDRATE

constexpr return_t os::driver::serial::ERROR_BAUDRATE = ERROR_SPECIFIC - 2
constexpr

Definition at line 225 of file serial.h.

◆ ERROR_CPHA

constexpr return_t os::driver::serial::ERROR_CPHA = ERROR_SPECIFIC - 8
constexpr

Definition at line 243 of file serial.h.

◆ ERROR_CPOL

constexpr return_t os::driver::serial::ERROR_CPOL = ERROR_SPECIFIC - 7
constexpr

Definition at line 240 of file serial.h.

◆ ERROR_DATA_BITS

constexpr return_t os::driver::serial::ERROR_DATA_BITS = ERROR_SPECIFIC - 3
constexpr

Definition at line 228 of file serial.h.

◆ ERROR_FLOW_CONTROL

constexpr return_t os::driver::serial::ERROR_FLOW_CONTROL = ERROR_SPECIFIC - 6
constexpr

Definition at line 237 of file serial.h.

◆ ERROR_MODE

constexpr return_t os::driver::serial::ERROR_MODE = ERROR_SPECIFIC - 1
constexpr

Definition at line 222 of file serial.h.

◆ ERROR_PARITY

constexpr return_t os::driver::serial::ERROR_PARITY = ERROR_SPECIFIC - 4
constexpr

Definition at line 231 of file serial.h.

◆ ERROR_STOP_BITS

constexpr return_t os::driver::serial::ERROR_STOP_BITS = ERROR_SPECIFIC - 5
constexpr

Definition at line 234 of file serial.h.

◆ FLOW_CONFIG_Pos

constexpr bit_number_t os::driver::serial::FLOW_CONFIG_Pos = 16
constexpr

Definition at line 129 of file serial.h.

◆ FLOW_CONTROL_CTS

constexpr config_t os::driver::serial::FLOW_CONTROL_CTS = (2UL << FLOW_CONFIG_Pos)
constexpr

Definition at line 139 of file serial.h.

◆ FLOW_CONTROL_Msk

constexpr config_t os::driver::serial::FLOW_CONTROL_Msk = (3UL << FLOW_CONFIG_Pos)
constexpr

Definition at line 130 of file serial.h.

◆ FLOW_CONTROL_NONE

constexpr config_t os::driver::serial::FLOW_CONTROL_NONE = (0UL << FLOW_CONFIG_Pos)
constexpr

Definition at line 133 of file serial.h.

Referenced by os::posix::device_serial_buffered< CS >::do_vopen().

◆ FLOW_CONTROL_RTS

constexpr config_t os::driver::serial::FLOW_CONTROL_RTS = (1UL << FLOW_CONFIG_Pos)
constexpr

Definition at line 136 of file serial.h.

◆ FLOW_CONTROL_RTS_CTS

constexpr config_t os::driver::serial::FLOW_CONTROL_RTS_CTS = (3UL << FLOW_CONFIG_Pos)
constexpr

Definition at line 142 of file serial.h.

◆ IRDA_PULSE

constexpr config_t os::driver::serial::IRDA_PULSE = (0x11UL << CONFIG_Pos)
constexpr

Definition at line 173 of file serial.h.

◆ MODE_ASYNCHRONOUS

constexpr config_t os::driver::serial::MODE_ASYNCHRONOUS = (0x01UL << CONFIG_Pos)
constexpr

Definition at line 62 of file serial.h.

Referenced by os::posix::device_serial_buffered< CS >::do_vopen().

◆ MODE_IRDA

constexpr config_t os::driver::serial::MODE_IRDA = (0x05UL << CONFIG_Pos)
constexpr

Definition at line 75 of file serial.h.

◆ MODE_SINGLE_WIRE

constexpr config_t os::driver::serial::MODE_SINGLE_WIRE = (0x04UL << CONFIG_Pos)
constexpr

Definition at line 72 of file serial.h.

◆ MODE_SMART_CARD

constexpr config_t os::driver::serial::MODE_SMART_CARD = (0x06UL << CONFIG_Pos)
constexpr

Definition at line 78 of file serial.h.

◆ MODE_SYNCHRONOUS_MASTER

constexpr config_t os::driver::serial::MODE_SYNCHRONOUS_MASTER = (0x02UL << CONFIG_Pos)
constexpr

Definition at line 66 of file serial.h.

◆ MODE_SYNCHRONOUS_SLAVE

constexpr config_t os::driver::serial::MODE_SYNCHRONOUS_SLAVE = (0x03UL << CONFIG_Pos)
constexpr

Definition at line 69 of file serial.h.

◆ PARITY_EVEN

constexpr config_t os::driver::serial::PARITY_EVEN = (1UL << PARITY_Pos)
constexpr

Definition at line 107 of file serial.h.

◆ PARITY_Msk

constexpr config_t os::driver::serial::PARITY_Msk = (3UL << PARITY_Pos)
constexpr

Definition at line 101 of file serial.h.

◆ PARITY_NONE

constexpr config_t os::driver::serial::PARITY_NONE = (0UL << PARITY_Pos)
constexpr

Definition at line 104 of file serial.h.

Referenced by os::posix::device_serial_buffered< CS >::do_vopen().

◆ PARITY_ODD

constexpr config_t os::driver::serial::PARITY_ODD = (2UL << PARITY_Pos)
constexpr

Definition at line 110 of file serial.h.

◆ PARITY_Pos

constexpr bit_number_t os::driver::serial::PARITY_Pos = 12
constexpr

Definition at line 100 of file serial.h.

◆ SMART_CARD_CLOCK

constexpr config_t os::driver::serial::SMART_CARD_CLOCK = (0x13UL << CONFIG_Pos)
constexpr

Definition at line 179 of file serial.h.

◆ SMART_CARD_GUARD_TIME

constexpr config_t os::driver::serial::SMART_CARD_GUARD_TIME = (0x12UL << CONFIG_Pos)
constexpr

Definition at line 176 of file serial.h.

◆ SMART_CARD_NACK

constexpr config_t os::driver::serial::SMART_CARD_NACK = (0x14UL << CONFIG_Pos)
constexpr

Definition at line 182 of file serial.h.

◆ STOP_BITS_0_5

constexpr config_t os::driver::serial::STOP_BITS_0_5 = (3UL << STOP_BITS_Pos)
constexpr

Definition at line 126 of file serial.h.

◆ STOP_BITS_1

constexpr config_t os::driver::serial::STOP_BITS_1 = (0UL << STOP_BITS_Pos)
constexpr

Definition at line 117 of file serial.h.

Referenced by os::posix::device_serial_buffered< CS >::do_vopen().

◆ STOP_BITS_1_5

constexpr config_t os::driver::serial::STOP_BITS_1_5 = (2UL << STOP_BITS_Pos)
constexpr

Definition at line 123 of file serial.h.

◆ STOP_BITS_2

constexpr config_t os::driver::serial::STOP_BITS_2 = (1UL << STOP_BITS_Pos)
constexpr

Definition at line 120 of file serial.h.

◆ STOP_BITS_Msk

constexpr config_t os::driver::serial::STOP_BITS_Msk = (3UL << STOP_BITS_Pos)
constexpr

Definition at line 114 of file serial.h.

◆ STOP_BITS_Pos

constexpr bit_number_t os::driver::serial::STOP_BITS_Pos = 14
constexpr

Definition at line 113 of file serial.h.