Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceDevices/DS2465.hpp@12:7eb41621ba22, 2020-05-29 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 29 16:19:22 2020 -0500
Revision:
12:7eb41621ba22
Parent:
8:5ea891c7d1a1 
Updated to version 2.2.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 8:5ea891c7d1a1 33 #ifndef MaximInterfaceDevices_DS2465_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS2465_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <MaximInterfaceCore/array_span.hpp>
IanBenzMaxim 7:9cd16581b578 37 #include <MaximInterfaceCore/I2CMaster.hpp>
IanBenzMaxim 7:9cd16581b578 38 #include <MaximInterfaceCore/OneWireMaster.hpp>
IanBenzMaxim 7:9cd16581b578 39 #include <MaximInterfaceCore/Sleep.hpp>
IanBenzMaxim 7:9cd16581b578 40 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 41
IanBenzMaxim 7:9cd16581b578 42 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 8:5ea891c7d1a1 44 /// @brief Interface to the DS2465 1-Wire master and SHA-256 coprocessor.
IanBenzMaxim 8:5ea891c7d1a1 45 /// @details
IanBenzMaxim 8:5ea891c7d1a1 46 /// Const member functions should not change the settings of the DS2465 or
IanBenzMaxim 8:5ea891c7d1a1 47 /// affect the state of the 1-Wire bus. Read pointer, scratchpad, MAC output
IanBenzMaxim 8:5ea891c7d1a1 48 /// register, and command register on the DS2465 are considered mutable.
IanBenzMaxim 7:9cd16581b578 49 class DS2465 : public Core::OneWireMaster {
IanBenzMaxim 7:9cd16581b578 50 public:
IanBenzMaxim 7:9cd16581b578 51 enum ErrorValue { HardwareError = 1, ArgumentOutOfRangeError };
IanBenzMaxim 7:9cd16581b578 52
IanBenzMaxim 7:9cd16581b578 53 /// @brief 1-Wire port adjustment parameters.
IanBenzMaxim 7:9cd16581b578 54 /// @note See datasheet page 13.
IanBenzMaxim 7:9cd16581b578 55 enum PortParameter {
IanBenzMaxim 7:9cd16581b578 56 tRSTL_STD,
IanBenzMaxim 7:9cd16581b578 57 tRSTL_OD,
IanBenzMaxim 7:9cd16581b578 58 tMSP_STD,
IanBenzMaxim 7:9cd16581b578 59 tMSP_OD,
IanBenzMaxim 7:9cd16581b578 60 tW0L_STD,
IanBenzMaxim 7:9cd16581b578 61 tW0L_OD,
IanBenzMaxim 7:9cd16581b578 62 tREC0,
IanBenzMaxim 7:9cd16581b578 63 RWPU,
IanBenzMaxim 7:9cd16581b578 64 tW1L_OD
IanBenzMaxim 7:9cd16581b578 65 };
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 7:9cd16581b578 67 /// Page region to use for swapping.
IanBenzMaxim 7:9cd16581b578 68 enum PageRegion { FullPage = 0x03, FirstHalf = 0x01, SecondHalf = 0x02 };
IanBenzMaxim 7:9cd16581b578 69
IanBenzMaxim 7:9cd16581b578 70 /// Holds the contents of a device memory segment.
IanBenzMaxim 7:9cd16581b578 71 typedef Core::array_span<uint_least8_t, 4> Segment;
IanBenzMaxim 7:9cd16581b578 72
IanBenzMaxim 7:9cd16581b578 73 /// Holds the contents of a device memory page.
IanBenzMaxim 7:9cd16581b578 74 typedef Core::array_span<uint_least8_t, 32> Page;
IanBenzMaxim 7:9cd16581b578 75
IanBenzMaxim 7:9cd16581b578 76 /// Data for Compute Write MAC operation.
IanBenzMaxim 7:9cd16581b578 77 typedef Core::array_span<uint_least8_t, 20> WriteMacData;
IanBenzMaxim 7:9cd16581b578 78
IanBenzMaxim 7:9cd16581b578 79 /// Data for the Compute Auth. MAC and Compute Slave Secret operations.
IanBenzMaxim 7:9cd16581b578 80 typedef Core::array_span<uint_least8_t, 76> AuthenticationData;
IanBenzMaxim 7:9cd16581b578 81
IanBenzMaxim 7:9cd16581b578 82 static const int memoryPages = 2;
IanBenzMaxim 7:9cd16581b578 83 static const int segmentsPerPage = Page::size / Segment::size;
IanBenzMaxim 7:9cd16581b578 84
IanBenzMaxim 7:9cd16581b578 85 /// Represents a DS2465 configuration.
IanBenzMaxim 7:9cd16581b578 86 class Config {
IanBenzMaxim 7:9cd16581b578 87 public:
IanBenzMaxim 7:9cd16581b578 88 /// Default construct with power-on config.
IanBenzMaxim 7:9cd16581b578 89 explicit Config(uint_least8_t readByte = optionAPU)
IanBenzMaxim 7:9cd16581b578 90 : readByte_(readByte & 0xF) {}
IanBenzMaxim 7:9cd16581b578 91
IanBenzMaxim 7:9cd16581b578 92 /// @name 1WS
IanBenzMaxim 7:9cd16581b578 93 /// @brief 1-Wire Speed
IanBenzMaxim 7:9cd16581b578 94 /// @{
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 7:9cd16581b578 96 /// Get 1WS bit.
IanBenzMaxim 7:9cd16581b578 97 bool get1WS() const { return (readByte_ & option1WS) == option1WS; }
IanBenzMaxim 7:9cd16581b578 98
IanBenzMaxim 7:9cd16581b578 99 /// Set 1WS bit.
IanBenzMaxim 7:9cd16581b578 100 Config & set1WS(bool new1WS) {
IanBenzMaxim 7:9cd16581b578 101 if (new1WS) {
IanBenzMaxim 7:9cd16581b578 102 readByte_ |= option1WS;
IanBenzMaxim 7:9cd16581b578 103 } else {
IanBenzMaxim 7:9cd16581b578 104 readByte_ &= ~option1WS;
IanBenzMaxim 7:9cd16581b578 105 }
IanBenzMaxim 7:9cd16581b578 106 return *this;
IanBenzMaxim 7:9cd16581b578 107 }
IanBenzMaxim 7:9cd16581b578 108
IanBenzMaxim 7:9cd16581b578 109 /// @}
IanBenzMaxim 7:9cd16581b578 110
IanBenzMaxim 7:9cd16581b578 111 /// @name SPU
IanBenzMaxim 7:9cd16581b578 112 /// @brief Strong Pullup
IanBenzMaxim 7:9cd16581b578 113 /// @{
IanBenzMaxim 7:9cd16581b578 114
IanBenzMaxim 7:9cd16581b578 115 /// Get SPU bit.
IanBenzMaxim 7:9cd16581b578 116 bool getSPU() const { return (readByte_ & optionSPU) == optionSPU; }
IanBenzMaxim 7:9cd16581b578 117
IanBenzMaxim 7:9cd16581b578 118 /// Set SPU bit.
IanBenzMaxim 7:9cd16581b578 119 Config & setSPU(bool newSPU) {
IanBenzMaxim 7:9cd16581b578 120 if (newSPU) {
IanBenzMaxim 7:9cd16581b578 121 readByte_ |= optionSPU;
IanBenzMaxim 7:9cd16581b578 122 } else {
IanBenzMaxim 7:9cd16581b578 123 readByte_ &= ~optionSPU;
IanBenzMaxim 7:9cd16581b578 124 }
IanBenzMaxim 7:9cd16581b578 125 return *this;
IanBenzMaxim 7:9cd16581b578 126 }
IanBenzMaxim 7:9cd16581b578 127
IanBenzMaxim 7:9cd16581b578 128 /// @}
IanBenzMaxim 7:9cd16581b578 129
IanBenzMaxim 7:9cd16581b578 130 /// @name PDN
IanBenzMaxim 7:9cd16581b578 131 /// @brief 1-Wire Power Down
IanBenzMaxim 7:9cd16581b578 132 /// @{
IanBenzMaxim 7:9cd16581b578 133
IanBenzMaxim 7:9cd16581b578 134 /// Get PDN bit.
IanBenzMaxim 7:9cd16581b578 135 bool getPDN() const { return (readByte_ & optionPDN) == optionPDN; }
IanBenzMaxim 7:9cd16581b578 136
IanBenzMaxim 7:9cd16581b578 137 /// Set PDN bit.
IanBenzMaxim 7:9cd16581b578 138 Config & setPDN(bool newPDN) {
IanBenzMaxim 7:9cd16581b578 139 if (newPDN) {
IanBenzMaxim 7:9cd16581b578 140 readByte_ |= optionPDN;
IanBenzMaxim 7:9cd16581b578 141 } else {
IanBenzMaxim 7:9cd16581b578 142 readByte_ &= ~optionPDN;
IanBenzMaxim 7:9cd16581b578 143 }
IanBenzMaxim 7:9cd16581b578 144 return *this;
IanBenzMaxim 7:9cd16581b578 145 }
IanBenzMaxim 7:9cd16581b578 146
IanBenzMaxim 7:9cd16581b578 147 /// @}
IanBenzMaxim 7:9cd16581b578 148
IanBenzMaxim 7:9cd16581b578 149 /// @name APU
IanBenzMaxim 7:9cd16581b578 150 /// @brief Active Pullup
IanBenzMaxim 7:9cd16581b578 151 /// @{
IanBenzMaxim 7:9cd16581b578 152
IanBenzMaxim 7:9cd16581b578 153 /// Get APU bit.
IanBenzMaxim 7:9cd16581b578 154 bool getAPU() const { return (readByte_ & optionAPU) == optionAPU; }
IanBenzMaxim 7:9cd16581b578 155
IanBenzMaxim 7:9cd16581b578 156 /// Set APU bit.
IanBenzMaxim 7:9cd16581b578 157 Config & setAPU(bool newAPU) {
IanBenzMaxim 7:9cd16581b578 158 if (newAPU) {
IanBenzMaxim 7:9cd16581b578 159 readByte_ |= optionAPU;
IanBenzMaxim 7:9cd16581b578 160 } else {
IanBenzMaxim 7:9cd16581b578 161 readByte_ &= ~optionAPU;
IanBenzMaxim 7:9cd16581b578 162 }
IanBenzMaxim 7:9cd16581b578 163 return *this;
IanBenzMaxim 7:9cd16581b578 164 }
IanBenzMaxim 7:9cd16581b578 165
IanBenzMaxim 7:9cd16581b578 166 /// @}
IanBenzMaxim 7:9cd16581b578 167
IanBenzMaxim 7:9cd16581b578 168 /// Byte representation that is read from the DS2465.
IanBenzMaxim 7:9cd16581b578 169 uint_least8_t readByte() const { return readByte_; }
IanBenzMaxim 7:9cd16581b578 170
IanBenzMaxim 7:9cd16581b578 171 private:
IanBenzMaxim 7:9cd16581b578 172 static const unsigned int option1WS = 0x8;
IanBenzMaxim 7:9cd16581b578 173 static const unsigned int optionSPU = 0x4;
IanBenzMaxim 7:9cd16581b578 174 static const unsigned int optionPDN = 0x2;
IanBenzMaxim 7:9cd16581b578 175 static const unsigned int optionAPU = 0x1;
IanBenzMaxim 7:9cd16581b578 176
IanBenzMaxim 7:9cd16581b578 177 uint_least8_t readByte_;
IanBenzMaxim 7:9cd16581b578 178 };
IanBenzMaxim 7:9cd16581b578 179
IanBenzMaxim 7:9cd16581b578 180 DS2465(Core::Sleep & sleep, Core::I2CMaster & master,
IanBenzMaxim 7:9cd16581b578 181 uint_least8_t address = 0x30)
IanBenzMaxim 7:9cd16581b578 182 : sleep(&sleep), master(&master), address_(address & 0xFE) {}
IanBenzMaxim 7:9cd16581b578 183
IanBenzMaxim 7:9cd16581b578 184 void setSleep(Core::Sleep & sleep) { this->sleep = &sleep; }
IanBenzMaxim 7:9cd16581b578 185
IanBenzMaxim 7:9cd16581b578 186 void setMaster(Core::I2CMaster & master) { this->master = &master; }
IanBenzMaxim 7:9cd16581b578 187
IanBenzMaxim 7:9cd16581b578 188 uint_least8_t address() const { return address_; }
IanBenzMaxim 7:9cd16581b578 189
IanBenzMaxim 7:9cd16581b578 190 void setAddress(uint_least8_t address) { address_ = address & 0xFE; }
IanBenzMaxim 7:9cd16581b578 191
IanBenzMaxim 7:9cd16581b578 192 /// Initialize hardware for use.
IanBenzMaxim 8:5ea891c7d1a1 193 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 194 initialize(Config config = Config());
IanBenzMaxim 7:9cd16581b578 195
IanBenzMaxim 7:9cd16581b578 196 /// @brief Write a new configuration to the DS2465.
IanBenzMaxim 7:9cd16581b578 197 /// @param[in] config New configuration to write.
IanBenzMaxim 8:5ea891c7d1a1 198 MaximInterfaceDevices_EXPORT Core::Result<void> writeConfig(Config config);
IanBenzMaxim 7:9cd16581b578 199
IanBenzMaxim 7:9cd16581b578 200 /// @brief Write a new port configuration parameter to the DS2465.
IanBenzMaxim 7:9cd16581b578 201 /// @param[in] param Parameter to adjust.
IanBenzMaxim 7:9cd16581b578 202 /// @param[in] val
IanBenzMaxim 7:9cd16581b578 203 /// New parameter value to set. Consult datasheet for value mappings.
IanBenzMaxim 8:5ea891c7d1a1 204 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 205 writePortParameter(PortParameter param, int val);
IanBenzMaxim 7:9cd16581b578 206
IanBenzMaxim 7:9cd16581b578 207 // 1-Wire Master Commands
IanBenzMaxim 7:9cd16581b578 208
IanBenzMaxim 8:5ea891c7d1a1 209 MaximInterfaceDevices_EXPORT virtual Core::Result<void> reset();
IanBenzMaxim 7:9cd16581b578 210
IanBenzMaxim 8:5ea891c7d1a1 211 MaximInterfaceDevices_EXPORT virtual Core::Result<bool>
IanBenzMaxim 8:5ea891c7d1a1 212 touchBitSetLevel(bool sendBit, Level afterLevel);
IanBenzMaxim 7:9cd16581b578 213
IanBenzMaxim 8:5ea891c7d1a1 214 MaximInterfaceDevices_EXPORT virtual Core::Result<uint_least8_t>
IanBenzMaxim 8:5ea891c7d1a1 215 readByteSetLevel(Level afterLevel);
IanBenzMaxim 7:9cd16581b578 216
IanBenzMaxim 8:5ea891c7d1a1 217 MaximInterfaceDevices_EXPORT virtual Core::Result<void>
IanBenzMaxim 7:9cd16581b578 218 writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
IanBenzMaxim 7:9cd16581b578 219
IanBenzMaxim 8:5ea891c7d1a1 220 MaximInterfaceDevices_EXPORT virtual Core::Result<void>
IanBenzMaxim 7:9cd16581b578 221 readBlock(Core::span<uint_least8_t> recvBuf);
IanBenzMaxim 7:9cd16581b578 222
IanBenzMaxim 8:5ea891c7d1a1 223 MaximInterfaceDevices_EXPORT virtual Core::Result<void>
IanBenzMaxim 7:9cd16581b578 224 writeBlock(Core::span<const uint_least8_t> sendBuf);
IanBenzMaxim 7:9cd16581b578 225
IanBenzMaxim 8:5ea891c7d1a1 226 MaximInterfaceDevices_EXPORT virtual Core::Result<void>
IanBenzMaxim 7:9cd16581b578 227 setSpeed(Speed newSpeed);
IanBenzMaxim 7:9cd16581b578 228
IanBenzMaxim 7:9cd16581b578 229 /// @copydoc Core::OneWireMaster::setLevel
IanBenzMaxim 7:9cd16581b578 230 /// @note
IanBenzMaxim 7:9cd16581b578 231 /// The DS2465 only supports enabling strong pullup following a 1-Wire read or
IanBenzMaxim 7:9cd16581b578 232 /// write operation.
IanBenzMaxim 8:5ea891c7d1a1 233 MaximInterfaceDevices_EXPORT virtual Core::Result<void>
IanBenzMaxim 7:9cd16581b578 234 setLevel(Level newLevel);
IanBenzMaxim 7:9cd16581b578 235
IanBenzMaxim 8:5ea891c7d1a1 236 MaximInterfaceDevices_EXPORT virtual Core::Result<TripletData>
IanBenzMaxim 8:5ea891c7d1a1 237 triplet(bool sendBit);
IanBenzMaxim 7:9cd16581b578 238
IanBenzMaxim 7:9cd16581b578 239 // DS2465 Coprocessor Commands
IanBenzMaxim 7:9cd16581b578 240
IanBenzMaxim 7:9cd16581b578 241 /// @brief Read data from an EEPROM memory page.
IanBenzMaxim 7:9cd16581b578 242 /// @param pageNum Page number to read from.
IanBenzMaxim 8:5ea891c7d1a1 243 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 244 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 245 readPage(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 246
IanBenzMaxim 7:9cd16581b578 247 /// @brief Write data to an EEPROM memory page.
IanBenzMaxim 7:9cd16581b578 248 /// @param pageNum Page number to copy to.
IanBenzMaxim 7:9cd16581b578 249 /// @param data Data to write.
IanBenzMaxim 8:5ea891c7d1a1 250 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 251 writePage(int pageNum, Page::const_span data);
IanBenzMaxim 7:9cd16581b578 252
IanBenzMaxim 7:9cd16581b578 253 /// @brief Write data to an EEPROM memory segment.
IanBenzMaxim 7:9cd16581b578 254 /// @param pageNum Page number to copy to.
IanBenzMaxim 7:9cd16581b578 255 /// @param segmentNum Segment number to copy to.
IanBenzMaxim 7:9cd16581b578 256 /// @param data Data to write.
IanBenzMaxim 8:5ea891c7d1a1 257 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 258 writeSegment(int pageNum, int segmentNum, Segment::const_span data);
IanBenzMaxim 7:9cd16581b578 259
IanBenzMaxim 7:9cd16581b578 260 /// Write data to the secret EEPROM memory page.
IanBenzMaxim 8:5ea891c7d1a1 261 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 262 writeMasterSecret(Page::const_span masterSecret);
IanBenzMaxim 7:9cd16581b578 263
IanBenzMaxim 7:9cd16581b578 264 /// @brief Compute Next Master Secret.
IanBenzMaxim 7:9cd16581b578 265 /// @param data Combined data fields for computation.
IanBenzMaxim 8:5ea891c7d1a1 266 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 267 computeNextMasterSecret(AuthenticationData::const_span data);
IanBenzMaxim 7:9cd16581b578 268
IanBenzMaxim 7:9cd16581b578 269 /// @brief Compute Next Master Secret with page swapping.
IanBenzMaxim 7:9cd16581b578 270 /// @param data Combined data fields for computation.
IanBenzMaxim 7:9cd16581b578 271 /// @param pageNum Page number to swap in.
IanBenzMaxim 7:9cd16581b578 272 /// @param region Region of the page to swap in.
IanBenzMaxim 8:5ea891c7d1a1 273 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 274 computeNextMasterSecretWithSwap(AuthenticationData::const_span data,
IanBenzMaxim 7:9cd16581b578 275 int pageNum, PageRegion region);
IanBenzMaxim 7:9cd16581b578 276
IanBenzMaxim 7:9cd16581b578 277 /// @brief Compute Write MAC.
IanBenzMaxim 7:9cd16581b578 278 /// @param data Combined data fields for computation.
IanBenzMaxim 8:5ea891c7d1a1 279 /// @returns Computed Write MAC.
IanBenzMaxim 8:5ea891c7d1a1 280 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 281 computeWriteMac(WriteMacData::const_span data) const;
IanBenzMaxim 7:9cd16581b578 282
IanBenzMaxim 7:9cd16581b578 283 /// @brief Compute Write MAC.
IanBenzMaxim 7:9cd16581b578 284 /// @param data Combined data fields for computation.
IanBenzMaxim 8:5ea891c7d1a1 285 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 286 computeAndTransmitWriteMac(WriteMacData::const_span data);
IanBenzMaxim 7:9cd16581b578 287
IanBenzMaxim 7:9cd16581b578 288 /// @brief Compute Write MAC with page swapping.
IanBenzMaxim 7:9cd16581b578 289 /// @param data Combined data fields for computation.
IanBenzMaxim 7:9cd16581b578 290 /// @param pageNum Page number to swap in.
IanBenzMaxim 7:9cd16581b578 291 /// @param segmentNum Segment number to swap in.
IanBenzMaxim 8:5ea891c7d1a1 292 /// @returns Computed Write MAC.
IanBenzMaxim 8:5ea891c7d1a1 293 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 7:9cd16581b578 294 computeWriteMacWithSwap(WriteMacData::const_span data, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 295 int segmentNum) const;
IanBenzMaxim 7:9cd16581b578 296
IanBenzMaxim 7:9cd16581b578 297 /// @brief Compute Write MAC with page swapping.
IanBenzMaxim 7:9cd16581b578 298 /// @param data Combined data fields for computation.
IanBenzMaxim 7:9cd16581b578 299 /// @param pageNum Page number to swap in.
IanBenzMaxim 7:9cd16581b578 300 /// @param segmentNum Segment number to swap in.
IanBenzMaxim 8:5ea891c7d1a1 301 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 302 computeAndTransmitWriteMacWithSwap(WriteMacData::const_span data, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 303 int segmentNum);
IanBenzMaxim 7:9cd16581b578 304
IanBenzMaxim 7:9cd16581b578 305 /// @brief Compute Slave Secret (S-Secret).
IanBenzMaxim 7:9cd16581b578 306 /// @param data Combined data fields for computation.
IanBenzMaxim 8:5ea891c7d1a1 307 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 308 computeSlaveSecret(AuthenticationData::const_span data);
IanBenzMaxim 7:9cd16581b578 309
IanBenzMaxim 7:9cd16581b578 310 /// @brief Compute Slave Secret (S-Secret) with page swapping.
IanBenzMaxim 7:9cd16581b578 311 /// @param data Combined data fields for computation.
IanBenzMaxim 7:9cd16581b578 312 /// @param pageNum Page number to swap in.
IanBenzMaxim 7:9cd16581b578 313 /// @param region Region of the page to swap in.
IanBenzMaxim 8:5ea891c7d1a1 314 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 315 computeSlaveSecretWithSwap(AuthenticationData::const_span data, int pageNum,
IanBenzMaxim 7:9cd16581b578 316 PageRegion region);
IanBenzMaxim 7:9cd16581b578 317
IanBenzMaxim 7:9cd16581b578 318 /// @brief Compute Authentication MAC.
IanBenzMaxim 7:9cd16581b578 319 /// @param data Combined data fields for computation.
IanBenzMaxim 8:5ea891c7d1a1 320 /// @returns Computed Auth MAC.
IanBenzMaxim 8:5ea891c7d1a1 321 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 322 computeAuthMac(AuthenticationData::const_span data) const;
IanBenzMaxim 7:9cd16581b578 323
IanBenzMaxim 7:9cd16581b578 324 /// @brief Compute Authentication MAC.
IanBenzMaxim 7:9cd16581b578 325 /// @param data Combined data fields for computation.
IanBenzMaxim 8:5ea891c7d1a1 326 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 327 computeAndTransmitAuthMac(AuthenticationData::const_span data);
IanBenzMaxim 7:9cd16581b578 328
IanBenzMaxim 7:9cd16581b578 329 /// @brief Compute Authentication MAC with page swapping.
IanBenzMaxim 7:9cd16581b578 330 /// @param data Combined data fields for computation.
IanBenzMaxim 7:9cd16581b578 331 /// @param pageNum Page number to swap in.
IanBenzMaxim 7:9cd16581b578 332 /// @param region Region of the page to swap in.
IanBenzMaxim 8:5ea891c7d1a1 333 /// @returns Computed Auth MAC.
IanBenzMaxim 8:5ea891c7d1a1 334 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 7:9cd16581b578 335 computeAuthMacWithSwap(AuthenticationData::const_span data, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 336 PageRegion region) const;
IanBenzMaxim 7:9cd16581b578 337
IanBenzMaxim 7:9cd16581b578 338 /// @brief Compute Authentication MAC with page swapping.
IanBenzMaxim 7:9cd16581b578 339 /// @param data Combined data fields for computation.
IanBenzMaxim 7:9cd16581b578 340 /// @param pageNum Page number to swap in.
IanBenzMaxim 7:9cd16581b578 341 /// @param region Region of the page to swap in.
IanBenzMaxim 8:5ea891c7d1a1 342 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 343 computeAndTransmitAuthMacWithSwap(AuthenticationData::const_span data,
IanBenzMaxim 8:5ea891c7d1a1 344 int pageNum, PageRegion region);
IanBenzMaxim 7:9cd16581b578 345
IanBenzMaxim 7:9cd16581b578 346 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 347 errorCategory();
IanBenzMaxim 7:9cd16581b578 348
IanBenzMaxim 7:9cd16581b578 349 private:
IanBenzMaxim 7:9cd16581b578 350 const Core::Sleep * sleep;
IanBenzMaxim 7:9cd16581b578 351 Core::I2CMaster * master;
IanBenzMaxim 7:9cd16581b578 352 uint_least8_t address_;
IanBenzMaxim 7:9cd16581b578 353 Config curConfig;
IanBenzMaxim 7:9cd16581b578 354
IanBenzMaxim 7:9cd16581b578 355 /// @brief Performs a soft reset on the DS2465.
IanBenzMaxim 7:9cd16581b578 356 /// @note This is not a 1-Wire Reset.
IanBenzMaxim 8:5ea891c7d1a1 357 Core::Result<void> resetDevice();
IanBenzMaxim 7:9cd16581b578 358
IanBenzMaxim 7:9cd16581b578 359 /// @brief
IanBenzMaxim 8:5ea891c7d1a1 360 /// Polls the DS2465 status waiting for the 1-Wire Busy bit (1WB) to be cleared.
IanBenzMaxim 8:5ea891c7d1a1 361 /// @returns Status byte or TimeoutError if poll limit reached.
IanBenzMaxim 8:5ea891c7d1a1 362 Core::Result<uint_least8_t> pollBusy() const;
IanBenzMaxim 7:9cd16581b578 363
IanBenzMaxim 7:9cd16581b578 364 /// @brief Ensure that the desired 1-Wire level is set in the configuration.
IanBenzMaxim 7:9cd16581b578 365 /// @param level Desired 1-Wire level.
IanBenzMaxim 8:5ea891c7d1a1 366 Core::Result<void> configureLevel(Level level);
IanBenzMaxim 7:9cd16581b578 367
IanBenzMaxim 7:9cd16581b578 368 /// @note Const since only for internal use.
IanBenzMaxim 8:5ea891c7d1a1 369 Core::Result<void> writeMemory(uint_least8_t addr,
IanBenzMaxim 8:5ea891c7d1a1 370 Core::span<const uint_least8_t> buf) const;
IanBenzMaxim 7:9cd16581b578 371
IanBenzMaxim 7:9cd16581b578 372 /// @brief Read memory from the DS2465.
IanBenzMaxim 7:9cd16581b578 373 /// @param addr Address to begin reading from.
IanBenzMaxim 7:9cd16581b578 374 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 8:5ea891c7d1a1 375 Core::Result<void> readMemory(uint_least8_t addr,
IanBenzMaxim 8:5ea891c7d1a1 376 Core::span<uint_least8_t> buf) const;
IanBenzMaxim 7:9cd16581b578 377
IanBenzMaxim 7:9cd16581b578 378 /// @brief Read memory from the DS2465 at the current pointer.
IanBenzMaxim 7:9cd16581b578 379 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 8:5ea891c7d1a1 380 Core::Result<void> readMemory(Core::span<uint_least8_t> buf) const;
IanBenzMaxim 7:9cd16581b578 381
IanBenzMaxim 7:9cd16581b578 382 /// Write the last computed MAC to the 1-Wire bus.
IanBenzMaxim 8:5ea891c7d1a1 383 Core::Result<void> writeMacBlock();
IanBenzMaxim 7:9cd16581b578 384
IanBenzMaxim 8:5ea891c7d1a1 385 Core::Result<void> doComputeWriteMac(WriteMacData::const_span data) const;
IanBenzMaxim 7:9cd16581b578 386
IanBenzMaxim 8:5ea891c7d1a1 387 Core::Result<void> doComputeWriteMacWithSwap(WriteMacData::const_span data,
IanBenzMaxim 8:5ea891c7d1a1 388 int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 389 int segmentNum) const;
IanBenzMaxim 7:9cd16581b578 390
IanBenzMaxim 8:5ea891c7d1a1 391 Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 392 doComputeAuthMac(AuthenticationData::const_span data) const;
IanBenzMaxim 7:9cd16581b578 393
IanBenzMaxim 8:5ea891c7d1a1 394 Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 395 doComputeAuthMacWithSwap(AuthenticationData::const_span data, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 396 PageRegion region) const;
IanBenzMaxim 7:9cd16581b578 397
IanBenzMaxim 7:9cd16581b578 398 // Legacy implementations
IanBenzMaxim 8:5ea891c7d1a1 399 Core::Result<void> copyScratchpad(bool destSecret, int pageNum, bool notFull,
IanBenzMaxim 8:5ea891c7d1a1 400 int segmentNum);
IanBenzMaxim 8:5ea891c7d1a1 401
IanBenzMaxim 8:5ea891c7d1a1 402 Core::Result<void> computeNextMasterSecret(bool swap, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 403 PageRegion region);
IanBenzMaxim 7:9cd16581b578 404
IanBenzMaxim 8:5ea891c7d1a1 405 Core::Result<void> computeWriteMac(bool regwrite, bool swap, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 406 int segmentNum) const;
IanBenzMaxim 8:5ea891c7d1a1 407
IanBenzMaxim 8:5ea891c7d1a1 408 Core::Result<void> computeSlaveSecret(bool swap, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 409 PageRegion region);
IanBenzMaxim 7:9cd16581b578 410
IanBenzMaxim 8:5ea891c7d1a1 411 Core::Result<void> computeAuthMac(bool swap, int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 412 PageRegion region) const;
IanBenzMaxim 8:5ea891c7d1a1 413 };
IanBenzMaxim 8:5ea891c7d1a1 414
IanBenzMaxim 8:5ea891c7d1a1 415 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 416 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 417
IanBenzMaxim 8:5ea891c7d1a1 418 template <>
IanBenzMaxim 8:5ea891c7d1a1 419 struct is_error_code_enum<MaximInterfaceDevices::DS2465::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 420 : true_type {};
IanBenzMaxim 7:9cd16581b578 421
IanBenzMaxim 8:5ea891c7d1a1 422 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 423 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 424
IanBenzMaxim 7:9cd16581b578 425 inline Core::error_code make_error_code(DS2465::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 426 return Core::error_code(e, DS2465::errorCategory());
IanBenzMaxim 7:9cd16581b578 427 }
IanBenzMaxim 7:9cd16581b578 428
IanBenzMaxim 7:9cd16581b578 429 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 430
IanBenzMaxim 7:9cd16581b578 431 #endif