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/DS28E83_DS28E84.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_DS28E83_DS28E84_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28E83_DS28E84_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <stdint.h>
IanBenzMaxim 8:5ea891c7d1a1 37 #include <utility>
IanBenzMaxim 7:9cd16581b578 38 #include <MaximInterfaceCore/Algorithm.hpp>
IanBenzMaxim 7:9cd16581b578 39 #include <MaximInterfaceCore/array_span.hpp>
IanBenzMaxim 7:9cd16581b578 40 #include <MaximInterfaceCore/Ecc256.hpp>
IanBenzMaxim 7:9cd16581b578 41 #include <MaximInterfaceCore/FlagSet.hpp>
IanBenzMaxim 7:9cd16581b578 42 #include <MaximInterfaceCore/ManId.hpp>
IanBenzMaxim 7:9cd16581b578 43 #include <MaximInterfaceCore/Optional.hpp>
IanBenzMaxim 7:9cd16581b578 44 #include <MaximInterfaceCore/RomId.hpp>
IanBenzMaxim 7:9cd16581b578 45 #include <MaximInterfaceCore/RunCommand.hpp>
IanBenzMaxim 7:9cd16581b578 46 #include <MaximInterfaceCore/system_error.hpp>
IanBenzMaxim 7:9cd16581b578 47 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 48
IanBenzMaxim 7:9cd16581b578 49 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 50
IanBenzMaxim 7:9cd16581b578 51 class DS28E83_DS28E84 {
IanBenzMaxim 7:9cd16581b578 52 public:
IanBenzMaxim 7:9cd16581b578 53 /// Device command results.
IanBenzMaxim 7:9cd16581b578 54 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 55 InternalError = 0x22,
IanBenzMaxim 7:9cd16581b578 56 InvalidSequenceError = 0x33,
IanBenzMaxim 7:9cd16581b578 57 InvalidOperationError = 0x55,
IanBenzMaxim 7:9cd16581b578 58 InvalidParameterError = 0x77,
IanBenzMaxim 7:9cd16581b578 59 DeviceDisabledError = 0x88,
IanBenzMaxim 12:7eb41621ba22 60 EntropyHealthTestError = 0xDD,
IanBenzMaxim 7:9cd16581b578 61 AuthenticationError = 0x100,
IanBenzMaxim 7:9cd16581b578 62 InvalidResponseError ///< Command 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 = 28;
IanBenzMaxim 7:9cd16581b578 69 static const int publicKeyAyPage = 29;
IanBenzMaxim 7:9cd16581b578 70 static const int publicKeyBxPage = 30;
IanBenzMaxim 7:9cd16581b578 71 static const int publicKeyByPage = 31;
IanBenzMaxim 7:9cd16581b578 72 static const int authorityPublicKeyAxPage = 32;
IanBenzMaxim 7:9cd16581b578 73 static const int authorityPublicKeyAyPage = 33;
IanBenzMaxim 7:9cd16581b578 74 static const int authorityPublicKeyBxPage = 34;
IanBenzMaxim 7:9cd16581b578 75 static const int authorityPublicKeyByPage = 35;
IanBenzMaxim 7:9cd16581b578 76 static const int privateKeyAPage = 36;
IanBenzMaxim 7:9cd16581b578 77 static const int privateKeyBPage = 37;
IanBenzMaxim 7:9cd16581b578 78 static const int secretAPage = 38;
IanBenzMaxim 7:9cd16581b578 79 static const int secretBPage = 39;
IanBenzMaxim 7:9cd16581b578 80 static const int romOptionsPage = 40;
IanBenzMaxim 7:9cd16581b578 81 static const int gpioControlPage = 41;
IanBenzMaxim 7:9cd16581b578 82 static const int publicKeySxPage = 42;
IanBenzMaxim 7:9cd16581b578 83 static const int publicKeySyPage = 43;
IanBenzMaxim 7:9cd16581b578 84
IanBenzMaxim 7:9cd16581b578 85 /// @}
IanBenzMaxim 7:9cd16581b578 86
IanBenzMaxim 7:9cd16581b578 87 /// Key or secret to use for operation.
IanBenzMaxim 7:9cd16581b578 88 enum KeySecret { KeySecretA = 0, KeySecretB = 1, KeySecretS = 2 };
IanBenzMaxim 7:9cd16581b578 89
IanBenzMaxim 7:9cd16581b578 90 /// Available PIO states when verifying an ECDSA signature.
IanBenzMaxim 7:9cd16581b578 91 enum GpioState { Unchanged, Conducting, HighImpedance };
IanBenzMaxim 7:9cd16581b578 92
IanBenzMaxim 7:9cd16581b578 93 /// Holds a device memory page.
IanBenzMaxim 7:9cd16581b578 94 typedef Core::array_span<uint_least8_t, 32> Page;
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 7:9cd16581b578 96 /// Challenge for an encrypted device memory page.
IanBenzMaxim 7:9cd16581b578 97 typedef Core::array_span<uint_least8_t, 8> EncryptionChallenge;
IanBenzMaxim 7:9cd16581b578 98
IanBenzMaxim 7:9cd16581b578 99 // Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 100 class PageAuthenticationData;
IanBenzMaxim 7:9cd16581b578 101
IanBenzMaxim 7:9cd16581b578 102 // Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 103 class WriteAuthenticationData;
IanBenzMaxim 7:9cd16581b578 104
IanBenzMaxim 7:9cd16581b578 105 // Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 106 class ComputeSecretData;
IanBenzMaxim 7:9cd16581b578 107
IanBenzMaxim 7:9cd16581b578 108 // Format decryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 109 class DecryptionHmacData;
IanBenzMaxim 7:9cd16581b578 110
IanBenzMaxim 7:9cd16581b578 111 // Format encryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 112 class EncryptionHmacData;
IanBenzMaxim 7:9cd16581b578 113
IanBenzMaxim 7:9cd16581b578 114 // Access fields in the ROM Options page.
IanBenzMaxim 7:9cd16581b578 115 class RomOptions;
IanBenzMaxim 7:9cd16581b578 116
IanBenzMaxim 7:9cd16581b578 117 // Access fields in the GPIO Control page.
IanBenzMaxim 7:9cd16581b578 118 class GpioControl;
IanBenzMaxim 7:9cd16581b578 119
IanBenzMaxim 7:9cd16581b578 120 /// Page protection types.
IanBenzMaxim 7:9cd16581b578 121 enum BlockProtectionType {
IanBenzMaxim 7:9cd16581b578 122 RP = 0x01, ///< Read protection.
IanBenzMaxim 7:9cd16581b578 123 WP = 0x02, ///< Write protection.
IanBenzMaxim 7:9cd16581b578 124 EM = 0x04, ///< EPROM emulation mode.
IanBenzMaxim 7:9cd16581b578 125 APH = 0x08, ///< Authentication Write Protection HMAC
IanBenzMaxim 7:9cd16581b578 126 EPH = 0x10, ///< Encryption and Authentication Write Protection HMAC
IanBenzMaxim 7:9cd16581b578 127 ECH = 0x40, ///< Encryption and write using shared key from ECDH
IanBenzMaxim 7:9cd16581b578 128 ECW = 0x80 ///< Authentication Write Protection ECDSA
IanBenzMaxim 7:9cd16581b578 129 };
IanBenzMaxim 7:9cd16581b578 130 typedef Core::FlagSet<BlockProtectionType, 8> BlockProtection;
IanBenzMaxim 7:9cd16581b578 131
IanBenzMaxim 7:9cd16581b578 132 protected:
IanBenzMaxim 7:9cd16581b578 133 explicit DS28E83_DS28E84(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 134 : doRunCommand(runCommand) {}
IanBenzMaxim 7:9cd16581b578 135
IanBenzMaxim 7:9cd16581b578 136 ~DS28E83_DS28E84() {}
IanBenzMaxim 7:9cd16581b578 137
IanBenzMaxim 7:9cd16581b578 138 public:
IanBenzMaxim 7:9cd16581b578 139 void setRunCommand(const Core::RunCommand & runCommand) {
IanBenzMaxim 7:9cd16581b578 140 doRunCommand = runCommand;
IanBenzMaxim 7:9cd16581b578 141 }
IanBenzMaxim 7:9cd16581b578 142
IanBenzMaxim 7:9cd16581b578 143 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 144 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 145 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 146 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 147 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 148
IanBenzMaxim 7:9cd16581b578 149 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 150 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 151 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 152 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 153 readMemory(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 154
IanBenzMaxim 7:9cd16581b578 155 /// @brief Read memory with encryption.
IanBenzMaxim 7:9cd16581b578 156 /// @param pageNum Number of page to read from.
IanBenzMaxim 7:9cd16581b578 157 /// @param secret Secret to use for encryption.
IanBenzMaxim 8:5ea891c7d1a1 158 /// @returns Encryption challenge and encrypted page data that was read.
IanBenzMaxim 8:5ea891c7d1a1 159 MaximInterfaceDevices_EXPORT
IanBenzMaxim 8:5ea891c7d1a1 160 Core::Result<std::pair<EncryptionChallenge::array, Page::array> >
IanBenzMaxim 8:5ea891c7d1a1 161 encryptedReadMemory(int pageNum, KeySecret secret) const;
IanBenzMaxim 7:9cd16581b578 162
IanBenzMaxim 7:9cd16581b578 163 /// @brief Read the protection settings of a block.
IanBenzMaxim 7:9cd16581b578 164 /// @param blockNum Number of block to read.
IanBenzMaxim 8:5ea891c7d1a1 165 /// @returns Secret/Key and protection set on the block.
IanBenzMaxim 8:5ea891c7d1a1 166 MaximInterfaceDevices_EXPORT
IanBenzMaxim 8:5ea891c7d1a1 167 Core::Result<std::pair<Core::Optional<KeySecret>, BlockProtection> >
IanBenzMaxim 8:5ea891c7d1a1 168 readBlockProtection(int blockNum) const;
IanBenzMaxim 7:9cd16581b578 169
IanBenzMaxim 7:9cd16581b578 170 /// @brief Set the protection settings of a block.
IanBenzMaxim 7:9cd16581b578 171 /// @param blockNum Number of block to write.
IanBenzMaxim 7:9cd16581b578 172 /// @param keySecret Secret/Key A or B.
IanBenzMaxim 7:9cd16581b578 173 /// @param protection Protection to write.
IanBenzMaxim 8:5ea891c7d1a1 174 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 175 setBlockProtection(int blockNum, KeySecret keySecret,
IanBenzMaxim 7:9cd16581b578 176 const BlockProtection & protection);
IanBenzMaxim 7:9cd16581b578 177
IanBenzMaxim 7:9cd16581b578 178 /// @brief Compute and read page authentication with ECDSA.
IanBenzMaxim 7:9cd16581b578 179 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 180 /// @param key
IanBenzMaxim 7:9cd16581b578 181 /// Private key to use for authentication.
IanBenzMaxim 7:9cd16581b578 182 /// Key S cannot be used with this command.
IanBenzMaxim 7:9cd16581b578 183 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 184 /// @returns Computed page signature.
IanBenzMaxim 8:5ea891c7d1a1 185 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::Signature::array>
IanBenzMaxim 8:5ea891c7d1a1 186 computeAndReadEcdsaPageAuthentication(int pageNum, KeySecret key,
IanBenzMaxim 8:5ea891c7d1a1 187 Page::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 188
IanBenzMaxim 7:9cd16581b578 189 /// @brief Compute and read page authentication with HMAC.
IanBenzMaxim 7:9cd16581b578 190 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 191 /// @param secret
IanBenzMaxim 7:9cd16581b578 192 /// Secret to use for authentication.
IanBenzMaxim 7:9cd16581b578 193 /// Secret S cannot be used with this command.
IanBenzMaxim 7:9cd16581b578 194 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 195 /// @returns Computed page HMAC.
IanBenzMaxim 8:5ea891c7d1a1 196 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 197 computeAndReadSha256PageAuthentication(int pageNum, KeySecret secret,
IanBenzMaxim 8:5ea891c7d1a1 198 Page::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 199
IanBenzMaxim 7:9cd16581b578 200 /// @brief Compute a hash over multiple blocks.
IanBenzMaxim 7:9cd16581b578 201 /// @param firstBlock True if this is the first block being hashed.
IanBenzMaxim 7:9cd16581b578 202 /// @param lastBlock True if this is the last block being hashed.
IanBenzMaxim 7:9cd16581b578 203 /// @param data
IanBenzMaxim 7:9cd16581b578 204 /// Data block to hash. Should be 64 bytes unless this is the last block.
IanBenzMaxim 8:5ea891c7d1a1 205 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 206 computeMultiblockHash(bool firstBlock, bool lastBlock,
IanBenzMaxim 7:9cd16581b578 207 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 208
IanBenzMaxim 7:9cd16581b578 209 /// @brief Verify ECDSA signature with data input.
IanBenzMaxim 7:9cd16581b578 210 /// @param key Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 211 /// @param authorityKey Use the authority key instead of the standard key.
IanBenzMaxim 7:9cd16581b578 212 /// @param gpioState New state of the GPIO pin if verification successful.
IanBenzMaxim 7:9cd16581b578 213 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 214 /// @param data Data to verify with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 215 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 216 verifyEcdsaSignature(KeySecret key, bool authorityKey, GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 217 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 218 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 219
IanBenzMaxim 7:9cd16581b578 220 /// @brief Verify ECDSA signature with hash input.
IanBenzMaxim 7:9cd16581b578 221 /// @param key Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 222 /// @param authorityKey Use the authority key instead of the standard key.
IanBenzMaxim 7:9cd16581b578 223 /// @param gpioState New state of the GPIO pin if verification successful.
IanBenzMaxim 7:9cd16581b578 224 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 225 /// @param hash Hash of data to verify.
IanBenzMaxim 8:5ea891c7d1a1 226 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 227 verifyEcdsaSignature(KeySecret key, bool authorityKey, GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 228 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 229 Page::const_span hash);
IanBenzMaxim 7:9cd16581b578 230
IanBenzMaxim 7:9cd16581b578 231 /// @brief
IanBenzMaxim 7:9cd16581b578 232 /// Verify ECDSA signature with THASH input from Compute Multiblock Hash.
IanBenzMaxim 7:9cd16581b578 233 /// @param key Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 234 /// @param authorityKey Use the authority key instead of the standard key.
IanBenzMaxim 7:9cd16581b578 235 /// @param gpioState New state of the GPIO pin if verification successful.
IanBenzMaxim 7:9cd16581b578 236 /// @param signature Signature to verify.
IanBenzMaxim 8:5ea891c7d1a1 237 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 238 verifyEcdsaSignature(KeySecret key, bool authorityKey, GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 239 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 240
IanBenzMaxim 7:9cd16581b578 241 /// @brief Authenticate a public key for authenticated writes.
IanBenzMaxim 7:9cd16581b578 242 /// @param key
IanBenzMaxim 7:9cd16581b578 243 /// Authority key to use for authentication. Key A or B can be selected.
IanBenzMaxim 7:9cd16581b578 244 /// @param cert Certificate to use for authentication of Public Key S.
IanBenzMaxim 7:9cd16581b578 245 /// @param certCustomization
IanBenzMaxim 7:9cd16581b578 246 /// Certificate customization with length from 1 to 32.
IanBenzMaxim 8:5ea891c7d1a1 247 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 248 authenticateEcdsaPublicKey(KeySecret key,
IanBenzMaxim 7:9cd16581b578 249 Core::Ecc256::Signature::const_span cert,
IanBenzMaxim 7:9cd16581b578 250 Core::span<const uint_least8_t> certCustomization);
IanBenzMaxim 7:9cd16581b578 251
IanBenzMaxim 7:9cd16581b578 252 /// @brief
IanBenzMaxim 7:9cd16581b578 253 /// Authenticate a public key for ECDH and optionally authenticated writes.
IanBenzMaxim 7:9cd16581b578 254 /// @param key
IanBenzMaxim 7:9cd16581b578 255 /// Keys to use for authentication and ECDH key exchange.
IanBenzMaxim 7:9cd16581b578 256 /// Key A or B can be selected.
IanBenzMaxim 7:9cd16581b578 257 /// @param authWrites True to select authentication for writes.
IanBenzMaxim 7:9cd16581b578 258 /// @param cert Certificate to use for authentication of Public Key S.
IanBenzMaxim 7:9cd16581b578 259 /// @param certCustomization
IanBenzMaxim 7:9cd16581b578 260 /// Certificate customization with length from 1 to 32.
IanBenzMaxim 7:9cd16581b578 261 /// @param ecdhCustomization ECDH customization with length from 1 to 48.
IanBenzMaxim 7:9cd16581b578 262 /// @note The maximum total customization length is 60 bytes.
IanBenzMaxim 8:5ea891c7d1a1 263 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 264 authenticateEcdsaPublicKey(KeySecret key, bool authWrites,
IanBenzMaxim 7:9cd16581b578 265 Core::Ecc256::Signature::const_span cert,
IanBenzMaxim 7:9cd16581b578 266 Core::span<const uint_least8_t> certCustomization,
IanBenzMaxim 7:9cd16581b578 267 Core::span<const uint_least8_t> ecdhCustomization);
IanBenzMaxim 7:9cd16581b578 268
IanBenzMaxim 7:9cd16581b578 269 /// @brief Write with ECDSA authentication.
IanBenzMaxim 7:9cd16581b578 270 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 271 /// @param useKeyS
IanBenzMaxim 7:9cd16581b578 272 /// Use Public Key S instead of the authority key set in the block protection.
IanBenzMaxim 7:9cd16581b578 273 /// @param newPageData Data to write.
IanBenzMaxim 7:9cd16581b578 274 /// @param signature Signature to use for authentication of page data.
IanBenzMaxim 8:5ea891c7d1a1 275 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 276 authenticatedEcdsaWriteMemory(int pageNum, bool useKeyS,
IanBenzMaxim 7:9cd16581b578 277 Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 278 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 279
IanBenzMaxim 7:9cd16581b578 280 /// @brief Write with ECDSA authentication and encryption.
IanBenzMaxim 7:9cd16581b578 281 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 282 /// @param useKeyS
IanBenzMaxim 7:9cd16581b578 283 /// Use Public Key S instead of the authority key set in the block protection.
IanBenzMaxim 7:9cd16581b578 284 /// @param newPageData Encrypted data to write.
IanBenzMaxim 7:9cd16581b578 285 /// @param signature Signature to use for authentication of page data.
IanBenzMaxim 7:9cd16581b578 286 /// @param challenge Challenge to use for decryption of page data.
IanBenzMaxim 8:5ea891c7d1a1 287 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 288 authenticatedEcdsaWriteMemory(int pageNum, bool useKeyS,
IanBenzMaxim 7:9cd16581b578 289 Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 290 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 291 EncryptionChallenge::const_span challenge);
IanBenzMaxim 7:9cd16581b578 292
IanBenzMaxim 7:9cd16581b578 293 /// @brief Write with SHA-256 HMAC authentication.
IanBenzMaxim 7:9cd16581b578 294 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 295 /// @param useSecretS
IanBenzMaxim 7:9cd16581b578 296 /// Use Secret S instead of the secret set in the block protection.
IanBenzMaxim 7:9cd16581b578 297 /// @param newPageData Data to write.
IanBenzMaxim 7:9cd16581b578 298 /// @param hmac HMAC to use for authentication of page data.
IanBenzMaxim 8:5ea891c7d1a1 299 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 300 authenticatedSha256WriteMemory(int pageNum, bool useSecretS,
IanBenzMaxim 7:9cd16581b578 301 Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 302 Page::const_span hmac);
IanBenzMaxim 7:9cd16581b578 303
IanBenzMaxim 7:9cd16581b578 304 /// @brief Write with SHA-256 HMAC authentication and encryption.
IanBenzMaxim 7:9cd16581b578 305 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 306 /// @param useSecretS
IanBenzMaxim 7:9cd16581b578 307 /// Use Secret S instead of the secret set in the block protection.
IanBenzMaxim 7:9cd16581b578 308 /// @param newPageData Data to write.
IanBenzMaxim 7:9cd16581b578 309 /// @param hmac HMAC to use for authentication of page data.
IanBenzMaxim 7:9cd16581b578 310 /// @param challenge Challenge to use for decryption of page data.
IanBenzMaxim 8:5ea891c7d1a1 311 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 312 authenticatedSha256WriteMemory(int pageNum, bool useSecretS,
IanBenzMaxim 8:5ea891c7d1a1 313 Page::const_span newPageData,
IanBenzMaxim 8:5ea891c7d1a1 314 Page::const_span hmac,
IanBenzMaxim 8:5ea891c7d1a1 315 EncryptionChallenge::const_span challenge);
IanBenzMaxim 7:9cd16581b578 316
IanBenzMaxim 7:9cd16581b578 317 /// @brief Compute a derivative SHA-256 secret from an existing secret.
IanBenzMaxim 7:9cd16581b578 318 /// @param pageNum Number of page to use in computation.
IanBenzMaxim 7:9cd16581b578 319 /// @param masterSecret Master secret to use in computation.
IanBenzMaxim 7:9cd16581b578 320 /// @param destinationSecret
IanBenzMaxim 7:9cd16581b578 321 /// Destination secret to receive the computation result.
IanBenzMaxim 7:9cd16581b578 322 /// @param partialSecret Partial secret to use in computation.
IanBenzMaxim 8:5ea891c7d1a1 323 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 324 computeAndWriteSha256Secret(int pageNum, KeySecret masterSecret,
IanBenzMaxim 7:9cd16581b578 325 KeySecret destinationSecret,
IanBenzMaxim 7:9cd16581b578 326 Page::const_span partialSecret);
IanBenzMaxim 7:9cd16581b578 327
IanBenzMaxim 7:9cd16581b578 328 /// @brief Generate a new ECDSA key pair.
IanBenzMaxim 7:9cd16581b578 329 /// @param key Key to generate. Key S cannot be used with this command.
IanBenzMaxim 8:5ea891c7d1a1 330 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 331 generateEcc256KeyPair(KeySecret key);
IanBenzMaxim 7:9cd16581b578 332
IanBenzMaxim 7:9cd16581b578 333 /// @brief Read a block of random data from the RNG.
IanBenzMaxim 7:9cd16581b578 334 /// @param[out] data Random data from RNG with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 335 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 336 readRng(Core::span<uint_least8_t> data) const;
IanBenzMaxim 7:9cd16581b578 337
IanBenzMaxim 7:9cd16581b578 338 /// Run entropy health test on the RNG.
IanBenzMaxim 8:5ea891c7d1a1 339 MaximInterfaceDevices_EXPORT Core::Result<void> entropyHealthTest() const;
IanBenzMaxim 7:9cd16581b578 340
IanBenzMaxim 7:9cd16581b578 341 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 342 errorCategory();
IanBenzMaxim 7:9cd16581b578 343
IanBenzMaxim 7:9cd16581b578 344 protected:
IanBenzMaxim 8:5ea891c7d1a1 345 MaximInterfaceDevices_EXPORT Core::Result<Core::span<uint_least8_t> >
IanBenzMaxim 7:9cd16581b578 346 runCommand(Core::span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 347 Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 348
IanBenzMaxim 8:5ea891c7d1a1 349 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 350 runCommand(Core::span<const uint_least8_t> request, int delayTime) const;
IanBenzMaxim 7:9cd16581b578 351
IanBenzMaxim 7:9cd16581b578 352 private:
IanBenzMaxim 7:9cd16581b578 353 enum HashType { HashInput, DataInput, THASH };
IanBenzMaxim 7:9cd16581b578 354
IanBenzMaxim 8:5ea891c7d1a1 355 Core::Result<void>
IanBenzMaxim 7:9cd16581b578 356 verifyEcdsaSignature(KeySecret key, bool authorityKey, HashType hashType,
IanBenzMaxim 7:9cd16581b578 357 GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 358 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 359 Core::span<const uint_least8_t> buffer);
IanBenzMaxim 7:9cd16581b578 360
IanBenzMaxim 8:5ea891c7d1a1 361 Core::Result<void> authenticateEcdsaPublicKey(
IanBenzMaxim 7:9cd16581b578 362 KeySecret key, bool authWrites, Core::Ecc256::Signature::const_span cert,
IanBenzMaxim 7:9cd16581b578 363 Core::span<const uint_least8_t> certCustomization,
IanBenzMaxim 7:9cd16581b578 364 const Core::span<const uint_least8_t> * ecdhCustomization);
IanBenzMaxim 7:9cd16581b578 365
IanBenzMaxim 8:5ea891c7d1a1 366 Core::Result<void> authenticatedEcdsaWriteMemory(
IanBenzMaxim 7:9cd16581b578 367 int pageNum, bool useKeyS, Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 368 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 369 const EncryptionChallenge::const_span * challenge);
IanBenzMaxim 7:9cd16581b578 370
IanBenzMaxim 8:5ea891c7d1a1 371 Core::Result<void> authenticatedSha256WriteMemory(
IanBenzMaxim 7:9cd16581b578 372 int pageNum, bool useSecretS, Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 373 Page::const_span hmac, const EncryptionChallenge::const_span * challenge);
IanBenzMaxim 7:9cd16581b578 374
IanBenzMaxim 7:9cd16581b578 375 Core::RunCommand doRunCommand;
IanBenzMaxim 7:9cd16581b578 376 };
IanBenzMaxim 7:9cd16581b578 377
IanBenzMaxim 8:5ea891c7d1a1 378 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 379 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 380
IanBenzMaxim 8:5ea891c7d1a1 381 template <>
IanBenzMaxim 8:5ea891c7d1a1 382 struct is_error_code_enum<MaximInterfaceDevices::DS28E83_DS28E84::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 383 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 384
IanBenzMaxim 8:5ea891c7d1a1 385 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 386 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 387
IanBenzMaxim 7:9cd16581b578 388 inline Core::error_code make_error_code(DS28E83_DS28E84::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 389 return Core::error_code(e, DS28E83_DS28E84::errorCategory());
IanBenzMaxim 7:9cd16581b578 390 }
IanBenzMaxim 7:9cd16581b578 391
IanBenzMaxim 7:9cd16581b578 392 class DS28E83 : public DS28E83_DS28E84 {
IanBenzMaxim 7:9cd16581b578 393 public:
IanBenzMaxim 7:9cd16581b578 394 static const int memoryPages = 44;
IanBenzMaxim 7:9cd16581b578 395 static const int protectionBlocks = 9;
IanBenzMaxim 7:9cd16581b578 396
IanBenzMaxim 7:9cd16581b578 397 explicit DS28E83(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 398 : DS28E83_DS28E84(runCommand) {}
IanBenzMaxim 7:9cd16581b578 399 };
IanBenzMaxim 7:9cd16581b578 400
IanBenzMaxim 7:9cd16581b578 401 class DS28E84 : public DS28E83_DS28E84 {
IanBenzMaxim 7:9cd16581b578 402 public:
IanBenzMaxim 7:9cd16581b578 403 /// @name Device memory pages
IanBenzMaxim 7:9cd16581b578 404 /// @{
IanBenzMaxim 7:9cd16581b578 405
IanBenzMaxim 7:9cd16581b578 406 static const int publicKeySxBackupPage = 104;
IanBenzMaxim 7:9cd16581b578 407 static const int publicKeySyBackupPage = 105;
IanBenzMaxim 7:9cd16581b578 408 static const int decrementCounterPage = 106;
IanBenzMaxim 7:9cd16581b578 409
IanBenzMaxim 7:9cd16581b578 410 /// @}
IanBenzMaxim 7:9cd16581b578 411
IanBenzMaxim 7:9cd16581b578 412 static const int memoryPages = 107;
IanBenzMaxim 7:9cd16581b578 413 static const int protectionBlocks = 24;
IanBenzMaxim 7:9cd16581b578 414
IanBenzMaxim 8:5ea891c7d1a1 415 enum StateOperation { Restore, Backup };
IanBenzMaxim 7:9cd16581b578 416
IanBenzMaxim 7:9cd16581b578 417 explicit DS28E84(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 418 : DS28E83_DS28E84(runCommand) {}
IanBenzMaxim 7:9cd16581b578 419
IanBenzMaxim 7:9cd16581b578 420 /// Decrement the decrement-only counter.
IanBenzMaxim 8:5ea891c7d1a1 421 MaximInterfaceDevices_EXPORT Core::Result<void> decrementCounter();
IanBenzMaxim 7:9cd16581b578 422
IanBenzMaxim 7:9cd16581b578 423 /// Back up or restore the state of the device to non-volatile memory.
IanBenzMaxim 8:5ea891c7d1a1 424 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 425 deviceStateControl(StateOperation operation);
IanBenzMaxim 7:9cd16581b578 426 };
IanBenzMaxim 7:9cd16581b578 427
IanBenzMaxim 7:9cd16581b578 428 /// @brief
IanBenzMaxim 7:9cd16581b578 429 /// Hash arbitrary length data with successive Compute Multiblock Hash commands.
IanBenzMaxim 7:9cd16581b578 430 /// @param device Device for computation.
IanBenzMaxim 7:9cd16581b578 431 /// @param data Data to hash.
IanBenzMaxim 8:5ea891c7d1a1 432 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 433 computeMultiblockHash(DS28E83_DS28E84 & device,
IanBenzMaxim 7:9cd16581b578 434 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 435
IanBenzMaxim 7:9cd16581b578 436 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 437 class DS28E83_DS28E84::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 438 public:
IanBenzMaxim 7:9cd16581b578 439 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 440 1 + Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 441 Result;
IanBenzMaxim 7:9cd16581b578 442
IanBenzMaxim 7:9cd16581b578 443 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 444
IanBenzMaxim 7:9cd16581b578 445 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 446 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 447
IanBenzMaxim 7:9cd16581b578 448 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 449 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 450 /// @{
IanBenzMaxim 7:9cd16581b578 451
IanBenzMaxim 7:9cd16581b578 452 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 453 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 454 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 455 }
IanBenzMaxim 7:9cd16581b578 456
IanBenzMaxim 7:9cd16581b578 457 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 458 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 459 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 460 }
IanBenzMaxim 7:9cd16581b578 461
IanBenzMaxim 7:9cd16581b578 462 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 463 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 464 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 465 return *this;
IanBenzMaxim 7:9cd16581b578 466 }
IanBenzMaxim 7:9cd16581b578 467
IanBenzMaxim 7:9cd16581b578 468 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 469 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 470
IanBenzMaxim 7:9cd16581b578 471 /// @}
IanBenzMaxim 7:9cd16581b578 472
IanBenzMaxim 7:9cd16581b578 473 /// @name Page
IanBenzMaxim 7:9cd16581b578 474 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 475 /// @{
IanBenzMaxim 7:9cd16581b578 476
IanBenzMaxim 7:9cd16581b578 477 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 478 Page::span page() {
IanBenzMaxim 7:9cd16581b578 479 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 480 }
IanBenzMaxim 7:9cd16581b578 481
IanBenzMaxim 7:9cd16581b578 482 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 483 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 484 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 485 }
IanBenzMaxim 7:9cd16581b578 486
IanBenzMaxim 7:9cd16581b578 487 /// Set page.
IanBenzMaxim 7:9cd16581b578 488 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 489 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 490 return *this;
IanBenzMaxim 7:9cd16581b578 491 }
IanBenzMaxim 7:9cd16581b578 492
IanBenzMaxim 7:9cd16581b578 493 /// @}
IanBenzMaxim 7:9cd16581b578 494
IanBenzMaxim 7:9cd16581b578 495 /// @name Challenge
IanBenzMaxim 7:9cd16581b578 496 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 497 /// @{
IanBenzMaxim 7:9cd16581b578 498
IanBenzMaxim 7:9cd16581b578 499 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 500 Page::span challenge() {
IanBenzMaxim 7:9cd16581b578 501 return make_span(result_).subspan<challengeIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 502 }
IanBenzMaxim 7:9cd16581b578 503
IanBenzMaxim 7:9cd16581b578 504 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 505 Page::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 506 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 507 }
IanBenzMaxim 7:9cd16581b578 508
IanBenzMaxim 7:9cd16581b578 509 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 510 PageAuthenticationData & setChallenge(Page::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 511 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 512 return *this;
IanBenzMaxim 7:9cd16581b578 513 }
IanBenzMaxim 7:9cd16581b578 514
IanBenzMaxim 7:9cd16581b578 515 /// @}
IanBenzMaxim 7:9cd16581b578 516
IanBenzMaxim 7:9cd16581b578 517 /// @name Page number
IanBenzMaxim 7:9cd16581b578 518 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 519 /// @{
IanBenzMaxim 7:9cd16581b578 520
IanBenzMaxim 7:9cd16581b578 521 /// Get page number.
IanBenzMaxim 7:9cd16581b578 522 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 523
IanBenzMaxim 7:9cd16581b578 524 /// Set page number.
IanBenzMaxim 7:9cd16581b578 525 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 526 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 527 return *this;
IanBenzMaxim 7:9cd16581b578 528 }
IanBenzMaxim 7:9cd16581b578 529
IanBenzMaxim 7:9cd16581b578 530 /// @}
IanBenzMaxim 7:9cd16581b578 531
IanBenzMaxim 7:9cd16581b578 532 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 533 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 534 /// @{
IanBenzMaxim 7:9cd16581b578 535
IanBenzMaxim 7:9cd16581b578 536 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 537 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 538 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 539 }
IanBenzMaxim 7:9cd16581b578 540
IanBenzMaxim 7:9cd16581b578 541 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 542 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 543 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 544 }
IanBenzMaxim 7:9cd16581b578 545
IanBenzMaxim 7:9cd16581b578 546 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 547 PageAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 548 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 549 return *this;
IanBenzMaxim 7:9cd16581b578 550 }
IanBenzMaxim 7:9cd16581b578 551
IanBenzMaxim 7:9cd16581b578 552 /// @}
IanBenzMaxim 7:9cd16581b578 553
IanBenzMaxim 7:9cd16581b578 554 private:
IanBenzMaxim 8:5ea891c7d1a1 555 static const size_t romIdIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 556 static const size_t pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 557 static const size_t challengeIdx = pageIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 558 static const size_t pageNumIdx = challengeIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 559 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 560
IanBenzMaxim 7:9cd16581b578 561 Result::array result_;
IanBenzMaxim 7:9cd16581b578 562 };
IanBenzMaxim 7:9cd16581b578 563
IanBenzMaxim 7:9cd16581b578 564 /// Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 565 class DS28E83_DS28E84::WriteAuthenticationData {
IanBenzMaxim 7:9cd16581b578 566 public:
IanBenzMaxim 7:9cd16581b578 567 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 568
IanBenzMaxim 7:9cd16581b578 569 WriteAuthenticationData() : data() { setPageNum(0); }
IanBenzMaxim 7:9cd16581b578 570
IanBenzMaxim 7:9cd16581b578 571 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 572 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 573
IanBenzMaxim 7:9cd16581b578 574 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 575 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 576 /// @{
IanBenzMaxim 7:9cd16581b578 577
IanBenzMaxim 7:9cd16581b578 578 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 579 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 580
IanBenzMaxim 7:9cd16581b578 581 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 582 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 583
IanBenzMaxim 7:9cd16581b578 584 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 585 WriteAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 586 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 587 return *this;
IanBenzMaxim 7:9cd16581b578 588 }
IanBenzMaxim 7:9cd16581b578 589
IanBenzMaxim 7:9cd16581b578 590 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 591 WriteAuthenticationData & setAnonymousRomId() {
IanBenzMaxim 7:9cd16581b578 592 data.setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 593 return *this;
IanBenzMaxim 7:9cd16581b578 594 }
IanBenzMaxim 7:9cd16581b578 595
IanBenzMaxim 7:9cd16581b578 596 /// @}
IanBenzMaxim 7:9cd16581b578 597
IanBenzMaxim 7:9cd16581b578 598 /// @name Old page
IanBenzMaxim 7:9cd16581b578 599 /// @brief Existing data contained in the page.
IanBenzMaxim 7:9cd16581b578 600 /// @{
IanBenzMaxim 7:9cd16581b578 601
IanBenzMaxim 7:9cd16581b578 602 /// Get mutable old page.
IanBenzMaxim 7:9cd16581b578 603 Page::span oldPage() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 604
IanBenzMaxim 7:9cd16581b578 605 /// Get immutable old page.
IanBenzMaxim 7:9cd16581b578 606 Page::const_span oldPage() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 607
IanBenzMaxim 7:9cd16581b578 608 /// Set old page.
IanBenzMaxim 7:9cd16581b578 609 WriteAuthenticationData & setOldPage(Page::const_span oldPage) {
IanBenzMaxim 7:9cd16581b578 610 data.setPage(oldPage);
IanBenzMaxim 7:9cd16581b578 611 return *this;
IanBenzMaxim 7:9cd16581b578 612 }
IanBenzMaxim 7:9cd16581b578 613
IanBenzMaxim 7:9cd16581b578 614 /// @}
IanBenzMaxim 7:9cd16581b578 615
IanBenzMaxim 7:9cd16581b578 616 /// @name New page
IanBenzMaxim 7:9cd16581b578 617 /// @brief New data to write to the page.
IanBenzMaxim 7:9cd16581b578 618 /// @{
IanBenzMaxim 7:9cd16581b578 619
IanBenzMaxim 7:9cd16581b578 620 /// Get mutable new page.
IanBenzMaxim 7:9cd16581b578 621 Page::span newPage() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 622
IanBenzMaxim 7:9cd16581b578 623 /// Get immutable new page.
IanBenzMaxim 7:9cd16581b578 624 Page::const_span newPage() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 625
IanBenzMaxim 7:9cd16581b578 626 /// Set new page.
IanBenzMaxim 7:9cd16581b578 627 WriteAuthenticationData & setNewPage(Page::const_span newPage) {
IanBenzMaxim 7:9cd16581b578 628 data.setChallenge(newPage);
IanBenzMaxim 7:9cd16581b578 629 return *this;
IanBenzMaxim 7:9cd16581b578 630 }
IanBenzMaxim 7:9cd16581b578 631
IanBenzMaxim 7:9cd16581b578 632 /// @}
IanBenzMaxim 7:9cd16581b578 633
IanBenzMaxim 7:9cd16581b578 634 /// @name Page number
IanBenzMaxim 7:9cd16581b578 635 /// @brief Page number for write operation.
IanBenzMaxim 7:9cd16581b578 636 /// @{
IanBenzMaxim 7:9cd16581b578 637
IanBenzMaxim 7:9cd16581b578 638 /// Get page number.
IanBenzMaxim 7:9cd16581b578 639 int pageNum() const { return data.pageNum() & 0x7F; }
IanBenzMaxim 7:9cd16581b578 640
IanBenzMaxim 7:9cd16581b578 641 /// Set page number.
IanBenzMaxim 7:9cd16581b578 642 WriteAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 643 data.setPageNum(pageNum | 0x80);
IanBenzMaxim 7:9cd16581b578 644 return *this;
IanBenzMaxim 7:9cd16581b578 645 }
IanBenzMaxim 7:9cd16581b578 646
IanBenzMaxim 7:9cd16581b578 647 /// @}
IanBenzMaxim 7:9cd16581b578 648
IanBenzMaxim 7:9cd16581b578 649 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 650 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 651 /// @{
IanBenzMaxim 7:9cd16581b578 652
IanBenzMaxim 7:9cd16581b578 653 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 654 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 655
IanBenzMaxim 7:9cd16581b578 656 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 657 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 658
IanBenzMaxim 7:9cd16581b578 659 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 660 WriteAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 661 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 662 return *this;
IanBenzMaxim 7:9cd16581b578 663 }
IanBenzMaxim 7:9cd16581b578 664
IanBenzMaxim 7:9cd16581b578 665 /// @}
IanBenzMaxim 7:9cd16581b578 666
IanBenzMaxim 7:9cd16581b578 667 private:
IanBenzMaxim 7:9cd16581b578 668 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 669 };
IanBenzMaxim 7:9cd16581b578 670
IanBenzMaxim 7:9cd16581b578 671 /// Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 672 class DS28E83_DS28E84::ComputeSecretData {
IanBenzMaxim 7:9cd16581b578 673 public:
IanBenzMaxim 7:9cd16581b578 674 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 675
IanBenzMaxim 7:9cd16581b578 676 MaximInterfaceDevices_EXPORT ComputeSecretData();
IanBenzMaxim 7:9cd16581b578 677
IanBenzMaxim 7:9cd16581b578 678 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 679 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 680
IanBenzMaxim 7:9cd16581b578 681 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 682 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 683 /// @{
IanBenzMaxim 7:9cd16581b578 684
IanBenzMaxim 7:9cd16581b578 685 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 686 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 687
IanBenzMaxim 7:9cd16581b578 688 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 689 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 690
IanBenzMaxim 7:9cd16581b578 691 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 692 ComputeSecretData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 693 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 694 return *this;
IanBenzMaxim 7:9cd16581b578 695 }
IanBenzMaxim 7:9cd16581b578 696
IanBenzMaxim 7:9cd16581b578 697 /// @}
IanBenzMaxim 7:9cd16581b578 698
IanBenzMaxim 7:9cd16581b578 699 /// @name Binding Data
IanBenzMaxim 7:9cd16581b578 700 /// @brief Binding Data contained in the selected page.
IanBenzMaxim 7:9cd16581b578 701 /// @{
IanBenzMaxim 7:9cd16581b578 702
IanBenzMaxim 7:9cd16581b578 703 /// Get mutable Binding Data.
IanBenzMaxim 7:9cd16581b578 704 Page::span bindingData() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 705
IanBenzMaxim 7:9cd16581b578 706 /// Get immutable Binding Data.
IanBenzMaxim 7:9cd16581b578 707 Page::const_span bindingData() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 708
IanBenzMaxim 7:9cd16581b578 709 /// Set Binding Data.
IanBenzMaxim 7:9cd16581b578 710 ComputeSecretData & setBindingData(Page::const_span bindingData) {
IanBenzMaxim 7:9cd16581b578 711 data.setPage(bindingData);
IanBenzMaxim 7:9cd16581b578 712 return *this;
IanBenzMaxim 7:9cd16581b578 713 }
IanBenzMaxim 7:9cd16581b578 714
IanBenzMaxim 7:9cd16581b578 715 /// @}
IanBenzMaxim 7:9cd16581b578 716
IanBenzMaxim 7:9cd16581b578 717 /// @name Partial Secret
IanBenzMaxim 7:9cd16581b578 718 /// @brief Partial Secret used for customization.
IanBenzMaxim 7:9cd16581b578 719 /// @{
IanBenzMaxim 7:9cd16581b578 720
IanBenzMaxim 7:9cd16581b578 721 /// Get mutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 722 Page::span partialSecret() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 723
IanBenzMaxim 7:9cd16581b578 724 /// Get immutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 725 Page::const_span partialSecret() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 726
IanBenzMaxim 7:9cd16581b578 727 /// Set Partial Secret.
IanBenzMaxim 7:9cd16581b578 728 ComputeSecretData & setPartialSecret(Page::const_span partialSecret) {
IanBenzMaxim 7:9cd16581b578 729 data.setChallenge(partialSecret);
IanBenzMaxim 7:9cd16581b578 730 return *this;
IanBenzMaxim 7:9cd16581b578 731 }
IanBenzMaxim 7:9cd16581b578 732
IanBenzMaxim 7:9cd16581b578 733 /// @}
IanBenzMaxim 7:9cd16581b578 734
IanBenzMaxim 7:9cd16581b578 735 /// @name Page number
IanBenzMaxim 7:9cd16581b578 736 /// @brief Page number for Binding Data.
IanBenzMaxim 7:9cd16581b578 737 /// @{
IanBenzMaxim 7:9cd16581b578 738
IanBenzMaxim 7:9cd16581b578 739 /// Get page number.
IanBenzMaxim 7:9cd16581b578 740 int pageNum() const { return data.pageNum() & 0x3F; }
IanBenzMaxim 7:9cd16581b578 741
IanBenzMaxim 7:9cd16581b578 742 /// Set page number.
IanBenzMaxim 7:9cd16581b578 743 ComputeSecretData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 744 data.setPageNum(pageNum | 0xC0);
IanBenzMaxim 7:9cd16581b578 745 return *this;
IanBenzMaxim 7:9cd16581b578 746 }
IanBenzMaxim 7:9cd16581b578 747
IanBenzMaxim 7:9cd16581b578 748 /// @}
IanBenzMaxim 7:9cd16581b578 749
IanBenzMaxim 7:9cd16581b578 750 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 751 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 752 /// @{
IanBenzMaxim 7:9cd16581b578 753
IanBenzMaxim 7:9cd16581b578 754 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 755 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 756
IanBenzMaxim 7:9cd16581b578 757 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 758 MaximInterfaceDevices_EXPORT ComputeSecretData &
IanBenzMaxim 7:9cd16581b578 759 setManId(Core::ManId::const_span manId);
IanBenzMaxim 7:9cd16581b578 760
IanBenzMaxim 7:9cd16581b578 761 /// @}
IanBenzMaxim 7:9cd16581b578 762
IanBenzMaxim 7:9cd16581b578 763 private:
IanBenzMaxim 7:9cd16581b578 764 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 765 };
IanBenzMaxim 7:9cd16581b578 766
IanBenzMaxim 7:9cd16581b578 767 /// Format decryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 768 class DS28E83_DS28E84::DecryptionHmacData {
IanBenzMaxim 7:9cd16581b578 769 public:
IanBenzMaxim 7:9cd16581b578 770 typedef Core::array_span<uint_least8_t, EncryptionChallenge::size +
IanBenzMaxim 7:9cd16581b578 771 Core::RomId::size + 1 +
IanBenzMaxim 7:9cd16581b578 772 Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 773 Result;
IanBenzMaxim 7:9cd16581b578 774
IanBenzMaxim 7:9cd16581b578 775 DecryptionHmacData() : result_() {}
IanBenzMaxim 7:9cd16581b578 776
IanBenzMaxim 7:9cd16581b578 777 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 778 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 779
IanBenzMaxim 7:9cd16581b578 780 /// @name Encryption Challenge
IanBenzMaxim 7:9cd16581b578 781 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 782 /// @{
IanBenzMaxim 7:9cd16581b578 783
IanBenzMaxim 7:9cd16581b578 784 /// Get mutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 785 EncryptionChallenge::span encryptionChallenge() {
IanBenzMaxim 7:9cd16581b578 786 return make_span(result_)
IanBenzMaxim 7:9cd16581b578 787 .subspan<encryptionChallengeIdx, EncryptionChallenge::size>();
IanBenzMaxim 7:9cd16581b578 788 }
IanBenzMaxim 7:9cd16581b578 789
IanBenzMaxim 7:9cd16581b578 790 /// Get immutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 791 EncryptionChallenge::const_span encryptionChallenge() const {
IanBenzMaxim 7:9cd16581b578 792 return const_cast<DecryptionHmacData &>(*this).encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 793 }
IanBenzMaxim 7:9cd16581b578 794
IanBenzMaxim 7:9cd16581b578 795 /// Set Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 796 DecryptionHmacData &
IanBenzMaxim 7:9cd16581b578 797 setEncryptionChallenge(EncryptionChallenge::const_span encryptionChallenge) {
IanBenzMaxim 7:9cd16581b578 798 copy(encryptionChallenge, this->encryptionChallenge());
IanBenzMaxim 7:9cd16581b578 799 return *this;
IanBenzMaxim 7:9cd16581b578 800 }
IanBenzMaxim 7:9cd16581b578 801
IanBenzMaxim 7:9cd16581b578 802 /// @}
IanBenzMaxim 7:9cd16581b578 803
IanBenzMaxim 7:9cd16581b578 804 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 805 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 806 /// @{
IanBenzMaxim 7:9cd16581b578 807
IanBenzMaxim 7:9cd16581b578 808 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 809 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 810 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 811 }
IanBenzMaxim 7:9cd16581b578 812
IanBenzMaxim 7:9cd16581b578 813 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 814 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 815 return const_cast<DecryptionHmacData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 816 }
IanBenzMaxim 7:9cd16581b578 817
IanBenzMaxim 7:9cd16581b578 818 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 819 DecryptionHmacData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 820 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 821 return *this;
IanBenzMaxim 7:9cd16581b578 822 }
IanBenzMaxim 7:9cd16581b578 823
IanBenzMaxim 7:9cd16581b578 824 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 825 MaximInterfaceDevices_EXPORT DecryptionHmacData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 826
IanBenzMaxim 7:9cd16581b578 827 /// @}
IanBenzMaxim 7:9cd16581b578 828
IanBenzMaxim 7:9cd16581b578 829 /// @name Page number
IanBenzMaxim 7:9cd16581b578 830 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 831 /// @{
IanBenzMaxim 7:9cd16581b578 832
IanBenzMaxim 7:9cd16581b578 833 /// Get page number.
IanBenzMaxim 7:9cd16581b578 834 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 835
IanBenzMaxim 7:9cd16581b578 836 /// Set page number.
IanBenzMaxim 7:9cd16581b578 837 DecryptionHmacData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 838 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 839 return *this;
IanBenzMaxim 7:9cd16581b578 840 }
IanBenzMaxim 7:9cd16581b578 841
IanBenzMaxim 7:9cd16581b578 842 /// @}
IanBenzMaxim 7:9cd16581b578 843
IanBenzMaxim 7:9cd16581b578 844 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 845 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 846 /// @{
IanBenzMaxim 7:9cd16581b578 847
IanBenzMaxim 7:9cd16581b578 848 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 849 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 850 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 851 }
IanBenzMaxim 7:9cd16581b578 852
IanBenzMaxim 7:9cd16581b578 853 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 854 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 855 return const_cast<DecryptionHmacData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 856 }
IanBenzMaxim 7:9cd16581b578 857
IanBenzMaxim 7:9cd16581b578 858 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 859 DecryptionHmacData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 860 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 861 return *this;
IanBenzMaxim 7:9cd16581b578 862 }
IanBenzMaxim 7:9cd16581b578 863
IanBenzMaxim 7:9cd16581b578 864 /// @}
IanBenzMaxim 7:9cd16581b578 865
IanBenzMaxim 7:9cd16581b578 866 private:
IanBenzMaxim 8:5ea891c7d1a1 867 static const size_t encryptionChallengeIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 868 static const size_t romIdIdx =
IanBenzMaxim 7:9cd16581b578 869 encryptionChallengeIdx + EncryptionChallenge::size;
IanBenzMaxim 8:5ea891c7d1a1 870 static const size_t pageNumIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 871 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 872
IanBenzMaxim 7:9cd16581b578 873 Result::array result_;
IanBenzMaxim 7:9cd16581b578 874 };
IanBenzMaxim 7:9cd16581b578 875
IanBenzMaxim 7:9cd16581b578 876 /// Format encryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 877 class DS28E83_DS28E84::EncryptionHmacData {
IanBenzMaxim 7:9cd16581b578 878 public:
IanBenzMaxim 7:9cd16581b578 879 typedef DecryptionHmacData::Result Result;
IanBenzMaxim 7:9cd16581b578 880
IanBenzMaxim 7:9cd16581b578 881 EncryptionHmacData() : data() { setPageNum(0); }
IanBenzMaxim 7:9cd16581b578 882
IanBenzMaxim 7:9cd16581b578 883 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 884 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 885
IanBenzMaxim 7:9cd16581b578 886 /// @name Encryption Challenge
IanBenzMaxim 7:9cd16581b578 887 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 888 /// @{
IanBenzMaxim 7:9cd16581b578 889
IanBenzMaxim 7:9cd16581b578 890 /// Get mutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 891 EncryptionChallenge::span encryptionChallenge() {
IanBenzMaxim 7:9cd16581b578 892 return data.encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 893 }
IanBenzMaxim 7:9cd16581b578 894
IanBenzMaxim 7:9cd16581b578 895 /// Get immutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 896 EncryptionChallenge::const_span encryptionChallenge() const {
IanBenzMaxim 7:9cd16581b578 897 return data.encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 898 }
IanBenzMaxim 7:9cd16581b578 899
IanBenzMaxim 7:9cd16581b578 900 /// Set Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 901 EncryptionHmacData &
IanBenzMaxim 7:9cd16581b578 902 setEncryptionChallenge(EncryptionChallenge::const_span encryptionChallenge) {
IanBenzMaxim 7:9cd16581b578 903 data.setEncryptionChallenge(encryptionChallenge);
IanBenzMaxim 7:9cd16581b578 904 return *this;
IanBenzMaxim 7:9cd16581b578 905 }
IanBenzMaxim 7:9cd16581b578 906
IanBenzMaxim 7:9cd16581b578 907 /// @}
IanBenzMaxim 7:9cd16581b578 908
IanBenzMaxim 7:9cd16581b578 909 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 910 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 911 /// @{
IanBenzMaxim 7:9cd16581b578 912
IanBenzMaxim 7:9cd16581b578 913 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 914 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 915
IanBenzMaxim 7:9cd16581b578 916 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 917 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 918
IanBenzMaxim 7:9cd16581b578 919 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 920 EncryptionHmacData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 921 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 922 return *this;
IanBenzMaxim 7:9cd16581b578 923 }
IanBenzMaxim 7:9cd16581b578 924
IanBenzMaxim 7:9cd16581b578 925 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 926 EncryptionHmacData & setAnonymousRomId() {
IanBenzMaxim 7:9cd16581b578 927 data.setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 928 return *this;
IanBenzMaxim 7:9cd16581b578 929 }
IanBenzMaxim 7:9cd16581b578 930
IanBenzMaxim 7:9cd16581b578 931 /// @}
IanBenzMaxim 7:9cd16581b578 932
IanBenzMaxim 7:9cd16581b578 933 /// @name Page number
IanBenzMaxim 7:9cd16581b578 934 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 935 /// @{
IanBenzMaxim 7:9cd16581b578 936
IanBenzMaxim 7:9cd16581b578 937 /// Get page number.
IanBenzMaxim 7:9cd16581b578 938 int pageNum() const { return data.pageNum() & 0x7F; }
IanBenzMaxim 7:9cd16581b578 939
IanBenzMaxim 7:9cd16581b578 940 /// Set page number.
IanBenzMaxim 7:9cd16581b578 941 EncryptionHmacData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 942 data.setPageNum(pageNum | 0x80);
IanBenzMaxim 7:9cd16581b578 943 return *this;
IanBenzMaxim 7:9cd16581b578 944 }
IanBenzMaxim 7:9cd16581b578 945
IanBenzMaxim 7:9cd16581b578 946 /// @}
IanBenzMaxim 7:9cd16581b578 947
IanBenzMaxim 7:9cd16581b578 948 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 949 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 950 /// @{
IanBenzMaxim 7:9cd16581b578 951
IanBenzMaxim 7:9cd16581b578 952 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 953 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 954
IanBenzMaxim 7:9cd16581b578 955 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 956 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 957
IanBenzMaxim 7:9cd16581b578 958 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 959 EncryptionHmacData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 960 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 961 return *this;
IanBenzMaxim 7:9cd16581b578 962 }
IanBenzMaxim 7:9cd16581b578 963
IanBenzMaxim 7:9cd16581b578 964 /// @}
IanBenzMaxim 7:9cd16581b578 965
IanBenzMaxim 7:9cd16581b578 966 private:
IanBenzMaxim 7:9cd16581b578 967 DecryptionHmacData data;
IanBenzMaxim 7:9cd16581b578 968 };
IanBenzMaxim 7:9cd16581b578 969
IanBenzMaxim 7:9cd16581b578 970 /// Access fields in the ROM Options page.
IanBenzMaxim 7:9cd16581b578 971 class DS28E83_DS28E84::RomOptions {
IanBenzMaxim 7:9cd16581b578 972 public:
IanBenzMaxim 7:9cd16581b578 973 explicit RomOptions(Page::span page) : page(page) {}
IanBenzMaxim 7:9cd16581b578 974
IanBenzMaxim 7:9cd16581b578 975 bool anonymous() const { return page[anonymousIdx] == anonymousValue; }
IanBenzMaxim 7:9cd16581b578 976
IanBenzMaxim 7:9cd16581b578 977 void setAnonymous(bool anonymous) {
IanBenzMaxim 7:9cd16581b578 978 page[anonymousIdx] = (anonymous ? anonymousValue : 0);
IanBenzMaxim 7:9cd16581b578 979 }
IanBenzMaxim 7:9cd16581b578 980
IanBenzMaxim 7:9cd16581b578 981 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 982 return page.subspan<22, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 983 }
IanBenzMaxim 7:9cd16581b578 984
IanBenzMaxim 7:9cd16581b578 985 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 986 return page.subspan<24, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 987 }
IanBenzMaxim 7:9cd16581b578 988
IanBenzMaxim 7:9cd16581b578 989 private:
IanBenzMaxim 7:9cd16581b578 990 static const Page::span::index_type anonymousIdx = 1;
IanBenzMaxim 7:9cd16581b578 991 static const Page::span::value_type anonymousValue = 0xAA;
IanBenzMaxim 7:9cd16581b578 992
IanBenzMaxim 7:9cd16581b578 993 Page::span page;
IanBenzMaxim 7:9cd16581b578 994 };
IanBenzMaxim 7:9cd16581b578 995
IanBenzMaxim 7:9cd16581b578 996 /// Access fields in the GPIO Control page.
IanBenzMaxim 7:9cd16581b578 997 class DS28E83_DS28E84::GpioControl {
IanBenzMaxim 7:9cd16581b578 998 public:
IanBenzMaxim 7:9cd16581b578 999 explicit GpioControl(Page::span page) : page(page) {}
IanBenzMaxim 7:9cd16581b578 1000
IanBenzMaxim 7:9cd16581b578 1001 bool conducting() const { return page[conductingIdx] == conductingValue; }
IanBenzMaxim 7:9cd16581b578 1002
IanBenzMaxim 7:9cd16581b578 1003 void setConducting(bool conducting) {
IanBenzMaxim 7:9cd16581b578 1004 page[conductingIdx] = (conducting ? conductingValue : 0x55);
IanBenzMaxim 7:9cd16581b578 1005 }
IanBenzMaxim 7:9cd16581b578 1006
IanBenzMaxim 7:9cd16581b578 1007 bool level() const { return page[2] == 0x55; }
IanBenzMaxim 7:9cd16581b578 1008
IanBenzMaxim 7:9cd16581b578 1009 private:
IanBenzMaxim 7:9cd16581b578 1010 static const Page::span::index_type conductingIdx = 0;
IanBenzMaxim 7:9cd16581b578 1011 static const Page::span::value_type conductingValue = 0xAA;
IanBenzMaxim 7:9cd16581b578 1012
IanBenzMaxim 7:9cd16581b578 1013 Page::span page;
IanBenzMaxim 7:9cd16581b578 1014 };
IanBenzMaxim 7:9cd16581b578 1015
IanBenzMaxim 7:9cd16581b578 1016 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 1017
IanBenzMaxim 7:9cd16581b578 1018 #endif