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/DS28E39.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) 2018 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_DS28E39
IanBenzMaxim 7:9cd16581b578 34 #define MaximInterfaceDevices_DS28E39
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <stdint.h>
IanBenzMaxim 7:9cd16581b578 37 #include <MaximInterfaceCore/Algorithm.hpp>
IanBenzMaxim 7:9cd16581b578 38 #include <MaximInterfaceCore/array_span.hpp>
IanBenzMaxim 7:9cd16581b578 39 #include <MaximInterfaceCore/Ecc256.hpp>
IanBenzMaxim 7:9cd16581b578 40 #include <MaximInterfaceCore/FlagSet.hpp>
IanBenzMaxim 7:9cd16581b578 41 #include <MaximInterfaceCore/ManId.hpp>
IanBenzMaxim 7:9cd16581b578 42 #include <MaximInterfaceCore/RomId.hpp>
IanBenzMaxim 7:9cd16581b578 43 #include <MaximInterfaceCore/RunCommand.hpp>
IanBenzMaxim 7:9cd16581b578 44 #include <MaximInterfaceCore/system_error.hpp>
IanBenzMaxim 7:9cd16581b578 45 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 46
IanBenzMaxim 7:9cd16581b578 47 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 48
IanBenzMaxim 7:9cd16581b578 49 class DS28E39 {
IanBenzMaxim 7:9cd16581b578 50 public:
IanBenzMaxim 7:9cd16581b578 51 /// Device command results.
IanBenzMaxim 7:9cd16581b578 52 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 53 InvalidOperationError = 0x55,
IanBenzMaxim 7:9cd16581b578 54 InvalidParameterError = 0x77,
IanBenzMaxim 7:9cd16581b578 55 InvalidSequenceError = 0x33,
IanBenzMaxim 7:9cd16581b578 56 InternalError = 0x22,
IanBenzMaxim 7:9cd16581b578 57 DeviceDisabledError = 0x88,
IanBenzMaxim 7:9cd16581b578 58 AuthenticationError = 0x100,
IanBenzMaxim 7:9cd16581b578 59 InvalidResponseError ///< Command response does not match expected format.
IanBenzMaxim 7:9cd16581b578 60 };
IanBenzMaxim 7:9cd16581b578 61
IanBenzMaxim 7:9cd16581b578 62 /// @name Device memory pages
IanBenzMaxim 7:9cd16581b578 63 /// @{
IanBenzMaxim 7:9cd16581b578 64
IanBenzMaxim 7:9cd16581b578 65 static const int decrementCounterPage = 4;
IanBenzMaxim 7:9cd16581b578 66 static const int authorityPublicKeyXPage = 5;
IanBenzMaxim 7:9cd16581b578 67 static const int authorityPublicKeyYPage = 6;
IanBenzMaxim 7:9cd16581b578 68 static const int writePublicKeyXPage = 7;
IanBenzMaxim 7:9cd16581b578 69 static const int writePublicKeyYPage = 8;
IanBenzMaxim 7:9cd16581b578 70
IanBenzMaxim 7:9cd16581b578 71 /// @}
IanBenzMaxim 7:9cd16581b578 72
IanBenzMaxim 7:9cd16581b578 73 static const int memoryPages = 9;
IanBenzMaxim 7:9cd16581b578 74
IanBenzMaxim 7:9cd16581b578 75 /// Holds a device memory page.
IanBenzMaxim 7:9cd16581b578 76 typedef Core::array_span<uint_least8_t, 32> Page;
IanBenzMaxim 7:9cd16581b578 77
IanBenzMaxim 7:9cd16581b578 78 // Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 79 class PageAuthenticationData;
IanBenzMaxim 7:9cd16581b578 80
IanBenzMaxim 7:9cd16581b578 81 // Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 82 class WriteAuthenticationData;
IanBenzMaxim 7:9cd16581b578 83
IanBenzMaxim 7:9cd16581b578 84 /// Page protection types.
IanBenzMaxim 7:9cd16581b578 85 enum PageProtectionType {
IanBenzMaxim 7:9cd16581b578 86 RP = 0x01, ///< Read protection.
IanBenzMaxim 7:9cd16581b578 87 WP = 0x02, ///< Write protection.
IanBenzMaxim 7:9cd16581b578 88 EM = 0x04, ///< EPROM emulation mode.
IanBenzMaxim 7:9cd16581b578 89 DC = 0x08, ///< Decrement counter.
IanBenzMaxim 7:9cd16581b578 90 ECW = 0x10 ///< Authenticated write.
IanBenzMaxim 7:9cd16581b578 91 };
IanBenzMaxim 7:9cd16581b578 92 typedef Core::FlagSet<PageProtectionType, 5> PageProtection;
IanBenzMaxim 7:9cd16581b578 93
IanBenzMaxim 7:9cd16581b578 94 struct Status {
IanBenzMaxim 7:9cd16581b578 95 enum EntropyHealthTestStatus {
IanBenzMaxim 7:9cd16581b578 96 TestNotPerformed = 0xFF,
IanBenzMaxim 7:9cd16581b578 97 EntropyHealthy = 0xAA,
IanBenzMaxim 7:9cd16581b578 98 EntropyNotHealthy = 0xDD
IanBenzMaxim 7:9cd16581b578 99 };
IanBenzMaxim 7:9cd16581b578 100
IanBenzMaxim 7:9cd16581b578 101 typedef Core::array<PageProtection, memoryPages - 2> PageProtectionList;
IanBenzMaxim 7:9cd16581b578 102 typedef Core::array<uint_least8_t, 2> RomVersion;
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 PageProtectionList pageProtection;
IanBenzMaxim 7:9cd16581b578 105 Core::ManId::array manId;
IanBenzMaxim 7:9cd16581b578 106 RomVersion romVersion;
IanBenzMaxim 7:9cd16581b578 107 EntropyHealthTestStatus entropyHealthTestStatus;
IanBenzMaxim 7:9cd16581b578 108 };
IanBenzMaxim 7:9cd16581b578 109
IanBenzMaxim 7:9cd16581b578 110 explicit DS28E39(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 111 : doRunCommand(runCommand) {}
IanBenzMaxim 7:9cd16581b578 112
IanBenzMaxim 7:9cd16581b578 113 void setRunCommand(const Core::RunCommand & runCommand) {
IanBenzMaxim 7:9cd16581b578 114 doRunCommand = runCommand;
IanBenzMaxim 7:9cd16581b578 115 }
IanBenzMaxim 7:9cd16581b578 116
IanBenzMaxim 7:9cd16581b578 117 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 118 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 119 /// @param page Data to write.
IanBenzMaxim 7:9cd16581b578 120 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 121 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 122
IanBenzMaxim 7:9cd16581b578 123 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 124 /// @param pageNum Number of page to read.
IanBenzMaxim 7:9cd16581b578 125 /// @param[out] page Data that was read.
IanBenzMaxim 7:9cd16581b578 126 MaximInterfaceDevices_EXPORT Core::error_code readMemory(int pageNum,
IanBenzMaxim 7:9cd16581b578 127 Page::span page);
IanBenzMaxim 7:9cd16581b578 128
IanBenzMaxim 7:9cd16581b578 129 /// @brief
IanBenzMaxim 7:9cd16581b578 130 /// Reads the current status of the device and optionally performs an
IanBenzMaxim 7:9cd16581b578 131 /// entropy health test.
IanBenzMaxim 7:9cd16581b578 132 /// @param entropyHealthTest True to perform an entropy health test.
IanBenzMaxim 7:9cd16581b578 133 /// @param[out] status Status that was read.
IanBenzMaxim 7:9cd16581b578 134 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 135 readStatus(bool entropyHealthTest, Status & status);
IanBenzMaxim 7:9cd16581b578 136
IanBenzMaxim 7:9cd16581b578 137 /// @brief Set the protection settings of a page.
IanBenzMaxim 7:9cd16581b578 138 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 139 /// @param protection Protection to write.
IanBenzMaxim 7:9cd16581b578 140 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 141 setPageProtection(int pageNum, const PageProtection & protection);
IanBenzMaxim 7:9cd16581b578 142
IanBenzMaxim 7:9cd16581b578 143 /// @brief Compute and read page authentication with ECDSA.
IanBenzMaxim 7:9cd16581b578 144 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 145 /// @param anonymous True to disable use of ROM ID in computation.
IanBenzMaxim 7:9cd16581b578 146 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 147 /// @param[out] signature Computed page signature.
IanBenzMaxim 7:9cd16581b578 148 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 149 computeAndReadPageAuthentication(int pageNum, bool anonymous,
IanBenzMaxim 7:9cd16581b578 150 Page::const_span challenge,
IanBenzMaxim 7:9cd16581b578 151 Core::Ecc256::Signature::span signature);
IanBenzMaxim 7:9cd16581b578 152
IanBenzMaxim 7:9cd16581b578 153 /// Decrement the decrement-only counter.
IanBenzMaxim 7:9cd16581b578 154 MaximInterfaceDevices_EXPORT Core::error_code decrementCounter();
IanBenzMaxim 7:9cd16581b578 155
IanBenzMaxim 7:9cd16581b578 156 /// Permanently disable the device.
IanBenzMaxim 7:9cd16581b578 157 MaximInterfaceDevices_EXPORT Core::error_code disableDevice();
IanBenzMaxim 7:9cd16581b578 158
IanBenzMaxim 7:9cd16581b578 159 /// @brief Generate the device's ECDSA public key from the PUF private key.
IanBenzMaxim 7:9cd16581b578 160 /// @param[out] devicePublicKey Device Public Key
IanBenzMaxim 7:9cd16581b578 161 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 162 readDevicePublicKey(Core::Ecc256::PublicKey::span devicePublicKey);
IanBenzMaxim 7:9cd16581b578 163
IanBenzMaxim 7:9cd16581b578 164 /// @brief Read a block of random data from the RNG.
IanBenzMaxim 7:9cd16581b578 165 /// @param[out] data Random data from RNG with length from 1 to 64.
IanBenzMaxim 7:9cd16581b578 166 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 167 readRng(Core::span<uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 168
IanBenzMaxim 7:9cd16581b578 169 /// @brief
IanBenzMaxim 7:9cd16581b578 170 /// Authenticate a public key for authenticated writes using the
IanBenzMaxim 7:9cd16581b578 171 /// Authority Public Key.
IanBenzMaxim 7:9cd16581b578 172 /// @param certificate
IanBenzMaxim 7:9cd16581b578 173 /// Certificate to use for authentication of the Write Public Key.
IanBenzMaxim 7:9cd16581b578 174 /// @param customization
IanBenzMaxim 7:9cd16581b578 175 /// Certificate customization with length from 1 to 32.
IanBenzMaxim 7:9cd16581b578 176 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 177 authenticatePublicKey(Core::Ecc256::Signature::const_span certificate,
IanBenzMaxim 7:9cd16581b578 178 Core::span<const uint_least8_t> customization);
IanBenzMaxim 7:9cd16581b578 179
IanBenzMaxim 7:9cd16581b578 180 /// @brief Write with ECDSA authentication using the Write Public Key.
IanBenzMaxim 7:9cd16581b578 181 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 182 /// @param page Data to write.
IanBenzMaxim 7:9cd16581b578 183 /// @param signature Signature to use for authentication of page data.
IanBenzMaxim 7:9cd16581b578 184 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 185 authenticatedWriteMemory(int pageNum, Page::const_span page,
IanBenzMaxim 7:9cd16581b578 186 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 187
IanBenzMaxim 7:9cd16581b578 188 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 189 errorCategory();
IanBenzMaxim 7:9cd16581b578 190
IanBenzMaxim 7:9cd16581b578 191 protected:
IanBenzMaxim 7:9cd16581b578 192 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 193 runCommand(Core::span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 7:9cd16581b578 194 Core::span<uint_least8_t> & response);
IanBenzMaxim 7:9cd16581b578 195
IanBenzMaxim 7:9cd16581b578 196 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 197 runCommand(Core::span<const uint_least8_t> request, int delayTime);
IanBenzMaxim 7:9cd16581b578 198
IanBenzMaxim 7:9cd16581b578 199 private:
IanBenzMaxim 7:9cd16581b578 200 Core::RunCommand doRunCommand;
IanBenzMaxim 7:9cd16581b578 201 };
IanBenzMaxim 7:9cd16581b578 202
IanBenzMaxim 7:9cd16581b578 203 inline Core::error_code make_error_code(DS28E39::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 204 return Core::error_code(e, DS28E39::errorCategory());
IanBenzMaxim 7:9cd16581b578 205 }
IanBenzMaxim 7:9cd16581b578 206
IanBenzMaxim 7:9cd16581b578 207 /// @brief Read the device MAN ID using the Read Status command.
IanBenzMaxim 7:9cd16581b578 208 /// @param ds28e39 Device to read.
IanBenzMaxim 7:9cd16581b578 209 /// @param[out] manId Read MAN ID valid when operation is successful.
IanBenzMaxim 7:9cd16581b578 210 MaximInterfaceDevices_EXPORT Core::error_code
IanBenzMaxim 7:9cd16581b578 211 readManId(DS28E39 & ds28e39, Core::ManId::span manId);
IanBenzMaxim 7:9cd16581b578 212
IanBenzMaxim 7:9cd16581b578 213 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 214 class DS28E39::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 215 public:
IanBenzMaxim 7:9cd16581b578 216 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 217 1 + Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 218 Result;
IanBenzMaxim 7:9cd16581b578 219
IanBenzMaxim 7:9cd16581b578 220 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 221
IanBenzMaxim 7:9cd16581b578 222 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 223 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 224
IanBenzMaxim 7:9cd16581b578 225 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 226 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 227 /// @{
IanBenzMaxim 7:9cd16581b578 228
IanBenzMaxim 7:9cd16581b578 229 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 230 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 231 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 232 }
IanBenzMaxim 7:9cd16581b578 233
IanBenzMaxim 7:9cd16581b578 234 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 235 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 236 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 237 }
IanBenzMaxim 7:9cd16581b578 238
IanBenzMaxim 7:9cd16581b578 239 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 240 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 241 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 242 return *this;
IanBenzMaxim 7:9cd16581b578 243 }
IanBenzMaxim 7:9cd16581b578 244
IanBenzMaxim 7:9cd16581b578 245 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 246 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 247
IanBenzMaxim 7:9cd16581b578 248 /// @}
IanBenzMaxim 7:9cd16581b578 249
IanBenzMaxim 7:9cd16581b578 250 /// @name Page
IanBenzMaxim 7:9cd16581b578 251 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 252 /// @{
IanBenzMaxim 7:9cd16581b578 253
IanBenzMaxim 7:9cd16581b578 254 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 255 Page::span page() {
IanBenzMaxim 7:9cd16581b578 256 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 257 }
IanBenzMaxim 7:9cd16581b578 258
IanBenzMaxim 7:9cd16581b578 259 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 260 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 261 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 262 }
IanBenzMaxim 7:9cd16581b578 263
IanBenzMaxim 7:9cd16581b578 264 /// Set page.
IanBenzMaxim 7:9cd16581b578 265 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 266 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 267 return *this;
IanBenzMaxim 7:9cd16581b578 268 }
IanBenzMaxim 7:9cd16581b578 269
IanBenzMaxim 7:9cd16581b578 270 /// @}
IanBenzMaxim 7:9cd16581b578 271
IanBenzMaxim 7:9cd16581b578 272 /// @name Challenge
IanBenzMaxim 7:9cd16581b578 273 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 274 /// @{
IanBenzMaxim 7:9cd16581b578 275
IanBenzMaxim 7:9cd16581b578 276 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 277 Page::span challenge() {
IanBenzMaxim 7:9cd16581b578 278 return make_span(result_).subspan<challengeIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 279 }
IanBenzMaxim 7:9cd16581b578 280
IanBenzMaxim 7:9cd16581b578 281 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 282 Page::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 283 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 284 }
IanBenzMaxim 7:9cd16581b578 285
IanBenzMaxim 7:9cd16581b578 286 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 287 PageAuthenticationData & setChallenge(Page::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 288 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 289 return *this;
IanBenzMaxim 7:9cd16581b578 290 }
IanBenzMaxim 7:9cd16581b578 291
IanBenzMaxim 7:9cd16581b578 292 /// @}
IanBenzMaxim 7:9cd16581b578 293
IanBenzMaxim 7:9cd16581b578 294 /// @name Page number
IanBenzMaxim 7:9cd16581b578 295 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 296 /// @{
IanBenzMaxim 7:9cd16581b578 297
IanBenzMaxim 7:9cd16581b578 298 /// Get page number.
IanBenzMaxim 7:9cd16581b578 299 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 300
IanBenzMaxim 7:9cd16581b578 301 /// Set page number.
IanBenzMaxim 7:9cd16581b578 302 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 303 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 304 return *this;
IanBenzMaxim 7:9cd16581b578 305 }
IanBenzMaxim 7:9cd16581b578 306
IanBenzMaxim 7:9cd16581b578 307 /// @}
IanBenzMaxim 7:9cd16581b578 308
IanBenzMaxim 7:9cd16581b578 309 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 310 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 311 /// @{
IanBenzMaxim 7:9cd16581b578 312
IanBenzMaxim 7:9cd16581b578 313 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 314 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 315 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 316 }
IanBenzMaxim 7:9cd16581b578 317
IanBenzMaxim 7:9cd16581b578 318 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 319 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 320 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 321 }
IanBenzMaxim 7:9cd16581b578 322
IanBenzMaxim 7:9cd16581b578 323 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 324 PageAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 325 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 326 return *this;
IanBenzMaxim 7:9cd16581b578 327 }
IanBenzMaxim 7:9cd16581b578 328
IanBenzMaxim 7:9cd16581b578 329 /// @}
IanBenzMaxim 7:9cd16581b578 330
IanBenzMaxim 7:9cd16581b578 331 private:
IanBenzMaxim 7:9cd16581b578 332 typedef Result::span::index_type index;
IanBenzMaxim 7:9cd16581b578 333
IanBenzMaxim 7:9cd16581b578 334 static const index romIdIdx = 0;
IanBenzMaxim 7:9cd16581b578 335 static const index pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 7:9cd16581b578 336 static const index challengeIdx = pageIdx + Page::size;
IanBenzMaxim 7:9cd16581b578 337 static const index pageNumIdx = challengeIdx + Page::size;
IanBenzMaxim 7:9cd16581b578 338 static const index manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 339
IanBenzMaxim 7:9cd16581b578 340 Result::array result_;
IanBenzMaxim 7:9cd16581b578 341 };
IanBenzMaxim 7:9cd16581b578 342
IanBenzMaxim 7:9cd16581b578 343 /// Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 344 class DS28E39::WriteAuthenticationData {
IanBenzMaxim 7:9cd16581b578 345 public:
IanBenzMaxim 7:9cd16581b578 346 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 347
IanBenzMaxim 7:9cd16581b578 348 WriteAuthenticationData() : data() { setPageNum(0); }
IanBenzMaxim 7:9cd16581b578 349
IanBenzMaxim 7:9cd16581b578 350 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 351 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 352
IanBenzMaxim 7:9cd16581b578 353 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 354 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 355 /// @{
IanBenzMaxim 7:9cd16581b578 356
IanBenzMaxim 7:9cd16581b578 357 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 358 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 359
IanBenzMaxim 7:9cd16581b578 360 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 361 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 362
IanBenzMaxim 7:9cd16581b578 363 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 364 WriteAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 365 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 366 return *this;
IanBenzMaxim 7:9cd16581b578 367 }
IanBenzMaxim 7:9cd16581b578 368
IanBenzMaxim 7:9cd16581b578 369 /// @}
IanBenzMaxim 7:9cd16581b578 370
IanBenzMaxim 7:9cd16581b578 371 /// @name Old page
IanBenzMaxim 7:9cd16581b578 372 /// @brief Existing data contained in the page.
IanBenzMaxim 7:9cd16581b578 373 /// @{
IanBenzMaxim 7:9cd16581b578 374
IanBenzMaxim 7:9cd16581b578 375 /// Get mutable old page.
IanBenzMaxim 7:9cd16581b578 376 Page::span oldPage() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 377
IanBenzMaxim 7:9cd16581b578 378 /// Get immutable old page.
IanBenzMaxim 7:9cd16581b578 379 Page::const_span oldPage() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 380
IanBenzMaxim 7:9cd16581b578 381 /// Set old page.
IanBenzMaxim 7:9cd16581b578 382 WriteAuthenticationData & setOldPage(Page::const_span oldPage) {
IanBenzMaxim 7:9cd16581b578 383 data.setPage(oldPage);
IanBenzMaxim 7:9cd16581b578 384 return *this;
IanBenzMaxim 7:9cd16581b578 385 }
IanBenzMaxim 7:9cd16581b578 386
IanBenzMaxim 7:9cd16581b578 387 /// @}
IanBenzMaxim 7:9cd16581b578 388
IanBenzMaxim 7:9cd16581b578 389 /// @name New page
IanBenzMaxim 7:9cd16581b578 390 /// @brief New data to write to the page.
IanBenzMaxim 7:9cd16581b578 391 /// @{
IanBenzMaxim 7:9cd16581b578 392
IanBenzMaxim 7:9cd16581b578 393 /// Get mutable new page.
IanBenzMaxim 7:9cd16581b578 394 Page::span newPage() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 395
IanBenzMaxim 7:9cd16581b578 396 /// Get immutable new page.
IanBenzMaxim 7:9cd16581b578 397 Page::const_span newPage() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 398
IanBenzMaxim 7:9cd16581b578 399 /// Set new page.
IanBenzMaxim 7:9cd16581b578 400 WriteAuthenticationData & setNewPage(Page::const_span newPage) {
IanBenzMaxim 7:9cd16581b578 401 data.setChallenge(newPage);
IanBenzMaxim 7:9cd16581b578 402 return *this;
IanBenzMaxim 7:9cd16581b578 403 }
IanBenzMaxim 7:9cd16581b578 404
IanBenzMaxim 7:9cd16581b578 405 /// @}
IanBenzMaxim 7:9cd16581b578 406
IanBenzMaxim 7:9cd16581b578 407 /// @name Page number
IanBenzMaxim 7:9cd16581b578 408 /// @brief Page number for write operation.
IanBenzMaxim 7:9cd16581b578 409 /// @{
IanBenzMaxim 7:9cd16581b578 410
IanBenzMaxim 7:9cd16581b578 411 /// Get page number.
IanBenzMaxim 7:9cd16581b578 412 int pageNum() const { return data.pageNum() & 0x7F; }
IanBenzMaxim 7:9cd16581b578 413
IanBenzMaxim 7:9cd16581b578 414 /// Set page number.
IanBenzMaxim 7:9cd16581b578 415 WriteAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 416 data.setPageNum(pageNum | 0x80);
IanBenzMaxim 7:9cd16581b578 417 return *this;
IanBenzMaxim 7:9cd16581b578 418 }
IanBenzMaxim 7:9cd16581b578 419
IanBenzMaxim 7:9cd16581b578 420 /// @}
IanBenzMaxim 7:9cd16581b578 421
IanBenzMaxim 7:9cd16581b578 422 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 423 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 424 /// @{
IanBenzMaxim 7:9cd16581b578 425
IanBenzMaxim 7:9cd16581b578 426 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 427 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 428
IanBenzMaxim 7:9cd16581b578 429 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 430 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 431
IanBenzMaxim 7:9cd16581b578 432 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 433 WriteAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 434 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 435 return *this;
IanBenzMaxim 7:9cd16581b578 436 }
IanBenzMaxim 7:9cd16581b578 437
IanBenzMaxim 7:9cd16581b578 438 /// @}
IanBenzMaxim 7:9cd16581b578 439
IanBenzMaxim 7:9cd16581b578 440 private:
IanBenzMaxim 7:9cd16581b578 441 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 442 };
IanBenzMaxim 7:9cd16581b578 443
IanBenzMaxim 7:9cd16581b578 444 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 445
IanBenzMaxim 7:9cd16581b578 446 #endif