mbed source development branch
Fork of mbed-dev by
SerialBase Class Reference
[Drivers]
A base class for serial port implementations Can't be instantiated directly (use Serial or RawSerial) More...
#include <SerialBase.h>
Inherited by RawSerial, and Serial.
Public Member Functions | |
void | baud (int baudrate) |
Set the baud rate of the serial port. | |
void | format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1) |
Set the transmission format used by the serial port. | |
int | readable () |
Determine if there is a character available to read. | |
int | writeable () |
Determine if there is space available to write a character. | |
void | attach (Callback< void()> func, IrqType type=RxIrq) |
Attach a function to call whenever a serial interrupt is generated. | |
template<typename T > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type).") void attach(T *obj | |
Attach a member function to call whenever a serial interrupt is generated. | |
void | set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC) |
Set the flow control type on the serial port. | |
int | write (const uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE) |
Begin asynchronous write using 8bit buffer. | |
int | write (const uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE) |
Begin asynchronous write using 16bit buffer. | |
void | abort_write () |
Abort the on-going write transfer. | |
int | read (uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH) |
Begin asynchronous reading using 8bit buffer. | |
int | read (uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH) |
Begin asynchronous reading using 16bit buffer. | |
void | abort_read () |
Abort the on-going read transfer. | |
int | set_dma_usage_tx (DMAUsage usage) |
Configure DMA usage suggestion for non-blocking TX transfers. | |
int | set_dma_usage_rx (DMAUsage usage) |
Configure DMA usage suggestion for non-blocking RX transfers. | |
Protected Member Functions | |
virtual void | lock (void) |
Acquire exclusive access to this serial port. | |
virtual void | unlock (void) |
Release exclusive access to this serial port. |
Detailed Description
A base class for serial port implementations Can't be instantiated directly (use Serial or RawSerial)
Synchronization level: Set by subclass
Definition at line 42 of file SerialBase.h.
Member Function Documentation
void baud | ( | int | baudrate ) |
Set the baud rate of the serial port.
- Parameters:
-
baudrate The baudrate of the serial port (default = 9600).
Definition at line 43 of file SerialBase.cpp.
Generated on Tue Jul 12 2022 19:34:54 by 1.7.2