Aleksandrs Gumenuks / MaximInterface_Extended

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:   mbed_DS28EC20_GPIO

Devices/DS9481P_300.hpp@3:f818ea5172ed, 2018-01-11 (annotated)

Committer:
IanBenzMaxim
Date:
Thu Jan 11 13:50:39 2018 -0600
Revision:
3:f818ea5172ed
Child:
6:a8c83a2e6fa4
Updated to version 1.1.

Who changed what in which revision?

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