Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS2431.cpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Child:
6:a8c83a2e6fa4
Initial commit.

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