Mark UARTSerial as deprecated

Author: hugueskamba

drivers/UARTSerial.h

@@ -48,28 +48,39 @@ namespace mbed {
  *
  */
 
-class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UARTSerial> {
+class
+    MBED_DEPRECATED_SINCE(
+        "mbed-os-6.0.0",
+        "Use BufferedSerial instead."
+    ) UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UARTSerial> {
 
 public:
 
-    /** Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
+    /** @deprecated
+     *  Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
      *  @param tx Transmit pin
      *  @param rx Receive pin
      *  @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     UARTSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
 
-    /** Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
+    /** @deprecated
+     *  Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
      *  @param static_pinmap reference to structure which holds static pinmap
      *  @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     UARTSerial(const serial_pinmap_t &static_pinmap, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
 
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual ~UARTSerial();
 
-    /** Equivalent to POSIX poll(). Derived from FileHandle.
+    /** @deprecated
+     *  Equivalent to POSIX poll(). Derived from FileHandle.
      *  Provides a mechanism to multiplex input/output over a set of file handles.
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual short poll(short events) const;
 
     /* Resolve ambiguities versus our private SerialBase
@@ -78,7 +89,8 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
     using FileHandle::readable;
     using FileHandle::writable;
 
-    /** Write the contents of a buffer to a file
+    /** @deprecated
+     *  Write the contents of a buffer to a file
      *
      *  Follows POSIX semantics:
      *
@@ -90,9 +102,11 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
      *  @param length   The number of bytes to write
      *  @return         The number of bytes written, negative error on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual ssize_t write(const void *buffer, size_t length);
 
-    /** Read the contents of a file into a buffer
+    /** @deprecated
+     *  Read the contents of a file into a buffer
      *
      *  Follows POSIX semantics:
      *
@@ -104,23 +118,29 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
      *  @param length   The number of bytes to read
      *  @return         The number of bytes read, 0 at end of file, negative error on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual ssize_t read(void *buffer, size_t length);
 
-    /** Close a file
+    /** @deprecated
+     *  Close a file
      *
      *  @return         0 on success, negative error code on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual int close();
 
-    /** Check if the file in an interactive terminal device
+    /** @deprecated
+     *  Check if the file in an interactive terminal device
      *
      *  @return         True if the file is a terminal
      *  @return         False if the file is not a terminal
      *  @return         Negative error code on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual int isatty();
 
-    /** Move the file position to a given offset from from a given location
+    /** @deprecated
+     * Move the file position to a given offset from from a given location
      *
      * Not valid for a device type FileHandle like UARTSerial.
      * In case of UARTSerial, returns ESPIPE
@@ -132,35 +152,43 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
      *      SEEK_END to start from end of file
      *  @return         The new offset of the file, negative error code on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual off_t seek(off_t offset, int whence);
 
-    /** Flush any buffers associated with the file
+    /** @deprecated
+     *  Flush any buffers associated with the file
      *
      *  @return         0 on success, negative error code on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual int sync();
 
-    /** Set blocking or non-blocking mode
+    /** @deprecated
+     *  Set blocking or non-blocking mode
      *  The default is blocking.
      *
      *  @param blocking true for blocking mode, false for non-blocking mode.
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual int set_blocking(bool blocking)
     {
         _blocking = blocking;
         return 0;
     }
 
-    /** Check current blocking or non-blocking mode for file operations.
+    /** @deprecated
+     *  Check current blocking or non-blocking mode for file operations.
      *
      *  @return             true for blocking mode, false for non-blocking mode.
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual bool is_blocking() const
     {
         return _blocking;
     }
 
-    /** Enable or disable input
+    /** @deprecated
+     * Enable or disable input
      *
      * Control enabling of device for input. This is primarily intended
      * for temporary power-saving; the overall ability of the device to operate for
@@ -173,9 +201,11 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
      *  @return             0 on success
      *  @return             Negative error code on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual int enable_input(bool enabled);
 
-    /** Enable or disable output
+    /** @deprecated
+     * Enable or disable output
      *
      * Control enabling of device for output. This is primarily intended
      * for temporary power-saving; the overall ability of the device to operate for
@@ -188,9 +218,11 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
      *  @return             0 on success
      *  @return             Negative error code on failure
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual int enable_output(bool enabled);
 
-    /** Register a callback on state change of the file.
+    /** @deprecated
+     *  Register a callback on state change of the file.
      *
      *  The specified callback will be called on state changes such as when
      *  the file can be written to or read from.
@@ -207,22 +239,27 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
      *
      *  @param func     Function to call on state change
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     virtual void sigio(Callback<void()> func);
 
-    /** Setup interrupt handler for DCD line
+    /** @deprecated
+     *  Setup interrupt handler for DCD line
      *
      *  If DCD line is connected, an IRQ handler will be setup.
      *  Does nothing if DCD is NC, i.e., not connected.
      *
      *  @param dcd_pin         Pin-name for DCD
      *  @param active_high     a boolean set to true if DCD polarity is active low
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     void set_data_carrier_detect(PinName dcd_pin, bool active_high = false);
 
-    /** Set the baud rate
+    /** @deprecated
+     *  Set the baud rate
      *
      *  @param baud   The baud rate
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     void set_baud(int baud);
 
     // Expose private SerialBase::Parity as UARTSerial::Parity
@@ -234,12 +271,14 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
     using SerialBase::Forced1;
     using SerialBase::Forced0;
 
-    /** Set the transmission format used by the serial port
+    /** @deprecated
+     *  Set the transmission format used by the serial port
      *
      *  @param bits The number of bits in a word (5-8; default = 8)
      *  @param parity The parity used (None, Odd, Even, Forced1, Forced0; default = None)
      *  @param stop_bits The number of stop bits (1 or 2; default = 1)
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     void set_format(int bits = 8, Parity parity = UARTSerial::None, int stop_bits = 1);
 
 #if DEVICE_SERIAL_FC
@@ -252,38 +291,51 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
     using SerialBase::CTS;
     using SerialBase::RTSCTS;
 
-    /** Set the flow control type on the serial port
+    /** @deprecated
+     *  Set the flow control type on the serial port
      *
      *  @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
      *  @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
      *  @param flow2 the second flow control pin (CTS for RTSCTS)
      */
+    MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
     void set_flow_control(Flow type, PinName flow1 = NC, PinName flow2 = NC);
 #endif
 
 private:
 
-    /** SerialBase lock override */
+    /** @deprecated
+     * SerialBase lock override
+     */
     virtual void lock(void);
 
-    /** SerialBase unlock override */
+    /** @deprecated
+     * SerialBase unlock override
+     */
     virtual void unlock(void);
 
-    /** Acquire mutex */
+    /** @deprecated
+     * Acquire mutex
+     */
     virtual void api_lock(void);
 
-    /** Release mutex */
+    /** @deprecated
+     * Release mutex
+     */
     virtual void api_unlock(void);
 
-    /** Unbuffered write - invoked when write called from critical section */
+    /** @deprecated
+     * Unbuffered write - invoked when write called from critical section
+     */
     ssize_t write_unbuffered(const char *buf_ptr, size_t length);
 
     void enable_rx_irq();
     void disable_rx_irq();
     void enable_tx_irq();
     void disable_tx_irq();
 
-    /** Software serial buffers
+    /** @deprecated
+     *  Software serial buffers
      *  By default buffer size is 256 for TX and 256 for RX. Configurable through mbed_app.json
      */
     CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _rxbuf;
@@ -300,14 +352,16 @@ class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UA
     bool _rx_enabled;
     InterruptIn *_dcd_irq;
 
-    /** Device Hanged up
+    /** @deprecated
+     *  Device Hanged up
      *  Determines if the device hanged up on us.
      *
      *  @return True, if hanged up
      */
     bool hup() const;
 
-    /** ISRs for serial
+    /** @deprecated
+     *  ISRs for serial
      *  Routines to handle interrupts on serial pins.
      *  Copies data into Circular Buffer.
      *  Reports the state change to File handle.