Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Links/RomCommands.cpp@10:de4b8812877d, 2020-01-06 (annotated)

Committer:
reARMnimator
Date:
Mon Jan 06 15:54:55 2020 +0000
Revision:
10:de4b8812877d
Parent:
6:a8c83a2e6fa4 
Fixed inappropriate include path.

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