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/DS28E38.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_DS28E38_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28E38_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 DS28E38 {
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 InvalidResponseError =
IanBenzMaxim 7:9cd16581b578 59 0x100 ///< 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 = 3;
IanBenzMaxim 7:9cd16581b578 66 static const int publicKeyXPage = 4;
IanBenzMaxim 7:9cd16581b578 67 static const int publicKeyYPage = 5;
IanBenzMaxim 7:9cd16581b578 68 static const int privateKeyPage = 6;
IanBenzMaxim 7:9cd16581b578 69
IanBenzMaxim 7:9cd16581b578 70 /// @}
IanBenzMaxim 7:9cd16581b578 71
IanBenzMaxim 7:9cd16581b578 72 static const int memoryPages = 7;
IanBenzMaxim 7:9cd16581b578 73
IanBenzMaxim 7:9cd16581b578 74 /// Holds a device memory page.
IanBenzMaxim 7:9cd16581b578 75 typedef Core::array_span<uint_least8_t, 32> Page;
IanBenzMaxim 7:9cd16581b578 76
IanBenzMaxim 7:9cd16581b578 77 // Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 78 class PageAuthenticationData;
IanBenzMaxim 7:9cd16581b578 79
IanBenzMaxim 7:9cd16581b578 80 /// Page protection types.
IanBenzMaxim 7:9cd16581b578 81 enum PageProtectionType {
IanBenzMaxim 7:9cd16581b578 82 RP = 0x01, ///< Read protection.
IanBenzMaxim 7:9cd16581b578 83 WP = 0x02, ///< Write protection.
IanBenzMaxim 7:9cd16581b578 84 EM = 0x04, ///< EPROM emulation mode.
IanBenzMaxim 7:9cd16581b578 85 DC = 0x08, ///< Decrement counter.
IanBenzMaxim 7:9cd16581b578 86 PF = 0x10 ///< PUF used as private key.
IanBenzMaxim 7:9cd16581b578 87 };
IanBenzMaxim 7:9cd16581b578 88 typedef Core::FlagSet<PageProtectionType, 5> PageProtection;
IanBenzMaxim 7:9cd16581b578 89
IanBenzMaxim 7:9cd16581b578 90 struct Status {
IanBenzMaxim 7:9cd16581b578 91 enum EntropyHealthTestStatus {
IanBenzMaxim 7:9cd16581b578 92 TestNotPerformed = 0xFF,
IanBenzMaxim 7:9cd16581b578 93 EntropyHealthy = 0xAA,
IanBenzMaxim 7:9cd16581b578 94 EntropyNotHealthy = 0xDD
IanBenzMaxim 7:9cd16581b578 95 };
IanBenzMaxim 7:9cd16581b578 96
IanBenzMaxim 8:5ea891c7d1a1 97 typedef Core::array_span<PageProtection, memoryPages> PageProtectionList;
IanBenzMaxim 8:5ea891c7d1a1 98 typedef Core::array_span<uint_least8_t, 2> RomVersion;
IanBenzMaxim 7:9cd16581b578 99
IanBenzMaxim 8:5ea891c7d1a1 100 PageProtectionList::array pageProtection;
IanBenzMaxim 7:9cd16581b578 101 Core::ManId::array manId;
IanBenzMaxim 8:5ea891c7d1a1 102 RomVersion::array romVersion;
IanBenzMaxim 7:9cd16581b578 103 EntropyHealthTestStatus entropyHealthTestStatus;
IanBenzMaxim 7:9cd16581b578 104 };
IanBenzMaxim 7:9cd16581b578 105
IanBenzMaxim 7:9cd16581b578 106 explicit DS28E38(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 107 : doRunCommand(runCommand) {}
IanBenzMaxim 7:9cd16581b578 108
IanBenzMaxim 7:9cd16581b578 109 void setRunCommand(const Core::RunCommand & runCommand) {
IanBenzMaxim 7:9cd16581b578 110 doRunCommand = runCommand;
IanBenzMaxim 7:9cd16581b578 111 }
IanBenzMaxim 7:9cd16581b578 112
IanBenzMaxim 7:9cd16581b578 113 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 114 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 115 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 116 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 117 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 118
IanBenzMaxim 7:9cd16581b578 119 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 120 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 121 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 122 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 123 readMemory(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 124
IanBenzMaxim 7:9cd16581b578 125 /// @brief
IanBenzMaxim 7:9cd16581b578 126 /// Reads the current status of the device and optionally performs an
IanBenzMaxim 7:9cd16581b578 127 /// entropy health test.
IanBenzMaxim 7:9cd16581b578 128 /// @param entropyHealthTest True to perform an entropy health test.
IanBenzMaxim 8:5ea891c7d1a1 129 /// @returns status Status that was read.
IanBenzMaxim 8:5ea891c7d1a1 130 MaximInterfaceDevices_EXPORT Core::Result<Status>
IanBenzMaxim 8:5ea891c7d1a1 131 readStatus(bool entropyHealthTest) const;
IanBenzMaxim 7:9cd16581b578 132
IanBenzMaxim 7:9cd16581b578 133 /// @brief Set the protection settings of a page.
IanBenzMaxim 7:9cd16581b578 134 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 135 /// @param protection Protection to write.
IanBenzMaxim 8:5ea891c7d1a1 136 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 137 setPageProtection(int pageNum, const PageProtection & protection);
IanBenzMaxim 7:9cd16581b578 138
IanBenzMaxim 7:9cd16581b578 139 /// @brief Compute and read page authentication with ECDSA.
IanBenzMaxim 7:9cd16581b578 140 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 141 /// @param anonymous True to disable use of ROM ID in computation.
IanBenzMaxim 7:9cd16581b578 142 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 143 /// @returns Computed page signature.
IanBenzMaxim 8:5ea891c7d1a1 144 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::Signature::array>
IanBenzMaxim 7:9cd16581b578 145 computeAndReadPageAuthentication(int pageNum, bool anonymous,
IanBenzMaxim 8:5ea891c7d1a1 146 Page::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 147
IanBenzMaxim 7:9cd16581b578 148 /// Decrement the decrement-only counter.
IanBenzMaxim 8:5ea891c7d1a1 149 MaximInterfaceDevices_EXPORT Core::Result<void> decrementCounter();
IanBenzMaxim 7:9cd16581b578 150
IanBenzMaxim 7:9cd16581b578 151 /// Permanently disable the device.
IanBenzMaxim 8:5ea891c7d1a1 152 MaximInterfaceDevices_EXPORT Core::Result<void> disableDevice();
IanBenzMaxim 7:9cd16581b578 153
IanBenzMaxim 7:9cd16581b578 154 /// @brief Generate a new ECDSA public key from an existing private key.
IanBenzMaxim 7:9cd16581b578 155 /// @param privateKeyPuf True if PUF is used as the private key.
IanBenzMaxim 7:9cd16581b578 156 /// @param writeProtectEnable True to lock the key against further writes.
IanBenzMaxim 8:5ea891c7d1a1 157 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 158 generateEcc256KeyPair(bool privateKeyPuf, bool writeProtectEnable);
IanBenzMaxim 7:9cd16581b578 159
IanBenzMaxim 7:9cd16581b578 160 /// @brief Read a block of random data from the RNG.
IanBenzMaxim 7:9cd16581b578 161 /// @param[out] data Random data from RNG with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 162 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 163 readRng(Core::span<uint_least8_t> data) const;
IanBenzMaxim 7:9cd16581b578 164
IanBenzMaxim 7:9cd16581b578 165 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 166 errorCategory();
IanBenzMaxim 7:9cd16581b578 167
IanBenzMaxim 7:9cd16581b578 168 protected:
IanBenzMaxim 8:5ea891c7d1a1 169 MaximInterfaceDevices_EXPORT Core::Result<Core::span<uint_least8_t> >
IanBenzMaxim 7:9cd16581b578 170 runCommand(Core::span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 171 Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 172
IanBenzMaxim 8:5ea891c7d1a1 173 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 174 runCommand(Core::span<const uint_least8_t> request, int delayTime);
IanBenzMaxim 7:9cd16581b578 175
IanBenzMaxim 7:9cd16581b578 176 private:
IanBenzMaxim 7:9cd16581b578 177 Core::RunCommand doRunCommand;
IanBenzMaxim 7:9cd16581b578 178 };
IanBenzMaxim 7:9cd16581b578 179
IanBenzMaxim 8:5ea891c7d1a1 180 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 181 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 182
IanBenzMaxim 8:5ea891c7d1a1 183 template <>
IanBenzMaxim 8:5ea891c7d1a1 184 struct is_error_code_enum<MaximInterfaceDevices::DS28E38::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 185 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 186
IanBenzMaxim 8:5ea891c7d1a1 187 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 188 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 189
IanBenzMaxim 7:9cd16581b578 190 inline Core::error_code make_error_code(DS28E38::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 191 return Core::error_code(e, DS28E38::errorCategory());
IanBenzMaxim 7:9cd16581b578 192 }
IanBenzMaxim 7:9cd16581b578 193
IanBenzMaxim 7:9cd16581b578 194 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 195 class DS28E38::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 196 public:
IanBenzMaxim 7:9cd16581b578 197 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 198 1 + Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 199 Result;
IanBenzMaxim 7:9cd16581b578 200
IanBenzMaxim 7:9cd16581b578 201 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 202
IanBenzMaxim 7:9cd16581b578 203 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 204 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 205
IanBenzMaxim 7:9cd16581b578 206 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 207 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 208 /// @{
IanBenzMaxim 7:9cd16581b578 209
IanBenzMaxim 7:9cd16581b578 210 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 211 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 212 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 213 }
IanBenzMaxim 7:9cd16581b578 214
IanBenzMaxim 7:9cd16581b578 215 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 216 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 217 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 218 }
IanBenzMaxim 7:9cd16581b578 219
IanBenzMaxim 7:9cd16581b578 220 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 221 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 222 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 223 return *this;
IanBenzMaxim 7:9cd16581b578 224 }
IanBenzMaxim 7:9cd16581b578 225
IanBenzMaxim 7:9cd16581b578 226 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 227 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 228
IanBenzMaxim 7:9cd16581b578 229 /// @}
IanBenzMaxim 7:9cd16581b578 230
IanBenzMaxim 7:9cd16581b578 231 /// @name Page
IanBenzMaxim 7:9cd16581b578 232 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 233 /// @{
IanBenzMaxim 7:9cd16581b578 234
IanBenzMaxim 7:9cd16581b578 235 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 236 Page::span page() {
IanBenzMaxim 7:9cd16581b578 237 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 238 }
IanBenzMaxim 7:9cd16581b578 239
IanBenzMaxim 7:9cd16581b578 240 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 241 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 242 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 243 }
IanBenzMaxim 7:9cd16581b578 244
IanBenzMaxim 7:9cd16581b578 245 /// Set page.
IanBenzMaxim 7:9cd16581b578 246 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 247 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 248 return *this;
IanBenzMaxim 7:9cd16581b578 249 }
IanBenzMaxim 7:9cd16581b578 250
IanBenzMaxim 7:9cd16581b578 251 /// @}
IanBenzMaxim 7:9cd16581b578 252
IanBenzMaxim 7:9cd16581b578 253 /// @name Challenge
IanBenzMaxim 7:9cd16581b578 254 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 255 /// @{
IanBenzMaxim 7:9cd16581b578 256
IanBenzMaxim 7:9cd16581b578 257 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 258 Page::span challenge() {
IanBenzMaxim 7:9cd16581b578 259 return make_span(result_).subspan<challengeIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 260 }
IanBenzMaxim 7:9cd16581b578 261
IanBenzMaxim 7:9cd16581b578 262 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 263 Page::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 264 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 265 }
IanBenzMaxim 7:9cd16581b578 266
IanBenzMaxim 7:9cd16581b578 267 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 268 PageAuthenticationData & setChallenge(Page::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 269 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 270 return *this;
IanBenzMaxim 7:9cd16581b578 271 }
IanBenzMaxim 7:9cd16581b578 272
IanBenzMaxim 7:9cd16581b578 273 /// @}
IanBenzMaxim 7:9cd16581b578 274
IanBenzMaxim 7:9cd16581b578 275 /// @name Page number
IanBenzMaxim 7:9cd16581b578 276 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 277 /// @{
IanBenzMaxim 7:9cd16581b578 278
IanBenzMaxim 7:9cd16581b578 279 /// Get page number.
IanBenzMaxim 7:9cd16581b578 280 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 281
IanBenzMaxim 7:9cd16581b578 282 /// Set page number.
IanBenzMaxim 7:9cd16581b578 283 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 284 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 285 return *this;
IanBenzMaxim 7:9cd16581b578 286 }
IanBenzMaxim 7:9cd16581b578 287
IanBenzMaxim 7:9cd16581b578 288 /// @}
IanBenzMaxim 7:9cd16581b578 289
IanBenzMaxim 7:9cd16581b578 290 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 291 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 292 /// @{
IanBenzMaxim 7:9cd16581b578 293
IanBenzMaxim 7:9cd16581b578 294 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 295 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 296 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 297 }
IanBenzMaxim 7:9cd16581b578 298
IanBenzMaxim 7:9cd16581b578 299 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 300 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 301 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 302 }
IanBenzMaxim 7:9cd16581b578 303
IanBenzMaxim 7:9cd16581b578 304 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 305 PageAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 306 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 307 return *this;
IanBenzMaxim 7:9cd16581b578 308 }
IanBenzMaxim 7:9cd16581b578 309
IanBenzMaxim 7:9cd16581b578 310 /// @}
IanBenzMaxim 7:9cd16581b578 311
IanBenzMaxim 7:9cd16581b578 312 private:
IanBenzMaxim 8:5ea891c7d1a1 313 static const size_t romIdIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 314 static const size_t pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 315 static const size_t challengeIdx = pageIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 316 static const size_t pageNumIdx = challengeIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 317 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 318
IanBenzMaxim 7:9cd16581b578 319 Result::array result_;
IanBenzMaxim 7:9cd16581b578 320 };
IanBenzMaxim 7:9cd16581b578 321
IanBenzMaxim 7:9cd16581b578 322 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 323
IanBenzMaxim 7:9cd16581b578 324 #endif