From 84dad6ce539925a683f5ba121f87686d61b2e507 Mon Sep 17 00:00:00 2001 From: Jenny Plunkett Date: Fri, 12 Oct 2018 13:18:11 -0500 Subject: [PATCH 1/6] Remove RawSerial protected member functions --- drivers/RawSerial.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/drivers/RawSerial.h b/drivers/RawSerial.h index 1ede0c8a33..4325bcb9e0 100644 --- a/drivers/RawSerial.h +++ b/drivers/RawSerial.h @@ -88,6 +88,7 @@ public: int printf(const char *format, ...); +#if !(DOXYGEN_ONLY) protected: /* Acquire exclusive access to this serial port @@ -97,6 +98,7 @@ protected: /* Release exclusive access to this serial port */ virtual void unlock(void); +#endif }; } // namespace mbed From 20f913a06e48a0c260175a279b94e19cc676bb99 Mon Sep 17 00:00:00 2001 From: Jenny Plunkett Date: Fri, 12 Oct 2018 13:20:02 -0500 Subject: [PATCH 2/6] Remove Serial protected member functions and attributes --- drivers/Serial.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/drivers/Serial.h b/drivers/Serial.h index 7c5e536acb..4493c6f6f9 100644 --- a/drivers/Serial.h +++ b/drivers/Serial.h @@ -99,6 +99,7 @@ public: return SerialBase::writeable(); } +#if !(DOXYGEN_ONLY) protected: virtual int _getc(); virtual int _putc(int c); @@ -106,6 +107,7 @@ protected: virtual void unlock(); PlatformMutex _mutex; +#endif }; } // namespace mbed From 9a7f359ab54cfaca24385bde3722215afe8b0c85 Mon Sep 17 00:00:00 2001 From: Jenny Plunkett Date: Fri, 12 Oct 2018 13:22:14 -0500 Subject: [PATCH 3/6] Add (Not Connected) --- drivers/Serial.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/Serial.h b/drivers/Serial.h index 4493c6f6f9..0e88d00fee 100644 --- a/drivers/Serial.h +++ b/drivers/Serial.h @@ -66,7 +66,7 @@ public: * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) * * @note - * Either tx or rx may be specified as NC if unused + * Either tx or rx may be specified as NC (Not Connected) if unused */ Serial(PinName tx, PinName rx, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE); @@ -78,7 +78,7 @@ public: * @param baud The baud rate of the serial port * * @note - * Either tx or rx may be specified as NC if unused + * Either tx or rx may be specified as NC (Not Connected) if unused */ Serial(PinName tx, PinName rx, int baud); From 5ee5b071ab5b45bbcf0ab8b8f9ca0cba9f06fc72 Mon Sep 17 00:00:00 2001 From: Jenny Plunkett Date: Fri, 12 Oct 2018 13:22:49 -0500 Subject: [PATCH 4/6] Remove note about Stream/Serial deprecation --- drivers/Serial.h | 4 ---- 1 file changed, 4 deletions(-) diff --git a/drivers/Serial.h b/drivers/Serial.h index 0e88d00fee..12882808b6 100644 --- a/drivers/Serial.h +++ b/drivers/Serial.h @@ -82,10 +82,6 @@ public: */ Serial(PinName tx, PinName rx, int baud); - /* 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 - * part of why Stream and Serial should be deprecated. - */ bool readable() { return SerialBase::readable(); From b31bc766e661f64b8bbeb096c892bddc023fe8cf Mon Sep 17 00:00:00 2001 From: Jenny Plunkett Date: Fri, 12 Oct 2018 13:40:23 -0500 Subject: [PATCH 5/6] Add note about default baud rate is 9600 --- drivers/Serial.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/Serial.h b/drivers/Serial.h index 12882808b6..434d6aa177 100644 --- a/drivers/Serial.h +++ b/drivers/Serial.h @@ -63,7 +63,7 @@ public: * @param tx Transmit pin * @param rx Receive pin * @param name The name of the stream associated with this serial port (optional) - * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) + * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600) * * @note * Either tx or rx may be specified as NC (Not Connected) if unused From 383798b525bdc599c0194bd0f4268ea230d1e088 Mon Sep 17 00:00:00 2001 From: Jenny Plunkett Date: Mon, 15 Oct 2018 14:42:45 -0500 Subject: [PATCH 6/6] Revert "Remove note about Stream/Serial deprecation" This reverts commit 5ee5b071ab5b45bbcf0ab8b8f9ca0cba9f06fc72. --- drivers/Serial.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/drivers/Serial.h b/drivers/Serial.h index 434d6aa177..1b1e6aa34e 100644 --- a/drivers/Serial.h +++ b/drivers/Serial.h @@ -82,6 +82,10 @@ public: */ Serial(PinName tx, PinName rx, int baud); + /* 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 + * part of why Stream and Serial should be deprecated. + */ bool readable() { return SerialBase::readable();