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