diff --git a/drivers/include/drivers/DigitalIn.h b/drivers/include/drivers/DigitalIn.h index 1dfddcd0cc..5543ec7253 100644 --- a/drivers/include/drivers/DigitalIn.h +++ b/drivers/include/drivers/DigitalIn.h @@ -1,5 +1,5 @@ /* mbed Microcontroller Library - * Copyright (c) 2006-2019 ARM Limited + * Copyright (c) 2006-2020 ARM Limited * SPDX-License-Identifier: Apache-2.0 * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -19,9 +19,11 @@ #include "platform/platform.h" +#include "interfaces/InterfaceDigitalIn.h" #include "hal/gpio_api.h" namespace mbed { + /** * \defgroup drivers_DigitalIn DigitalIn class * \ingroup drivers-public-api-gpio @@ -51,7 +53,11 @@ namespace mbed { * } * @endcode */ -class DigitalIn { +class DigitalIn +#ifdef FEATURE_EXPERIMENTAL_API + final : public interface::DigitalIn +#endif +{ public: /** Create a DigitalIn connected to the specified pin @@ -75,6 +81,13 @@ public: gpio_init_in_ex(&gpio, pin, mode); } + /** Class destructor, deinitialize the pin + */ + ~DigitalIn() + { + gpio_free(&gpio); + } + /** Read the input, represented as 0 or 1 (int) * * @returns @@ -92,7 +105,6 @@ public: * @param pull PullUp, PullDown, PullNone, OpenDrain */ void mode(PinMode pull); - /** Return the output setting, represented as 0 or 1 (int) * * @returns 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/DigitalOut.h b/drivers/include/drivers/DigitalOut.h index dd910cc4c8..4b9ba18550 100644 --- a/drivers/include/drivers/DigitalOut.h +++ b/drivers/include/drivers/DigitalOut.h @@ -18,6 +18,8 @@ #define MBED_DIGITALOUT_H #include "platform/platform.h" + +#include "interfaces/InterfaceDigitalOut.h" #include "hal/gpio_api.h" namespace mbed { @@ -46,7 +48,11 @@ namespace mbed { * } * @endcode */ -class DigitalOut { +class DigitalOut +#ifdef FEATURE_EXPERIMENTAL_API + final : public interface::DigitalOut +#endif +{ public: /** Create a DigitalOut connected to the specified pin diff --git a/drivers/include/drivers/interfaces/InterfaceDigitalIn.h b/drivers/include/drivers/interfaces/InterfaceDigitalIn.h new file mode 100644 index 0000000000..a8eda9e72f --- /dev/null +++ b/drivers/include/drivers/interfaces/InterfaceDigitalIn.h @@ -0,0 +1,55 @@ +/* + * 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_DIGITALIN_H_ +#define MBED_INTERFACE_DIGITALIN_H_ + + +namespace mbed { + +class DigitalIn; + +namespace interface { + +#ifdef FEATURE_EXPERIMENTAL_API + +// TODO - move method doxygen comments to interface once this polymorphism is mainstream + +// Pure interface definition for DigitalIn +struct DigitalIn { + virtual ~DigitalIn() = default; + virtual int read() = 0; + virtual void mode(PinMode pull) = 0; + virtual int is_connected() = 0; + + operator int() + { + // Underlying implementation is responsible for thread-safety + return read(); + } + +}; +#else +using DigitalIn = ::mbed::DigitalIn; +#endif /* FEATURE_EXPERIMENTAL_API */ + +} // namespace interface +} // namespace mbed + +#endif /* MBED_INTERFACE_DIGITALIN_H_ */ diff --git a/drivers/include/drivers/interfaces/InterfaceDigitalInOut.h b/drivers/include/drivers/interfaces/InterfaceDigitalInOut.h new file mode 100644 index 0000000000..45003cd288 --- /dev/null +++ b/drivers/include/drivers/interfaces/InterfaceDigitalInOut.h @@ -0,0 +1,73 @@ +/* + * 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; + + DigitalInOut &operator= (int value) + { + // Underlying implementation is responsible for thread-safety + write(value); + return *this; + } + + DigitalInOut &operator= (DigitalInOut &rhs) + { + // Underlying implementation is responsible for thread-safety + write(rhs.read()); + return *this; + } + + 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_ */ diff --git a/drivers/include/drivers/interfaces/InterfaceDigitalOut.h b/drivers/include/drivers/interfaces/InterfaceDigitalOut.h new file mode 100644 index 0000000000..321e33e5af --- /dev/null +++ b/drivers/include/drivers/interfaces/InterfaceDigitalOut.h @@ -0,0 +1,71 @@ +/* + * 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_DIGITALOUT_H_ +#define MBED_INTERFACE_DIGITALOUT_H_ + +#include "PinNames.h" + +namespace mbed { + +class DigitalOut; + +namespace interface { + +#ifdef FEATURE_EXPERIMENTAL_API + +// TODO - move method doxygen comments to interface once this polymorphism is mainstream + +// Pure interface definition for DigitalOut +struct DigitalOut { + virtual ~DigitalOut() = default; + virtual void write(int value) = 0; + virtual int read() = 0; + virtual int is_connected() = 0; + + DigitalOut &operator= (int value) + { + // Underlying implementation is responsible for thread-safety + write(value); + return *this; + } + + DigitalOut &operator= (DigitalOut &rhs) + { + // Underlying implementation is responsible for thread-safety + write(rhs.read()); + return *this; + } + + operator int() + { + // Underlying implementation is responsible for thread-safety + return read(); + } + +}; +#else +using DigitalOut = ::mbed::DigitalOut; +#endif /* FEATURE_EXPERIMENTAL_API */ + +} // namespace interface +} // namespace mbed + + +#endif /* MBED_INTERFACE_DIGITALOUT_H_ */