Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS2465.hpp@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 #ifndef MaximInterface_DS2465
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_DS2465
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <MaximInterface/Links/I2CMaster.hpp>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/OneWireMaster.hpp>
IanBenzMaxim 0:f77ad7f72d04 38 #include <MaximInterface/Links/Sleep.hpp>
IanBenzMaxim 6:a8c83a2e6fa4 39 #include <MaximInterface/Utilities/array_span.hpp>
IanBenzMaxim 0:f77ad7f72d04 40 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 0:f77ad7f72d04 41 #include <MaximInterface/Utilities/Sha256.hpp>
IanBenzMaxim 0:f77ad7f72d04 42
IanBenzMaxim 0:f77ad7f72d04 43 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 44
IanBenzMaxim 0:f77ad7f72d04 45 /// Interface to the DS2465 1-Wire master and SHA-256 coprocessor.
IanBenzMaxim 0:f77ad7f72d04 46 class DS2465 : public OneWireMaster {
IanBenzMaxim 0:f77ad7f72d04 47 public:
IanBenzMaxim 0:f77ad7f72d04 48 enum ErrorValue { HardwareError = 1, ArgumentOutOfRangeError };
IanBenzMaxim 0:f77ad7f72d04 49
IanBenzMaxim 0:f77ad7f72d04 50 /// 1-Wire port adjustment parameters.
IanBenzMaxim 0:f77ad7f72d04 51 /// @note See datasheet page 13.
IanBenzMaxim 0:f77ad7f72d04 52 enum PortParameter {
IanBenzMaxim 0:f77ad7f72d04 53 tRSTL_STD,
IanBenzMaxim 0:f77ad7f72d04 54 tRSTL_OD,
IanBenzMaxim 0:f77ad7f72d04 55 tMSP_STD,
IanBenzMaxim 0:f77ad7f72d04 56 tMSP_OD,
IanBenzMaxim 0:f77ad7f72d04 57 tW0L_STD,
IanBenzMaxim 0:f77ad7f72d04 58 tW0L_OD,
IanBenzMaxim 0:f77ad7f72d04 59 tREC0,
IanBenzMaxim 0:f77ad7f72d04 60 RWPU,
IanBenzMaxim 0:f77ad7f72d04 61 tW1L_OD
IanBenzMaxim 0:f77ad7f72d04 62 };
IanBenzMaxim 0:f77ad7f72d04 63
IanBenzMaxim 0:f77ad7f72d04 64 /// Page region to use for swapping.
IanBenzMaxim 0:f77ad7f72d04 65 enum PageRegion { FullPage = 0x03, FirstHalf = 0x01, SecondHalf = 0x02 };
IanBenzMaxim 0:f77ad7f72d04 66
IanBenzMaxim 0:f77ad7f72d04 67 /// Holds the contents of a device memory segment.
IanBenzMaxim 6:a8c83a2e6fa4 68 typedef array_span<uint_least8_t, 4> Segment;
IanBenzMaxim 0:f77ad7f72d04 69
IanBenzMaxim 0:f77ad7f72d04 70 /// Holds the contents of a device memory page.
IanBenzMaxim 6:a8c83a2e6fa4 71 typedef array_span<uint_least8_t, 32> Page;
IanBenzMaxim 0:f77ad7f72d04 72
IanBenzMaxim 0:f77ad7f72d04 73 static const int memoryPages = 2;
IanBenzMaxim 6:a8c83a2e6fa4 74 static const int segmentsPerPage = Page::size / Segment::size;
IanBenzMaxim 0:f77ad7f72d04 75
IanBenzMaxim 0:f77ad7f72d04 76 /// Represents a DS2465 configuration.
IanBenzMaxim 0:f77ad7f72d04 77 class Config {
IanBenzMaxim 0:f77ad7f72d04 78 public:
IanBenzMaxim 0:f77ad7f72d04 79 /// Default construct with power-on config.
IanBenzMaxim 0:f77ad7f72d04 80 explicit Config(uint_least8_t readByte = optionAPU)
IanBenzMaxim 0:f77ad7f72d04 81 : readByte_(readByte & 0xF) {}
IanBenzMaxim 0:f77ad7f72d04 82
IanBenzMaxim 0:f77ad7f72d04 83 /// @{
IanBenzMaxim 0:f77ad7f72d04 84 /// 1-Wire Speed
IanBenzMaxim 0:f77ad7f72d04 85 bool get1WS() const { return (readByte_ & option1WS) == option1WS; }
IanBenzMaxim 6:a8c83a2e6fa4 86
IanBenzMaxim 6:a8c83a2e6fa4 87 Config & set1WS(bool new1WS) {
IanBenzMaxim 0:f77ad7f72d04 88 if (new1WS) {
IanBenzMaxim 0:f77ad7f72d04 89 readByte_ |= option1WS;
IanBenzMaxim 0:f77ad7f72d04 90 } else {
IanBenzMaxim 0:f77ad7f72d04 91 readByte_ &= ~option1WS;
IanBenzMaxim 0:f77ad7f72d04 92 }
IanBenzMaxim 6:a8c83a2e6fa4 93 return *this;
IanBenzMaxim 0:f77ad7f72d04 94 }
IanBenzMaxim 0:f77ad7f72d04 95 /// @}
IanBenzMaxim 0:f77ad7f72d04 96
IanBenzMaxim 0:f77ad7f72d04 97 /// @{
IanBenzMaxim 0:f77ad7f72d04 98 /// Strong Pullup
IanBenzMaxim 0:f77ad7f72d04 99 bool getSPU() const { return (readByte_ & optionSPU) == optionSPU; }
IanBenzMaxim 6:a8c83a2e6fa4 100
IanBenzMaxim 6:a8c83a2e6fa4 101 Config & setSPU(bool newSPU) {
IanBenzMaxim 0:f77ad7f72d04 102 if (newSPU) {
IanBenzMaxim 0:f77ad7f72d04 103 readByte_ |= optionSPU;
IanBenzMaxim 0:f77ad7f72d04 104 } else {
IanBenzMaxim 0:f77ad7f72d04 105 readByte_ &= ~optionSPU;
IanBenzMaxim 0:f77ad7f72d04 106 }
IanBenzMaxim 6:a8c83a2e6fa4 107 return *this;
IanBenzMaxim 0:f77ad7f72d04 108 }
IanBenzMaxim 0:f77ad7f72d04 109 /// @}
IanBenzMaxim 0:f77ad7f72d04 110
IanBenzMaxim 0:f77ad7f72d04 111 /// @{
IanBenzMaxim 0:f77ad7f72d04 112 /// 1-Wire Power Down
IanBenzMaxim 0:f77ad7f72d04 113 bool getPDN() const { return (readByte_ & optionPDN) == optionPDN; }
IanBenzMaxim 6:a8c83a2e6fa4 114
IanBenzMaxim 6:a8c83a2e6fa4 115 Config & setPDN(bool newPDN) {
IanBenzMaxim 0:f77ad7f72d04 116 if (newPDN) {
IanBenzMaxim 0:f77ad7f72d04 117 readByte_ |= optionPDN;
IanBenzMaxim 0:f77ad7f72d04 118 } else {
IanBenzMaxim 0:f77ad7f72d04 119 readByte_ &= ~optionPDN;
IanBenzMaxim 0:f77ad7f72d04 120 }
IanBenzMaxim 6:a8c83a2e6fa4 121 return *this;
IanBenzMaxim 0:f77ad7f72d04 122 }
IanBenzMaxim 0:f77ad7f72d04 123 /// @}
IanBenzMaxim 0:f77ad7f72d04 124
IanBenzMaxim 0:f77ad7f72d04 125 /// @{
IanBenzMaxim 0:f77ad7f72d04 126 /// Active Pullup
IanBenzMaxim 0:f77ad7f72d04 127 bool getAPU() const { return (readByte_ & optionAPU) == optionAPU; }
IanBenzMaxim 6:a8c83a2e6fa4 128
IanBenzMaxim 6:a8c83a2e6fa4 129 Config & setAPU(bool newAPU) {
IanBenzMaxim 0:f77ad7f72d04 130 if (newAPU) {
IanBenzMaxim 0:f77ad7f72d04 131 readByte_ |= optionAPU;
IanBenzMaxim 0:f77ad7f72d04 132 } else {
IanBenzMaxim 0:f77ad7f72d04 133 readByte_ &= ~optionAPU;
IanBenzMaxim 0:f77ad7f72d04 134 }
IanBenzMaxim 6:a8c83a2e6fa4 135 return *this;
IanBenzMaxim 0:f77ad7f72d04 136 }
IanBenzMaxim 0:f77ad7f72d04 137 /// @}
IanBenzMaxim 0:f77ad7f72d04 138
IanBenzMaxim 0:f77ad7f72d04 139 /// Byte representation that is read from the DS2465.
IanBenzMaxim 0:f77ad7f72d04 140 uint_least8_t readByte() const { return readByte_; }
IanBenzMaxim 0:f77ad7f72d04 141
IanBenzMaxim 0:f77ad7f72d04 142 private:
IanBenzMaxim 0:f77ad7f72d04 143 static const unsigned int option1WS = 0x8;
IanBenzMaxim 0:f77ad7f72d04 144 static const unsigned int optionSPU = 0x4;
IanBenzMaxim 0:f77ad7f72d04 145 static const unsigned int optionPDN = 0x2;
IanBenzMaxim 0:f77ad7f72d04 146 static const unsigned int optionAPU = 0x1;
IanBenzMaxim 0:f77ad7f72d04 147
IanBenzMaxim 0:f77ad7f72d04 148 uint_least8_t readByte_;
IanBenzMaxim 0:f77ad7f72d04 149 };
IanBenzMaxim 0:f77ad7f72d04 150
IanBenzMaxim 0:f77ad7f72d04 151 // Const member functions should not change the settings of the DS2465 or
IanBenzMaxim 0:f77ad7f72d04 152 // affect the state of the 1-Wire bus. Read pointer, scratchpad, MAC output
IanBenzMaxim 0:f77ad7f72d04 153 // register, and command register on the DS2465 are considered mutable.
IanBenzMaxim 0:f77ad7f72d04 154
IanBenzMaxim 6:a8c83a2e6fa4 155 DS2465(Sleep & sleep, I2CMaster & master, uint_least8_t address = 0x30)
IanBenzMaxim 6:a8c83a2e6fa4 156 : sleep(&sleep), master(&master), address_(address & 0xFE) {}
IanBenzMaxim 0:f77ad7f72d04 157
IanBenzMaxim 6:a8c83a2e6fa4 158 void setSleep(Sleep & sleep) { this->sleep = &sleep; }
IanBenzMaxim 6:a8c83a2e6fa4 159
IanBenzMaxim 6:a8c83a2e6fa4 160 void setMaster(I2CMaster & master) { this->master = &master; }
IanBenzMaxim 6:a8c83a2e6fa4 161
IanBenzMaxim 6:a8c83a2e6fa4 162 uint_least8_t address() const { return address_; }
IanBenzMaxim 6:a8c83a2e6fa4 163
IanBenzMaxim 6:a8c83a2e6fa4 164 void setAddress(uint_least8_t address) { address_ = address & 0xFE; }
IanBenzMaxim 0:f77ad7f72d04 165
IanBenzMaxim 0:f77ad7f72d04 166 /// Initialize hardware for use.
IanBenzMaxim 0:f77ad7f72d04 167 MaximInterface_EXPORT error_code initialize(Config config = Config());
IanBenzMaxim 0:f77ad7f72d04 168
IanBenzMaxim 0:f77ad7f72d04 169 /// Write a new configuration to the DS2465.
IanBenzMaxim 0:f77ad7f72d04 170 /// @param[in] config New configuration to write.
IanBenzMaxim 0:f77ad7f72d04 171 MaximInterface_EXPORT error_code writeConfig(Config config);
IanBenzMaxim 0:f77ad7f72d04 172
IanBenzMaxim 0:f77ad7f72d04 173 /// Write a new port configuration parameter to the DS2465.
IanBenzMaxim 0:f77ad7f72d04 174 /// @param[in] param Parameter to adjust.
IanBenzMaxim 0:f77ad7f72d04 175 /// @param[in] val New parameter value to set. Consult datasheet for value
IanBenzMaxim 0:f77ad7f72d04 176 /// mappings.
IanBenzMaxim 0:f77ad7f72d04 177 MaximInterface_EXPORT error_code writePortParameter(PortParameter param,
IanBenzMaxim 0:f77ad7f72d04 178 int val);
IanBenzMaxim 0:f77ad7f72d04 179
IanBenzMaxim 0:f77ad7f72d04 180 // 1-Wire Master Commands
IanBenzMaxim 0:f77ad7f72d04 181
IanBenzMaxim 0:f77ad7f72d04 182 MaximInterface_EXPORT virtual error_code reset();
IanBenzMaxim 6:a8c83a2e6fa4 183
IanBenzMaxim 0:f77ad7f72d04 184 MaximInterface_EXPORT virtual error_code touchBitSetLevel(bool & sendRecvBit,
IanBenzMaxim 0:f77ad7f72d04 185 Level afterLevel);
IanBenzMaxim 6:a8c83a2e6fa4 186
IanBenzMaxim 0:f77ad7f72d04 187 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 188 readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
IanBenzMaxim 6:a8c83a2e6fa4 189
IanBenzMaxim 0:f77ad7f72d04 190 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 191 writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
IanBenzMaxim 6:a8c83a2e6fa4 192
IanBenzMaxim 6:a8c83a2e6fa4 193 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 6:a8c83a2e6fa4 194 readBlock(span<uint_least8_t> recvBuf);
IanBenzMaxim 6:a8c83a2e6fa4 195
IanBenzMaxim 0:f77ad7f72d04 196 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 6:a8c83a2e6fa4 197 writeBlock(span<const uint_least8_t> sendBuf);
IanBenzMaxim 6:a8c83a2e6fa4 198
IanBenzMaxim 0:f77ad7f72d04 199 MaximInterface_EXPORT virtual error_code setSpeed(Speed newSpeed);
IanBenzMaxim 6:a8c83a2e6fa4 200
IanBenzMaxim 0:f77ad7f72d04 201 /// @note The DS2465 only supports enabling strong pullup following a 1-Wire
IanBenzMaxim 0:f77ad7f72d04 202 /// read or write operation.
IanBenzMaxim 0:f77ad7f72d04 203 MaximInterface_EXPORT virtual error_code setLevel(Level newLevel);
IanBenzMaxim 6:a8c83a2e6fa4 204
IanBenzMaxim 0:f77ad7f72d04 205 MaximInterface_EXPORT virtual error_code triplet(TripletData & data);
IanBenzMaxim 0:f77ad7f72d04 206
IanBenzMaxim 0:f77ad7f72d04 207 // DS2465 Coprocessor Commands
IanBenzMaxim 6:a8c83a2e6fa4 208
IanBenzMaxim 0:f77ad7f72d04 209 /// Read data from an EEPROM memory page.
IanBenzMaxim 0:f77ad7f72d04 210 /// @param pageNum Page number to read from.
IanBenzMaxim 6:a8c83a2e6fa4 211 MaximInterface_EXPORT error_code readPage(int pageNum, Page::span data) const;
IanBenzMaxim 0:f77ad7f72d04 212
IanBenzMaxim 0:f77ad7f72d04 213 /// Write data to an EEPROM memory page.
IanBenzMaxim 0:f77ad7f72d04 214 /// @param pageNum Page number to copy to.
IanBenzMaxim 6:a8c83a2e6fa4 215 MaximInterface_EXPORT error_code writePage(int pageNum,
IanBenzMaxim 6:a8c83a2e6fa4 216 Page::const_span data);
IanBenzMaxim 0:f77ad7f72d04 217
IanBenzMaxim 0:f77ad7f72d04 218 /// Write data to an EEPROM memory segment.
IanBenzMaxim 0:f77ad7f72d04 219 /// @param pageNum Page number to copy to.
IanBenzMaxim 0:f77ad7f72d04 220 /// @param segmentNum Segment number to copy to.
IanBenzMaxim 0:f77ad7f72d04 221 MaximInterface_EXPORT error_code writeSegment(int pageNum, int segmentNum,
IanBenzMaxim 6:a8c83a2e6fa4 222 Segment::const_span data);
IanBenzMaxim 0:f77ad7f72d04 223
IanBenzMaxim 0:f77ad7f72d04 224 /// Write data to the secret EEPROM memory page.
IanBenzMaxim 0:f77ad7f72d04 225 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 226 writeMasterSecret(Sha256::Hash::const_span masterSecret);
IanBenzMaxim 0:f77ad7f72d04 227
IanBenzMaxim 0:f77ad7f72d04 228 /// Compute Next Master Secret.
IanBenzMaxim 0:f77ad7f72d04 229 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 230 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 231 computeNextMasterSecret(Sha256::AuthenticationData::const_span data);
IanBenzMaxim 0:f77ad7f72d04 232
IanBenzMaxim 0:f77ad7f72d04 233 /// Compute Next Master Secret with page swapping.
IanBenzMaxim 0:f77ad7f72d04 234 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 235 /// @param pageNum Page number to swap in.
IanBenzMaxim 0:f77ad7f72d04 236 /// @param region Region of the page to swap in.
IanBenzMaxim 6:a8c83a2e6fa4 237 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 238 computeNextMasterSecretWithSwap(Sha256::AuthenticationData::const_span data,
IanBenzMaxim 6:a8c83a2e6fa4 239 int pageNum, PageRegion region);
IanBenzMaxim 0:f77ad7f72d04 240
IanBenzMaxim 0:f77ad7f72d04 241 /// Compute Write MAC.
IanBenzMaxim 0:f77ad7f72d04 242 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 243 /// @param[out] mac Computed Write MAC.
IanBenzMaxim 6:a8c83a2e6fa4 244 MaximInterface_EXPORT error_code computeWriteMac(
IanBenzMaxim 6:a8c83a2e6fa4 245 Sha256::WriteMacData::const_span data, Sha256::Hash::span mac) const;
IanBenzMaxim 0:f77ad7f72d04 246
IanBenzMaxim 0:f77ad7f72d04 247 /// Compute Write MAC.
IanBenzMaxim 0:f77ad7f72d04 248 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 249 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 250 computeAndTransmitWriteMac(Sha256::WriteMacData::const_span data) const;
IanBenzMaxim 0:f77ad7f72d04 251
IanBenzMaxim 0:f77ad7f72d04 252 /// Compute Write MAC with page swapping.
IanBenzMaxim 0:f77ad7f72d04 253 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 254 /// @param pageNum Page number to swap in.
IanBenzMaxim 0:f77ad7f72d04 255 /// @param segmentNum Segment number to swap in.
IanBenzMaxim 0:f77ad7f72d04 256 /// @param[out] mac Computed Write MAC.
IanBenzMaxim 0:f77ad7f72d04 257 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 258 computeWriteMacWithSwap(Sha256::WriteMacData::const_span data, int pageNum,
IanBenzMaxim 6:a8c83a2e6fa4 259 int segmentNum, Sha256::Hash::span mac) const;
IanBenzMaxim 0:f77ad7f72d04 260
IanBenzMaxim 0:f77ad7f72d04 261 /// Compute Write MAC with page swapping.
IanBenzMaxim 0:f77ad7f72d04 262 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 263 /// @param pageNum Page number to swap in.
IanBenzMaxim 0:f77ad7f72d04 264 /// @param segmentNum Segment number to swap in.
IanBenzMaxim 0:f77ad7f72d04 265 MaximInterface_EXPORT error_code computeAndTransmitWriteMacWithSwap(
IanBenzMaxim 6:a8c83a2e6fa4 266 Sha256::WriteMacData::const_span data, int pageNum, int segmentNum) const;
IanBenzMaxim 0:f77ad7f72d04 267
IanBenzMaxim 0:f77ad7f72d04 268 /// Compute Slave Secret (S-Secret).
IanBenzMaxim 0:f77ad7f72d04 269 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 270 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 271 computeSlaveSecret(Sha256::AuthenticationData::const_span data);
IanBenzMaxim 0:f77ad7f72d04 272
IanBenzMaxim 0:f77ad7f72d04 273 /// Compute Slave Secret (S-Secret) with page swapping.
IanBenzMaxim 0:f77ad7f72d04 274 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 275 /// @param pageNum Page number to swap in.
IanBenzMaxim 0:f77ad7f72d04 276 /// @param region Region of the page to swap in.
IanBenzMaxim 6:a8c83a2e6fa4 277 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 278 computeSlaveSecretWithSwap(Sha256::AuthenticationData::const_span data,
IanBenzMaxim 6:a8c83a2e6fa4 279 int pageNum, PageRegion region);
IanBenzMaxim 0:f77ad7f72d04 280
IanBenzMaxim 0:f77ad7f72d04 281 /// Compute Authentication MAC.
IanBenzMaxim 0:f77ad7f72d04 282 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 283 /// @param[out] mac Computed Auth MAC.
IanBenzMaxim 0:f77ad7f72d04 284 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 285 computeAuthMac(Sha256::AuthenticationData::const_span data,
IanBenzMaxim 6:a8c83a2e6fa4 286 Sha256::Hash::span mac) const;
IanBenzMaxim 0:f77ad7f72d04 287
IanBenzMaxim 0:f77ad7f72d04 288 /// Compute Authentication MAC.
IanBenzMaxim 0:f77ad7f72d04 289 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 290 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 291 computeAndTransmitAuthMac(Sha256::AuthenticationData::const_span data) const;
IanBenzMaxim 0:f77ad7f72d04 292
IanBenzMaxim 0:f77ad7f72d04 293 /// Compute Authentication MAC with page swapping.
IanBenzMaxim 0:f77ad7f72d04 294 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 295 /// @param pageNum Page number to swap in.
IanBenzMaxim 0:f77ad7f72d04 296 /// @param region Region of the page to swap in.
IanBenzMaxim 0:f77ad7f72d04 297 /// @param[out] mac Computed Auth MAC.
IanBenzMaxim 6:a8c83a2e6fa4 298 MaximInterface_EXPORT error_code computeAuthMacWithSwap(
IanBenzMaxim 6:a8c83a2e6fa4 299 Sha256::AuthenticationData::const_span data, int pageNum,
IanBenzMaxim 6:a8c83a2e6fa4 300 PageRegion region, Sha256::Hash::span mac) const;
IanBenzMaxim 0:f77ad7f72d04 301
IanBenzMaxim 0:f77ad7f72d04 302 /// Compute Authentication MAC with page swapping.
IanBenzMaxim 0:f77ad7f72d04 303 /// @param data Combined data fields for computation.
IanBenzMaxim 0:f77ad7f72d04 304 /// @param pageNum Page number to swap in.
IanBenzMaxim 0:f77ad7f72d04 305 /// @param region Region of the page to swap in.
IanBenzMaxim 6:a8c83a2e6fa4 306 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 307 computeAndTransmitAuthMacWithSwap(Sha256::AuthenticationData::const_span data,
IanBenzMaxim 6:a8c83a2e6fa4 308 int pageNum, PageRegion region) const;
IanBenzMaxim 0:f77ad7f72d04 309
IanBenzMaxim 0:f77ad7f72d04 310 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 311
IanBenzMaxim 0:f77ad7f72d04 312 private:
IanBenzMaxim 0:f77ad7f72d04 313 const Sleep * sleep;
IanBenzMaxim 6:a8c83a2e6fa4 314 I2CMaster * master;
IanBenzMaxim 6:a8c83a2e6fa4 315 uint_least8_t address_;
IanBenzMaxim 0:f77ad7f72d04 316 Config curConfig;
IanBenzMaxim 0:f77ad7f72d04 317
IanBenzMaxim 0:f77ad7f72d04 318 /// Performs a soft reset on the DS2465.
IanBenzMaxim 0:f77ad7f72d04 319 /// @note This is not a 1-Wire Reset.
IanBenzMaxim 0:f77ad7f72d04 320 error_code resetDevice();
IanBenzMaxim 0:f77ad7f72d04 321
IanBenzMaxim 0:f77ad7f72d04 322 /// Polls the DS2465 status waiting for the 1-Wire Busy bit (1WB) to be cleared.
IanBenzMaxim 0:f77ad7f72d04 323 /// @param[out] pStatus Optionally retrive the status byte when 1WB cleared.
IanBenzMaxim 0:f77ad7f72d04 324 /// @returns Success or TimeoutError if poll limit reached.
IanBenzMaxim 0:f77ad7f72d04 325 error_code pollBusy(uint_least8_t * pStatus = NULL) const;
IanBenzMaxim 0:f77ad7f72d04 326
IanBenzMaxim 0:f77ad7f72d04 327 /// Ensure that the desired 1-Wire level is set in the configuration.
IanBenzMaxim 0:f77ad7f72d04 328 /// @param level Desired 1-Wire level.
IanBenzMaxim 0:f77ad7f72d04 329 error_code configureLevel(Level level);
IanBenzMaxim 0:f77ad7f72d04 330
IanBenzMaxim 0:f77ad7f72d04 331 /// Const since only for internal use.
IanBenzMaxim 6:a8c83a2e6fa4 332 error_code writeMemory(uint_least8_t addr,
IanBenzMaxim 6:a8c83a2e6fa4 333 span<const uint_least8_t> buf) const;
IanBenzMaxim 0:f77ad7f72d04 334
IanBenzMaxim 0:f77ad7f72d04 335 /// Read memory from the DS2465.
IanBenzMaxim 0:f77ad7f72d04 336 /// @param addr Address to begin reading from.
IanBenzMaxim 0:f77ad7f72d04 337 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 6:a8c83a2e6fa4 338 error_code readMemory(uint_least8_t addr, span<uint_least8_t> buf) const;
IanBenzMaxim 0:f77ad7f72d04 339
IanBenzMaxim 0:f77ad7f72d04 340 /// Read memory from the DS2465 at the current pointer.
IanBenzMaxim 0:f77ad7f72d04 341 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 6:a8c83a2e6fa4 342 error_code readMemory(span<uint_least8_t> buf) const;
IanBenzMaxim 0:f77ad7f72d04 343
IanBenzMaxim 0:f77ad7f72d04 344 /// Write the last computed MAC to the 1-Wire bus.
IanBenzMaxim 0:f77ad7f72d04 345 error_code writeMacBlock() const;
IanBenzMaxim 0:f77ad7f72d04 346
IanBenzMaxim 6:a8c83a2e6fa4 347 error_code computeWriteMac(Sha256::WriteMacData::const_span data) const;
IanBenzMaxim 0:f77ad7f72d04 348
IanBenzMaxim 6:a8c83a2e6fa4 349 error_code computeWriteMacWithSwap(Sha256::WriteMacData::const_span data,
IanBenzMaxim 0:f77ad7f72d04 350 int pageNum, int segmentNum) const;
IanBenzMaxim 0:f77ad7f72d04 351
IanBenzMaxim 6:a8c83a2e6fa4 352 error_code computeAuthMac(Sha256::AuthenticationData::const_span data) const;
IanBenzMaxim 0:f77ad7f72d04 353
IanBenzMaxim 6:a8c83a2e6fa4 354 error_code computeAuthMacWithSwap(Sha256::AuthenticationData::const_span data,
IanBenzMaxim 0:f77ad7f72d04 355 int pageNum, PageRegion region) const;
IanBenzMaxim 0:f77ad7f72d04 356
IanBenzMaxim 0:f77ad7f72d04 357 // Legacy implementations
IanBenzMaxim 0:f77ad7f72d04 358 error_code copyScratchpad(bool destSecret, int pageNum, bool notFull,
IanBenzMaxim 0:f77ad7f72d04 359 int segmentNum);
IanBenzMaxim 0:f77ad7f72d04 360
IanBenzMaxim 0:f77ad7f72d04 361 error_code computeNextMasterSecret(bool swap, int pageNum, PageRegion region);
IanBenzMaxim 0:f77ad7f72d04 362
IanBenzMaxim 0:f77ad7f72d04 363 error_code computeWriteMac(bool regwrite, bool swap, int pageNum,
IanBenzMaxim 0:f77ad7f72d04 364 int segmentNum) const;
IanBenzMaxim 0:f77ad7f72d04 365
IanBenzMaxim 0:f77ad7f72d04 366 error_code computeSlaveSecret(bool swap, int pageNum, PageRegion region);
IanBenzMaxim 0:f77ad7f72d04 367
IanBenzMaxim 0:f77ad7f72d04 368 error_code computeAuthMac(bool swap, int pageNum, PageRegion region) const;
IanBenzMaxim 0:f77ad7f72d04 369 };
IanBenzMaxim 0:f77ad7f72d04 370
IanBenzMaxim 0:f77ad7f72d04 371 inline error_code make_error_code(DS2465::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 372 return error_code(e, DS2465::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 373 }
IanBenzMaxim 0:f77ad7f72d04 374
IanBenzMaxim 0:f77ad7f72d04 375 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 376
IanBenzMaxim 0:f77ad7f72d04 377 #endif