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/MaximInterfaceDevices/DS9481P_300.hpp	Mon Jul 22 11:44:07 2019 -0500
@@ -0,0 +1,179 @@
+/*******************************************************************************
+* Copyright (C) 2017 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 MaximInterfaceDevices_DS9481P_300
+#define MaximInterfaceDevices_DS9481P_300
+
+#include <MaximInterfaceCore/I2CMasterDecorator.hpp>
+#include <MaximInterfaceCore/OneWireMasterDecorator.hpp>
+#include <MaximInterfaceCore/SerialPort.hpp>
+#include <MaximInterfaceCore/Sleep.hpp>
+#include "DS2480B.hpp"
+#include "DS9400.hpp"
+#include "Config.hpp"
+
+namespace MaximInterfaceDevices {
+
+/// DS9481P-300 USB to 1-Wire and I2C adapter.
+class DS9481P_300 {
+public:
+  MaximInterfaceDevices_EXPORT DS9481P_300(Core::Sleep & sleep,
+                                           Core::SerialPort & serialPort);
+
+  void setSleep(Core::Sleep & sleep) { ds2480b.setSleep(sleep); }
+
+  void setSerialPort(Core::SerialPort & serialPort) {
+    this->serialPort = &serialPort;
+    ds2480b.setUart(serialPort);
+    ds9400.setUart(serialPort);
+  }
+
+  MaximInterfaceDevices_EXPORT Core::error_code
+  connect(const std::string & portName);
+
+  MaximInterfaceDevices_EXPORT Core::error_code disconnect();
+
+  MaximInterfaceDevices_EXPORT bool connected() const;
+
+  MaximInterfaceDevices_EXPORT std::string portName() const;
+
+  /// Access the 1-Wire master when connected to an adapter.
+  Core::OneWireMaster & oneWireMaster() { return oneWireMaster_; }
+
+  /// Access the I2C master when connected to an adapter.
+  Core::I2CMaster & i2cMaster() { return i2cMaster_; }
+
+private:
+  class OneWireMaster : public Core::OneWireMasterDecorator {
+  public:
+    explicit OneWireMaster(DS9481P_300 & parent)
+        : OneWireMasterDecorator(parent.ds2480b), parent(&parent) {}
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code reset();
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    touchBitSetLevel(bool & sendRecvBit, Level afterLevel);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    writeBlock(Core::span<const uint_least8_t> sendBuf);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    readBlock(Core::span<uint_least8_t> recvBuf);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    setSpeed(Speed newSpeed);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    setLevel(Level newLevel);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    triplet(TripletData & data);
+
+  private:
+    DS9481P_300 * parent;
+  };
+
+  class I2CMaster : public Core::I2CMasterDecorator {
+  public:
+    explicit I2CMaster(DS9481P_300 & parent)
+        : I2CMasterDecorator(parent.ds9400), parent(&parent) {}
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    start(uint_least8_t address);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code stop();
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    writeByte(uint_least8_t data);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    writeBlock(Core::span<const uint_least8_t> data);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    readByte(AckStatus status, uint_least8_t & data);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    readBlock(AckStatus status, Core::span<uint_least8_t> data);
+
+  protected:
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    doWritePacket(uint_least8_t address, Core::span<const uint_least8_t> data,
+                  bool sendStop);
+
+    MaximInterfaceDevices_EXPORT virtual Core::error_code
+    doReadPacket(uint_least8_t address, Core::span<uint_least8_t> data,
+                 bool sendStop);
+
+  private:
+    DS9481P_300 * parent;
+  };
+
+  class DS2480BWithEscape : public DS2480B {
+  public:
+    DS2480BWithEscape(Core::Sleep & sleep, Core::Uart & uart)
+        : DS2480B(sleep, uart) {}
+
+    Core::error_code escape();
+  };
+
+  class DS9400WithEscape : public DS9400 {
+  public:
+    explicit DS9400WithEscape(Core::Uart & uart) : DS9400(uart) {}
+
+    Core::error_code escape();
+  };
+
+  enum Bus { OneWire, I2C };
+
+  Core::SerialPort * serialPort;
+  Bus currentBus;
+  DS2480BWithEscape ds2480b;
+  OneWireMaster oneWireMaster_;
+  DS9400WithEscape ds9400;
+  I2CMaster i2cMaster_;
+
+  Core::error_code selectOneWire();
+  Core::error_code selectBus(Bus newBus);
+
+  friend class OneWireMaster;
+  friend class I2CMaster;
+};
+
+} // namespace MaximInterfaceDevices
+
+#endif