Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

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

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

MaximInterfaceDevices/DS28C36_DS2476.hpp@7:9cd16581b578, 2019-07-22 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Jul 22 11:44:07 2019 -0500
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
Updated to version 1.9.

Who changed what in which revision?

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