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/DS28C36_DS2476.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_DS28C36_DS2476_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28C36_DS2476_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <stdint.h>
IanBenzMaxim 8:5ea891c7d1a1 37 #include <utility>
IanBenzMaxim 7:9cd16581b578 38 #include <vector>
IanBenzMaxim 7:9cd16581b578 39 #include <MaximInterfaceCore/Algorithm.hpp>
IanBenzMaxim 7:9cd16581b578 40 #include <MaximInterfaceCore/array_span.hpp>
IanBenzMaxim 7:9cd16581b578 41 #include <MaximInterfaceCore/Ecc256.hpp>
IanBenzMaxim 7:9cd16581b578 42 #include <MaximInterfaceCore/FlagSet.hpp>
IanBenzMaxim 7:9cd16581b578 43 #include <MaximInterfaceCore/I2CMaster.hpp>
IanBenzMaxim 7:9cd16581b578 44 #include <MaximInterfaceCore/ManId.hpp>
IanBenzMaxim 7:9cd16581b578 45 #include <MaximInterfaceCore/RomId.hpp>
IanBenzMaxim 7:9cd16581b578 46 #include <MaximInterfaceCore/Sleep.hpp>
IanBenzMaxim 7:9cd16581b578 47 #include <MaximInterfaceCore/system_error.hpp>
IanBenzMaxim 7:9cd16581b578 48 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 49
IanBenzMaxim 7:9cd16581b578 50 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 51
IanBenzMaxim 7:9cd16581b578 52 /// Interface to the DS28C36 authenticator.
IanBenzMaxim 7:9cd16581b578 53 class DS28C36 {
IanBenzMaxim 7:9cd16581b578 54 public:
IanBenzMaxim 7:9cd16581b578 55 /// Device command results.
IanBenzMaxim 7:9cd16581b578 56 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 57 ProtectionError = 0x55,
IanBenzMaxim 7:9cd16581b578 58 InvalidParameterError = 0x77,
IanBenzMaxim 7:9cd16581b578 59 InvalidSequenceError = 0x33,
IanBenzMaxim 7:9cd16581b578 60 InvalidEcdsaInputOrResultError = 0x22,
IanBenzMaxim 7:9cd16581b578 61 AuthenticationError = 0x100,
IanBenzMaxim 7:9cd16581b578 62 InvalidResponseError = 0x101 ///< Response does not match expected format.
IanBenzMaxim 7:9cd16581b578 63 };
IanBenzMaxim 7:9cd16581b578 64
IanBenzMaxim 7:9cd16581b578 65 /// @name Device memory pages
IanBenzMaxim 7:9cd16581b578 66 /// @{
IanBenzMaxim 7:9cd16581b578 67
IanBenzMaxim 7:9cd16581b578 68 static const int publicKeyAxPage = 16;
IanBenzMaxim 7:9cd16581b578 69 static const int publicKeyAyPage = 17;
IanBenzMaxim 7:9cd16581b578 70 static const int publicKeyBxPage = 18;
IanBenzMaxim 7:9cd16581b578 71 static const int publicKeyByPage = 19;
IanBenzMaxim 7:9cd16581b578 72 static const int publicKeyCxPage = 20;
IanBenzMaxim 7:9cd16581b578 73 static const int publicKeyCyPage = 21;
IanBenzMaxim 7:9cd16581b578 74 static const int privateKeyAPage = 22;
IanBenzMaxim 7:9cd16581b578 75 static const int privateKeyBPage = 23;
IanBenzMaxim 7:9cd16581b578 76 static const int privateKeyCPage = 24;
IanBenzMaxim 7:9cd16581b578 77 static const int secretAPage = 25;
IanBenzMaxim 7:9cd16581b578 78 static const int secretBPage = 26;
IanBenzMaxim 7:9cd16581b578 79 static const int decrementCounterPage = 27;
IanBenzMaxim 7:9cd16581b578 80 static const int romOptionsPage = 28;
IanBenzMaxim 7:9cd16581b578 81 static const int gpioControlPage = 29;
IanBenzMaxim 7:9cd16581b578 82 static const int publicKeySxPage = 30;
IanBenzMaxim 7:9cd16581b578 83 static const int publicKeySyPage = 31;
IanBenzMaxim 7:9cd16581b578 84
IanBenzMaxim 7:9cd16581b578 85 /// @}
IanBenzMaxim 7:9cd16581b578 86
IanBenzMaxim 7:9cd16581b578 87 /// Number of memory pages on the device.
IanBenzMaxim 7:9cd16581b578 88 static const int memoryPages = 32;
IanBenzMaxim 7:9cd16581b578 89
IanBenzMaxim 7:9cd16581b578 90 /// Available keys for ECDSA operations.
IanBenzMaxim 7:9cd16581b578 91 enum KeyNum { KeyNumA = 0, KeyNumB = 1, KeyNumC = 2, KeyNumS = 3 };
IanBenzMaxim 7:9cd16581b578 92
IanBenzMaxim 7:9cd16581b578 93 /// Available secrets for HMAC operations.
IanBenzMaxim 7:9cd16581b578 94 enum SecretNum { SecretNumA = 0, SecretNumB = 1, SecretNumS = 2 };
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 7:9cd16581b578 96 /// Data hash type when verifying an ECDSA signature.
IanBenzMaxim 7:9cd16581b578 97 enum HashType {
IanBenzMaxim 7:9cd16581b578 98 HashInBuffer = 0, ///< Hash is loaded in the buffer.
IanBenzMaxim 7:9cd16581b578 99 DataInBuffer = 1, ///< Compute hash from data loaded in the buffer.
IanBenzMaxim 7:9cd16581b578 100 THASH = 2 ///< Use THASH from Compute Multiblock Hash command.
IanBenzMaxim 7:9cd16581b578 101 };
IanBenzMaxim 7:9cd16581b578 102
IanBenzMaxim 7:9cd16581b578 103 /// Available PIO states when verifying an ECDSA signature.
IanBenzMaxim 7:9cd16581b578 104 enum PioState { Unchanged, Conducting, HighImpedance };
IanBenzMaxim 7:9cd16581b578 105
IanBenzMaxim 7:9cd16581b578 106 /// Holds a device memory page.
IanBenzMaxim 7:9cd16581b578 107 typedef Core::array_span<uint_least8_t, 32> Page;
IanBenzMaxim 7:9cd16581b578 108
IanBenzMaxim 7:9cd16581b578 109 // Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 110 class PageAuthenticationData;
IanBenzMaxim 7:9cd16581b578 111
IanBenzMaxim 7:9cd16581b578 112 // Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 113 class WriteAuthenticationData;
IanBenzMaxim 7:9cd16581b578 114
IanBenzMaxim 7:9cd16581b578 115 // Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 116 class ComputeSecretData;
IanBenzMaxim 7:9cd16581b578 117
IanBenzMaxim 7:9cd16581b578 118 // Format encryption or decryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 119 class EncryptionHmacData;
IanBenzMaxim 7:9cd16581b578 120
IanBenzMaxim 7:9cd16581b578 121 // Access fields in the ROM Options page.
IanBenzMaxim 7:9cd16581b578 122 class RomOptions;
IanBenzMaxim 7:9cd16581b578 123
IanBenzMaxim 7:9cd16581b578 124 // Access fields in the GPIO Control page.
IanBenzMaxim 7:9cd16581b578 125 class GpioControl;
IanBenzMaxim 7:9cd16581b578 126
IanBenzMaxim 7:9cd16581b578 127 /// Page protection types.
IanBenzMaxim 7:9cd16581b578 128 enum PageProtectionType {
IanBenzMaxim 7:9cd16581b578 129 RP = 0x01, ///< Read protection.
IanBenzMaxim 7:9cd16581b578 130 WP = 0x02, ///< Write protection.
IanBenzMaxim 7:9cd16581b578 131 EM = 0x04, ///< EPROM emulation mode.
IanBenzMaxim 7:9cd16581b578 132 APH = 0x08, ///< Authentication write protection HMAC.
IanBenzMaxim 7:9cd16581b578 133 EPH = 0x10, ///< Encryption and authenticated write protection HMAC.
IanBenzMaxim 7:9cd16581b578 134 AUTH = 0x20, ///< Public Key C is set to authority public key.
IanBenzMaxim 7:9cd16581b578 135 ECH = 0x40, ///< Encrypted read and write using shared key from ECDH.
IanBenzMaxim 7:9cd16581b578 136 ECW = 0x80 ///< Authentication write protection ECDSA.
IanBenzMaxim 7:9cd16581b578 137 };
IanBenzMaxim 7:9cd16581b578 138 typedef Core::FlagSet<PageProtectionType, 8> PageProtection;
IanBenzMaxim 7:9cd16581b578 139
IanBenzMaxim 7:9cd16581b578 140 /// Challenge for an encrypted device memory page.
IanBenzMaxim 7:9cd16581b578 141 typedef Core::array_span<uint_least8_t, 8> EncryptionChallenge;
IanBenzMaxim 7:9cd16581b578 142
IanBenzMaxim 7:9cd16581b578 143 DS28C36(Core::Sleep & sleep, Core::I2CMaster & master,
IanBenzMaxim 7:9cd16581b578 144 uint_least8_t address = 0x36)
IanBenzMaxim 7:9cd16581b578 145 : sleep_(&sleep), master(&master), address_(address & 0xFE) {}
IanBenzMaxim 7:9cd16581b578 146
IanBenzMaxim 7:9cd16581b578 147 void setSleep(Core::Sleep & sleep) { sleep_ = &sleep; }
IanBenzMaxim 7:9cd16581b578 148
IanBenzMaxim 7:9cd16581b578 149 void setMaster(Core::I2CMaster & master) { this->master = &master; }
IanBenzMaxim 7:9cd16581b578 150
IanBenzMaxim 7:9cd16581b578 151 uint_least8_t address() const { return address_; }
IanBenzMaxim 7:9cd16581b578 152
IanBenzMaxim 7:9cd16581b578 153 void setAddress(uint_least8_t address) { address_ = address & 0xFE; }
IanBenzMaxim 7:9cd16581b578 154
IanBenzMaxim 7:9cd16581b578 155 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 156 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 157 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 158 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 159 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 160
IanBenzMaxim 7:9cd16581b578 161 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 162 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 163 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 164 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 165 readMemory(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 166
IanBenzMaxim 7:9cd16581b578 167 /// @brief Write the temporary buffer.
IanBenzMaxim 7:9cd16581b578 168 /// @param data Data to write.
IanBenzMaxim 8:5ea891c7d1a1 169 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 170 writeBuffer(Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 171
IanBenzMaxim 7:9cd16581b578 172 /// @brief Read the temporary buffer.
IanBenzMaxim 8:5ea891c7d1a1 173 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 174 MaximInterfaceDevices_EXPORT Core::Result<std::vector<uint_least8_t> >
IanBenzMaxim 8:5ea891c7d1a1 175 readBuffer() const;
IanBenzMaxim 7:9cd16581b578 176
IanBenzMaxim 7:9cd16581b578 177 /// @brief Read the protection settings of a page.
IanBenzMaxim 7:9cd16581b578 178 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 179 /// @returns Protection that was read.
IanBenzMaxim 8:5ea891c7d1a1 180 MaximInterfaceDevices_EXPORT Core::Result<PageProtection>
IanBenzMaxim 8:5ea891c7d1a1 181 readPageProtection(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 182
IanBenzMaxim 7:9cd16581b578 183 /// @brief Set the protection settings of a page.
IanBenzMaxim 7:9cd16581b578 184 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 185 /// @param protection Protection to write.
IanBenzMaxim 8:5ea891c7d1a1 186 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 187 setPageProtection(int pageNum, const PageProtection & protection);
IanBenzMaxim 7:9cd16581b578 188
IanBenzMaxim 7:9cd16581b578 189 /// Decrement the decrement-only counter.
IanBenzMaxim 8:5ea891c7d1a1 190 MaximInterfaceDevices_EXPORT Core::Result<void> decrementCounter();
IanBenzMaxim 7:9cd16581b578 191
IanBenzMaxim 7:9cd16581b578 192 /// @brief Read a block of random data from the RNG.
IanBenzMaxim 7:9cd16581b578 193 /// @param[out] data Random data from RNG with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 194 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 195 readRng(Core::span<uint_least8_t> data) const;
IanBenzMaxim 7:9cd16581b578 196
IanBenzMaxim 7:9cd16581b578 197 /// @brief Read memory with encryption.
IanBenzMaxim 7:9cd16581b578 198 /// @param pageNum Number of page to read from.
IanBenzMaxim 7:9cd16581b578 199 /// @param secretNum Secret to use for encryption.
IanBenzMaxim 8:5ea891c7d1a1 200 /// @returns Encryption challenge and encrypted page data that was read.
IanBenzMaxim 8:5ea891c7d1a1 201 MaximInterfaceDevices_EXPORT
IanBenzMaxim 8:5ea891c7d1a1 202 Core::Result<std::pair<EncryptionChallenge::array, Page::array> >
IanBenzMaxim 8:5ea891c7d1a1 203 encryptedReadMemory(int pageNum, SecretNum secretNum) const;
IanBenzMaxim 7:9cd16581b578 204
IanBenzMaxim 7:9cd16581b578 205 /// @brief Compute and read page authentication with ECDSA.
IanBenzMaxim 7:9cd16581b578 206 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 207 /// @param keyNum
IanBenzMaxim 7:9cd16581b578 208 /// Private key to use for authentication.
IanBenzMaxim 7:9cd16581b578 209 /// Key S cannot be used with this command.
IanBenzMaxim 8:5ea891c7d1a1 210 /// @returns Computed page signature.
IanBenzMaxim 8:5ea891c7d1a1 211 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::Signature::array>
IanBenzMaxim 8:5ea891c7d1a1 212 computeAndReadPageAuthentication(int pageNum, KeyNum keyNum) const;
IanBenzMaxim 7:9cd16581b578 213
IanBenzMaxim 7:9cd16581b578 214 /// @brief Compute and read page authentication with HMAC.
IanBenzMaxim 7:9cd16581b578 215 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 216 /// @param secretNum Secret to use for authentication.
IanBenzMaxim 8:5ea891c7d1a1 217 /// @returns Computed page HMAC.
IanBenzMaxim 8:5ea891c7d1a1 218 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 219 computeAndReadPageAuthentication(int pageNum, SecretNum secretNum) const;
IanBenzMaxim 7:9cd16581b578 220
IanBenzMaxim 7:9cd16581b578 221 /// @brief Write with SHA2 authentication.
IanBenzMaxim 7:9cd16581b578 222 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 223 /// @param secretNum Secret to use for authentication.
IanBenzMaxim 7:9cd16581b578 224 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 225 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 226 authenticatedSha2WriteMemory(int pageNum, SecretNum secretNum,
IanBenzMaxim 7:9cd16581b578 227 Page::const_span page);
IanBenzMaxim 7:9cd16581b578 228
IanBenzMaxim 7:9cd16581b578 229 /// @brief Compute SHA2 secret and optionally lock.
IanBenzMaxim 7:9cd16581b578 230 /// @param pageNum Number of page to use in computation.
IanBenzMaxim 7:9cd16581b578 231 /// @param msecretNum Master secret to use in computation.
IanBenzMaxim 7:9cd16581b578 232 /// @param dsecretNum Destination secret to receive the computation result.
IanBenzMaxim 7:9cd16581b578 233 /// @param writeProtectEnable
IanBenzMaxim 7:9cd16581b578 234 /// True to lock the destination secret against further writes.
IanBenzMaxim 8:5ea891c7d1a1 235 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 236 computeAndLockSha2Secret(int pageNum, SecretNum msecretNum,
IanBenzMaxim 7:9cd16581b578 237 SecretNum dsecretNum, bool writeProtectEnable);
IanBenzMaxim 7:9cd16581b578 238
IanBenzMaxim 7:9cd16581b578 239 /// @brief Generate a new ECDSA key pair.
IanBenzMaxim 7:9cd16581b578 240 /// @param keyNum Key to generate. Key S cannot be used with this command.
IanBenzMaxim 7:9cd16581b578 241 /// @param writeProtectEnable True to lock the key against further writes.
IanBenzMaxim 8:5ea891c7d1a1 242 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 243 generateEcc256KeyPair(KeyNum keyNum, bool writeProtectEnable);
IanBenzMaxim 7:9cd16581b578 244
IanBenzMaxim 7:9cd16581b578 245 /// @brief Compute a hash over multiple blocks.
IanBenzMaxim 7:9cd16581b578 246 /// @param firstBlock True if this is the first block being hashed.
IanBenzMaxim 7:9cd16581b578 247 /// @param lastBlock True if this is the last block being hashed.
IanBenzMaxim 7:9cd16581b578 248 /// @param data
IanBenzMaxim 7:9cd16581b578 249 /// Data block to hash. Should be 64 bytes unless this is the last block.
IanBenzMaxim 8:5ea891c7d1a1 250 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 251 computeMultiblockHash(bool firstBlock, bool lastBlock,
IanBenzMaxim 7:9cd16581b578 252 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 253
IanBenzMaxim 7:9cd16581b578 254 /// @brief Verify ECDSA signature.
IanBenzMaxim 7:9cd16581b578 255 /// @param keyNum Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 256 /// @param hashType Source of the data hash input.
IanBenzMaxim 7:9cd16581b578 257 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 258 /// @param pioa New state of PIOA if verification successful.
IanBenzMaxim 7:9cd16581b578 259 /// @param piob New state of PIOB if verification successful.
IanBenzMaxim 8:5ea891c7d1a1 260 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 261 verifyEcdsaSignature(KeyNum keyNum, HashType hashType,
IanBenzMaxim 7:9cd16581b578 262 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 263 PioState pioa = Unchanged, PioState piob = Unchanged);
IanBenzMaxim 7:9cd16581b578 264
IanBenzMaxim 7:9cd16581b578 265 /// @brief
IanBenzMaxim 7:9cd16581b578 266 /// Authenticate a public key for authenticated writes or encrypted reads
IanBenzMaxim 7:9cd16581b578 267 /// with ECDH.
IanBenzMaxim 7:9cd16581b578 268 /// @param authWrites True to select authentication for writes.
IanBenzMaxim 7:9cd16581b578 269 /// @param ecdh True to select ECDH key exchange.
IanBenzMaxim 7:9cd16581b578 270 /// @param keyNum
IanBenzMaxim 7:9cd16581b578 271 /// Private key to use for ECDH key exchange. Key A or B can be selected.
IanBenzMaxim 7:9cd16581b578 272 /// @param csOffset Certificate customization field ending offset in buffer.
IanBenzMaxim 7:9cd16581b578 273 /// @param signature Signature to use for authentication of public key S.
IanBenzMaxim 8:5ea891c7d1a1 274 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 275 authenticateEcdsaPublicKey(bool authWrites, bool ecdh, KeyNum keyNum,
IanBenzMaxim 7:9cd16581b578 276 int csOffset,
IanBenzMaxim 7:9cd16581b578 277 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 278
IanBenzMaxim 7:9cd16581b578 279 /// @brief Write with ECDSA authentication.
IanBenzMaxim 7:9cd16581b578 280 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 281 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 282 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 283 authenticatedEcdsaWriteMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 284
IanBenzMaxim 7:9cd16581b578 285 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 286 errorCategory();
IanBenzMaxim 7:9cd16581b578 287
IanBenzMaxim 7:9cd16581b578 288 protected:
IanBenzMaxim 7:9cd16581b578 289 // Timing constants.
IanBenzMaxim 7:9cd16581b578 290 static const int generateEcdsaSignatureTimeMs = 50;
IanBenzMaxim 7:9cd16581b578 291 static const int generateEccKeyPairTimeMs = 100;
IanBenzMaxim 7:9cd16581b578 292 static const int verifyEsdsaSignatureOrComputeEcdhTimeMs = 150;
IanBenzMaxim 7:9cd16581b578 293 static const int sha256ComputationTimeMs = 3;
IanBenzMaxim 7:9cd16581b578 294 static const int readMemoryTimeMs = /*1*/ 2;
IanBenzMaxim 7:9cd16581b578 295 static const int writeMemoryTimeMs = 15;
IanBenzMaxim 7:9cd16581b578 296
IanBenzMaxim 8:5ea891c7d1a1 297 Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 298 writeCommand(uint_least8_t command,
IanBenzMaxim 8:5ea891c7d1a1 299 Core::span<const uint_least8_t> parameters) const;
IanBenzMaxim 7:9cd16581b578 300
IanBenzMaxim 8:5ea891c7d1a1 301 Core::Result<void> writeCommand(uint_least8_t command) const {
IanBenzMaxim 7:9cd16581b578 302 return writeCommand(command, Core::span<const uint_least8_t>());
IanBenzMaxim 7:9cd16581b578 303 }
IanBenzMaxim 7:9cd16581b578 304
IanBenzMaxim 8:5ea891c7d1a1 305 Core::Result<Core::span<uint_least8_t>::index_type>
IanBenzMaxim 8:5ea891c7d1a1 306 readVariableLengthResponse(Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 307
IanBenzMaxim 8:5ea891c7d1a1 308 Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 309 readFixedLengthResponse(Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 310
IanBenzMaxim 7:9cd16581b578 311 void sleep(int ms) const { sleep_->invoke(ms); }
IanBenzMaxim 7:9cd16581b578 312
IanBenzMaxim 7:9cd16581b578 313 private:
IanBenzMaxim 7:9cd16581b578 314 enum AuthType {
IanBenzMaxim 7:9cd16581b578 315 HmacWithSecretA = 0,
IanBenzMaxim 7:9cd16581b578 316 HmacWithSecretB = 1,
IanBenzMaxim 7:9cd16581b578 317 HmacWithSecretS = 2,
IanBenzMaxim 7:9cd16581b578 318 EcdsaWithKeyA = 3,
IanBenzMaxim 7:9cd16581b578 319 EcdsaWithKeyB = 4,
IanBenzMaxim 7:9cd16581b578 320 EcdsaWithKeyC = 5
IanBenzMaxim 7:9cd16581b578 321 };
IanBenzMaxim 7:9cd16581b578 322
IanBenzMaxim 8:5ea891c7d1a1 323 Core::Result<void> computeAndReadPageAuthentication(int pageNum,
IanBenzMaxim 8:5ea891c7d1a1 324 AuthType authType) const;
IanBenzMaxim 8:5ea891c7d1a1 325
IanBenzMaxim 7:9cd16581b578 326 const Core::Sleep * sleep_;
IanBenzMaxim 7:9cd16581b578 327 Core::I2CMaster * master;
IanBenzMaxim 7:9cd16581b578 328 uint_least8_t address_;
IanBenzMaxim 7:9cd16581b578 329 };
IanBenzMaxim 7:9cd16581b578 330
IanBenzMaxim 7:9cd16581b578 331 /// Interface to the DS2476 coprocessor.
IanBenzMaxim 7:9cd16581b578 332 class DS2476 : public DS28C36 {
IanBenzMaxim 7:9cd16581b578 333 public:
IanBenzMaxim 7:9cd16581b578 334 DS2476(Core::Sleep & sleep, Core::I2CMaster & master,
IanBenzMaxim 7:9cd16581b578 335 uint_least8_t address = 0x76)
IanBenzMaxim 7:9cd16581b578 336 : DS28C36(sleep, master, address) {}
IanBenzMaxim 7:9cd16581b578 337
IanBenzMaxim 7:9cd16581b578 338 /// @brief Generate ECDSA signature.
IanBenzMaxim 7:9cd16581b578 339 /// @param keyNum
IanBenzMaxim 7:9cd16581b578 340 /// Private key to use to create signature.
IanBenzMaxim 7:9cd16581b578 341 /// Key S cannot be used with this command.
IanBenzMaxim 8:5ea891c7d1a1 342 /// @returns Computed signature.
IanBenzMaxim 8:5ea891c7d1a1 343 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::Signature::array>
IanBenzMaxim 8:5ea891c7d1a1 344 generateEcdsaSignature(KeyNum keyNum) const;
IanBenzMaxim 7:9cd16581b578 345
IanBenzMaxim 7:9cd16581b578 346 /// @brief Compute unique SHA2 secret.
IanBenzMaxim 7:9cd16581b578 347 /// @param msecretNum Master secret to use in computation.
IanBenzMaxim 8:5ea891c7d1a1 348 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 349 computeSha2UniqueSecret(SecretNum msecretNum);
IanBenzMaxim 7:9cd16581b578 350
IanBenzMaxim 7:9cd16581b578 351 /// @brief Compute SHA2 HMAC.
IanBenzMaxim 8:5ea891c7d1a1 352 /// @returns Computed HMAC.
IanBenzMaxim 8:5ea891c7d1a1 353 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 354 computeSha2Hmac() const;
IanBenzMaxim 7:9cd16581b578 355 };
IanBenzMaxim 7:9cd16581b578 356
IanBenzMaxim 8:5ea891c7d1a1 357 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 358 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 359
IanBenzMaxim 8:5ea891c7d1a1 360 template <>
IanBenzMaxim 8:5ea891c7d1a1 361 struct is_error_code_enum<MaximInterfaceDevices::DS28C36::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 362 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 363
IanBenzMaxim 8:5ea891c7d1a1 364 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 365 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 366
IanBenzMaxim 7:9cd16581b578 367 inline Core::error_code make_error_code(DS28C36::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 368 return Core::error_code(e, DS28C36::errorCategory());
IanBenzMaxim 7:9cd16581b578 369 }
IanBenzMaxim 7:9cd16581b578 370
IanBenzMaxim 7:9cd16581b578 371 /// @brief
IanBenzMaxim 7:9cd16581b578 372 /// Hash arbitrary length data with successive Compute Multiblock Hash commands.
IanBenzMaxim 7:9cd16581b578 373 /// @param ds28c36 Device for computation.
IanBenzMaxim 7:9cd16581b578 374 /// @param data Data to hash.
IanBenzMaxim 8:5ea891c7d1a1 375 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 376 computeMultiblockHash(DS28C36 & ds28c36, Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 377
IanBenzMaxim 7:9cd16581b578 378 /// @brief Verify ECDSA signature.
IanBenzMaxim 7:9cd16581b578 379 /// @param ds28c36 Device for computation.
IanBenzMaxim 7:9cd16581b578 380 /// @param publicKey Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 381 /// @param data Data to verify.
IanBenzMaxim 7:9cd16581b578 382 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 383 /// @param pioa New state of PIOA if verification successful.
IanBenzMaxim 7:9cd16581b578 384 /// @param piob New state of PIOB if verification successful.
IanBenzMaxim 8:5ea891c7d1a1 385 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 386 verifyEcdsaSignature(DS28C36 & ds28c36, DS28C36::KeyNum publicKey,
IanBenzMaxim 7:9cd16581b578 387 Core::span<const uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 388 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 389 DS28C36::PioState pioa = DS28C36::Unchanged,
IanBenzMaxim 7:9cd16581b578 390 DS28C36::PioState piob = DS28C36::Unchanged);
IanBenzMaxim 7:9cd16581b578 391
IanBenzMaxim 7:9cd16581b578 392 /// @brief Verify ECDSA signature.
IanBenzMaxim 7:9cd16581b578 393 /// @param ds28c36 Device for computation.
IanBenzMaxim 7:9cd16581b578 394 /// @param publicKey
IanBenzMaxim 7:9cd16581b578 395 /// Public key to use for verification which is loaded into Public Key S.
IanBenzMaxim 7:9cd16581b578 396 /// @param data Data to verify.
IanBenzMaxim 7:9cd16581b578 397 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 398 /// @param pioa New state of PIOA if verification successful.
IanBenzMaxim 7:9cd16581b578 399 /// @param piob New state of PIOB if verification successful.
IanBenzMaxim 8:5ea891c7d1a1 400 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 401 verifyEcdsaSignature(DS28C36 & ds28c36,
IanBenzMaxim 7:9cd16581b578 402 Core::Ecc256::PublicKey::const_span publicKey,
IanBenzMaxim 7:9cd16581b578 403 Core::span<const uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 404 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 405 DS28C36::PioState pioa = DS28C36::Unchanged,
IanBenzMaxim 7:9cd16581b578 406 DS28C36::PioState piob = DS28C36::Unchanged);
IanBenzMaxim 7:9cd16581b578 407
IanBenzMaxim 7:9cd16581b578 408 /// @brief
IanBenzMaxim 7:9cd16581b578 409 /// Enable coprocessor functionality on the DS2476 by writing to the
IanBenzMaxim 7:9cd16581b578 410 /// GPIO Control page.
IanBenzMaxim 8:5ea891c7d1a1 411 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 412 enableCoprocessor(DS2476 & ds2476);
IanBenzMaxim 7:9cd16581b578 413
IanBenzMaxim 7:9cd16581b578 414 /// @brief
IanBenzMaxim 7:9cd16581b578 415 /// Disable blocking of the ROM ID on the DS2476 by writing to the
IanBenzMaxim 7:9cd16581b578 416 /// ROM Options page.
IanBenzMaxim 8:5ea891c7d1a1 417 MaximInterfaceDevices_EXPORT Core::Result<void> enableRomId(DS2476 & ds2476);
IanBenzMaxim 7:9cd16581b578 418
IanBenzMaxim 7:9cd16581b578 419 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 420 class DS28C36::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 421 public:
IanBenzMaxim 7:9cd16581b578 422 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 423 1 + Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 424 Result;
IanBenzMaxim 7:9cd16581b578 425
IanBenzMaxim 7:9cd16581b578 426 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 427
IanBenzMaxim 7:9cd16581b578 428 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 429 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 430
IanBenzMaxim 7:9cd16581b578 431 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 432 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 433 /// @{
IanBenzMaxim 7:9cd16581b578 434
IanBenzMaxim 7:9cd16581b578 435 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 436 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 437 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 438 }
IanBenzMaxim 7:9cd16581b578 439
IanBenzMaxim 7:9cd16581b578 440 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 441 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 442 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 443 }
IanBenzMaxim 7:9cd16581b578 444
IanBenzMaxim 7:9cd16581b578 445 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 446 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 447 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 448 return *this;
IanBenzMaxim 7:9cd16581b578 449 }
IanBenzMaxim 7:9cd16581b578 450
IanBenzMaxim 7:9cd16581b578 451 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 452 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 453
IanBenzMaxim 7:9cd16581b578 454 /// @}
IanBenzMaxim 7:9cd16581b578 455
IanBenzMaxim 7:9cd16581b578 456 /// @name Page
IanBenzMaxim 7:9cd16581b578 457 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 458 /// @{
IanBenzMaxim 7:9cd16581b578 459
IanBenzMaxim 7:9cd16581b578 460 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 461 Page::span page() {
IanBenzMaxim 7:9cd16581b578 462 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 463 }
IanBenzMaxim 7:9cd16581b578 464
IanBenzMaxim 7:9cd16581b578 465 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 466 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 467 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 468 }
IanBenzMaxim 7:9cd16581b578 469
IanBenzMaxim 7:9cd16581b578 470 /// Set page.
IanBenzMaxim 7:9cd16581b578 471 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 472 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 473 return *this;
IanBenzMaxim 7:9cd16581b578 474 }
IanBenzMaxim 7:9cd16581b578 475
IanBenzMaxim 7:9cd16581b578 476 /// @}
IanBenzMaxim 7:9cd16581b578 477
IanBenzMaxim 7:9cd16581b578 478 /// @name Challenge
IanBenzMaxim 7:9cd16581b578 479 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 480 /// @{
IanBenzMaxim 7:9cd16581b578 481
IanBenzMaxim 7:9cd16581b578 482 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 483 Page::span challenge() {
IanBenzMaxim 7:9cd16581b578 484 return make_span(result_).subspan<challengeIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 485 }
IanBenzMaxim 7:9cd16581b578 486
IanBenzMaxim 7:9cd16581b578 487 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 488 Page::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 489 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 490 }
IanBenzMaxim 7:9cd16581b578 491
IanBenzMaxim 7:9cd16581b578 492 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 493 PageAuthenticationData & setChallenge(Page::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 494 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 495 return *this;
IanBenzMaxim 7:9cd16581b578 496 }
IanBenzMaxim 7:9cd16581b578 497
IanBenzMaxim 7:9cd16581b578 498 /// @}
IanBenzMaxim 7:9cd16581b578 499
IanBenzMaxim 7:9cd16581b578 500 /// @name Page number
IanBenzMaxim 7:9cd16581b578 501 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 502 /// @{
IanBenzMaxim 7:9cd16581b578 503
IanBenzMaxim 7:9cd16581b578 504 /// Get page number.
IanBenzMaxim 7:9cd16581b578 505 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 506
IanBenzMaxim 7:9cd16581b578 507 /// Set page number.
IanBenzMaxim 7:9cd16581b578 508 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 509 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 510 return *this;
IanBenzMaxim 7:9cd16581b578 511 }
IanBenzMaxim 7:9cd16581b578 512
IanBenzMaxim 7:9cd16581b578 513 /// @}
IanBenzMaxim 7:9cd16581b578 514
IanBenzMaxim 7:9cd16581b578 515 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 516 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 517 /// @{
IanBenzMaxim 7:9cd16581b578 518
IanBenzMaxim 7:9cd16581b578 519 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 520 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 521 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 522 }
IanBenzMaxim 7:9cd16581b578 523
IanBenzMaxim 7:9cd16581b578 524 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 525 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 526 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 527 }
IanBenzMaxim 7:9cd16581b578 528
IanBenzMaxim 7:9cd16581b578 529 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 530 PageAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 531 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 532 return *this;
IanBenzMaxim 7:9cd16581b578 533 }
IanBenzMaxim 7:9cd16581b578 534
IanBenzMaxim 7:9cd16581b578 535 /// @}
IanBenzMaxim 7:9cd16581b578 536
IanBenzMaxim 7:9cd16581b578 537 private:
IanBenzMaxim 8:5ea891c7d1a1 538 static const size_t romIdIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 539 static const size_t pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 540 static const size_t challengeIdx = pageIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 541 static const size_t pageNumIdx = challengeIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 542 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 543
IanBenzMaxim 7:9cd16581b578 544 Result::array result_;
IanBenzMaxim 7:9cd16581b578 545 };
IanBenzMaxim 7:9cd16581b578 546
IanBenzMaxim 7:9cd16581b578 547 /// Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 548 class DS28C36::WriteAuthenticationData {
IanBenzMaxim 7:9cd16581b578 549 public:
IanBenzMaxim 7:9cd16581b578 550 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 551
IanBenzMaxim 7:9cd16581b578 552 WriteAuthenticationData() : data() {}
IanBenzMaxim 7:9cd16581b578 553
IanBenzMaxim 7:9cd16581b578 554 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 555 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 556
IanBenzMaxim 7:9cd16581b578 557 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 558 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 559 /// @{
IanBenzMaxim 7:9cd16581b578 560
IanBenzMaxim 7:9cd16581b578 561 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 562 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 563
IanBenzMaxim 7:9cd16581b578 564 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 565 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 566
IanBenzMaxim 7:9cd16581b578 567 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 568 WriteAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 569 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 570 return *this;
IanBenzMaxim 7:9cd16581b578 571 }
IanBenzMaxim 7:9cd16581b578 572
IanBenzMaxim 7:9cd16581b578 573 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 574 WriteAuthenticationData & setAnonymousRomId() {
IanBenzMaxim 7:9cd16581b578 575 data.setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 576 return *this;
IanBenzMaxim 7:9cd16581b578 577 }
IanBenzMaxim 7:9cd16581b578 578
IanBenzMaxim 7:9cd16581b578 579 /// @}
IanBenzMaxim 7:9cd16581b578 580
IanBenzMaxim 7:9cd16581b578 581 /// @name Old page
IanBenzMaxim 7:9cd16581b578 582 /// @brief Existing data contained in the page.
IanBenzMaxim 7:9cd16581b578 583 /// @{
IanBenzMaxim 7:9cd16581b578 584
IanBenzMaxim 7:9cd16581b578 585 /// Get mutable old page.
IanBenzMaxim 7:9cd16581b578 586 Page::span oldPage() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 587
IanBenzMaxim 7:9cd16581b578 588 /// Get immutable old page.
IanBenzMaxim 7:9cd16581b578 589 Page::const_span oldPage() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 590
IanBenzMaxim 7:9cd16581b578 591 /// Set old page.
IanBenzMaxim 7:9cd16581b578 592 WriteAuthenticationData & setOldPage(Page::const_span oldPage) {
IanBenzMaxim 7:9cd16581b578 593 data.setPage(oldPage);
IanBenzMaxim 7:9cd16581b578 594 return *this;
IanBenzMaxim 7:9cd16581b578 595 }
IanBenzMaxim 7:9cd16581b578 596
IanBenzMaxim 7:9cd16581b578 597 /// @}
IanBenzMaxim 7:9cd16581b578 598
IanBenzMaxim 7:9cd16581b578 599 /// @name New page
IanBenzMaxim 7:9cd16581b578 600 /// @brief New data to write to the page.
IanBenzMaxim 7:9cd16581b578 601 /// @{
IanBenzMaxim 7:9cd16581b578 602
IanBenzMaxim 7:9cd16581b578 603 /// Get mutable new page.
IanBenzMaxim 7:9cd16581b578 604 Page::span newPage() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 605
IanBenzMaxim 7:9cd16581b578 606 /// Get immutable new page.
IanBenzMaxim 7:9cd16581b578 607 Page::const_span newPage() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 608
IanBenzMaxim 7:9cd16581b578 609 /// Set new page.
IanBenzMaxim 7:9cd16581b578 610 WriteAuthenticationData & setNewPage(Page::const_span newPage) {
IanBenzMaxim 7:9cd16581b578 611 data.setChallenge(newPage);
IanBenzMaxim 7:9cd16581b578 612 return *this;
IanBenzMaxim 7:9cd16581b578 613 }
IanBenzMaxim 7:9cd16581b578 614
IanBenzMaxim 7:9cd16581b578 615 /// @}
IanBenzMaxim 7:9cd16581b578 616
IanBenzMaxim 7:9cd16581b578 617 /// @name Page number
IanBenzMaxim 7:9cd16581b578 618 /// @brief Page number for write operation.
IanBenzMaxim 7:9cd16581b578 619 /// @{
IanBenzMaxim 7:9cd16581b578 620
IanBenzMaxim 7:9cd16581b578 621 /// Get page number.
IanBenzMaxim 7:9cd16581b578 622 int pageNum() const { return data.pageNum(); }
IanBenzMaxim 7:9cd16581b578 623
IanBenzMaxim 7:9cd16581b578 624 /// Set page number.
IanBenzMaxim 7:9cd16581b578 625 WriteAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 626 data.setPageNum(pageNum);
IanBenzMaxim 7:9cd16581b578 627 return *this;
IanBenzMaxim 7:9cd16581b578 628 }
IanBenzMaxim 7:9cd16581b578 629
IanBenzMaxim 7:9cd16581b578 630 /// @}
IanBenzMaxim 7:9cd16581b578 631
IanBenzMaxim 7:9cd16581b578 632 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 633 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 634 /// @{
IanBenzMaxim 7:9cd16581b578 635
IanBenzMaxim 7:9cd16581b578 636 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 637 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 638
IanBenzMaxim 7:9cd16581b578 639 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 640 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 641
IanBenzMaxim 7:9cd16581b578 642 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 643 WriteAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 644 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 645 return *this;
IanBenzMaxim 7:9cd16581b578 646 }
IanBenzMaxim 7:9cd16581b578 647
IanBenzMaxim 7:9cd16581b578 648 /// @}
IanBenzMaxim 7:9cd16581b578 649
IanBenzMaxim 7:9cd16581b578 650 private:
IanBenzMaxim 7:9cd16581b578 651 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 652 };
IanBenzMaxim 7:9cd16581b578 653
IanBenzMaxim 7:9cd16581b578 654 /// Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 655 class DS28C36::ComputeSecretData {
IanBenzMaxim 7:9cd16581b578 656 public:
IanBenzMaxim 7:9cd16581b578 657 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 658
IanBenzMaxim 7:9cd16581b578 659 ComputeSecretData() : data() {}
IanBenzMaxim 7:9cd16581b578 660
IanBenzMaxim 7:9cd16581b578 661 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 662 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 663
IanBenzMaxim 7:9cd16581b578 664 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 665 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 666 /// @{
IanBenzMaxim 7:9cd16581b578 667
IanBenzMaxim 7:9cd16581b578 668 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 669 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 670
IanBenzMaxim 7:9cd16581b578 671 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 672 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 673
IanBenzMaxim 7:9cd16581b578 674 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 675 ComputeSecretData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 676 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 677 return *this;
IanBenzMaxim 7:9cd16581b578 678 }
IanBenzMaxim 7:9cd16581b578 679
IanBenzMaxim 7:9cd16581b578 680 /// @}
IanBenzMaxim 7:9cd16581b578 681
IanBenzMaxim 7:9cd16581b578 682 /// @name Binding Data
IanBenzMaxim 7:9cd16581b578 683 /// @brief Binding Data contained in the selected page.
IanBenzMaxim 7:9cd16581b578 684 /// @{
IanBenzMaxim 7:9cd16581b578 685
IanBenzMaxim 7:9cd16581b578 686 /// Get mutable Binding Data.
IanBenzMaxim 7:9cd16581b578 687 Page::span bindingData() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 688
IanBenzMaxim 7:9cd16581b578 689 /// Get immutable Binding Data.
IanBenzMaxim 7:9cd16581b578 690 Page::const_span bindingData() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 691
IanBenzMaxim 7:9cd16581b578 692 /// Set Binding Data.
IanBenzMaxim 7:9cd16581b578 693 ComputeSecretData & setBindingData(Page::const_span bindingData) {
IanBenzMaxim 7:9cd16581b578 694 data.setPage(bindingData);
IanBenzMaxim 7:9cd16581b578 695 return *this;
IanBenzMaxim 7:9cd16581b578 696 }
IanBenzMaxim 7:9cd16581b578 697
IanBenzMaxim 7:9cd16581b578 698 /// @}
IanBenzMaxim 7:9cd16581b578 699
IanBenzMaxim 7:9cd16581b578 700 /// @name Partial Secret
IanBenzMaxim 7:9cd16581b578 701 /// @brief Partial Secret used for customization.
IanBenzMaxim 7:9cd16581b578 702 /// @{
IanBenzMaxim 7:9cd16581b578 703
IanBenzMaxim 7:9cd16581b578 704 /// Get mutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 705 Page::span partialSecret() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 706
IanBenzMaxim 7:9cd16581b578 707 /// Get immutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 708 Page::const_span partialSecret() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 709
IanBenzMaxim 7:9cd16581b578 710 /// Set Partial Secret.
IanBenzMaxim 7:9cd16581b578 711 ComputeSecretData & setPartialSecret(Page::const_span partialSecret) {
IanBenzMaxim 7:9cd16581b578 712 data.setChallenge(partialSecret);
IanBenzMaxim 7:9cd16581b578 713 return *this;
IanBenzMaxim 7:9cd16581b578 714 }
IanBenzMaxim 7:9cd16581b578 715
IanBenzMaxim 7:9cd16581b578 716 /// @}
IanBenzMaxim 7:9cd16581b578 717
IanBenzMaxim 7:9cd16581b578 718 /// @name Page number
IanBenzMaxim 7:9cd16581b578 719 /// @brief Page number for Binding Data.
IanBenzMaxim 7:9cd16581b578 720 /// @{
IanBenzMaxim 7:9cd16581b578 721
IanBenzMaxim 7:9cd16581b578 722 /// Get page number.
IanBenzMaxim 7:9cd16581b578 723 int pageNum() const { return data.pageNum(); }
IanBenzMaxim 7:9cd16581b578 724
IanBenzMaxim 7:9cd16581b578 725 /// Set page number.
IanBenzMaxim 7:9cd16581b578 726 ComputeSecretData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 727 data.setPageNum(pageNum);
IanBenzMaxim 7:9cd16581b578 728 return *this;
IanBenzMaxim 7:9cd16581b578 729 }
IanBenzMaxim 7:9cd16581b578 730
IanBenzMaxim 7:9cd16581b578 731 /// @}
IanBenzMaxim 7:9cd16581b578 732
IanBenzMaxim 7:9cd16581b578 733 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 734 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 735 /// @{
IanBenzMaxim 7:9cd16581b578 736
IanBenzMaxim 7:9cd16581b578 737 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 738 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 739
IanBenzMaxim 7:9cd16581b578 740 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 741 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 742
IanBenzMaxim 7:9cd16581b578 743 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 744 ComputeSecretData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 745 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 746 return *this;
IanBenzMaxim 7:9cd16581b578 747 }
IanBenzMaxim 7:9cd16581b578 748
IanBenzMaxim 7:9cd16581b578 749 /// @}
IanBenzMaxim 7:9cd16581b578 750
IanBenzMaxim 7:9cd16581b578 751 private:
IanBenzMaxim 7:9cd16581b578 752 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 753 };
IanBenzMaxim 7:9cd16581b578 754
IanBenzMaxim 7:9cd16581b578 755 /// Format encryption or decryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 756 class DS28C36::EncryptionHmacData {
IanBenzMaxim 7:9cd16581b578 757 public:
IanBenzMaxim 7:9cd16581b578 758 typedef Core::array_span<uint_least8_t, EncryptionChallenge::size +
IanBenzMaxim 7:9cd16581b578 759 Core::RomId::size + 1 +
IanBenzMaxim 7:9cd16581b578 760 Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 761 Result;
IanBenzMaxim 7:9cd16581b578 762
IanBenzMaxim 7:9cd16581b578 763 EncryptionHmacData() : result_() {}
IanBenzMaxim 7:9cd16581b578 764
IanBenzMaxim 7:9cd16581b578 765 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 766 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 767
IanBenzMaxim 7:9cd16581b578 768 /// @name Encryption Challenge
IanBenzMaxim 7:9cd16581b578 769 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 770 /// @{
IanBenzMaxim 7:9cd16581b578 771
IanBenzMaxim 7:9cd16581b578 772 /// Get mutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 773 EncryptionChallenge::span encryptionChallenge() {
IanBenzMaxim 7:9cd16581b578 774 return make_span(result_)
IanBenzMaxim 7:9cd16581b578 775 .subspan<encryptionChallengeIdx, EncryptionChallenge::size>();
IanBenzMaxim 7:9cd16581b578 776 }
IanBenzMaxim 7:9cd16581b578 777
IanBenzMaxim 7:9cd16581b578 778 /// Get immutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 779 EncryptionChallenge::const_span encryptionChallenge() const {
IanBenzMaxim 7:9cd16581b578 780 return const_cast<EncryptionHmacData &>(*this).encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 781 }
IanBenzMaxim 7:9cd16581b578 782
IanBenzMaxim 7:9cd16581b578 783 /// Set Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 784 EncryptionHmacData &
IanBenzMaxim 7:9cd16581b578 785 setEncryptionChallenge(EncryptionChallenge::const_span encryptionChallenge) {
IanBenzMaxim 7:9cd16581b578 786 copy(encryptionChallenge, this->encryptionChallenge());
IanBenzMaxim 7:9cd16581b578 787 return *this;
IanBenzMaxim 7:9cd16581b578 788 }
IanBenzMaxim 7:9cd16581b578 789
IanBenzMaxim 7:9cd16581b578 790 /// @}
IanBenzMaxim 7:9cd16581b578 791
IanBenzMaxim 7:9cd16581b578 792 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 793 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 794 /// @{
IanBenzMaxim 7:9cd16581b578 795
IanBenzMaxim 7:9cd16581b578 796 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 797 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 798 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 799 }
IanBenzMaxim 7:9cd16581b578 800
IanBenzMaxim 7:9cd16581b578 801 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 802 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 803 return const_cast<EncryptionHmacData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 804 }
IanBenzMaxim 7:9cd16581b578 805
IanBenzMaxim 7:9cd16581b578 806 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 807 EncryptionHmacData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 808 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 809 return *this;
IanBenzMaxim 7:9cd16581b578 810 }
IanBenzMaxim 7:9cd16581b578 811
IanBenzMaxim 7:9cd16581b578 812 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 813 MaximInterfaceDevices_EXPORT EncryptionHmacData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 814
IanBenzMaxim 7:9cd16581b578 815 /// @}
IanBenzMaxim 7:9cd16581b578 816
IanBenzMaxim 7:9cd16581b578 817 /// @name Page number
IanBenzMaxim 7:9cd16581b578 818 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 819 /// @{
IanBenzMaxim 7:9cd16581b578 820
IanBenzMaxim 7:9cd16581b578 821 /// Get page number.
IanBenzMaxim 7:9cd16581b578 822 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 823
IanBenzMaxim 7:9cd16581b578 824 /// Set page number.
IanBenzMaxim 7:9cd16581b578 825 EncryptionHmacData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 826 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 827 return *this;
IanBenzMaxim 7:9cd16581b578 828 }
IanBenzMaxim 7:9cd16581b578 829
IanBenzMaxim 7:9cd16581b578 830 /// @}
IanBenzMaxim 7:9cd16581b578 831
IanBenzMaxim 7:9cd16581b578 832 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 833 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 834 /// @{
IanBenzMaxim 7:9cd16581b578 835
IanBenzMaxim 7:9cd16581b578 836 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 837 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 838 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 839 }
IanBenzMaxim 7:9cd16581b578 840
IanBenzMaxim 7:9cd16581b578 841 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 842 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 843 return const_cast<EncryptionHmacData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 844 }
IanBenzMaxim 7:9cd16581b578 845
IanBenzMaxim 7:9cd16581b578 846 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 847 EncryptionHmacData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 848 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 849 return *this;
IanBenzMaxim 7:9cd16581b578 850 }
IanBenzMaxim 7:9cd16581b578 851
IanBenzMaxim 7:9cd16581b578 852 /// @}
IanBenzMaxim 7:9cd16581b578 853
IanBenzMaxim 7:9cd16581b578 854 private:
IanBenzMaxim 8:5ea891c7d1a1 855 static const size_t encryptionChallengeIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 856 static const size_t romIdIdx =
IanBenzMaxim 7:9cd16581b578 857 encryptionChallengeIdx + EncryptionChallenge::size;
IanBenzMaxim 8:5ea891c7d1a1 858 static const size_t pageNumIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 859 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 860
IanBenzMaxim 7:9cd16581b578 861 Result::array result_;
IanBenzMaxim 7:9cd16581b578 862 };
IanBenzMaxim 7:9cd16581b578 863
IanBenzMaxim 7:9cd16581b578 864 /// Access fields in the ROM Options page.
IanBenzMaxim 7:9cd16581b578 865 class DS28C36::RomOptions {
IanBenzMaxim 7:9cd16581b578 866 public:
IanBenzMaxim 7:9cd16581b578 867 explicit RomOptions(Page::span page) : page(page) {}
IanBenzMaxim 7:9cd16581b578 868
IanBenzMaxim 7:9cd16581b578 869 bool romBlockDisable() const {
IanBenzMaxim 7:9cd16581b578 870 return page[romBlockDisableIdx] == enabledValue;
IanBenzMaxim 7:9cd16581b578 871 }
IanBenzMaxim 7:9cd16581b578 872
IanBenzMaxim 7:9cd16581b578 873 RomOptions & setRomBlockDisable(bool romBlockDisable) {
IanBenzMaxim 7:9cd16581b578 874 page[romBlockDisableIdx] = (romBlockDisable ? enabledValue : 0);
IanBenzMaxim 7:9cd16581b578 875 return *this;
IanBenzMaxim 7:9cd16581b578 876 }
IanBenzMaxim 7:9cd16581b578 877
IanBenzMaxim 7:9cd16581b578 878 bool anonymous() const { return page[anonymousIdx] == enabledValue; }
IanBenzMaxim 7:9cd16581b578 879
IanBenzMaxim 7:9cd16581b578 880 RomOptions & setAnonymous(bool anonymous) {
IanBenzMaxim 7:9cd16581b578 881 page[anonymousIdx] = (anonymous ? enabledValue : 0);
IanBenzMaxim 7:9cd16581b578 882 return *this;
IanBenzMaxim 7:9cd16581b578 883 }
IanBenzMaxim 7:9cd16581b578 884
IanBenzMaxim 7:9cd16581b578 885 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 886 return page.subspan<22, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 887 }
IanBenzMaxim 7:9cd16581b578 888
IanBenzMaxim 7:9cd16581b578 889 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 890 return page.subspan<24, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 891 }
IanBenzMaxim 7:9cd16581b578 892
IanBenzMaxim 7:9cd16581b578 893 private:
IanBenzMaxim 7:9cd16581b578 894 static const Page::span::index_type romBlockDisableIdx = 0;
IanBenzMaxim 7:9cd16581b578 895 static const Page::span::index_type anonymousIdx = 1;
IanBenzMaxim 7:9cd16581b578 896 static const Page::span::value_type enabledValue = 0xAA;
IanBenzMaxim 7:9cd16581b578 897
IanBenzMaxim 7:9cd16581b578 898 Page::span page;
IanBenzMaxim 7:9cd16581b578 899 };
IanBenzMaxim 7:9cd16581b578 900
IanBenzMaxim 7:9cd16581b578 901 /// Access fields in the GPIO Control page.
IanBenzMaxim 7:9cd16581b578 902 class DS28C36::GpioControl {
IanBenzMaxim 7:9cd16581b578 903 public:
IanBenzMaxim 7:9cd16581b578 904 explicit GpioControl(Page::span page) : page(page) {}
IanBenzMaxim 7:9cd16581b578 905
IanBenzMaxim 7:9cd16581b578 906 bool pioaConducting() const {
IanBenzMaxim 7:9cd16581b578 907 return page[pioaConductingIdx] == pioConductingValue;
IanBenzMaxim 7:9cd16581b578 908 }
IanBenzMaxim 7:9cd16581b578 909
IanBenzMaxim 7:9cd16581b578 910 GpioControl & setPioaConducting(bool pioaConducting) {
IanBenzMaxim 7:9cd16581b578 911 page[pioaConductingIdx] = (pioaConducting ? pioConductingValue : 0x55);
IanBenzMaxim 7:9cd16581b578 912 return *this;
IanBenzMaxim 7:9cd16581b578 913 }
IanBenzMaxim 7:9cd16581b578 914
IanBenzMaxim 7:9cd16581b578 915 bool piobConducting() const {
IanBenzMaxim 7:9cd16581b578 916 return page[piobConductingIdx] == pioConductingValue;
IanBenzMaxim 7:9cd16581b578 917 }
IanBenzMaxim 7:9cd16581b578 918
IanBenzMaxim 7:9cd16581b578 919 GpioControl & setPiobConducting(bool piobConducting) {
IanBenzMaxim 7:9cd16581b578 920 page[piobConductingIdx] = (piobConducting ? pioConductingValue : 0x55);
IanBenzMaxim 7:9cd16581b578 921 return *this;
IanBenzMaxim 7:9cd16581b578 922 }
IanBenzMaxim 7:9cd16581b578 923
IanBenzMaxim 7:9cd16581b578 924 bool pioaLevel() const { return page[2] == pioLevelValue; }
IanBenzMaxim 7:9cd16581b578 925
IanBenzMaxim 7:9cd16581b578 926 bool piobLevel() const { return page[3] == pioLevelValue; }
IanBenzMaxim 7:9cd16581b578 927
IanBenzMaxim 7:9cd16581b578 928 private:
IanBenzMaxim 7:9cd16581b578 929 static const Page::span::index_type pioaConductingIdx = 0;
IanBenzMaxim 7:9cd16581b578 930 static const Page::span::index_type piobConductingIdx = 1;
IanBenzMaxim 7:9cd16581b578 931 static const Page::span::value_type pioConductingValue = 0xAA;
IanBenzMaxim 7:9cd16581b578 932 static const Page::span::value_type pioLevelValue = 0x55;
IanBenzMaxim 7:9cd16581b578 933
IanBenzMaxim 7:9cd16581b578 934 Page::span page;
IanBenzMaxim 7:9cd16581b578 935 };
IanBenzMaxim 7:9cd16581b578 936
IanBenzMaxim 7:9cd16581b578 937 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 938
IanBenzMaxim 7:9cd16581b578 939 #endif