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@8:5ea891c7d1a1, 2019-09-16 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Sep 16 11:13:37 2019 -0500
Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578
Child:
12:7eb41621ba22
Updated to version 2.0.

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