Maxim Integrated / MaximInterface

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

MaximInterfaceDevices/DS9481P_300.cpp@7:9cd16581b578, 2019-07-22 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Jul 22 11:44:07 2019 -0500
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
Updated to version 1.9.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 7:9cd16581b578 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 7:9cd16581b578 33 #include <MaximInterfaceCore/Error.hpp>
IanBenzMaxim 7:9cd16581b578 34 #include "DS9481P_300.hpp"
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 37
IanBenzMaxim 7:9cd16581b578 38 using namespace Core;
IanBenzMaxim 7:9cd16581b578 39
IanBenzMaxim 7:9cd16581b578 40 DS9481P_300::DS9481P_300(Sleep & sleep, SerialPort & serialPort)
IanBenzMaxim 7:9cd16581b578 41 : serialPort(&serialPort), currentBus(OneWire), ds2480b(sleep, serialPort),
IanBenzMaxim 7:9cd16581b578 42 oneWireMaster_(*this), ds9400(serialPort), i2cMaster_(*this) {}
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 7:9cd16581b578 44 error_code DS9481P_300::connect(const std::string & portName) {
IanBenzMaxim 7:9cd16581b578 45 error_code result = serialPort->connect(portName);
IanBenzMaxim 7:9cd16581b578 46 if (!result) {
IanBenzMaxim 7:9cd16581b578 47 result = selectOneWire();
IanBenzMaxim 7:9cd16581b578 48 if (result) {
IanBenzMaxim 7:9cd16581b578 49 serialPort->disconnect();
IanBenzMaxim 7:9cd16581b578 50 } else {
IanBenzMaxim 7:9cd16581b578 51 currentBus = OneWire;
IanBenzMaxim 7:9cd16581b578 52 }
IanBenzMaxim 7:9cd16581b578 53 }
IanBenzMaxim 7:9cd16581b578 54 return result;
IanBenzMaxim 7:9cd16581b578 55 }
IanBenzMaxim 7:9cd16581b578 56
IanBenzMaxim 7:9cd16581b578 57 error_code DS9481P_300::disconnect() { return serialPort->disconnect(); }
IanBenzMaxim 7:9cd16581b578 58
IanBenzMaxim 7:9cd16581b578 59 bool DS9481P_300::connected() const { return serialPort->connected(); }
IanBenzMaxim 7:9cd16581b578 60
IanBenzMaxim 7:9cd16581b578 61 std::string DS9481P_300::portName() const { return serialPort->portName(); }
IanBenzMaxim 7:9cd16581b578 62
IanBenzMaxim 7:9cd16581b578 63 error_code DS9481P_300::selectOneWire() {
IanBenzMaxim 7:9cd16581b578 64 // Escape DS9400 mode.
IanBenzMaxim 7:9cd16581b578 65 error_code result = ds9400.escape();
IanBenzMaxim 7:9cd16581b578 66 if (!result) {
IanBenzMaxim 7:9cd16581b578 67 result = ds2480b.initialize();
IanBenzMaxim 7:9cd16581b578 68 }
IanBenzMaxim 7:9cd16581b578 69 return result;
IanBenzMaxim 7:9cd16581b578 70 }
IanBenzMaxim 7:9cd16581b578 71
IanBenzMaxim 7:9cd16581b578 72 error_code DS9481P_300::selectBus(Bus newBus) {
IanBenzMaxim 7:9cd16581b578 73 error_code result;
IanBenzMaxim 7:9cd16581b578 74 if (currentBus != newBus) {
IanBenzMaxim 7:9cd16581b578 75 switch (currentBus) {
IanBenzMaxim 7:9cd16581b578 76 case OneWire: // Next bus I2C.
IanBenzMaxim 7:9cd16581b578 77 // Escape DS2480 Mode.
IanBenzMaxim 7:9cd16581b578 78 result = ds2480b.escape();
IanBenzMaxim 7:9cd16581b578 79 if (!result) {
IanBenzMaxim 7:9cd16581b578 80 // Wait for awake notification.
IanBenzMaxim 7:9cd16581b578 81 result = ds9400.waitAwake();
IanBenzMaxim 7:9cd16581b578 82 }
IanBenzMaxim 7:9cd16581b578 83 break;
IanBenzMaxim 7:9cd16581b578 84
IanBenzMaxim 7:9cd16581b578 85 case I2C: // Next bus OneWire.
IanBenzMaxim 7:9cd16581b578 86 result = selectOneWire();
IanBenzMaxim 7:9cd16581b578 87 break;
IanBenzMaxim 7:9cd16581b578 88 }
IanBenzMaxim 7:9cd16581b578 89 if (!result) {
IanBenzMaxim 7:9cd16581b578 90 currentBus = newBus;
IanBenzMaxim 7:9cd16581b578 91 }
IanBenzMaxim 7:9cd16581b578 92 }
IanBenzMaxim 7:9cd16581b578 93 return result;
IanBenzMaxim 7:9cd16581b578 94 }
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 7:9cd16581b578 96 error_code DS9481P_300::OneWireMaster::reset() {
IanBenzMaxim 7:9cd16581b578 97 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 98 if (!result) {
IanBenzMaxim 7:9cd16581b578 99 result = OneWireMasterDecorator::reset();
IanBenzMaxim 7:9cd16581b578 100 }
IanBenzMaxim 7:9cd16581b578 101 return result;
IanBenzMaxim 7:9cd16581b578 102 }
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 error_code DS9481P_300::OneWireMaster::touchBitSetLevel(bool & sendRecvBit,
IanBenzMaxim 7:9cd16581b578 105 Level afterLevel) {
IanBenzMaxim 7:9cd16581b578 106 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 107 if (!result) {
IanBenzMaxim 7:9cd16581b578 108 result = OneWireMasterDecorator::touchBitSetLevel(sendRecvBit, afterLevel);
IanBenzMaxim 7:9cd16581b578 109 }
IanBenzMaxim 7:9cd16581b578 110 return result;
IanBenzMaxim 7:9cd16581b578 111 }
IanBenzMaxim 7:9cd16581b578 112
IanBenzMaxim 7:9cd16581b578 113 error_code DS9481P_300::OneWireMaster::writeByteSetLevel(uint_least8_t sendByte,
IanBenzMaxim 7:9cd16581b578 114 Level afterLevel) {
IanBenzMaxim 7:9cd16581b578 115 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 116 if (!result) {
IanBenzMaxim 7:9cd16581b578 117 result = OneWireMasterDecorator::writeByteSetLevel(sendByte, afterLevel);
IanBenzMaxim 7:9cd16581b578 118 }
IanBenzMaxim 7:9cd16581b578 119 return result;
IanBenzMaxim 7:9cd16581b578 120 }
IanBenzMaxim 7:9cd16581b578 121
IanBenzMaxim 7:9cd16581b578 122 error_code
IanBenzMaxim 7:9cd16581b578 123 DS9481P_300::OneWireMaster::readByteSetLevel(uint_least8_t & recvByte,
IanBenzMaxim 7:9cd16581b578 124 Level afterLevel) {
IanBenzMaxim 7:9cd16581b578 125 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 126 if (!result) {
IanBenzMaxim 7:9cd16581b578 127 result = OneWireMasterDecorator::readByteSetLevel(recvByte, afterLevel);
IanBenzMaxim 7:9cd16581b578 128 }
IanBenzMaxim 7:9cd16581b578 129 return result;
IanBenzMaxim 7:9cd16581b578 130 }
IanBenzMaxim 7:9cd16581b578 131
IanBenzMaxim 7:9cd16581b578 132 error_code
IanBenzMaxim 7:9cd16581b578 133 DS9481P_300::OneWireMaster::writeBlock(span<const uint_least8_t> sendBuf) {
IanBenzMaxim 7:9cd16581b578 134 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 135 if (!result) {
IanBenzMaxim 7:9cd16581b578 136 result = OneWireMasterDecorator::writeBlock(sendBuf);
IanBenzMaxim 7:9cd16581b578 137 }
IanBenzMaxim 7:9cd16581b578 138 return result;
IanBenzMaxim 7:9cd16581b578 139 }
IanBenzMaxim 7:9cd16581b578 140
IanBenzMaxim 7:9cd16581b578 141 error_code DS9481P_300::OneWireMaster::readBlock(span<uint_least8_t> recvBuf) {
IanBenzMaxim 7:9cd16581b578 142 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 143 if (!result) {
IanBenzMaxim 7:9cd16581b578 144 result = OneWireMasterDecorator::readBlock(recvBuf);
IanBenzMaxim 7:9cd16581b578 145 }
IanBenzMaxim 7:9cd16581b578 146 return result;
IanBenzMaxim 7:9cd16581b578 147 }
IanBenzMaxim 7:9cd16581b578 148
IanBenzMaxim 7:9cd16581b578 149 error_code DS9481P_300::OneWireMaster::setSpeed(Speed newSpeed) {
IanBenzMaxim 7:9cd16581b578 150 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 151 if (!result) {
IanBenzMaxim 7:9cd16581b578 152 result = OneWireMasterDecorator::setSpeed(newSpeed);
IanBenzMaxim 7:9cd16581b578 153 }
IanBenzMaxim 7:9cd16581b578 154 return result;
IanBenzMaxim 7:9cd16581b578 155 }
IanBenzMaxim 7:9cd16581b578 156
IanBenzMaxim 7:9cd16581b578 157 error_code DS9481P_300::OneWireMaster::setLevel(Level newLevel) {
IanBenzMaxim 7:9cd16581b578 158 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 159 if (!result) {
IanBenzMaxim 7:9cd16581b578 160 result = OneWireMasterDecorator::setLevel(newLevel);
IanBenzMaxim 7:9cd16581b578 161 }
IanBenzMaxim 7:9cd16581b578 162 return result;
IanBenzMaxim 7:9cd16581b578 163 }
IanBenzMaxim 7:9cd16581b578 164
IanBenzMaxim 7:9cd16581b578 165 error_code DS9481P_300::OneWireMaster::triplet(TripletData & data) {
IanBenzMaxim 7:9cd16581b578 166 error_code result = parent->selectBus(OneWire);
IanBenzMaxim 7:9cd16581b578 167 if (!result) {
IanBenzMaxim 7:9cd16581b578 168 result = OneWireMasterDecorator::triplet(data);
IanBenzMaxim 7:9cd16581b578 169 }
IanBenzMaxim 7:9cd16581b578 170 return result;
IanBenzMaxim 7:9cd16581b578 171 }
IanBenzMaxim 7:9cd16581b578 172
IanBenzMaxim 7:9cd16581b578 173 error_code DS9481P_300::I2CMaster::start(uint_least8_t address) {
IanBenzMaxim 7:9cd16581b578 174 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 175 if (!result) {
IanBenzMaxim 7:9cd16581b578 176 result = I2CMasterDecorator::start(address);
IanBenzMaxim 7:9cd16581b578 177 }
IanBenzMaxim 7:9cd16581b578 178 return result;
IanBenzMaxim 7:9cd16581b578 179 }
IanBenzMaxim 7:9cd16581b578 180
IanBenzMaxim 7:9cd16581b578 181 error_code DS9481P_300::I2CMaster::stop() {
IanBenzMaxim 7:9cd16581b578 182 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 183 if (!result) {
IanBenzMaxim 7:9cd16581b578 184 result = I2CMasterDecorator::stop();
IanBenzMaxim 7:9cd16581b578 185 }
IanBenzMaxim 7:9cd16581b578 186 return result;
IanBenzMaxim 7:9cd16581b578 187 }
IanBenzMaxim 7:9cd16581b578 188
IanBenzMaxim 7:9cd16581b578 189 error_code DS9481P_300::I2CMaster::writeByte(uint_least8_t data) {
IanBenzMaxim 7:9cd16581b578 190 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 191 if (!result) {
IanBenzMaxim 7:9cd16581b578 192 result = I2CMasterDecorator::writeByte(data);
IanBenzMaxim 7:9cd16581b578 193 }
IanBenzMaxim 7:9cd16581b578 194 return result;
IanBenzMaxim 7:9cd16581b578 195 }
IanBenzMaxim 7:9cd16581b578 196
IanBenzMaxim 7:9cd16581b578 197 error_code DS9481P_300::I2CMaster::writeBlock(span<const uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 198 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 199 if (!result) {
IanBenzMaxim 7:9cd16581b578 200 result = I2CMasterDecorator::writeBlock(data);
IanBenzMaxim 7:9cd16581b578 201 }
IanBenzMaxim 7:9cd16581b578 202 return result;
IanBenzMaxim 7:9cd16581b578 203 }
IanBenzMaxim 7:9cd16581b578 204
IanBenzMaxim 7:9cd16581b578 205 error_code DS9481P_300::I2CMaster::doWritePacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 206 span<const uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 207 bool sendStop) {
IanBenzMaxim 7:9cd16581b578 208 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 209 if (!result) {
IanBenzMaxim 7:9cd16581b578 210 result = I2CMasterDecorator::doWritePacket(address, data, sendStop);
IanBenzMaxim 7:9cd16581b578 211 }
IanBenzMaxim 7:9cd16581b578 212 return result;
IanBenzMaxim 7:9cd16581b578 213 }
IanBenzMaxim 7:9cd16581b578 214
IanBenzMaxim 7:9cd16581b578 215 error_code DS9481P_300::I2CMaster::readByte(AckStatus status,
IanBenzMaxim 7:9cd16581b578 216 uint_least8_t & data) {
IanBenzMaxim 7:9cd16581b578 217 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 218 if (!result) {
IanBenzMaxim 7:9cd16581b578 219 result = I2CMasterDecorator::readByte(status, data);
IanBenzMaxim 7:9cd16581b578 220 }
IanBenzMaxim 7:9cd16581b578 221 return result;
IanBenzMaxim 7:9cd16581b578 222 }
IanBenzMaxim 7:9cd16581b578 223
IanBenzMaxim 7:9cd16581b578 224 error_code DS9481P_300::I2CMaster::readBlock(AckStatus status,
IanBenzMaxim 7:9cd16581b578 225 span<uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 226 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 227 if (!result) {
IanBenzMaxim 7:9cd16581b578 228 result = I2CMasterDecorator::readBlock(status, data);
IanBenzMaxim 7:9cd16581b578 229 }
IanBenzMaxim 7:9cd16581b578 230 return result;
IanBenzMaxim 7:9cd16581b578 231 }
IanBenzMaxim 7:9cd16581b578 232
IanBenzMaxim 7:9cd16581b578 233 error_code DS9481P_300::I2CMaster::doReadPacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 234 span<uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 235 bool sendStop) {
IanBenzMaxim 7:9cd16581b578 236 error_code result = parent->selectBus(I2C);
IanBenzMaxim 7:9cd16581b578 237 if (!result) {
IanBenzMaxim 7:9cd16581b578 238 result = I2CMasterDecorator::doReadPacket(address, data, sendStop);
IanBenzMaxim 7:9cd16581b578 239 }
IanBenzMaxim 7:9cd16581b578 240 return result;
IanBenzMaxim 7:9cd16581b578 241 }
IanBenzMaxim 7:9cd16581b578 242
IanBenzMaxim 7:9cd16581b578 243 error_code DS9481P_300::DS2480BWithEscape::escape() {
IanBenzMaxim 7:9cd16581b578 244 return sendCommand(0xE5);
IanBenzMaxim 7:9cd16581b578 245 }
IanBenzMaxim 7:9cd16581b578 246
IanBenzMaxim 7:9cd16581b578 247 error_code DS9481P_300::DS9400WithEscape::escape() { return configure('O'); }
IanBenzMaxim 7:9cd16581b578 248
IanBenzMaxim 7:9cd16581b578 249 } // namespace MaximInterfaceDevices