Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Links/RomCommands.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 "RomCommands.hpp"
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 37
IanBenzMaxim 0:f77ad7f72d04 38 enum RomCmd {
IanBenzMaxim 0:f77ad7f72d04 39 ReadRomCmd = 0x33,
IanBenzMaxim 0:f77ad7f72d04 40 MatchRomCmd = 0x55,
IanBenzMaxim 0:f77ad7f72d04 41 SearchRomCmd = 0xF0,
IanBenzMaxim 0:f77ad7f72d04 42 SkipRomCmd = 0xCC,
IanBenzMaxim 0:f77ad7f72d04 43 ResumeRomCmd = 0xA5,
IanBenzMaxim 0:f77ad7f72d04 44 OverdriveSkipRomCmd = 0x3C,
IanBenzMaxim 0:f77ad7f72d04 45 OverdriveMatchRomCmd = 0x69
IanBenzMaxim 0:f77ad7f72d04 46 };
IanBenzMaxim 0:f77ad7f72d04 47
IanBenzMaxim 0:f77ad7f72d04 48 void skipCurrentFamily(SearchRomState & searchState) {
IanBenzMaxim 0:f77ad7f72d04 49 // set the Last discrepancy to last family discrepancy
IanBenzMaxim 0:f77ad7f72d04 50 searchState.lastDiscrepancy = searchState.lastFamilyDiscrepancy;
IanBenzMaxim 0:f77ad7f72d04 51
IanBenzMaxim 0:f77ad7f72d04 52 // clear the last family discrepancy
IanBenzMaxim 0:f77ad7f72d04 53 searchState.lastFamilyDiscrepancy = 0;
IanBenzMaxim 0:f77ad7f72d04 54
IanBenzMaxim 0:f77ad7f72d04 55 // check for end of list
IanBenzMaxim 0:f77ad7f72d04 56 if (searchState.lastDiscrepancy == 0) {
IanBenzMaxim 0:f77ad7f72d04 57 searchState.lastDevice = true;
IanBenzMaxim 0:f77ad7f72d04 58 }
IanBenzMaxim 0:f77ad7f72d04 59 }
IanBenzMaxim 0:f77ad7f72d04 60
IanBenzMaxim 0:f77ad7f72d04 61 error_code verifyRom(OneWireMaster & master, const RomId & romId) {
IanBenzMaxim 0:f77ad7f72d04 62 SearchRomState searchState(romId);
IanBenzMaxim 0:f77ad7f72d04 63 error_code result = searchRom(master, searchState);
IanBenzMaxim 0:f77ad7f72d04 64 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 65 // check if same device found
IanBenzMaxim 0:f77ad7f72d04 66 if (romId != searchState.romId) {
IanBenzMaxim 0:f77ad7f72d04 67 result = make_error_code(OneWireMaster::NoSlaveError);
IanBenzMaxim 0:f77ad7f72d04 68 }
IanBenzMaxim 0:f77ad7f72d04 69 }
IanBenzMaxim 0:f77ad7f72d04 70 return result;
IanBenzMaxim 0:f77ad7f72d04 71 }
IanBenzMaxim 0:f77ad7f72d04 72
IanBenzMaxim 0:f77ad7f72d04 73 error_code readRom(OneWireMaster & master, RomId & romId) {
IanBenzMaxim 0:f77ad7f72d04 74 error_code result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 75 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 76 result = master.writeByte(ReadRomCmd);
IanBenzMaxim 0:f77ad7f72d04 77 }
IanBenzMaxim 0:f77ad7f72d04 78
IanBenzMaxim 0:f77ad7f72d04 79 // read the ROM
IanBenzMaxim 0:f77ad7f72d04 80 RomId readId;
IanBenzMaxim 0:f77ad7f72d04 81 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 82 result = master.readBlock(readId.data(), readId.size());
IanBenzMaxim 0:f77ad7f72d04 83 }
IanBenzMaxim 0:f77ad7f72d04 84
IanBenzMaxim 0:f77ad7f72d04 85 // verify CRC8
IanBenzMaxim 0:f77ad7f72d04 86 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 87 if (valid(readId)) {
IanBenzMaxim 0:f77ad7f72d04 88 romId = readId;
IanBenzMaxim 0:f77ad7f72d04 89 } else {
IanBenzMaxim 0:f77ad7f72d04 90 result = make_error_code(OneWireMaster::NoSlaveError);
IanBenzMaxim 0:f77ad7f72d04 91 }
IanBenzMaxim 0:f77ad7f72d04 92 }
IanBenzMaxim 0:f77ad7f72d04 93
IanBenzMaxim 0:f77ad7f72d04 94 return result;
IanBenzMaxim 0:f77ad7f72d04 95 }
IanBenzMaxim 0:f77ad7f72d04 96
IanBenzMaxim 0:f77ad7f72d04 97 error_code skipRom(OneWireMaster & master) {
IanBenzMaxim 0:f77ad7f72d04 98 error_code result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 99 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 100 result = master.writeByte(SkipRomCmd);
IanBenzMaxim 0:f77ad7f72d04 101 }
IanBenzMaxim 0:f77ad7f72d04 102 return result;
IanBenzMaxim 0:f77ad7f72d04 103 }
IanBenzMaxim 0:f77ad7f72d04 104
IanBenzMaxim 0:f77ad7f72d04 105 error_code matchRom(OneWireMaster & master, const RomId & romId) {
IanBenzMaxim 0:f77ad7f72d04 106 // use MatchROM
IanBenzMaxim 0:f77ad7f72d04 107 error_code result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 108 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 109 uint_least8_t buf[1 + RomId::csize];
IanBenzMaxim 0:f77ad7f72d04 110 buf[0] = MatchRomCmd;
IanBenzMaxim 0:f77ad7f72d04 111 std::copy(romId.begin(), romId.end(), buf + 1);
IanBenzMaxim 0:f77ad7f72d04 112 // send command and rom
IanBenzMaxim 0:f77ad7f72d04 113 result = master.writeBlock(buf, sizeof(buf) / sizeof(buf[0]));
IanBenzMaxim 0:f77ad7f72d04 114 }
IanBenzMaxim 0:f77ad7f72d04 115 return result;
IanBenzMaxim 0:f77ad7f72d04 116 }
IanBenzMaxim 0:f77ad7f72d04 117
IanBenzMaxim 0:f77ad7f72d04 118 error_code overdriveSkipRom(OneWireMaster & master) {
IanBenzMaxim 0:f77ad7f72d04 119 error_code result = master.setSpeed(OneWireMaster::StandardSpeed);
IanBenzMaxim 0:f77ad7f72d04 120
IanBenzMaxim 0:f77ad7f72d04 121 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 122 result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 123 }
IanBenzMaxim 0:f77ad7f72d04 124
IanBenzMaxim 0:f77ad7f72d04 125 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 126 result = master.writeByte(OverdriveSkipRomCmd);
IanBenzMaxim 0:f77ad7f72d04 127 }
IanBenzMaxim 0:f77ad7f72d04 128
IanBenzMaxim 0:f77ad7f72d04 129 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 130 result = master.setSpeed(OneWireMaster::OverdriveSpeed);
IanBenzMaxim 0:f77ad7f72d04 131 }
IanBenzMaxim 0:f77ad7f72d04 132
IanBenzMaxim 0:f77ad7f72d04 133 return result;
IanBenzMaxim 0:f77ad7f72d04 134 }
IanBenzMaxim 0:f77ad7f72d04 135
IanBenzMaxim 0:f77ad7f72d04 136 error_code overdriveMatchRom(OneWireMaster & master, const RomId & romId) {
IanBenzMaxim 0:f77ad7f72d04 137 // use overdrive MatchROM
IanBenzMaxim 0:f77ad7f72d04 138 master.setSpeed(OneWireMaster::StandardSpeed);
IanBenzMaxim 0:f77ad7f72d04 139
IanBenzMaxim 0:f77ad7f72d04 140 error_code result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 141 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 142 result = master.writeByte(OverdriveMatchRomCmd);
IanBenzMaxim 0:f77ad7f72d04 143 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 144 master.setSpeed(OneWireMaster::OverdriveSpeed);
IanBenzMaxim 0:f77ad7f72d04 145 // send ROM
IanBenzMaxim 0:f77ad7f72d04 146 result = master.writeBlock(romId.data(), romId.size());
IanBenzMaxim 0:f77ad7f72d04 147 }
IanBenzMaxim 0:f77ad7f72d04 148 }
IanBenzMaxim 0:f77ad7f72d04 149 return result;
IanBenzMaxim 0:f77ad7f72d04 150 }
IanBenzMaxim 0:f77ad7f72d04 151
IanBenzMaxim 0:f77ad7f72d04 152 error_code resumeRom(OneWireMaster & master) {
IanBenzMaxim 0:f77ad7f72d04 153 error_code result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 154 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 155 result = master.writeByte(ResumeRomCmd);
IanBenzMaxim 0:f77ad7f72d04 156 }
IanBenzMaxim 0:f77ad7f72d04 157 return result;
IanBenzMaxim 0:f77ad7f72d04 158 }
IanBenzMaxim 0:f77ad7f72d04 159
IanBenzMaxim 0:f77ad7f72d04 160 error_code searchRom(OneWireMaster & master, SearchRomState & searchState) {
IanBenzMaxim 0:f77ad7f72d04 161 if (searchState.lastDevice) {
IanBenzMaxim 0:f77ad7f72d04 162 searchState = SearchRomState();
IanBenzMaxim 0:f77ad7f72d04 163 }
IanBenzMaxim 0:f77ad7f72d04 164
IanBenzMaxim 0:f77ad7f72d04 165 error_code result = master.reset();
IanBenzMaxim 0:f77ad7f72d04 166 if (result) {
IanBenzMaxim 0:f77ad7f72d04 167 return result;
IanBenzMaxim 0:f77ad7f72d04 168 }
IanBenzMaxim 0:f77ad7f72d04 169 result = master.writeByte(SearchRomCmd);
IanBenzMaxim 0:f77ad7f72d04 170 if (result) {
IanBenzMaxim 0:f77ad7f72d04 171 return result;
IanBenzMaxim 0:f77ad7f72d04 172 }
IanBenzMaxim 0:f77ad7f72d04 173
IanBenzMaxim 0:f77ad7f72d04 174 SearchRomState newSearchState = searchState;
IanBenzMaxim 0:f77ad7f72d04 175 for (int idBitNumber = 1; idBitNumber <= 64; idBitNumber++) {
IanBenzMaxim 0:f77ad7f72d04 176 const int idByteNumber = (idBitNumber - 1) / 8;
IanBenzMaxim 0:f77ad7f72d04 177 const unsigned int idBitMask = 1 << ((idBitNumber - 1) % 8);
IanBenzMaxim 0:f77ad7f72d04 178
IanBenzMaxim 0:f77ad7f72d04 179 OneWireMaster::TripletData tripletData;
IanBenzMaxim 0:f77ad7f72d04 180 if (idBitNumber == newSearchState.lastDiscrepancy) {
IanBenzMaxim 0:f77ad7f72d04 181 tripletData.writeBit = 1;
IanBenzMaxim 0:f77ad7f72d04 182 } else if (idBitNumber > newSearchState.lastDiscrepancy) {
IanBenzMaxim 0:f77ad7f72d04 183 tripletData.writeBit = 0;
IanBenzMaxim 0:f77ad7f72d04 184 } else // idBitNumber < searchState.lastDiscrepancy
IanBenzMaxim 0:f77ad7f72d04 185 {
IanBenzMaxim 0:f77ad7f72d04 186 tripletData.writeBit =
IanBenzMaxim 0:f77ad7f72d04 187 (newSearchState.romId[idByteNumber] & idBitMask) == idBitMask;
IanBenzMaxim 0:f77ad7f72d04 188 }
IanBenzMaxim 0:f77ad7f72d04 189
IanBenzMaxim 0:f77ad7f72d04 190 result = master.triplet(tripletData);
IanBenzMaxim 0:f77ad7f72d04 191 if (result) {
IanBenzMaxim 0:f77ad7f72d04 192 return result;
IanBenzMaxim 0:f77ad7f72d04 193 }
IanBenzMaxim 0:f77ad7f72d04 194 if (tripletData.readBit && tripletData.readBitComplement) {
IanBenzMaxim 0:f77ad7f72d04 195 return make_error_code(OneWireMaster::NoSlaveError);
IanBenzMaxim 0:f77ad7f72d04 196 }
IanBenzMaxim 0:f77ad7f72d04 197
IanBenzMaxim 0:f77ad7f72d04 198 if (tripletData.writeBit) {
IanBenzMaxim 0:f77ad7f72d04 199 newSearchState.romId[idByteNumber] |= idBitMask;
IanBenzMaxim 0:f77ad7f72d04 200 } else {
IanBenzMaxim 0:f77ad7f72d04 201 newSearchState.romId[idByteNumber] &= ~idBitMask;
IanBenzMaxim 0:f77ad7f72d04 202 if (!tripletData.readBit && !tripletData.readBitComplement) {
IanBenzMaxim 0:f77ad7f72d04 203 newSearchState.lastDiscrepancy = idBitNumber;
IanBenzMaxim 0:f77ad7f72d04 204 if (idBitNumber <= 8) {
IanBenzMaxim 0:f77ad7f72d04 205 newSearchState.lastFamilyDiscrepancy = idBitNumber;
IanBenzMaxim 0:f77ad7f72d04 206 }
IanBenzMaxim 0:f77ad7f72d04 207 }
IanBenzMaxim 0:f77ad7f72d04 208 }
IanBenzMaxim 0:f77ad7f72d04 209 }
IanBenzMaxim 0:f77ad7f72d04 210
IanBenzMaxim 0:f77ad7f72d04 211 if (valid(newSearchState.romId)) {
IanBenzMaxim 0:f77ad7f72d04 212 if (newSearchState.lastDiscrepancy == searchState.lastDiscrepancy) {
IanBenzMaxim 0:f77ad7f72d04 213 newSearchState.lastDevice = true;
IanBenzMaxim 0:f77ad7f72d04 214 }
IanBenzMaxim 0:f77ad7f72d04 215 searchState = newSearchState;
IanBenzMaxim 0:f77ad7f72d04 216 } else {
IanBenzMaxim 0:f77ad7f72d04 217 result = make_error_code(OneWireMaster::NoSlaveError);
IanBenzMaxim 0:f77ad7f72d04 218 }
IanBenzMaxim 0:f77ad7f72d04 219 return result;
IanBenzMaxim 0:f77ad7f72d04 220 }
IanBenzMaxim 0:f77ad7f72d04 221
IanBenzMaxim 0:f77ad7f72d04 222 } // namespace MaximInterface