Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MaximInterfaceCore/RunCommand.hpp	Mon Jul 22 11:44:07 2019 -0500
@@ -0,0 +1,120 @@
+/*******************************************************************************
+* Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************/
+
+#ifndef MaximInterfaceCore_RunCommand
+#define MaximInterfaceCore_RunCommand
+
+#include "Config.hpp"
+#include "Function.hpp"
+#include "SelectRom.hpp"
+#include "span.hpp"
+#include "system_error.hpp"
+
+namespace MaximInterfaceCore {
+
+class I2CMaster;
+class OneWireMaster;
+class Sleep;
+
+typedef Function<error_code(span<const uint_least8_t>, int,
+                            span<uint_least8_t> &)>
+    RunCommand;
+
+class RunCommandWithOneWireMaster {
+public:
+  typedef RunCommand::result_type result_type;
+
+  enum ErrorValue { CrcError = 1, InvalidResponseError };
+  MaximInterfaceCore_EXPORT static const error_category & errorCategory();
+
+  RunCommandWithOneWireMaster(Sleep & sleep, OneWireMaster & master,
+                              const SelectRom & selectRom)
+      : selectRom(selectRom), master(&master), sleep(&sleep) {}
+
+  void setSleep(Sleep & sleep) { this->sleep = &sleep; }
+
+  void setMaster(OneWireMaster & master) { this->master = &master; }
+
+  void setSelectRom(const SelectRom & selectRom) {
+    this->selectRom = selectRom;
+  }
+
+  MaximInterfaceCore_EXPORT error_code
+  operator()(span<const uint_least8_t> request, int delayTime,
+             span<uint_least8_t> & response) const;
+
+private:
+  SelectRom selectRom;
+  OneWireMaster * master;
+  const Sleep * sleep;
+};
+
+inline error_code make_error_code(RunCommandWithOneWireMaster::ErrorValue e) {
+  return error_code(e, RunCommandWithOneWireMaster::errorCategory());
+}
+
+class RunCommandWithI2CMaster {
+public:
+  typedef RunCommand::result_type result_type;
+
+  enum ErrorValue { InvalidResponseError = 1 };
+  MaximInterfaceCore_EXPORT static const error_category & errorCategory();
+
+  RunCommandWithI2CMaster(Sleep & sleep, I2CMaster & master,
+                          uint_least8_t address)
+      : sleep(&sleep), master(&master), address_(address & 0xFE) {}
+
+  void setSleep(Sleep & sleep) { this->sleep = &sleep; }
+
+  void setMaster(I2CMaster & master) { this->master = &master; }
+
+  uint_least8_t address() const { return address_; }
+
+  void setAddress(uint_least8_t address) { address_ = address & 0xFE; }
+
+  MaximInterfaceCore_EXPORT error_code
+  operator()(span<const uint_least8_t> request, int delayTime,
+             span<uint_least8_t> & response) const;
+
+private:
+  const Sleep * sleep;
+  I2CMaster * master;
+  uint_least8_t address_;
+};
+
+inline error_code make_error_code(RunCommandWithI2CMaster::ErrorValue e) {
+  return error_code(e, RunCommandWithI2CMaster::errorCategory());
+}
+
+} // namespace MaximInterfaceCore
+
+#endif