Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

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

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