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/DS2431.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 <algorithm>
IanBenzMaxim 7:9cd16581b578 34 #include <MaximInterfaceCore/Error.hpp>
IanBenzMaxim 7:9cd16581b578 35 #include <MaximInterfaceCore/OneWireMaster.hpp>
IanBenzMaxim 7:9cd16581b578 36 #include "DS2431.hpp"
IanBenzMaxim 7:9cd16581b578 37
IanBenzMaxim 7:9cd16581b578 38 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 39
IanBenzMaxim 7:9cd16581b578 40 using namespace Core;
IanBenzMaxim 7:9cd16581b578 41
IanBenzMaxim 7:9cd16581b578 42 error_code writeMemory(DS2431 & device, DS2431::Address targetAddress,
IanBenzMaxim 7:9cd16581b578 43 DS2431::Scratchpad::const_span data) {
IanBenzMaxim 7:9cd16581b578 44 error_code result = device.writeScratchpad(targetAddress, data);
IanBenzMaxim 7:9cd16581b578 45 if (result) {
IanBenzMaxim 7:9cd16581b578 46 return result;
IanBenzMaxim 7:9cd16581b578 47 }
IanBenzMaxim 7:9cd16581b578 48 DS2431::Scratchpad::array readData;
IanBenzMaxim 7:9cd16581b578 49 uint_least8_t esByte;
IanBenzMaxim 7:9cd16581b578 50 result = device.readScratchpad(readData, esByte);
IanBenzMaxim 7:9cd16581b578 51 if (result) {
IanBenzMaxim 7:9cd16581b578 52 return result;
IanBenzMaxim 7:9cd16581b578 53 }
IanBenzMaxim 7:9cd16581b578 54 result = device.copyScratchpad(targetAddress, esByte);
IanBenzMaxim 7:9cd16581b578 55 return result;
IanBenzMaxim 7:9cd16581b578 56 }
IanBenzMaxim 7:9cd16581b578 57
IanBenzMaxim 7:9cd16581b578 58 error_code DS2431::readMemory(Address beginAddress,
IanBenzMaxim 7:9cd16581b578 59 span<uint_least8_t> data) const {
IanBenzMaxim 7:9cd16581b578 60 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 61 if (result) {
IanBenzMaxim 7:9cd16581b578 62 return result;
IanBenzMaxim 7:9cd16581b578 63 }
IanBenzMaxim 7:9cd16581b578 64 const uint_least8_t sendBlock[] = {0xF0, beginAddress, 0x00};
IanBenzMaxim 7:9cd16581b578 65 result = master->writeBlock(sendBlock);
IanBenzMaxim 7:9cd16581b578 66 if (result) {
IanBenzMaxim 7:9cd16581b578 67 return result;
IanBenzMaxim 7:9cd16581b578 68 }
IanBenzMaxim 7:9cd16581b578 69 result = master->readBlock(data);
IanBenzMaxim 7:9cd16581b578 70 return result;
IanBenzMaxim 7:9cd16581b578 71 }
IanBenzMaxim 7:9cd16581b578 72
IanBenzMaxim 7:9cd16581b578 73 error_code DS2431::writeScratchpad(Address targetAddress,
IanBenzMaxim 7:9cd16581b578 74 Scratchpad::const_span data) {
IanBenzMaxim 7:9cd16581b578 75 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 76 if (result) {
IanBenzMaxim 7:9cd16581b578 77 return result;
IanBenzMaxim 7:9cd16581b578 78 }
IanBenzMaxim 7:9cd16581b578 79 uint_least8_t block[3 + Scratchpad::size] = {0x0F, targetAddress, 0x00};
IanBenzMaxim 7:9cd16581b578 80 std::copy(data.begin(), data.end(), block + 3);
IanBenzMaxim 7:9cd16581b578 81 result = master->writeBlock(block);
IanBenzMaxim 7:9cd16581b578 82 if (result) {
IanBenzMaxim 7:9cd16581b578 83 return result;
IanBenzMaxim 7:9cd16581b578 84 }
IanBenzMaxim 7:9cd16581b578 85 const uint_fast16_t calculatedCrc = calculateCrc16(block) ^ 0xFFFFu;
IanBenzMaxim 7:9cd16581b578 86 result = master->readBlock(make_span(block, 2));
IanBenzMaxim 7:9cd16581b578 87 if (result) {
IanBenzMaxim 7:9cd16581b578 88 return result;
IanBenzMaxim 7:9cd16581b578 89 }
IanBenzMaxim 7:9cd16581b578 90 if (calculatedCrc !=
IanBenzMaxim 7:9cd16581b578 91 ((static_cast<uint_fast16_t>(block[1]) << 8) | block[0])) {
IanBenzMaxim 7:9cd16581b578 92 result = make_error_code(CrcError);
IanBenzMaxim 7:9cd16581b578 93 }
IanBenzMaxim 7:9cd16581b578 94 return result;
IanBenzMaxim 7:9cd16581b578 95 }
IanBenzMaxim 7:9cd16581b578 96
IanBenzMaxim 7:9cd16581b578 97 error_code DS2431::readScratchpad(Scratchpad::span data,
IanBenzMaxim 7:9cd16581b578 98 uint_least8_t & esByte) {
IanBenzMaxim 7:9cd16581b578 99 typedef array<uint_least8_t, 6 + Scratchpad::size> Block;
IanBenzMaxim 7:9cd16581b578 100
IanBenzMaxim 7:9cd16581b578 101 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 102 if (result) {
IanBenzMaxim 7:9cd16581b578 103 return result;
IanBenzMaxim 7:9cd16581b578 104 }
IanBenzMaxim 7:9cd16581b578 105 Block block = {0xAA};
IanBenzMaxim 7:9cd16581b578 106 result = master->writeByte(block.front());
IanBenzMaxim 7:9cd16581b578 107 if (result) {
IanBenzMaxim 7:9cd16581b578 108 return result;
IanBenzMaxim 7:9cd16581b578 109 }
IanBenzMaxim 7:9cd16581b578 110 result = master->readBlock(make_span(block).subspan(1));
IanBenzMaxim 7:9cd16581b578 111 if (result) {
IanBenzMaxim 7:9cd16581b578 112 return result;
IanBenzMaxim 7:9cd16581b578 113 }
IanBenzMaxim 7:9cd16581b578 114 Block::const_iterator blockIt = block.end();
IanBenzMaxim 7:9cd16581b578 115 uint_fast16_t receivedCrc = static_cast<uint_fast16_t>(*(--blockIt)) << 8;
IanBenzMaxim 7:9cd16581b578 116 receivedCrc |= *(--blockIt);
IanBenzMaxim 7:9cd16581b578 117 const uint_fast16_t expectedCrc =
IanBenzMaxim 7:9cd16581b578 118 calculateCrc16(make_span(block.data(), block.size() - 2)) ^ 0xFFFFu;
IanBenzMaxim 7:9cd16581b578 119 if (expectedCrc == receivedCrc) {
IanBenzMaxim 7:9cd16581b578 120 Block::const_iterator blockItEnd = blockIt;
IanBenzMaxim 7:9cd16581b578 121 blockIt -= data.size();
IanBenzMaxim 7:9cd16581b578 122 std::copy(blockIt, blockItEnd, data.begin());
IanBenzMaxim 7:9cd16581b578 123 esByte = *(--blockIt);
IanBenzMaxim 7:9cd16581b578 124 } else {
IanBenzMaxim 7:9cd16581b578 125 result = make_error_code(CrcError);
IanBenzMaxim 7:9cd16581b578 126 }
IanBenzMaxim 7:9cd16581b578 127 return result;
IanBenzMaxim 7:9cd16581b578 128 }
IanBenzMaxim 7:9cd16581b578 129
IanBenzMaxim 7:9cd16581b578 130 error_code DS2431::copyScratchpad(Address targetAddress, uint_least8_t esByte) {
IanBenzMaxim 7:9cd16581b578 131 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 132 if (result) {
IanBenzMaxim 7:9cd16581b578 133 return result;
IanBenzMaxim 7:9cd16581b578 134 }
IanBenzMaxim 7:9cd16581b578 135 uint_least8_t block[] = {0x55, targetAddress, 0x00};
IanBenzMaxim 7:9cd16581b578 136 result = master->writeBlock(block);
IanBenzMaxim 7:9cd16581b578 137 if (result) {
IanBenzMaxim 7:9cd16581b578 138 return result;
IanBenzMaxim 7:9cd16581b578 139 }
IanBenzMaxim 7:9cd16581b578 140 result = master->writeByteSetLevel(esByte, OneWireMaster::StrongLevel);
IanBenzMaxim 7:9cd16581b578 141 if (result) {
IanBenzMaxim 7:9cd16581b578 142 return result;
IanBenzMaxim 7:9cd16581b578 143 }
IanBenzMaxim 7:9cd16581b578 144 sleep->invoke(10);
IanBenzMaxim 7:9cd16581b578 145 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 146 if (result) {
IanBenzMaxim 7:9cd16581b578 147 return result;
IanBenzMaxim 7:9cd16581b578 148 }
IanBenzMaxim 7:9cd16581b578 149 result = master->readByte(block[0]);
IanBenzMaxim 7:9cd16581b578 150 if (result) {
IanBenzMaxim 7:9cd16581b578 151 return result;
IanBenzMaxim 7:9cd16581b578 152 }
IanBenzMaxim 7:9cd16581b578 153 if (block[0] != 0xAA) {
IanBenzMaxim 7:9cd16581b578 154 result = make_error_code(OperationFailure);
IanBenzMaxim 7:9cd16581b578 155 }
IanBenzMaxim 7:9cd16581b578 156 return result;
IanBenzMaxim 7:9cd16581b578 157 }
IanBenzMaxim 7:9cd16581b578 158
IanBenzMaxim 7:9cd16581b578 159 const error_category & DS2431::errorCategory() {
IanBenzMaxim 7:9cd16581b578 160 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 161 public:
IanBenzMaxim 7:9cd16581b578 162 virtual const char * name() const { return "DS2431"; }
IanBenzMaxim 7:9cd16581b578 163
IanBenzMaxim 7:9cd16581b578 164 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 165 switch (condition) {
IanBenzMaxim 7:9cd16581b578 166 case CrcError:
IanBenzMaxim 7:9cd16581b578 167 return "CRC Error";
IanBenzMaxim 7:9cd16581b578 168
IanBenzMaxim 7:9cd16581b578 169 case OperationFailure:
IanBenzMaxim 7:9cd16581b578 170 return "Operation Failure";
IanBenzMaxim 7:9cd16581b578 171 }
IanBenzMaxim 7:9cd16581b578 172 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 173 }
IanBenzMaxim 7:9cd16581b578 174 } instance;
IanBenzMaxim 7:9cd16581b578 175 return instance;
IanBenzMaxim 7:9cd16581b578 176 }
IanBenzMaxim 7:9cd16581b578 177
IanBenzMaxim 7:9cd16581b578 178 } // namespace MaximInterfaceDevices