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/DS28E16.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_DS28E16_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28E16_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/FlagSet.hpp>
IanBenzMaxim 7:9cd16581b578 40 #include <MaximInterfaceCore/RomId.hpp>
IanBenzMaxim 7:9cd16581b578 41 #include <MaximInterfaceCore/RunCommand.hpp>
IanBenzMaxim 7:9cd16581b578 42 #include <MaximInterfaceCore/system_error.hpp>
IanBenzMaxim 7:9cd16581b578 43 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 44
IanBenzMaxim 7:9cd16581b578 45 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 46
IanBenzMaxim 7:9cd16581b578 47 class DS28E16 {
IanBenzMaxim 7:9cd16581b578 48 public:
IanBenzMaxim 7:9cd16581b578 49 /// Device command results.
IanBenzMaxim 7:9cd16581b578 50 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 51 InvalidOperationError = 0x55,
IanBenzMaxim 7:9cd16581b578 52 InvalidParameterError = 0x77,
IanBenzMaxim 7:9cd16581b578 53 InvalidSequenceError = 0x33,
IanBenzMaxim 7:9cd16581b578 54 InternalError = 0x22,
IanBenzMaxim 7:9cd16581b578 55 DeviceDisabledError = 0x88,
IanBenzMaxim 7:9cd16581b578 56 AuthenticationError = 0x100,
IanBenzMaxim 7:9cd16581b578 57 InvalidResponseError ///< Command response does not match expected format.
IanBenzMaxim 7:9cd16581b578 58 };
IanBenzMaxim 7:9cd16581b578 59
IanBenzMaxim 7:9cd16581b578 60 /// @name Device memory pages
IanBenzMaxim 7:9cd16581b578 61 /// @{
IanBenzMaxim 7:9cd16581b578 62
IanBenzMaxim 7:9cd16581b578 63 static const int decrementCounterPage = 2;
IanBenzMaxim 7:9cd16581b578 64 static const int masterSecretPage = 3;
IanBenzMaxim 7:9cd16581b578 65
IanBenzMaxim 7:9cd16581b578 66 /// @}
IanBenzMaxim 7:9cd16581b578 67
IanBenzMaxim 7:9cd16581b578 68 static const int memoryPages = 4;
IanBenzMaxim 7:9cd16581b578 69
IanBenzMaxim 7:9cd16581b578 70 /// Holds a device memory page.
IanBenzMaxim 7:9cd16581b578 71 typedef Core::array_span<uint_least8_t, 16> Page;
IanBenzMaxim 7:9cd16581b578 72
IanBenzMaxim 7:9cd16581b578 73 /// Holds a Challenge, Partial Secret, or HMAC.
IanBenzMaxim 7:9cd16581b578 74 typedef Core::array_span<uint_least8_t, 32> DoublePage;
IanBenzMaxim 7:9cd16581b578 75
IanBenzMaxim 7:9cd16581b578 76 /// Holds a password used to disable the device.
IanBenzMaxim 7:9cd16581b578 77 typedef Core::array_span<uint_least8_t, 2> DisableDevicePassword;
IanBenzMaxim 7:9cd16581b578 78
IanBenzMaxim 7:9cd16581b578 79 // Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 80 class PageAuthenticationData;
IanBenzMaxim 7:9cd16581b578 81
IanBenzMaxim 7:9cd16581b578 82 // Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 83 class ComputeSecretData;
IanBenzMaxim 7:9cd16581b578 84
IanBenzMaxim 7:9cd16581b578 85 /// Page protection types.
IanBenzMaxim 7:9cd16581b578 86 enum PageProtectionType {
IanBenzMaxim 7:9cd16581b578 87 RP = 0x01, ///< Read protection.
IanBenzMaxim 7:9cd16581b578 88 WP = 0x02, ///< Write protection.
IanBenzMaxim 7:9cd16581b578 89 DC = 0x08 ///< Decrement counter.
IanBenzMaxim 7:9cd16581b578 90 };
IanBenzMaxim 7:9cd16581b578 91 typedef Core::FlagSet<PageProtectionType, 4> PageProtection;
IanBenzMaxim 7:9cd16581b578 92
IanBenzMaxim 7:9cd16581b578 93 struct Status {
IanBenzMaxim 8:5ea891c7d1a1 94 typedef Core::array_span<PageProtection, memoryPages> PageProtectionList;
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 8:5ea891c7d1a1 96 PageProtectionList::array pageProtection;
IanBenzMaxim 7:9cd16581b578 97 uint_least8_t manId;
IanBenzMaxim 7:9cd16581b578 98 uint_least8_t deviceVersion;
IanBenzMaxim 7:9cd16581b578 99 };
IanBenzMaxim 7:9cd16581b578 100
IanBenzMaxim 7:9cd16581b578 101 explicit DS28E16(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 102 : doRunCommand(runCommand) {}
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 void setRunCommand(const Core::RunCommand & runCommand) {
IanBenzMaxim 7:9cd16581b578 105 doRunCommand = runCommand;
IanBenzMaxim 7:9cd16581b578 106 }
IanBenzMaxim 7:9cd16581b578 107
IanBenzMaxim 7:9cd16581b578 108 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 109 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 110 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 111 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 112 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 113
IanBenzMaxim 7:9cd16581b578 114 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 115 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 116 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 117 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 118 readMemory(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 119
IanBenzMaxim 7:9cd16581b578 120 /// @brief Reads the current status of the device.
IanBenzMaxim 8:5ea891c7d1a1 121 /// @returns Status that was read.
IanBenzMaxim 8:5ea891c7d1a1 122 MaximInterfaceDevices_EXPORT Core::Result<Status> readStatus() const;
IanBenzMaxim 7:9cd16581b578 123
IanBenzMaxim 7:9cd16581b578 124 /// @brief Set the protection settings of a page.
IanBenzMaxim 7:9cd16581b578 125 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 126 /// @param protection Protection to write.
IanBenzMaxim 8:5ea891c7d1a1 127 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 128 setPageProtection(int pageNum, const PageProtection & protection);
IanBenzMaxim 7:9cd16581b578 129
IanBenzMaxim 7:9cd16581b578 130 /// @brief Compute and read page authentication with HMAC.
IanBenzMaxim 7:9cd16581b578 131 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 132 /// @param anonymous True to disable use of ROM ID in computation.
IanBenzMaxim 7:9cd16581b578 133 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 134 /// @returns Computed page HMAC.
IanBenzMaxim 8:5ea891c7d1a1 135 MaximInterfaceDevices_EXPORT Core::Result<DoublePage::array>
IanBenzMaxim 7:9cd16581b578 136 computeAndReadPageAuthentication(int pageNum, bool anonymous,
IanBenzMaxim 8:5ea891c7d1a1 137 DoublePage::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 138
IanBenzMaxim 7:9cd16581b578 139 /// Decrement the decrement-only counter.
IanBenzMaxim 8:5ea891c7d1a1 140 MaximInterfaceDevices_EXPORT Core::Result<void> decrementCounter();
IanBenzMaxim 7:9cd16581b578 141
IanBenzMaxim 7:9cd16581b578 142 /// Set password that will be subsequently used to disable the device.
IanBenzMaxim 8:5ea891c7d1a1 143 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 144 setDisableDevicePassword(DisableDevicePassword::const_span password);
IanBenzMaxim 7:9cd16581b578 145
IanBenzMaxim 7:9cd16581b578 146 /// @brief Lock-out all disable functionality for the device.
IanBenzMaxim 7:9cd16581b578 147 /// @note Only allowed prior to setting password.
IanBenzMaxim 8:5ea891c7d1a1 148 MaximInterfaceDevices_EXPORT Core::Result<void> lockOutDisableDevice();
IanBenzMaxim 7:9cd16581b578 149
IanBenzMaxim 7:9cd16581b578 150 /// Permanently disable the device.
IanBenzMaxim 8:5ea891c7d1a1 151 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 152 disableDevice(DisableDevicePassword::const_span password);
IanBenzMaxim 7:9cd16581b578 153
IanBenzMaxim 7:9cd16581b578 154 /// @brief
IanBenzMaxim 7:9cd16581b578 155 /// Compute a derivative secret for authentication from the Master Secret.
IanBenzMaxim 7:9cd16581b578 156 /// @param bindingDataPageNum Page number for Binding Data.
IanBenzMaxim 7:9cd16581b578 157 /// @param constantBindingData
IanBenzMaxim 7:9cd16581b578 158 /// Use constant Binding Data instead of Binding Data from the selected page.
IanBenzMaxim 7:9cd16581b578 159 /// @param anonymous True to disable use of ROM ID in computation.
IanBenzMaxim 7:9cd16581b578 160 /// @param partialSecret Partial secret to use in computation.
IanBenzMaxim 7:9cd16581b578 161 /// @note
IanBenzMaxim 7:9cd16581b578 162 /// This command should be executed prior to the
IanBenzMaxim 7:9cd16581b578 163 /// Compute and Read Page Authentication command.
IanBenzMaxim 8:5ea891c7d1a1 164 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 165 computeSecret(int bindingDataPageNum, bool constantBindingData,
IanBenzMaxim 7:9cd16581b578 166 bool anonymous, DoublePage::const_span partialSecret);
IanBenzMaxim 7:9cd16581b578 167
IanBenzMaxim 7:9cd16581b578 168 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 169 errorCategory();
IanBenzMaxim 7:9cd16581b578 170
IanBenzMaxim 7:9cd16581b578 171 protected:
IanBenzMaxim 8:5ea891c7d1a1 172 MaximInterfaceDevices_EXPORT Core::Result<Core::span<uint_least8_t> >
IanBenzMaxim 7:9cd16581b578 173 runCommand(Core::span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 174 Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 175
IanBenzMaxim 8:5ea891c7d1a1 176 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 177 runCommand(Core::span<const uint_least8_t> request, int delayTime);
IanBenzMaxim 7:9cd16581b578 178
IanBenzMaxim 7:9cd16581b578 179 private:
IanBenzMaxim 7:9cd16581b578 180 enum DisableDeviceOperation {
IanBenzMaxim 7:9cd16581b578 181 SetDisableDevicePassword = 0x0F,
IanBenzMaxim 7:9cd16581b578 182 LockOutDisableDevice = 0x05,
IanBenzMaxim 7:9cd16581b578 183 DisableDevice = 0x00
IanBenzMaxim 7:9cd16581b578 184 };
IanBenzMaxim 7:9cd16581b578 185
IanBenzMaxim 8:5ea891c7d1a1 186 Core::Result<void> disableDevice(DisableDeviceOperation operation,
IanBenzMaxim 8:5ea891c7d1a1 187 DisableDevicePassword::const_span password);
IanBenzMaxim 7:9cd16581b578 188
IanBenzMaxim 7:9cd16581b578 189 Core::RunCommand doRunCommand;
IanBenzMaxim 7:9cd16581b578 190 };
IanBenzMaxim 7:9cd16581b578 191
IanBenzMaxim 8:5ea891c7d1a1 192 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 193 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 194
IanBenzMaxim 8:5ea891c7d1a1 195 template <>
IanBenzMaxim 8:5ea891c7d1a1 196 struct is_error_code_enum<MaximInterfaceDevices::DS28E16::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 197 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 198
IanBenzMaxim 8:5ea891c7d1a1 199 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 200 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 201
IanBenzMaxim 7:9cd16581b578 202 inline Core::error_code make_error_code(DS28E16::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 203 return Core::error_code(e, DS28E16::errorCategory());
IanBenzMaxim 7:9cd16581b578 204 }
IanBenzMaxim 7:9cd16581b578 205
IanBenzMaxim 7:9cd16581b578 206 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 207 class DS28E16::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 208 public:
IanBenzMaxim 7:9cd16581b578 209 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 210 DoublePage::size + 3>
IanBenzMaxim 7:9cd16581b578 211 Result;
IanBenzMaxim 7:9cd16581b578 212
IanBenzMaxim 7:9cd16581b578 213 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 214
IanBenzMaxim 7:9cd16581b578 215 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 216 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 217
IanBenzMaxim 7:9cd16581b578 218 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 219 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 220 /// @{
IanBenzMaxim 7:9cd16581b578 221
IanBenzMaxim 7:9cd16581b578 222 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 223 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 224 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 225 }
IanBenzMaxim 7:9cd16581b578 226
IanBenzMaxim 7:9cd16581b578 227 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 228 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 229 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 230 }
IanBenzMaxim 7:9cd16581b578 231
IanBenzMaxim 7:9cd16581b578 232 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 233 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 234 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 235 return *this;
IanBenzMaxim 7:9cd16581b578 236 }
IanBenzMaxim 7:9cd16581b578 237
IanBenzMaxim 7:9cd16581b578 238 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 239 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 240
IanBenzMaxim 7:9cd16581b578 241 /// @}
IanBenzMaxim 7:9cd16581b578 242
IanBenzMaxim 7:9cd16581b578 243 /// @name Page
IanBenzMaxim 7:9cd16581b578 244 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 245 /// @{
IanBenzMaxim 7:9cd16581b578 246
IanBenzMaxim 7:9cd16581b578 247 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 248 Page::span page() {
IanBenzMaxim 7:9cd16581b578 249 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 250 }
IanBenzMaxim 7:9cd16581b578 251
IanBenzMaxim 7:9cd16581b578 252 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 253 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 254 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 255 }
IanBenzMaxim 7:9cd16581b578 256
IanBenzMaxim 7:9cd16581b578 257 /// Set page.
IanBenzMaxim 7:9cd16581b578 258 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 259 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 260 return *this;
IanBenzMaxim 7:9cd16581b578 261 }
IanBenzMaxim 7:9cd16581b578 262
IanBenzMaxim 7:9cd16581b578 263 /// @}
IanBenzMaxim 7:9cd16581b578 264
IanBenzMaxim 7:9cd16581b578 265 /// @name Challenge.
IanBenzMaxim 7:9cd16581b578 266 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 267 /// @{
IanBenzMaxim 7:9cd16581b578 268
IanBenzMaxim 7:9cd16581b578 269 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 270 DoublePage::span challenge() {
IanBenzMaxim 7:9cd16581b578 271 return make_span(result_).subspan<challengeIdx, DoublePage::size>();
IanBenzMaxim 7:9cd16581b578 272 }
IanBenzMaxim 7:9cd16581b578 273
IanBenzMaxim 7:9cd16581b578 274 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 275 DoublePage::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 276 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 277 }
IanBenzMaxim 7:9cd16581b578 278
IanBenzMaxim 7:9cd16581b578 279 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 280 PageAuthenticationData & setChallenge(DoublePage::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 281 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 282 return *this;
IanBenzMaxim 7:9cd16581b578 283 }
IanBenzMaxim 7:9cd16581b578 284
IanBenzMaxim 7:9cd16581b578 285 /// @}
IanBenzMaxim 7:9cd16581b578 286
IanBenzMaxim 7:9cd16581b578 287 /// @name Page number
IanBenzMaxim 7:9cd16581b578 288 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 289 /// @{
IanBenzMaxim 7:9cd16581b578 290
IanBenzMaxim 7:9cd16581b578 291 /// Get page number.
IanBenzMaxim 7:9cd16581b578 292 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 293
IanBenzMaxim 7:9cd16581b578 294 /// Set page number.
IanBenzMaxim 7:9cd16581b578 295 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 296 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 297 return *this;
IanBenzMaxim 7:9cd16581b578 298 }
IanBenzMaxim 7:9cd16581b578 299
IanBenzMaxim 7:9cd16581b578 300 /// @}
IanBenzMaxim 7:9cd16581b578 301
IanBenzMaxim 7:9cd16581b578 302 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 303 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 304 /// @{
IanBenzMaxim 7:9cd16581b578 305
IanBenzMaxim 7:9cd16581b578 306 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 307 uint_least8_t & manId() { return result_[manIdIdx]; }
IanBenzMaxim 7:9cd16581b578 308
IanBenzMaxim 7:9cd16581b578 309 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 310 uint_least8_t manId() const {
IanBenzMaxim 7:9cd16581b578 311 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 312 }
IanBenzMaxim 7:9cd16581b578 313
IanBenzMaxim 7:9cd16581b578 314 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 315 PageAuthenticationData & setManId(uint_least8_t manId) {
IanBenzMaxim 7:9cd16581b578 316 this->manId() = manId;
IanBenzMaxim 7:9cd16581b578 317 return *this;
IanBenzMaxim 7:9cd16581b578 318 }
IanBenzMaxim 7:9cd16581b578 319
IanBenzMaxim 7:9cd16581b578 320 /// @}
IanBenzMaxim 7:9cd16581b578 321
IanBenzMaxim 7:9cd16581b578 322 private:
IanBenzMaxim 8:5ea891c7d1a1 323 static const size_t romIdIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 324 static const size_t pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 325 static const size_t challengeIdx = pageIdx + 2 * Page::size;
IanBenzMaxim 8:5ea891c7d1a1 326 static const size_t pageNumIdx = challengeIdx + DoublePage::size;
IanBenzMaxim 8:5ea891c7d1a1 327 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 328
IanBenzMaxim 7:9cd16581b578 329 Result::array result_;
IanBenzMaxim 7:9cd16581b578 330 };
IanBenzMaxim 7:9cd16581b578 331
IanBenzMaxim 7:9cd16581b578 332 /// Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 333 class DS28E16::ComputeSecretData {
IanBenzMaxim 7:9cd16581b578 334 public:
IanBenzMaxim 7:9cd16581b578 335 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 336
IanBenzMaxim 7:9cd16581b578 337 ComputeSecretData() : data() {
IanBenzMaxim 7:9cd16581b578 338 data.setPageNum(0x80 | constantBindingDataMask);
IanBenzMaxim 7:9cd16581b578 339 }
IanBenzMaxim 7:9cd16581b578 340
IanBenzMaxim 7:9cd16581b578 341 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 342 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 343
IanBenzMaxim 7:9cd16581b578 344 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 345 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 346 /// @{
IanBenzMaxim 7:9cd16581b578 347
IanBenzMaxim 7:9cd16581b578 348 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 349 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 350
IanBenzMaxim 7:9cd16581b578 351 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 352 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 353
IanBenzMaxim 7:9cd16581b578 354 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 355 ComputeSecretData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 356 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 357 return *this;
IanBenzMaxim 7:9cd16581b578 358 }
IanBenzMaxim 7:9cd16581b578 359
IanBenzMaxim 7:9cd16581b578 360 /// @}
IanBenzMaxim 7:9cd16581b578 361
IanBenzMaxim 7:9cd16581b578 362 /// @name Binding Data
IanBenzMaxim 7:9cd16581b578 363 /// @brief Binding Data contained in the selected page.
IanBenzMaxim 7:9cd16581b578 364 /// @{
IanBenzMaxim 7:9cd16581b578 365
IanBenzMaxim 7:9cd16581b578 366 /// Get mutable Binding Data.
IanBenzMaxim 7:9cd16581b578 367 Page::span bindingData() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 368
IanBenzMaxim 7:9cd16581b578 369 /// Get immutable Binding Data.
IanBenzMaxim 7:9cd16581b578 370 Page::const_span bindingData() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 371
IanBenzMaxim 7:9cd16581b578 372 /// Set Binding Data.
IanBenzMaxim 7:9cd16581b578 373 ComputeSecretData & setBindingData(Page::const_span bindingData) {
IanBenzMaxim 7:9cd16581b578 374 data.setPage(bindingData);
IanBenzMaxim 7:9cd16581b578 375 return *this;
IanBenzMaxim 7:9cd16581b578 376 }
IanBenzMaxim 7:9cd16581b578 377
IanBenzMaxim 7:9cd16581b578 378 /// @}
IanBenzMaxim 7:9cd16581b578 379
IanBenzMaxim 7:9cd16581b578 380 /// @name Constant Binding Data
IanBenzMaxim 7:9cd16581b578 381 /// @brief
IanBenzMaxim 7:9cd16581b578 382 /// Use constant Binding Data instead of Binding Data from the selected page.
IanBenzMaxim 7:9cd16581b578 383 /// @{
IanBenzMaxim 7:9cd16581b578 384
IanBenzMaxim 7:9cd16581b578 385 /// Get Constant Binding Data.
IanBenzMaxim 7:9cd16581b578 386 bool constantBindingData() const {
IanBenzMaxim 7:9cd16581b578 387 return (data.pageNum() & constantBindingDataMask) ==
IanBenzMaxim 7:9cd16581b578 388 constantBindingDataMask;
IanBenzMaxim 7:9cd16581b578 389 }
IanBenzMaxim 7:9cd16581b578 390
IanBenzMaxim 7:9cd16581b578 391 /// Set Constant Binding Data.
IanBenzMaxim 7:9cd16581b578 392 MaximInterfaceDevices_EXPORT ComputeSecretData &
IanBenzMaxim 7:9cd16581b578 393 setConstantBindingData(bool constantBindingData);
IanBenzMaxim 7:9cd16581b578 394
IanBenzMaxim 7:9cd16581b578 395 /// @}
IanBenzMaxim 7:9cd16581b578 396
IanBenzMaxim 7:9cd16581b578 397 /// @name Partial Secret
IanBenzMaxim 7:9cd16581b578 398 /// @brief Partial Secret used for customization.
IanBenzMaxim 7:9cd16581b578 399 /// @{
IanBenzMaxim 7:9cd16581b578 400
IanBenzMaxim 7:9cd16581b578 401 /// Get mutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 402 DoublePage::span partialSecret() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 403
IanBenzMaxim 7:9cd16581b578 404 /// Get immutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 405 DoublePage::const_span partialSecret() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 406
IanBenzMaxim 7:9cd16581b578 407 /// Set Partial Secret.
IanBenzMaxim 7:9cd16581b578 408 ComputeSecretData & setPartialSecret(DoublePage::const_span partialSecret) {
IanBenzMaxim 7:9cd16581b578 409 data.setChallenge(partialSecret);
IanBenzMaxim 7:9cd16581b578 410 return *this;
IanBenzMaxim 7:9cd16581b578 411 }
IanBenzMaxim 7:9cd16581b578 412
IanBenzMaxim 7:9cd16581b578 413 /// @}
IanBenzMaxim 7:9cd16581b578 414
IanBenzMaxim 7:9cd16581b578 415 /// @name Binding Data page number
IanBenzMaxim 7:9cd16581b578 416 /// @{
IanBenzMaxim 7:9cd16581b578 417
IanBenzMaxim 7:9cd16581b578 418 /// Get Binding Data page number.
IanBenzMaxim 7:9cd16581b578 419 int bindingDataPageNum() const {
IanBenzMaxim 7:9cd16581b578 420 return data.pageNum() & bindingDataPageNumMask;
IanBenzMaxim 7:9cd16581b578 421 }
IanBenzMaxim 7:9cd16581b578 422
IanBenzMaxim 7:9cd16581b578 423 /// Set Binding Data page number.
IanBenzMaxim 7:9cd16581b578 424 ComputeSecretData & setBindingDataPageNum(int bindingDataPageNum) {
IanBenzMaxim 7:9cd16581b578 425 data.setPageNum((bindingDataPageNum & bindingDataPageNumMask) |
IanBenzMaxim 7:9cd16581b578 426 (data.pageNum() & ~bindingDataPageNumMask));
IanBenzMaxim 7:9cd16581b578 427 return *this;
IanBenzMaxim 7:9cd16581b578 428 }
IanBenzMaxim 7:9cd16581b578 429
IanBenzMaxim 7:9cd16581b578 430 /// @}
IanBenzMaxim 7:9cd16581b578 431
IanBenzMaxim 7:9cd16581b578 432 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 433 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 434 /// @{
IanBenzMaxim 7:9cd16581b578 435
IanBenzMaxim 7:9cd16581b578 436 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 437 uint_least8_t & manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 438
IanBenzMaxim 7:9cd16581b578 439 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 440 uint_least8_t manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 441
IanBenzMaxim 7:9cd16581b578 442 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 443 ComputeSecretData & setManId(uint_least8_t manId) {
IanBenzMaxim 7:9cd16581b578 444 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 445 return *this;
IanBenzMaxim 7:9cd16581b578 446 }
IanBenzMaxim 7:9cd16581b578 447
IanBenzMaxim 7:9cd16581b578 448 /// @}
IanBenzMaxim 7:9cd16581b578 449
IanBenzMaxim 7:9cd16581b578 450 private:
IanBenzMaxim 7:9cd16581b578 451 static const unsigned int bindingDataPageNumMask = 0x03;
IanBenzMaxim 7:9cd16581b578 452 static const unsigned int constantBindingDataMask = 0x04;
IanBenzMaxim 7:9cd16581b578 453
IanBenzMaxim 7:9cd16581b578 454 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 455 };
IanBenzMaxim 7:9cd16581b578 456
IanBenzMaxim 7:9cd16581b578 457 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 458
IanBenzMaxim 7:9cd16581b578 459 #endif