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@12:7eb41621ba22, 2020-05-29 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 29 16:19:22 2020 -0500
Revision:
12:7eb41621ba22
Parent:
8:5ea891c7d1a1 
Updated to version 2.2.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 8:5ea891c7d1a1 33 #ifndef MaximInterfaceDevices_DS28E39_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28E39_hpp
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 8:5ea891c7d1a1 101 typedef Core::array_span<PageProtection, memoryPages - 2>
IanBenzMaxim 8:5ea891c7d1a1 102 PageProtectionList;
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 8:5ea891c7d1a1 104 typedef Core::array_span<uint_least8_t, 2> RomVersion;
IanBenzMaxim 8:5ea891c7d1a1 105
IanBenzMaxim 8:5ea891c7d1a1 106 PageProtectionList::array pageProtection;
IanBenzMaxim 7:9cd16581b578 107 Core::ManId::array manId;
IanBenzMaxim 8:5ea891c7d1a1 108 RomVersion::array romVersion;
IanBenzMaxim 7:9cd16581b578 109 EntropyHealthTestStatus entropyHealthTestStatus;
IanBenzMaxim 7:9cd16581b578 110 };
IanBenzMaxim 7:9cd16581b578 111
IanBenzMaxim 7:9cd16581b578 112 explicit DS28E39(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 113 : doRunCommand(runCommand) {}
IanBenzMaxim 7:9cd16581b578 114
IanBenzMaxim 7:9cd16581b578 115 void setRunCommand(const Core::RunCommand & runCommand) {
IanBenzMaxim 7:9cd16581b578 116 doRunCommand = runCommand;
IanBenzMaxim 7:9cd16581b578 117 }
IanBenzMaxim 7:9cd16581b578 118
IanBenzMaxim 7:9cd16581b578 119 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 120 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 121 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 122 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 123 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 124
IanBenzMaxim 7:9cd16581b578 125 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 126 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 127 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 128 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 129 readMemory(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 130
IanBenzMaxim 7:9cd16581b578 131 /// @brief
IanBenzMaxim 7:9cd16581b578 132 /// Reads the current status of the device and optionally performs an
IanBenzMaxim 7:9cd16581b578 133 /// entropy health test.
IanBenzMaxim 7:9cd16581b578 134 /// @param entropyHealthTest True to perform an entropy health test.
IanBenzMaxim 8:5ea891c7d1a1 135 /// @returns Status that was read.
IanBenzMaxim 8:5ea891c7d1a1 136 MaximInterfaceDevices_EXPORT Core::Result<Status>
IanBenzMaxim 8:5ea891c7d1a1 137 readStatus(bool entropyHealthTest) const;
IanBenzMaxim 7:9cd16581b578 138
IanBenzMaxim 7:9cd16581b578 139 /// @brief Set the protection settings of a page.
IanBenzMaxim 7:9cd16581b578 140 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 141 /// @param protection Protection to write.
IanBenzMaxim 8:5ea891c7d1a1 142 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 143 setPageProtection(int pageNum, const PageProtection & protection);
IanBenzMaxim 7:9cd16581b578 144
IanBenzMaxim 7:9cd16581b578 145 /// @brief Compute and read page authentication with ECDSA.
IanBenzMaxim 7:9cd16581b578 146 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 147 /// @param anonymous True to disable use of ROM ID in computation.
IanBenzMaxim 7:9cd16581b578 148 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 149 /// @returns Computed page signature.
IanBenzMaxim 8:5ea891c7d1a1 150 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::Signature::array>
IanBenzMaxim 7:9cd16581b578 151 computeAndReadPageAuthentication(int pageNum, bool anonymous,
IanBenzMaxim 8:5ea891c7d1a1 152 Page::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 153
IanBenzMaxim 7:9cd16581b578 154 /// Decrement the decrement-only counter.
IanBenzMaxim 8:5ea891c7d1a1 155 MaximInterfaceDevices_EXPORT Core::Result<void> decrementCounter();
IanBenzMaxim 7:9cd16581b578 156
IanBenzMaxim 7:9cd16581b578 157 /// Permanently disable the device.
IanBenzMaxim 8:5ea891c7d1a1 158 MaximInterfaceDevices_EXPORT Core::Result<void> disableDevice();
IanBenzMaxim 7:9cd16581b578 159
IanBenzMaxim 7:9cd16581b578 160 /// @brief Generate the device's ECDSA public key from the PUF private key.
IanBenzMaxim 8:5ea891c7d1a1 161 /// @returns Device Public Key
IanBenzMaxim 8:5ea891c7d1a1 162 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::PublicKey::array>
IanBenzMaxim 8:5ea891c7d1a1 163 readDevicePublicKey() const;
IanBenzMaxim 7:9cd16581b578 164
IanBenzMaxim 7:9cd16581b578 165 /// @brief Read a block of random data from the RNG.
IanBenzMaxim 7:9cd16581b578 166 /// @param[out] data Random data from RNG with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 167 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 168 readRng(Core::span<uint_least8_t> data) const;
IanBenzMaxim 7:9cd16581b578 169
IanBenzMaxim 7:9cd16581b578 170 /// @brief
IanBenzMaxim 7:9cd16581b578 171 /// Authenticate a public key for authenticated writes using the
IanBenzMaxim 7:9cd16581b578 172 /// Authority Public Key.
IanBenzMaxim 7:9cd16581b578 173 /// @param certificate
IanBenzMaxim 7:9cd16581b578 174 /// Certificate to use for authentication of the Write Public Key.
IanBenzMaxim 7:9cd16581b578 175 /// @param customization
IanBenzMaxim 7:9cd16581b578 176 /// Certificate customization with length from 1 to 32.
IanBenzMaxim 8:5ea891c7d1a1 177 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 178 authenticatePublicKey(Core::Ecc256::Signature::const_span certificate,
IanBenzMaxim 7:9cd16581b578 179 Core::span<const uint_least8_t> customization);
IanBenzMaxim 7:9cd16581b578 180
IanBenzMaxim 7:9cd16581b578 181 /// @brief Write with ECDSA authentication using the Write Public Key.
IanBenzMaxim 7:9cd16581b578 182 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 183 /// @param page Data to write.
IanBenzMaxim 7:9cd16581b578 184 /// @param signature Signature to use for authentication of page data.
IanBenzMaxim 8:5ea891c7d1a1 185 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 186 authenticatedWriteMemory(int pageNum, Page::const_span page,
IanBenzMaxim 7:9cd16581b578 187 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 188
IanBenzMaxim 7:9cd16581b578 189 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 190 errorCategory();
IanBenzMaxim 7:9cd16581b578 191
IanBenzMaxim 7:9cd16581b578 192 protected:
IanBenzMaxim 8:5ea891c7d1a1 193 MaximInterfaceDevices_EXPORT Core::Result<Core::span<uint_least8_t> >
IanBenzMaxim 7:9cd16581b578 194 runCommand(Core::span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 195 Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 196
IanBenzMaxim 8:5ea891c7d1a1 197 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 198 runCommand(Core::span<const uint_least8_t> request, int delayTime);
IanBenzMaxim 7:9cd16581b578 199
IanBenzMaxim 7:9cd16581b578 200 private:
IanBenzMaxim 7:9cd16581b578 201 Core::RunCommand doRunCommand;
IanBenzMaxim 7:9cd16581b578 202 };
IanBenzMaxim 7:9cd16581b578 203
IanBenzMaxim 8:5ea891c7d1a1 204 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 205 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 206
IanBenzMaxim 8:5ea891c7d1a1 207 template <>
IanBenzMaxim 8:5ea891c7d1a1 208 struct is_error_code_enum<MaximInterfaceDevices::DS28E39::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 209 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 210
IanBenzMaxim 8:5ea891c7d1a1 211 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 212 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 213
IanBenzMaxim 7:9cd16581b578 214 inline Core::error_code make_error_code(DS28E39::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 215 return Core::error_code(e, DS28E39::errorCategory());
IanBenzMaxim 7:9cd16581b578 216 }
IanBenzMaxim 7:9cd16581b578 217
IanBenzMaxim 7:9cd16581b578 218 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 219 class DS28E39::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 220 public:
IanBenzMaxim 7:9cd16581b578 221 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 222 1 + Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 223 Result;
IanBenzMaxim 7:9cd16581b578 224
IanBenzMaxim 7:9cd16581b578 225 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 226
IanBenzMaxim 7:9cd16581b578 227 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 228 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 229
IanBenzMaxim 7:9cd16581b578 230 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 231 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 232 /// @{
IanBenzMaxim 7:9cd16581b578 233
IanBenzMaxim 7:9cd16581b578 234 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 235 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 236 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 237 }
IanBenzMaxim 7:9cd16581b578 238
IanBenzMaxim 7:9cd16581b578 239 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 240 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 241 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 242 }
IanBenzMaxim 7:9cd16581b578 243
IanBenzMaxim 7:9cd16581b578 244 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 245 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 246 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 247 return *this;
IanBenzMaxim 7:9cd16581b578 248 }
IanBenzMaxim 7:9cd16581b578 249
IanBenzMaxim 7:9cd16581b578 250 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 251 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 252
IanBenzMaxim 7:9cd16581b578 253 /// @}
IanBenzMaxim 7:9cd16581b578 254
IanBenzMaxim 7:9cd16581b578 255 /// @name Page
IanBenzMaxim 7:9cd16581b578 256 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 257 /// @{
IanBenzMaxim 7:9cd16581b578 258
IanBenzMaxim 7:9cd16581b578 259 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 260 Page::span page() {
IanBenzMaxim 7:9cd16581b578 261 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 262 }
IanBenzMaxim 7:9cd16581b578 263
IanBenzMaxim 7:9cd16581b578 264 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 265 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 266 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 267 }
IanBenzMaxim 7:9cd16581b578 268
IanBenzMaxim 7:9cd16581b578 269 /// Set page.
IanBenzMaxim 7:9cd16581b578 270 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 271 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 272 return *this;
IanBenzMaxim 7:9cd16581b578 273 }
IanBenzMaxim 7:9cd16581b578 274
IanBenzMaxim 7:9cd16581b578 275 /// @}
IanBenzMaxim 7:9cd16581b578 276
IanBenzMaxim 7:9cd16581b578 277 /// @name Challenge
IanBenzMaxim 7:9cd16581b578 278 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 279 /// @{
IanBenzMaxim 7:9cd16581b578 280
IanBenzMaxim 7:9cd16581b578 281 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 282 Page::span challenge() {
IanBenzMaxim 7:9cd16581b578 283 return make_span(result_).subspan<challengeIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 284 }
IanBenzMaxim 7:9cd16581b578 285
IanBenzMaxim 7:9cd16581b578 286 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 287 Page::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 288 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 289 }
IanBenzMaxim 7:9cd16581b578 290
IanBenzMaxim 7:9cd16581b578 291 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 292 PageAuthenticationData & setChallenge(Page::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 293 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 294 return *this;
IanBenzMaxim 7:9cd16581b578 295 }
IanBenzMaxim 7:9cd16581b578 296
IanBenzMaxim 7:9cd16581b578 297 /// @}
IanBenzMaxim 7:9cd16581b578 298
IanBenzMaxim 7:9cd16581b578 299 /// @name Page number
IanBenzMaxim 7:9cd16581b578 300 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 301 /// @{
IanBenzMaxim 7:9cd16581b578 302
IanBenzMaxim 7:9cd16581b578 303 /// Get page number.
IanBenzMaxim 7:9cd16581b578 304 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 305
IanBenzMaxim 7:9cd16581b578 306 /// Set page number.
IanBenzMaxim 7:9cd16581b578 307 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 308 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 309 return *this;
IanBenzMaxim 7:9cd16581b578 310 }
IanBenzMaxim 7:9cd16581b578 311
IanBenzMaxim 7:9cd16581b578 312 /// @}
IanBenzMaxim 7:9cd16581b578 313
IanBenzMaxim 7:9cd16581b578 314 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 315 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 316 /// @{
IanBenzMaxim 7:9cd16581b578 317
IanBenzMaxim 7:9cd16581b578 318 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 319 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 320 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 321 }
IanBenzMaxim 7:9cd16581b578 322
IanBenzMaxim 7:9cd16581b578 323 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 324 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 325 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 326 }
IanBenzMaxim 7:9cd16581b578 327
IanBenzMaxim 7:9cd16581b578 328 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 329 PageAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 330 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 331 return *this;
IanBenzMaxim 7:9cd16581b578 332 }
IanBenzMaxim 7:9cd16581b578 333
IanBenzMaxim 7:9cd16581b578 334 /// @}
IanBenzMaxim 7:9cd16581b578 335
IanBenzMaxim 7:9cd16581b578 336 private:
IanBenzMaxim 8:5ea891c7d1a1 337 static const size_t romIdIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 338 static const size_t pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 339 static const size_t challengeIdx = pageIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 340 static const size_t pageNumIdx = challengeIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 341 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 342
IanBenzMaxim 7:9cd16581b578 343 Result::array result_;
IanBenzMaxim 7:9cd16581b578 344 };
IanBenzMaxim 7:9cd16581b578 345
IanBenzMaxim 7:9cd16581b578 346 /// Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 347 class DS28E39::WriteAuthenticationData {
IanBenzMaxim 7:9cd16581b578 348 public:
IanBenzMaxim 7:9cd16581b578 349 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 350
IanBenzMaxim 7:9cd16581b578 351 WriteAuthenticationData() : data() { setPageNum(0); }
IanBenzMaxim 7:9cd16581b578 352
IanBenzMaxim 7:9cd16581b578 353 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 354 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 355
IanBenzMaxim 7:9cd16581b578 356 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 357 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 358 /// @{
IanBenzMaxim 7:9cd16581b578 359
IanBenzMaxim 7:9cd16581b578 360 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 361 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 362
IanBenzMaxim 7:9cd16581b578 363 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 364 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 365
IanBenzMaxim 7:9cd16581b578 366 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 367 WriteAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 368 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 369 return *this;
IanBenzMaxim 7:9cd16581b578 370 }
IanBenzMaxim 7:9cd16581b578 371
IanBenzMaxim 7:9cd16581b578 372 /// @}
IanBenzMaxim 7:9cd16581b578 373
IanBenzMaxim 7:9cd16581b578 374 /// @name Old page
IanBenzMaxim 7:9cd16581b578 375 /// @brief Existing data contained in the page.
IanBenzMaxim 7:9cd16581b578 376 /// @{
IanBenzMaxim 7:9cd16581b578 377
IanBenzMaxim 7:9cd16581b578 378 /// Get mutable old page.
IanBenzMaxim 7:9cd16581b578 379 Page::span oldPage() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 380
IanBenzMaxim 7:9cd16581b578 381 /// Get immutable old page.
IanBenzMaxim 7:9cd16581b578 382 Page::const_span oldPage() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 383
IanBenzMaxim 7:9cd16581b578 384 /// Set old page.
IanBenzMaxim 7:9cd16581b578 385 WriteAuthenticationData & setOldPage(Page::const_span oldPage) {
IanBenzMaxim 7:9cd16581b578 386 data.setPage(oldPage);
IanBenzMaxim 7:9cd16581b578 387 return *this;
IanBenzMaxim 7:9cd16581b578 388 }
IanBenzMaxim 7:9cd16581b578 389
IanBenzMaxim 7:9cd16581b578 390 /// @}
IanBenzMaxim 7:9cd16581b578 391
IanBenzMaxim 7:9cd16581b578 392 /// @name New page
IanBenzMaxim 7:9cd16581b578 393 /// @brief New data to write to the page.
IanBenzMaxim 7:9cd16581b578 394 /// @{
IanBenzMaxim 7:9cd16581b578 395
IanBenzMaxim 7:9cd16581b578 396 /// Get mutable new page.
IanBenzMaxim 7:9cd16581b578 397 Page::span newPage() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 398
IanBenzMaxim 7:9cd16581b578 399 /// Get immutable new page.
IanBenzMaxim 7:9cd16581b578 400 Page::const_span newPage() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 401
IanBenzMaxim 7:9cd16581b578 402 /// Set new page.
IanBenzMaxim 7:9cd16581b578 403 WriteAuthenticationData & setNewPage(Page::const_span newPage) {
IanBenzMaxim 7:9cd16581b578 404 data.setChallenge(newPage);
IanBenzMaxim 7:9cd16581b578 405 return *this;
IanBenzMaxim 7:9cd16581b578 406 }
IanBenzMaxim 7:9cd16581b578 407
IanBenzMaxim 7:9cd16581b578 408 /// @}
IanBenzMaxim 7:9cd16581b578 409
IanBenzMaxim 7:9cd16581b578 410 /// @name Page number
IanBenzMaxim 7:9cd16581b578 411 /// @brief Page number for write operation.
IanBenzMaxim 7:9cd16581b578 412 /// @{
IanBenzMaxim 7:9cd16581b578 413
IanBenzMaxim 7:9cd16581b578 414 /// Get page number.
IanBenzMaxim 7:9cd16581b578 415 int pageNum() const { return data.pageNum() & 0x7F; }
IanBenzMaxim 7:9cd16581b578 416
IanBenzMaxim 7:9cd16581b578 417 /// Set page number.
IanBenzMaxim 7:9cd16581b578 418 WriteAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 419 data.setPageNum(pageNum | 0x80);
IanBenzMaxim 7:9cd16581b578 420 return *this;
IanBenzMaxim 7:9cd16581b578 421 }
IanBenzMaxim 7:9cd16581b578 422
IanBenzMaxim 7:9cd16581b578 423 /// @}
IanBenzMaxim 7:9cd16581b578 424
IanBenzMaxim 7:9cd16581b578 425 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 426 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 427 /// @{
IanBenzMaxim 7:9cd16581b578 428
IanBenzMaxim 7:9cd16581b578 429 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 430 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 431
IanBenzMaxim 7:9cd16581b578 432 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 433 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 434
IanBenzMaxim 7:9cd16581b578 435 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 436 WriteAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 437 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 438 return *this;
IanBenzMaxim 7:9cd16581b578 439 }
IanBenzMaxim 7:9cd16581b578 440
IanBenzMaxim 7:9cd16581b578 441 /// @}
IanBenzMaxim 7:9cd16581b578 442
IanBenzMaxim 7:9cd16581b578 443 private:
IanBenzMaxim 7:9cd16581b578 444 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 445 };
IanBenzMaxim 7:9cd16581b578 446
IanBenzMaxim 7:9cd16581b578 447 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 448
IanBenzMaxim 7:9cd16581b578 449 #endif