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