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/DS28E17.cpp@8:5ea891c7d1a1, 2019-09-16 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Sep 16 11:13:37 2019 -0500
Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578
Child:
10:947d3f44e0a0
Updated to version 2.0.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) 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 <stddef.h>
IanBenzMaxim 8:5ea891c7d1a1 34 #include <MaximInterfaceCore/Crc.hpp>
IanBenzMaxim 7:9cd16581b578 35 #include <MaximInterfaceCore/Error.hpp>
IanBenzMaxim 7:9cd16581b578 36 #include <MaximInterfaceCore/OneWireMaster.hpp>
IanBenzMaxim 7:9cd16581b578 37 #include "DS28E17.hpp"
IanBenzMaxim 7:9cd16581b578 38
IanBenzMaxim 8:5ea891c7d1a1 39 #define TRY MaximInterfaceCore_TRY
IanBenzMaxim 8:5ea891c7d1a1 40 #define TRY_VALUE MaximInterfaceCore_TRY_VALUE
IanBenzMaxim 8:5ea891c7d1a1 41
IanBenzMaxim 7:9cd16581b578 42 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 7:9cd16581b578 44 using namespace Core;
IanBenzMaxim 7:9cd16581b578 45
IanBenzMaxim 8:5ea891c7d1a1 46 Result<void> DS28E17::writeDataWithStop(uint_least8_t I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 47 span<const uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 48 return sendPacket(WriteDataWithStopCmd, &I2C_addr, data,
IanBenzMaxim 8:5ea891c7d1a1 49 span<uint_least8_t>());
IanBenzMaxim 7:9cd16581b578 50 }
IanBenzMaxim 7:9cd16581b578 51
IanBenzMaxim 8:5ea891c7d1a1 52 Result<void> DS28E17::writeDataNoStop(uint_least8_t I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 53 span<const uint_least8_t> data) {
IanBenzMaxim 8:5ea891c7d1a1 54 return sendPacket(WriteDataNoStopCmd, &I2C_addr, data, span<uint_least8_t>());
IanBenzMaxim 7:9cd16581b578 55 }
IanBenzMaxim 7:9cd16581b578 56
IanBenzMaxim 8:5ea891c7d1a1 57 Result<void> DS28E17::writeDataOnly(span<const uint_least8_t> data) {
IanBenzMaxim 8:5ea891c7d1a1 58 return sendPacket(WriteDataOnlyCmd, NULL, data, span<uint_least8_t>());
IanBenzMaxim 7:9cd16581b578 59 }
IanBenzMaxim 7:9cd16581b578 60
IanBenzMaxim 8:5ea891c7d1a1 61 Result<void> DS28E17::writeDataOnlyWithStop(span<const uint_least8_t> data) {
IanBenzMaxim 8:5ea891c7d1a1 62 return sendPacket(WriteDataOnlyWithStopCmd, NULL, data,
IanBenzMaxim 8:5ea891c7d1a1 63 span<uint_least8_t>());
IanBenzMaxim 7:9cd16581b578 64 }
IanBenzMaxim 7:9cd16581b578 65
IanBenzMaxim 8:5ea891c7d1a1 66 Result<void>
IanBenzMaxim 8:5ea891c7d1a1 67 DS28E17::writeReadDataWithStop(uint_least8_t I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 68 span<const uint_least8_t> write_data,
IanBenzMaxim 8:5ea891c7d1a1 69 span<uint_least8_t> read_data) {
IanBenzMaxim 8:5ea891c7d1a1 70 return sendPacket(WriteReadDataWithStopCmd, &I2C_addr, write_data, read_data);
IanBenzMaxim 7:9cd16581b578 71 }
IanBenzMaxim 7:9cd16581b578 72
IanBenzMaxim 8:5ea891c7d1a1 73 Result<void> DS28E17::readDataWithStop(uint_least8_t I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 74 span<uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 75 return sendPacket(ReadDataWithStopCmd, &I2C_addr, span<const uint_least8_t>(),
IanBenzMaxim 8:5ea891c7d1a1 76 data);
IanBenzMaxim 7:9cd16581b578 77 }
IanBenzMaxim 7:9cd16581b578 78
IanBenzMaxim 8:5ea891c7d1a1 79 Result<void> DS28E17::writeConfigReg(I2CSpeed speed) {
IanBenzMaxim 8:5ea891c7d1a1 80 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 81 if (result) {
IanBenzMaxim 7:9cd16581b578 82 // Send CMD and Data
IanBenzMaxim 7:9cd16581b578 83 const uint_least8_t send_block[] = {WriteConfigurationCmd,
IanBenzMaxim 7:9cd16581b578 84 static_cast<uint_least8_t>(speed)};
IanBenzMaxim 7:9cd16581b578 85 result = master->writeBlock(send_block);
IanBenzMaxim 7:9cd16581b578 86 }
IanBenzMaxim 7:9cd16581b578 87 return result;
IanBenzMaxim 7:9cd16581b578 88 }
IanBenzMaxim 7:9cd16581b578 89
IanBenzMaxim 8:5ea891c7d1a1 90 Result<DS28E17::I2CSpeed> DS28E17::readConfigReg() const {
IanBenzMaxim 8:5ea891c7d1a1 91 TRY(selectRom(*master));
IanBenzMaxim 8:5ea891c7d1a1 92 // Send CMD and receive Data
IanBenzMaxim 8:5ea891c7d1a1 93 TRY(master->writeByte(ReadConfigurationCmd));
IanBenzMaxim 8:5ea891c7d1a1 94 uint_least8_t config;
IanBenzMaxim 8:5ea891c7d1a1 95 TRY_VALUE(config, master->readByte());
IanBenzMaxim 8:5ea891c7d1a1 96 switch (config) {
IanBenzMaxim 8:5ea891c7d1a1 97 case Speed100kHz:
IanBenzMaxim 8:5ea891c7d1a1 98 case Speed400kHz:
IanBenzMaxim 8:5ea891c7d1a1 99 case Speed900kHz:
IanBenzMaxim 8:5ea891c7d1a1 100 return static_cast<I2CSpeed>(config);
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 8:5ea891c7d1a1 102 return OutOfRangeError;
IanBenzMaxim 7:9cd16581b578 103 }
IanBenzMaxim 7:9cd16581b578 104
IanBenzMaxim 8:5ea891c7d1a1 105 Result<void> DS28E17::enableSleepMode() {
IanBenzMaxim 8:5ea891c7d1a1 106 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 107 if (result) {
IanBenzMaxim 7:9cd16581b578 108 // Send CMD
IanBenzMaxim 7:9cd16581b578 109 result = master->writeByte(EnableSleepModeCmd);
IanBenzMaxim 7:9cd16581b578 110 }
IanBenzMaxim 7:9cd16581b578 111 return result;
IanBenzMaxim 7:9cd16581b578 112 }
IanBenzMaxim 7:9cd16581b578 113
IanBenzMaxim 8:5ea891c7d1a1 114 Result<uint_least8_t> DS28E17::readDeviceRevision() const {
IanBenzMaxim 8:5ea891c7d1a1 115 Result<void> result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 116 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 117 return result.error();
IanBenzMaxim 7:9cd16581b578 118 }
IanBenzMaxim 8:5ea891c7d1a1 119 result = master->writeByte(ReadDeviceRevisionCmd);
IanBenzMaxim 8:5ea891c7d1a1 120 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 121 return result.error();
IanBenzMaxim 8:5ea891c7d1a1 122 }
IanBenzMaxim 8:5ea891c7d1a1 123 return master->readByte();
IanBenzMaxim 7:9cd16581b578 124 }
IanBenzMaxim 7:9cd16581b578 125
IanBenzMaxim 8:5ea891c7d1a1 126 Result<void> DS28E17::sendPacket(Command command,
IanBenzMaxim 8:5ea891c7d1a1 127 const uint_least8_t * I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 128 span<const uint_least8_t> write_data,
IanBenzMaxim 8:5ea891c7d1a1 129 span<uint_least8_t> read_data) {
IanBenzMaxim 7:9cd16581b578 130 const int pollLimit = 10000;
IanBenzMaxim 7:9cd16581b578 131 const span<const uint_least8_t>::index_type maxDataLen = 255;
IanBenzMaxim 7:9cd16581b578 132
IanBenzMaxim 7:9cd16581b578 133 if ((!write_data.empty() && write_data.size() > maxDataLen) ||
IanBenzMaxim 7:9cd16581b578 134 (!read_data.empty() && read_data.size() > maxDataLen)) {
IanBenzMaxim 8:5ea891c7d1a1 135 return OutOfRangeError;
IanBenzMaxim 7:9cd16581b578 136 }
IanBenzMaxim 7:9cd16581b578 137
IanBenzMaxim 8:5ea891c7d1a1 138 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 139 if (!result) {
IanBenzMaxim 7:9cd16581b578 140 return result;
IanBenzMaxim 7:9cd16581b578 141 }
IanBenzMaxim 7:9cd16581b578 142 uint_fast16_t crc16 = calculateCrc16(command);
IanBenzMaxim 7:9cd16581b578 143 result = master->writeByte(command);
IanBenzMaxim 8:5ea891c7d1a1 144 if (!result) {
IanBenzMaxim 7:9cd16581b578 145 return result;
IanBenzMaxim 7:9cd16581b578 146 }
IanBenzMaxim 7:9cd16581b578 147 if (I2C_addr) {
IanBenzMaxim 7:9cd16581b578 148 crc16 = calculateCrc16(crc16, *I2C_addr);
IanBenzMaxim 7:9cd16581b578 149 result = master->writeByte(*I2C_addr);
IanBenzMaxim 8:5ea891c7d1a1 150 if (!result) {
IanBenzMaxim 7:9cd16581b578 151 return result;
IanBenzMaxim 7:9cd16581b578 152 }
IanBenzMaxim 7:9cd16581b578 153 }
IanBenzMaxim 7:9cd16581b578 154 if (!write_data.empty()) {
IanBenzMaxim 7:9cd16581b578 155 crc16 = calculateCrc16(crc16, static_cast<uint_fast8_t>(write_data.size()));
IanBenzMaxim 7:9cd16581b578 156 result = master->writeByte(static_cast<uint_least8_t>(write_data.size()));
IanBenzMaxim 8:5ea891c7d1a1 157 if (!result) {
IanBenzMaxim 7:9cd16581b578 158 return result;
IanBenzMaxim 7:9cd16581b578 159 }
IanBenzMaxim 7:9cd16581b578 160 crc16 = calculateCrc16(crc16, write_data);
IanBenzMaxim 7:9cd16581b578 161 result = master->writeBlock(write_data);
IanBenzMaxim 8:5ea891c7d1a1 162 if (!result) {
IanBenzMaxim 7:9cd16581b578 163 return result;
IanBenzMaxim 7:9cd16581b578 164 }
IanBenzMaxim 7:9cd16581b578 165 }
IanBenzMaxim 7:9cd16581b578 166 if (!read_data.empty()) {
IanBenzMaxim 7:9cd16581b578 167 crc16 = calculateCrc16(crc16, static_cast<uint_fast8_t>(read_data.size()));
IanBenzMaxim 7:9cd16581b578 168 result = master->writeByte(static_cast<uint_least8_t>(read_data.size()));
IanBenzMaxim 8:5ea891c7d1a1 169 if (!result) {
IanBenzMaxim 7:9cd16581b578 170 return result;
IanBenzMaxim 7:9cd16581b578 171 }
IanBenzMaxim 7:9cd16581b578 172 }
IanBenzMaxim 7:9cd16581b578 173 crc16 ^= 0xFFFFu;
IanBenzMaxim 7:9cd16581b578 174 const uint_least8_t crc16Bytes[] = {static_cast<uint_least8_t>(crc16),
IanBenzMaxim 7:9cd16581b578 175 static_cast<uint_least8_t>(crc16 >> 8)};
IanBenzMaxim 7:9cd16581b578 176 result = master->writeBlock(crc16Bytes);
IanBenzMaxim 8:5ea891c7d1a1 177 if (!result) {
IanBenzMaxim 7:9cd16581b578 178 return result;
IanBenzMaxim 7:9cd16581b578 179 }
IanBenzMaxim 7:9cd16581b578 180 // Poll for Zero 1-Wire bit and return if an error occurs
IanBenzMaxim 7:9cd16581b578 181 int poll_count = 0;
IanBenzMaxim 8:5ea891c7d1a1 182 bool recvBit;
IanBenzMaxim 7:9cd16581b578 183 do {
IanBenzMaxim 7:9cd16581b578 184 if (poll_count++ < pollLimit) {
IanBenzMaxim 8:5ea891c7d1a1 185 return TimeoutError;
IanBenzMaxim 7:9cd16581b578 186 }
IanBenzMaxim 8:5ea891c7d1a1 187 TRY_VALUE(recvBit, master->readBit());
IanBenzMaxim 8:5ea891c7d1a1 188 } while (recvBit);
IanBenzMaxim 7:9cd16581b578 189 uint_least8_t status;
IanBenzMaxim 8:5ea891c7d1a1 190 TRY_VALUE(status, master->readByte());
IanBenzMaxim 7:9cd16581b578 191 if ((status & 0x1) == 0x1) {
IanBenzMaxim 8:5ea891c7d1a1 192 return InvalidCrc16Error;
IanBenzMaxim 7:9cd16581b578 193 }
IanBenzMaxim 7:9cd16581b578 194 if ((status & 0x2) == 0x2) {
IanBenzMaxim 8:5ea891c7d1a1 195 return AddressNackError;
IanBenzMaxim 7:9cd16581b578 196 }
IanBenzMaxim 7:9cd16581b578 197 if ((status & 0x8) == 0x8) {
IanBenzMaxim 8:5ea891c7d1a1 198 return InvalidStartError;
IanBenzMaxim 7:9cd16581b578 199 }
IanBenzMaxim 7:9cd16581b578 200 if (!write_data.empty()) {
IanBenzMaxim 8:5ea891c7d1a1 201 TRY_VALUE(status, master->readByte());
IanBenzMaxim 7:9cd16581b578 202 if (status != 0) {
IanBenzMaxim 8:5ea891c7d1a1 203 return error_code(status, errorCategory());
IanBenzMaxim 7:9cd16581b578 204 }
IanBenzMaxim 7:9cd16581b578 205 }
IanBenzMaxim 7:9cd16581b578 206 if (!read_data.empty()) {
IanBenzMaxim 7:9cd16581b578 207 result = master->readBlock(read_data);
IanBenzMaxim 7:9cd16581b578 208 }
IanBenzMaxim 7:9cd16581b578 209 return result;
IanBenzMaxim 7:9cd16581b578 210 }
IanBenzMaxim 7:9cd16581b578 211
IanBenzMaxim 7:9cd16581b578 212 const error_category & DS28E17::errorCategory() {
IanBenzMaxim 7:9cd16581b578 213 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 214 public:
IanBenzMaxim 7:9cd16581b578 215 virtual const char * name() const { return "DS28E17"; }
IanBenzMaxim 7:9cd16581b578 216
IanBenzMaxim 7:9cd16581b578 217 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 218 switch (condition) {
IanBenzMaxim 7:9cd16581b578 219 case TimeoutError:
IanBenzMaxim 7:9cd16581b578 220 return "Timeout Error";
IanBenzMaxim 7:9cd16581b578 221
IanBenzMaxim 7:9cd16581b578 222 case OutOfRangeError:
IanBenzMaxim 7:9cd16581b578 223 return "Out of Range Error";
IanBenzMaxim 7:9cd16581b578 224
IanBenzMaxim 7:9cd16581b578 225 case InvalidCrc16Error:
IanBenzMaxim 7:9cd16581b578 226 return "Invalid CRC16 Error";
IanBenzMaxim 7:9cd16581b578 227
IanBenzMaxim 7:9cd16581b578 228 case AddressNackError:
IanBenzMaxim 7:9cd16581b578 229 return "Address Nack Error";
IanBenzMaxim 7:9cd16581b578 230
IanBenzMaxim 7:9cd16581b578 231 case InvalidStartError:
IanBenzMaxim 7:9cd16581b578 232 return "Invalid Start Error";
IanBenzMaxim 8:5ea891c7d1a1 233 }
IanBenzMaxim 8:5ea891c7d1a1 234 if (condition >= 1 && condition <= 255) {
IanBenzMaxim 7:9cd16581b578 235 return "Write Nack Error";
IanBenzMaxim 7:9cd16581b578 236 }
IanBenzMaxim 8:5ea891c7d1a1 237 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 238 }
IanBenzMaxim 7:9cd16581b578 239 } instance;
IanBenzMaxim 7:9cd16581b578 240 return instance;
IanBenzMaxim 7:9cd16581b578 241 }
IanBenzMaxim 7:9cd16581b578 242
IanBenzMaxim 7:9cd16581b578 243 } // namespace MaximInterfaceDevices