ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Serial: Deprecate the class and promote UnbufferedSerial instead

pull/12121/head
Hugues Kamba 2019-12-17 08:11:00 +00:00
parent b1b0673622
commit 79054f154a
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
drivers/Serial.h
View File

@ -33,7 +33,8 @@ namespace mbed {
* @{ * @{
*/ */
/** A serial port (UART) for communication with other serial devices /** @deprecated
* A serial port (UART) for communication with other serial devices
* *
* Can be used for Full Duplex communication, or Simplex by specifying * Can be used for Full Duplex communication, or Simplex by specifying
* one pin as NC (Not Connected) * one pin as NC (Not Connected)
@ -53,7 +54,11 @@ namespace mbed {
* } * }
* @endcode * @endcode
*/ */
class Serial : public SerialBase, public Stream, private NonCopyable<Serial> { class
MBED_DEPRECATED_SINCE(
"mbed-os-6.0.0",
"Use printf and puts instead to access the console, BufferedSerial for blocking applications or UnbufferedSerial if bypassing locks in IRQ or short of RAM."
) Serial : public SerialBase, public Stream, private NonCopyable<Serial> {
public: public:
#if DEVICE_SERIAL_ASYNCH #if DEVICE_SERIAL_ASYNCH
@ -67,7 +72,8 @@ public:
using SerialBase::enable_input; using SerialBase::enable_input;
using SerialBase::enable_output; using SerialBase::enable_output;
/** Create a Serial port, connected to the specified transmit and receive pins /** @deprecated
* Create a Serial port, connected to the specified transmit and receive pins
* *
* @param tx Transmit pin * @param tx Transmit pin
* @param rx Receive pin * @param rx Receive pin
@ -77,9 +83,11 @@ public:
* @note * @note
* Either tx or rx may be specified as NC (Not Connected) if unused * Either tx or rx may be specified as NC (Not Connected) if unused
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Serial(PinName tx, PinName rx, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE); Serial(PinName tx, PinName rx, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
/** Create a Serial port, connected to the specified transmit and receive pins /** @deprecated
* Create a Serial port, connected to the specified transmit and receive pins
* *
* @param static_pinmap reference to structure which holds static pinmap. * @param static_pinmap reference to structure which holds static pinmap.
* @param name The name of the stream associated with this serial port (optional) * @param name The name of the stream associated with this serial port (optional)
@ -88,10 +96,13 @@ public:
* @note * @note
* Either tx or rx may be specified as NC (Not Connected) if unused * Either tx or rx may be specified as NC (Not Connected) if unused
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Serial(const serial_pinmap_t &static_pinmap, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE); Serial(const serial_pinmap_t &static_pinmap, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Serial(const serial_pinmap_t &&, const char * = NULL, int = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) = delete; // prevent passing of temporary objects Serial(const serial_pinmap_t &&, const char * = NULL, int = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) = delete; // prevent passing of temporary objects
/** Create a Serial port, connected to the specified transmit and receive pins, with the specified baud /** @deprecated
* Create a Serial port, connected to the specified transmit and receive pins, with the specified baud
* *
* @param tx Transmit pin * @param tx Transmit pin
* @param rx Receive pin * @param rx Receive pin
@ -100,9 +111,11 @@ public:
* @note * @note
* Either tx or rx may be specified as NC (Not Connected) if unused * Either tx or rx may be specified as NC (Not Connected) if unused
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Serial(PinName tx, PinName rx, int baud); Serial(PinName tx, PinName rx, int baud);
/** Create a Serial port, connected to the specified transmit and receive pins, with the specified baud /** @deprecated
* Create a Serial port, connected to the specified transmit and receive pins, with the specified baud
* *
* @param static_pinmap reference to structure which holds static pinmap. * @param static_pinmap reference to structure which holds static pinmap.
* @param baud The baud rate of the serial port * @param baud The baud rate of the serial port
@ -110,21 +123,26 @@ public:
* @note * @note
* Either tx or rx may be specified as NC (Not Connected) if unused * Either tx or rx may be specified as NC (Not Connected) if unused
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Serial(const serial_pinmap_t &static_pinmap, int baud); Serial(const serial_pinmap_t &static_pinmap, int baud);
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Serial(const serial_pinmap_t &&, int) = delete; // prevent passing of temporary objects Serial(const serial_pinmap_t &&, int) = delete; // prevent passing of temporary objects
/* Stream gives us a FileHandle with non-functional poll()/readable()/writable. Pass through /* Stream gives us a FileHandle with non-functional poll()/readable()/writable. Pass through
* the calls from the SerialBase instead for backwards compatibility. This problem is * the calls from the SerialBase instead for backwards compatibility. This problem is
* part of why Stream and Serial should be deprecated. * part of why Stream and Serial should be deprecated.
*/ */
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
bool readable() bool readable()
{ {
return SerialBase::readable(); return SerialBase::readable();
} }
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
bool writable() bool writable()
{ {
return SerialBase::writeable(); return SerialBase::writeable();
} }
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
bool writeable() bool writeable()
{ {
return SerialBase::writeable(); return SerialBase::writeable();