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/DS28E17.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_DS28E17_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28E17_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <stdint.h>
IanBenzMaxim 7:9cd16581b578 37 #include <MaximInterfaceCore/SelectRom.hpp>
IanBenzMaxim 7:9cd16581b578 38 #include <MaximInterfaceCore/span.hpp>
IanBenzMaxim 7:9cd16581b578 39 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 40
IanBenzMaxim 7:9cd16581b578 41 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 42
IanBenzMaxim 7:9cd16581b578 43 /// @brief DS28E17 1-Wire®-to-I2C Master Bridge
IanBenzMaxim 7:9cd16581b578 44 /// @details The DS28E17 is a 1-Wire slave to I2C master bridge
IanBenzMaxim 7:9cd16581b578 45 /// device that interfaces directly to I2C slaves at standard
IanBenzMaxim 7:9cd16581b578 46 /// (100kHz max) or fast (400kHz max). Data transfers serially by
IanBenzMaxim 7:9cd16581b578 47 /// means of the 1-Wire® protocol, which requires only a single data
IanBenzMaxim 7:9cd16581b578 48 /// lead and a ground return. Every DS28E17 is guaranteed to have a
IanBenzMaxim 7:9cd16581b578 49 /// unique 64-bit ROM registration number that serves as a node
IanBenzMaxim 7:9cd16581b578 50 /// address in the 1-Wire network. Multiple DS28E17 devices can
IanBenzMaxim 7:9cd16581b578 51 /// coexist with other devices in the 1-Wire network and be accessed
IanBenzMaxim 7:9cd16581b578 52 /// individually without affecting other devices. The DS28E17 allows
IanBenzMaxim 7:9cd16581b578 53 /// using complex I2C devices such as display controllers, ADCs, DACs,
IanBenzMaxim 7:9cd16581b578 54 /// I2C sensors, etc. in a 1-Wire environment. Each self-timed DS28E17
IanBenzMaxim 7:9cd16581b578 55 /// provides 1-Wire access for a single I2C interface.
IanBenzMaxim 7:9cd16581b578 56 class DS28E17 {
IanBenzMaxim 7:9cd16581b578 57 public:
IanBenzMaxim 8:5ea891c7d1a1 58 // Values from 1-255 represent the Write Status byte.
IanBenzMaxim 7:9cd16581b578 59 enum ErrorValue {
IanBenzMaxim 8:5ea891c7d1a1 60 TimeoutError = 256,
IanBenzMaxim 7:9cd16581b578 61 OutOfRangeError,
IanBenzMaxim 7:9cd16581b578 62 InvalidCrc16Error,
IanBenzMaxim 7:9cd16581b578 63 AddressNackError,
IanBenzMaxim 8:5ea891c7d1a1 64 InvalidStartError
IanBenzMaxim 7:9cd16581b578 65 };
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 7:9cd16581b578 67 enum I2CSpeed { Speed100kHz, Speed400kHz, Speed900kHz };
IanBenzMaxim 7:9cd16581b578 68
IanBenzMaxim 7:9cd16581b578 69 DS28E17(Core::OneWireMaster & master, const Core::SelectRom & selectRom)
IanBenzMaxim 7:9cd16581b578 70 : selectRom(selectRom), master(&master) {}
IanBenzMaxim 7:9cd16581b578 71
IanBenzMaxim 7:9cd16581b578 72 void setMaster(Core::OneWireMaster & master) { this->master = &master; }
IanBenzMaxim 7:9cd16581b578 73
IanBenzMaxim 7:9cd16581b578 74 void setSelectRom(const Core::SelectRom & selectRom) {
IanBenzMaxim 7:9cd16581b578 75 this->selectRom = selectRom;
IanBenzMaxim 7:9cd16581b578 76 }
IanBenzMaxim 7:9cd16581b578 77
IanBenzMaxim 7:9cd16581b578 78 /// @brief Write Data With Stop command.
IanBenzMaxim 7:9cd16581b578 79 /// @details Output on I2C: S, Address + Write, Write Data [1-255], P
IanBenzMaxim 7:9cd16581b578 80 /// @param[in] I2C_addr
IanBenzMaxim 7:9cd16581b578 81 /// I2C slave address. The least significant bit of the I2C
IanBenzMaxim 7:9cd16581b578 82 /// address is automatically cleared by the command.
IanBenzMaxim 7:9cd16581b578 83 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 8:5ea891c7d1a1 84 /// @returns
IanBenzMaxim 8:5ea891c7d1a1 85 /// Values from 1-255 in the DS28E17 category represent the Write Status
IanBenzMaxim 8:5ea891c7d1a1 86 /// indicating which write byte did not acknowledge.
IanBenzMaxim 8:5ea891c7d1a1 87 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 88 writeDataWithStop(uint_least8_t I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 89 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 90
IanBenzMaxim 7:9cd16581b578 91 /// @brief Write Data No Stop command.
IanBenzMaxim 7:9cd16581b578 92 /// @details Output on I2C: S, Address + Write, Write Data [1-255]
IanBenzMaxim 7:9cd16581b578 93 /// @param[in] I2C_addr
IanBenzMaxim 7:9cd16581b578 94 /// I2C slave address. The least significant bit of the I2C address
IanBenzMaxim 7:9cd16581b578 95 /// is automatically cleared by the command.
IanBenzMaxim 7:9cd16581b578 96 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 8:5ea891c7d1a1 97 /// @returns
IanBenzMaxim 8:5ea891c7d1a1 98 /// Values from 1-255 in the DS28E17 category represent the Write Status
IanBenzMaxim 8:5ea891c7d1a1 99 /// indicating which write byte did not acknowledge.
IanBenzMaxim 8:5ea891c7d1a1 100 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 101 writeDataNoStop(uint_least8_t I2C_addr, Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 102
IanBenzMaxim 7:9cd16581b578 103 /// @brief Write Data Only command.
IanBenzMaxim 7:9cd16581b578 104 /// @details Output on I2C: Write Data [1-255]
IanBenzMaxim 7:9cd16581b578 105 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 8:5ea891c7d1a1 106 /// @returns
IanBenzMaxim 8:5ea891c7d1a1 107 /// Values from 1-255 in the DS28E17 category represent the Write Status
IanBenzMaxim 8:5ea891c7d1a1 108 /// indicating which write byte did not acknowledge.
IanBenzMaxim 8:5ea891c7d1a1 109 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 110 writeDataOnly(Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 111
IanBenzMaxim 7:9cd16581b578 112 /// @brief Write Data Only With Stop command.
IanBenzMaxim 7:9cd16581b578 113 /// @details Output on I2C: Write Data [1-255], P
IanBenzMaxim 7:9cd16581b578 114 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 8:5ea891c7d1a1 115 /// @returns
IanBenzMaxim 8:5ea891c7d1a1 116 /// Values from 1-255 in the DS28E17 category represent the Write Status
IanBenzMaxim 8:5ea891c7d1a1 117 /// indicating which write byte did not acknowledge.
IanBenzMaxim 8:5ea891c7d1a1 118 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 119 writeDataOnlyWithStop(Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 120
IanBenzMaxim 7:9cd16581b578 121 /// @brief Write, Read Data With Stop command.
IanBenzMaxim 7:9cd16581b578 122 /// @details Output on I2C:
IanBenzMaxim 7:9cd16581b578 123 /// S, Slave Address + Write, Write Data [1-255],
IanBenzMaxim 7:9cd16581b578 124 /// Sr, Address + Read, Read Data [1-255], P (NACK last read byte)
IanBenzMaxim 7:9cd16581b578 125 /// @param[in] I2C_addr
IanBenzMaxim 7:9cd16581b578 126 /// I2C slave address. The least significant bit of the I2C address
IanBenzMaxim 7:9cd16581b578 127 /// is automatically cleared and set by the command.
IanBenzMaxim 7:9cd16581b578 128 /// @param[in] write_data I2C data to write with length 1-255.
IanBenzMaxim 7:9cd16581b578 129 /// @param[out] read_data I2C data that was read with length 1-255.
IanBenzMaxim 8:5ea891c7d1a1 130 /// @returns
IanBenzMaxim 8:5ea891c7d1a1 131 /// Values from 1-255 in the DS28E17 category represent the Write Status
IanBenzMaxim 8:5ea891c7d1a1 132 /// indicating which write byte did not acknowledge.
IanBenzMaxim 8:5ea891c7d1a1 133 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 134 writeReadDataWithStop(uint_least8_t I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 135 Core::span<const uint_least8_t> write_data,
IanBenzMaxim 8:5ea891c7d1a1 136 Core::span<uint_least8_t> read_data);
IanBenzMaxim 7:9cd16581b578 137
IanBenzMaxim 7:9cd16581b578 138 /// @brief Read Data With Stop command.
IanBenzMaxim 7:9cd16581b578 139 /// @details Output on I2C:
IanBenzMaxim 7:9cd16581b578 140 /// S, Slave Address + Read, Read Data [1-255], P (NACK last read byte)
IanBenzMaxim 7:9cd16581b578 141 /// @param[in] I2C_addr
IanBenzMaxim 7:9cd16581b578 142 /// I2C slave address. The least significant bit of the I2C address
IanBenzMaxim 7:9cd16581b578 143 /// is automatically set by the command.
IanBenzMaxim 7:9cd16581b578 144 /// @param[out] data I2C data that was read with length 1-255.
IanBenzMaxim 8:5ea891c7d1a1 145 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 146 readDataWithStop(uint_least8_t I2C_addr, Core::span<uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 147
IanBenzMaxim 7:9cd16581b578 148 /// Write to Configuration Register of DS28E17.
IanBenzMaxim 8:5ea891c7d1a1 149 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 150 writeConfigReg(I2CSpeed speed);
IanBenzMaxim 7:9cd16581b578 151
IanBenzMaxim 7:9cd16581b578 152 /// @brief Read the Configuration Register of DS28E17.
IanBenzMaxim 8:5ea891c7d1a1 153 /// @returns speed Speed read from configuration register.
IanBenzMaxim 8:5ea891c7d1a1 154 MaximInterfaceDevices_EXPORT Core::Result<I2CSpeed> readConfigReg() const;
IanBenzMaxim 7:9cd16581b578 155
IanBenzMaxim 7:9cd16581b578 156 /// @brief Put the device into a low current mode.
IanBenzMaxim 7:9cd16581b578 157 /// @details All 1-Wire communication is ignored until woken up. Immediately
IanBenzMaxim 7:9cd16581b578 158 /// after the command, the device monitors the WAKEUP input pin and exits
IanBenzMaxim 7:9cd16581b578 159 /// sleep mode on a rising edge.
IanBenzMaxim 8:5ea891c7d1a1 160 MaximInterfaceDevices_EXPORT Core::Result<void> enableSleepMode();
IanBenzMaxim 7:9cd16581b578 161
IanBenzMaxim 7:9cd16581b578 162 /// @brief Read the Device Revision of DS28E17.
IanBenzMaxim 7:9cd16581b578 163 /// @details The upper nibble is the major revision,
IanBenzMaxim 7:9cd16581b578 164 /// and the lower nibble is the minor revision.
IanBenzMaxim 8:5ea891c7d1a1 165 /// @returns Device Revision.
IanBenzMaxim 8:5ea891c7d1a1 166 MaximInterfaceDevices_EXPORT Core::Result<uint_least8_t>
IanBenzMaxim 8:5ea891c7d1a1 167 readDeviceRevision() const;
IanBenzMaxim 7:9cd16581b578 168
IanBenzMaxim 7:9cd16581b578 169 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 170 errorCategory();
IanBenzMaxim 7:9cd16581b578 171
IanBenzMaxim 7:9cd16581b578 172 private:
IanBenzMaxim 7:9cd16581b578 173 enum Command {
IanBenzMaxim 7:9cd16581b578 174 WriteDataWithStopCmd = 0x4B,
IanBenzMaxim 7:9cd16581b578 175 WriteDataNoStopCmd = 0x5A,
IanBenzMaxim 7:9cd16581b578 176 WriteDataOnlyCmd = 0x69,
IanBenzMaxim 7:9cd16581b578 177 WriteDataOnlyWithStopCmd = 0x78,
IanBenzMaxim 7:9cd16581b578 178 ReadDataWithStopCmd = 0x87,
IanBenzMaxim 7:9cd16581b578 179 WriteReadDataWithStopCmd = 0x2D,
IanBenzMaxim 7:9cd16581b578 180 WriteConfigurationCmd = 0xD2,
IanBenzMaxim 7:9cd16581b578 181 ReadConfigurationCmd = 0xE1,
IanBenzMaxim 7:9cd16581b578 182 EnableSleepModeCmd = 0x1E,
IanBenzMaxim 7:9cd16581b578 183 ReadDeviceRevisionCmd = 0xC3
IanBenzMaxim 7:9cd16581b578 184 };
IanBenzMaxim 7:9cd16581b578 185
IanBenzMaxim 8:5ea891c7d1a1 186 Core::Result<void> sendPacket(Command command, const uint_least8_t * I2C_addr,
IanBenzMaxim 8:5ea891c7d1a1 187 Core::span<const uint_least8_t> write_data,
IanBenzMaxim 8:5ea891c7d1a1 188 Core::span<uint_least8_t> read_data);
IanBenzMaxim 7:9cd16581b578 189
IanBenzMaxim 7:9cd16581b578 190 Core::SelectRom selectRom;
IanBenzMaxim 7:9cd16581b578 191 Core::OneWireMaster * master;
IanBenzMaxim 7:9cd16581b578 192 };
IanBenzMaxim 7:9cd16581b578 193
IanBenzMaxim 8:5ea891c7d1a1 194 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 195 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 196
IanBenzMaxim 8:5ea891c7d1a1 197 template <>
IanBenzMaxim 8:5ea891c7d1a1 198 struct is_error_code_enum<MaximInterfaceDevices::DS28E17::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 199 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 200
IanBenzMaxim 8:5ea891c7d1a1 201 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 202 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 203
IanBenzMaxim 7:9cd16581b578 204 inline Core::error_code make_error_code(DS28E17::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 205 return Core::error_code(e, DS28E17::errorCategory());
IanBenzMaxim 7:9cd16581b578 206 }
IanBenzMaxim 7:9cd16581b578 207
IanBenzMaxim 7:9cd16581b578 208 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 209
IanBenzMaxim 7:9cd16581b578 210 #endif