From 326f5bb89803542dcb8b68ea1285259000b922f0 Mon Sep 17 00:00:00 2001
From: George Beckstein <george.beckstein@gmail.com>
Date: Tue, 23 Feb 2021 16:43:02 -0500
Subject: [PATCH] Implement polymorphism for DigitalInOut

Co-authored-by: Vincent Coubard (pan-) <Vincent.Coubard@arm.com>
---
 drivers/include/drivers/DigitalInOut.h        |  7 +-
 .../interfaces/InterfaceDigitalInOut.h        | 72 +++++++++++++++++++
 2 files changed, 78 insertions(+), 1 deletion(-)
 create mode 100644 drivers/include/drivers/interfaces/InterfaceDigitalInOut.h

diff --git a/drivers/include/drivers/DigitalInOut.h b/drivers/include/drivers/DigitalInOut.h
index 26fafcac51..afc4137abe 100644
--- a/drivers/include/drivers/DigitalInOut.h
+++ b/drivers/include/drivers/DigitalInOut.h
@@ -19,6 +19,7 @@
 
 #include "platform/platform.h"
 
+#include "interfaces/InterfaceDigitalInOut.h"
 #include "hal/gpio_api.h"
 
 namespace mbed {
@@ -32,7 +33,11 @@ namespace mbed {
  *
  * @note Synchronization level: Interrupt safe
  */
-class DigitalInOut {
+class DigitalInOut
+#ifdef FEATURE_EXPERIMENTAL_API
+    final : public interface::DigitalInOut
+#endif
+{
 
 public:
     /** Create a DigitalInOut connected to the specified pin
diff --git a/drivers/include/drivers/interfaces/InterfaceDigitalInOut.h b/drivers/include/drivers/interfaces/InterfaceDigitalInOut.h
new file mode 100644
index 0000000000..a884784b5d
--- /dev/null
+++ b/drivers/include/drivers/interfaces/InterfaceDigitalInOut.h
@@ -0,0 +1,72 @@
+/*
+ * Mbed-OS Microcontroller Library
+ * Copyright (c) 2021 Embedded Planet
+ * Copyright (c) 2021 ARM Limited
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License
+ */
+
+#ifndef MBED_INTERFACE_DIGITALINOUT_H_
+#define MBED_INTERFACE_DIGITALINOUT_H_
+
+#include "PinNames.h"
+
+namespace mbed {
+
+class DigitalInOut;
+
+namespace interface {
+
+#ifdef FEATURE_EXPERIMENTAL_API
+
+// TODO - move method doxygen comments to interface once this polymorphism is mainstream
+
+// Pure interface definition for DigitalInOut
+struct DigitalInOut {
+    virtual ~DigitalInOut() = default;
+    virtual void write(int value) = 0;
+    virtual int read() = 0;
+    virtual void output() = 0;
+    virtual void input() = 0;
+    virtual void mode(PinMode pull) = 0;
+    virtual int is_connected() = 0;
+
+    virtual DigitalInOut &operator= (int value)
+    {
+        // Underlying implementation is responsible for thread-safety
+        write(value);
+        return *this;
+    }
+
+    virtual DigitalInOut &operator= (DigitalInOut &rhs) {
+        // Underlying implementation is responsible for thread-safety
+        write(rhs.read());
+        return *this;
+    }
+
+    virtual operator int()
+    {
+        // Underlying implementation is responsible for thread-safety
+        return read();
+    }
+
+};
+#else
+using DigitalInOut = ::mbed::DigitalInOut;
+#endif /* FEATURE_EXPERIMENTAL_API */
+
+} // namespace interface
+} // namespace mbed
+
+#endif /* MBED_INTERFACE_DIGITALINOUT_H_ */