Maxim Integrated / MaximInterface

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Platforms/dotnet/DS9481P_300.hpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:f77ad7f72d04 1 /*******************************************************************************
IanBenzMaxim 0:f77ad7f72d04 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:f77ad7f72d04 3 *
IanBenzMaxim 0:f77ad7f72d04 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:f77ad7f72d04 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:f77ad7f72d04 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:f77ad7f72d04 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:f77ad7f72d04 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:f77ad7f72d04 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:f77ad7f72d04 10 *
IanBenzMaxim 0:f77ad7f72d04 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:f77ad7f72d04 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:f77ad7f72d04 13 *
IanBenzMaxim 0:f77ad7f72d04 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:f77ad7f72d04 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:f77ad7f72d04 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:f77ad7f72d04 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:f77ad7f72d04 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:f77ad7f72d04 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:f77ad7f72d04 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:f77ad7f72d04 21 *
IanBenzMaxim 0:f77ad7f72d04 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:f77ad7f72d04 25 *
IanBenzMaxim 0:f77ad7f72d04 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:f77ad7f72d04 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:f77ad7f72d04 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:f77ad7f72d04 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:f77ad7f72d04 30 * ownership rights.
IanBenzMaxim 0:f77ad7f72d04 31 *******************************************************************************/
IanBenzMaxim 0:f77ad7f72d04 32
IanBenzMaxim 0:f77ad7f72d04 33 #pragma once
IanBenzMaxim 0:f77ad7f72d04 34
IanBenzMaxim 0:f77ad7f72d04 35 #include <string>
IanBenzMaxim 0:f77ad7f72d04 36 #include <MaximInterface/Devices/DS9400.hpp>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/I2CMasterDecorator.hpp>
IanBenzMaxim 0:f77ad7f72d04 38 #include <MaximInterface/Links/OneWireMasterDecorator.hpp>
IanBenzMaxim 0:f77ad7f72d04 39 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 0:f77ad7f72d04 40 #include "MoveOnly.hpp"
IanBenzMaxim 0:f77ad7f72d04 41 #include "OneWireLinkLayerMaster.hpp"
IanBenzMaxim 0:f77ad7f72d04 42 #include "Uart.hpp"
IanBenzMaxim 0:f77ad7f72d04 43
IanBenzMaxim 0:f77ad7f72d04 44 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 45
IanBenzMaxim 0:f77ad7f72d04 46 /// DS9481P-300 USB to 1-Wire and I2C adapter.
IanBenzMaxim 0:f77ad7f72d04 47 class DS9481P_300 : private MoveOnly {
IanBenzMaxim 0:f77ad7f72d04 48 public:
IanBenzMaxim 0:f77ad7f72d04 49 enum ErrorValue { ConnectionStateError = 1 };
IanBenzMaxim 0:f77ad7f72d04 50
IanBenzMaxim 0:f77ad7f72d04 51 MaximInterface_EXPORT DS9481P_300();
IanBenzMaxim 0:f77ad7f72d04 52 MaximInterface_EXPORT ~DS9481P_300();
IanBenzMaxim 0:f77ad7f72d04 53
IanBenzMaxim 0:f77ad7f72d04 54 DS9481P_300(DS9481P_300 &&) = default;
IanBenzMaxim 0:f77ad7f72d04 55 DS9481P_300 & operator=(DS9481P_300 &&) = default;
IanBenzMaxim 0:f77ad7f72d04 56
IanBenzMaxim 0:f77ad7f72d04 57 /// Access the 1-Wire master when connected to an adapter.
IanBenzMaxim 0:f77ad7f72d04 58 OneWireMaster & oneWireMaster() { return oneWireMaster_; }
IanBenzMaxim 0:f77ad7f72d04 59
IanBenzMaxim 0:f77ad7f72d04 60 /// Access the I2C master when connected to an adapter.
IanBenzMaxim 0:f77ad7f72d04 61 I2CMaster & i2cMaster() { return i2cMaster_; }
IanBenzMaxim 0:f77ad7f72d04 62
IanBenzMaxim 0:f77ad7f72d04 63 /// Connect to an adapter on the specified COM port.
IanBenzMaxim 0:f77ad7f72d04 64 MaximInterface_EXPORT error_code connect(const std::string & portName);
IanBenzMaxim 0:f77ad7f72d04 65
IanBenzMaxim 0:f77ad7f72d04 66 /// Disconnect from the adapter on the current COM port.
IanBenzMaxim 0:f77ad7f72d04 67 MaximInterface_EXPORT void disconnect();
IanBenzMaxim 0:f77ad7f72d04 68
IanBenzMaxim 0:f77ad7f72d04 69 /// Check if currently connected to an adapter.
IanBenzMaxim 0:f77ad7f72d04 70 /// @returns True if connected.
IanBenzMaxim 0:f77ad7f72d04 71 bool connected() const { return currentBus != Bus::None; }
IanBenzMaxim 0:f77ad7f72d04 72
IanBenzMaxim 0:f77ad7f72d04 73 /// Get the currently connected COM port name.
IanBenzMaxim 0:f77ad7f72d04 74 MaximInterface_EXPORT std::string portName() const;
IanBenzMaxim 0:f77ad7f72d04 75
IanBenzMaxim 0:f77ad7f72d04 76 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 77
IanBenzMaxim 0:f77ad7f72d04 78 private:
IanBenzMaxim 0:f77ad7f72d04 79 class OneWireMasterImpl : public OneWireMasterDecorator {
IanBenzMaxim 0:f77ad7f72d04 80 public:
IanBenzMaxim 0:f77ad7f72d04 81 explicit OneWireMasterImpl(DS9481P_300 & parent)
IanBenzMaxim 0:f77ad7f72d04 82 : OneWireMasterDecorator(parent.linkLayerMaster), parent(&parent) {}
IanBenzMaxim 0:f77ad7f72d04 83
IanBenzMaxim 0:f77ad7f72d04 84 virtual error_code reset() override;
IanBenzMaxim 0:f77ad7f72d04 85 virtual error_code touchBitSetLevel(bool & sendRecvBit,
IanBenzMaxim 0:f77ad7f72d04 86 Level afterLevel) override;
IanBenzMaxim 0:f77ad7f72d04 87 virtual error_code writeByteSetLevel(uint_least8_t sendByte,
IanBenzMaxim 0:f77ad7f72d04 88 Level afterLevel) override;
IanBenzMaxim 0:f77ad7f72d04 89 virtual error_code readByteSetLevel(uint_least8_t & recvByte,
IanBenzMaxim 0:f77ad7f72d04 90 Level afterLevel) override;
IanBenzMaxim 0:f77ad7f72d04 91 virtual error_code writeBlock(const uint_least8_t * sendBuf,
IanBenzMaxim 0:f77ad7f72d04 92 size_t sendLen) override;
IanBenzMaxim 0:f77ad7f72d04 93 virtual error_code readBlock(uint_least8_t * recvBuf,
IanBenzMaxim 0:f77ad7f72d04 94 size_t recvLen) override;
IanBenzMaxim 0:f77ad7f72d04 95 virtual error_code setSpeed(Speed newSpeed) override;
IanBenzMaxim 0:f77ad7f72d04 96 virtual error_code setLevel(Level newLevel) override;
IanBenzMaxim 0:f77ad7f72d04 97 virtual error_code triplet(TripletData & data) override;
IanBenzMaxim 0:f77ad7f72d04 98
IanBenzMaxim 0:f77ad7f72d04 99 private:
IanBenzMaxim 0:f77ad7f72d04 100 DS9481P_300 * parent;
IanBenzMaxim 0:f77ad7f72d04 101
IanBenzMaxim 0:f77ad7f72d04 102 template <typename Func> error_code selectAndExecute(Func operation);
IanBenzMaxim 0:f77ad7f72d04 103 };
IanBenzMaxim 0:f77ad7f72d04 104
IanBenzMaxim 0:f77ad7f72d04 105 class I2CMasterImpl : public I2CMasterDecorator {
IanBenzMaxim 0:f77ad7f72d04 106 public:
IanBenzMaxim 0:f77ad7f72d04 107 explicit I2CMasterImpl(DS9481P_300 & parent) noexcept
IanBenzMaxim 0:f77ad7f72d04 108 : I2CMasterDecorator(parent.ds9400), parent(&parent) {}
IanBenzMaxim 0:f77ad7f72d04 109
IanBenzMaxim 0:f77ad7f72d04 110 virtual error_code start(uint_least8_t address) override;
IanBenzMaxim 0:f77ad7f72d04 111 virtual error_code stop() override;
IanBenzMaxim 0:f77ad7f72d04 112 virtual error_code writeByte(uint_least8_t data) override;
IanBenzMaxim 0:f77ad7f72d04 113 virtual error_code writeBlock(const uint_least8_t * data,
IanBenzMaxim 0:f77ad7f72d04 114 size_t dataLen) override;
IanBenzMaxim 0:f77ad7f72d04 115 virtual error_code writePacket(uint_least8_t address,
IanBenzMaxim 0:f77ad7f72d04 116 const uint_least8_t * data, size_t dataLen,
IanBenzMaxim 0:f77ad7f72d04 117 bool sendStop) override;
IanBenzMaxim 0:f77ad7f72d04 118 virtual error_code readByte(AckStatus status,
IanBenzMaxim 0:f77ad7f72d04 119 uint_least8_t & data) override;
IanBenzMaxim 0:f77ad7f72d04 120 virtual error_code readBlock(AckStatus status, uint_least8_t * data,
IanBenzMaxim 0:f77ad7f72d04 121 size_t dataLen) override;
IanBenzMaxim 0:f77ad7f72d04 122 virtual error_code readPacket(uint_least8_t address, uint_least8_t * data,
IanBenzMaxim 0:f77ad7f72d04 123 size_t dataLen, bool sendStop) override;
IanBenzMaxim 0:f77ad7f72d04 124
IanBenzMaxim 0:f77ad7f72d04 125 private:
IanBenzMaxim 0:f77ad7f72d04 126 DS9481P_300 * parent;
IanBenzMaxim 0:f77ad7f72d04 127
IanBenzMaxim 0:f77ad7f72d04 128 template <typename Func> error_code selectAndExecute(Func operation);
IanBenzMaxim 0:f77ad7f72d04 129 };
IanBenzMaxim 0:f77ad7f72d04 130
IanBenzMaxim 0:f77ad7f72d04 131 enum class Bus { None, OneWire, I2C };
IanBenzMaxim 0:f77ad7f72d04 132
IanBenzMaxim 0:f77ad7f72d04 133 Bus currentBus;
IanBenzMaxim 0:f77ad7f72d04 134 OneWireLinkLayerMaster linkLayerMaster;
IanBenzMaxim 0:f77ad7f72d04 135 OneWireMasterImpl oneWireMaster_;
IanBenzMaxim 0:f77ad7f72d04 136 dotnet::Uart serial;
IanBenzMaxim 0:f77ad7f72d04 137 DS9400 ds9400;
IanBenzMaxim 0:f77ad7f72d04 138 I2CMasterImpl i2cMaster_;
IanBenzMaxim 0:f77ad7f72d04 139
IanBenzMaxim 0:f77ad7f72d04 140 error_code selectBus(Bus newBus);
IanBenzMaxim 0:f77ad7f72d04 141 error_code selectBus(Bus newBus, const std::string & portName);
IanBenzMaxim 0:f77ad7f72d04 142 };
IanBenzMaxim 0:f77ad7f72d04 143
IanBenzMaxim 0:f77ad7f72d04 144 inline error_code make_error_code(DS9481P_300::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 145 return error_code(e, DS9481P_300::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 146 }
IanBenzMaxim 0:f77ad7f72d04 147
IanBenzMaxim 0:f77ad7f72d04 148 } // namespace MaximInterface