Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS28E17.cpp@6:a8c83a2e6fa4, 2019-01-23 (annotated)

Committer:
IanBenzMaxim
Date:
Wed Jan 23 13:11:04 2019 -0600
Revision:
6:a8c83a2e6fa4
Parent:
0:f77ad7f72d04 
Updated to version 1.6 and removed platform files that are incompatible with mbed.

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