Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS28E17.hpp@8:211d1b8f730c, 2019-04-03 (annotated)

Committer:
reARMnimator
Date:
Wed Apr 03 12:33:10 2019 +0000
Revision:
8:211d1b8f730c
Parent:
7:471901a04573 
Merge with version 1.7;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:f77ad7f72d04 1 /*******************************************************************************
IanBenzMaxim 0:f77ad7f72d04 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:f77ad7f72d04 3 *
IanBenzMaxim 0:f77ad7f72d04 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:f77ad7f72d04 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:f77ad7f72d04 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:f77ad7f72d04 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:f77ad7f72d04 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:f77ad7f72d04 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:f77ad7f72d04 10 *
IanBenzMaxim 0:f77ad7f72d04 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:f77ad7f72d04 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:f77ad7f72d04 13 *
IanBenzMaxim 0:f77ad7f72d04 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:f77ad7f72d04 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:f77ad7f72d04 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:f77ad7f72d04 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:f77ad7f72d04 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:f77ad7f72d04 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:f77ad7f72d04 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:f77ad7f72d04 21 *
IanBenzMaxim 0:f77ad7f72d04 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:f77ad7f72d04 25 *
IanBenzMaxim 0:f77ad7f72d04 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:f77ad7f72d04 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:f77ad7f72d04 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:f77ad7f72d04 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:f77ad7f72d04 30 * ownership rights.
IanBenzMaxim 0:f77ad7f72d04 31 *******************************************************************************/
IanBenzMaxim 0:f77ad7f72d04 32
IanBenzMaxim 0:f77ad7f72d04 33 #ifndef MaximInterface_DS28E17
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_DS28E17
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <stdint.h>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/SelectRom.hpp>
IanBenzMaxim 0:f77ad7f72d04 38 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 6:a8c83a2e6fa4 39 #include <MaximInterface/Utilities/span.hpp>
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 42
IanBenzMaxim 7:471901a04573 43 /// @brief DS28E17 1-Wire®-to-I2C Master Bridge
IanBenzMaxim 0:f77ad7f72d04 44 /// @details The DS28E17 is a 1-Wire slave to I2C master bridge
IanBenzMaxim 0:f77ad7f72d04 45 /// device that interfaces directly to I2C slaves at standard
IanBenzMaxim 0:f77ad7f72d04 46 /// (100kHz max) or fast (400kHz max). Data transfers serially by
IanBenzMaxim 0:f77ad7f72d04 47 /// means of the 1-Wire® protocol, which requires only a single data
IanBenzMaxim 0:f77ad7f72d04 48 /// lead and a ground return. Every DS28E17 is guaranteed to have a
IanBenzMaxim 0:f77ad7f72d04 49 /// unique 64-bit ROM registration number that serves as a node
IanBenzMaxim 0:f77ad7f72d04 50 /// address in the 1-Wire network. Multiple DS28E17 devices can
IanBenzMaxim 0:f77ad7f72d04 51 /// coexist with other devices in the 1-Wire network and be accessed
IanBenzMaxim 0:f77ad7f72d04 52 /// individually without affecting other devices. The DS28E17 allows
IanBenzMaxim 0:f77ad7f72d04 53 /// using complex I2C devices such as display controllers, ADCs, DACs,
IanBenzMaxim 0:f77ad7f72d04 54 /// I2C sensors, etc. in a 1-Wire environment. Each self-timed DS28E17
IanBenzMaxim 0:f77ad7f72d04 55 /// provides 1-Wire access for a single I2C interface.
IanBenzMaxim 0:f77ad7f72d04 56 class DS28E17 {
IanBenzMaxim 0:f77ad7f72d04 57 public:
IanBenzMaxim 0:f77ad7f72d04 58 enum ErrorValue {
IanBenzMaxim 0:f77ad7f72d04 59 TimeoutError = 1,
IanBenzMaxim 0:f77ad7f72d04 60 OutOfRangeError,
IanBenzMaxim 0:f77ad7f72d04 61 InvalidCrc16Error,
IanBenzMaxim 0:f77ad7f72d04 62 AddressNackError,
IanBenzMaxim 0:f77ad7f72d04 63 InvalidStartError,
IanBenzMaxim 0:f77ad7f72d04 64 WriteNackError
IanBenzMaxim 0:f77ad7f72d04 65 };
IanBenzMaxim 0:f77ad7f72d04 66
IanBenzMaxim 0:f77ad7f72d04 67 enum I2CSpeed { Speed100kHz, Speed400kHz, Speed900kHz };
IanBenzMaxim 0:f77ad7f72d04 68
IanBenzMaxim 0:f77ad7f72d04 69 DS28E17(OneWireMaster & master, const SelectRom & selectRom)
IanBenzMaxim 0:f77ad7f72d04 70 : selectRom(selectRom), master(&master) {}
IanBenzMaxim 0:f77ad7f72d04 71
IanBenzMaxim 0:f77ad7f72d04 72 void setMaster(OneWireMaster & master) { this->master = &master; }
IanBenzMaxim 6:a8c83a2e6fa4 73
IanBenzMaxim 0:f77ad7f72d04 74 void setSelectRom(const SelectRom & selectRom) {
IanBenzMaxim 0:f77ad7f72d04 75 this->selectRom = selectRom;
IanBenzMaxim 0:f77ad7f72d04 76 }
IanBenzMaxim 0:f77ad7f72d04 77
IanBenzMaxim 7:471901a04573 78 /// @brief Write Data With Stop command.
IanBenzMaxim 0:f77ad7f72d04 79 /// @details Output on I2C: S, Address + Write, Write Data [1-255], P
IanBenzMaxim 0:f77ad7f72d04 80 /// @param[in] I2C_addr
IanBenzMaxim 0:f77ad7f72d04 81 /// I2C slave address. The least significant bit of the I2C
IanBenzMaxim 0:f77ad7f72d04 82 /// address is automatically cleared by the command.
IanBenzMaxim 6:a8c83a2e6fa4 83 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 0:f77ad7f72d04 84 /// @param[out] wr_status
IanBenzMaxim 0:f77ad7f72d04 85 /// Indicates which write byte NACK’d. A value of 00h indicates all bytes
IanBenzMaxim 0:f77ad7f72d04 86 /// were acknowledged by the slave. A non-zero value indicates the byte number
IanBenzMaxim 0:f77ad7f72d04 87 /// that NACK’d. May be set to NULL.
IanBenzMaxim 0:f77ad7f72d04 88 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 89 writeDataWithStop(uint_least8_t I2C_addr, span<const uint_least8_t> data,
IanBenzMaxim 6:a8c83a2e6fa4 90 uint_least8_t * wr_status = NULL);
IanBenzMaxim 0:f77ad7f72d04 91
IanBenzMaxim 7:471901a04573 92 /// @brief Write Data No Stop command.
IanBenzMaxim 0:f77ad7f72d04 93 /// @details Output on I2C: S, Address + Write, Write Data [1-255]
IanBenzMaxim 0:f77ad7f72d04 94 /// @param[in] I2C_addr
IanBenzMaxim 0:f77ad7f72d04 95 /// I2C slave address. The least significant bit of the I2C address
IanBenzMaxim 0:f77ad7f72d04 96 /// is automatically cleared by the command.
IanBenzMaxim 6:a8c83a2e6fa4 97 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 0:f77ad7f72d04 98 /// @param[out] wr_status
IanBenzMaxim 0:f77ad7f72d04 99 /// Indicates which write byte NACK’d. A value of 00h indicates all bytes
IanBenzMaxim 0:f77ad7f72d04 100 /// were acknowledged by the slave. A non-zero value indicates the byte number
IanBenzMaxim 0:f77ad7f72d04 101 /// that NACK’d. May be set to NULL.
IanBenzMaxim 0:f77ad7f72d04 102 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 103 writeDataNoStop(uint_least8_t I2C_addr, span<const uint_least8_t> data,
IanBenzMaxim 6:a8c83a2e6fa4 104 uint_least8_t * wr_status = NULL);
IanBenzMaxim 0:f77ad7f72d04 105
IanBenzMaxim 7:471901a04573 106 /// @brief Write Data Only command.
IanBenzMaxim 0:f77ad7f72d04 107 /// @details Output on I2C: Write Data [1-255]
IanBenzMaxim 6:a8c83a2e6fa4 108 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 0:f77ad7f72d04 109 /// @param[out] wr_status
IanBenzMaxim 0:f77ad7f72d04 110 /// Indicates which write byte NACK’d. A value of 00h indicates all bytes
IanBenzMaxim 0:f77ad7f72d04 111 /// were acknowledged by the slave. A non-zero value indicates the byte number
IanBenzMaxim 0:f77ad7f72d04 112 /// that NACK’d. May be set to NULL.
IanBenzMaxim 0:f77ad7f72d04 113 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 114 writeDataOnly(span<const uint_least8_t> data,
IanBenzMaxim 0:f77ad7f72d04 115 uint_least8_t * wr_status = NULL);
IanBenzMaxim 0:f77ad7f72d04 116
IanBenzMaxim 7:471901a04573 117 /// @brief Write Data Only With Stop command.
IanBenzMaxim 0:f77ad7f72d04 118 /// @details Output on I2C: Write Data [1-255], P
IanBenzMaxim 6:a8c83a2e6fa4 119 /// @param[in] data I2C data to write with length 1-255.
IanBenzMaxim 0:f77ad7f72d04 120 /// @param[out] wr_status
IanBenzMaxim 0:f77ad7f72d04 121 /// Indicates which write byte NACK’d. A value of 00h indicates all bytes
IanBenzMaxim 0:f77ad7f72d04 122 /// were acknowledged by the slave. A non-zero value indicates the byte number
IanBenzMaxim 0:f77ad7f72d04 123 /// that NACK’d. May be set to NULL.
IanBenzMaxim 0:f77ad7f72d04 124 MaximInterface_EXPORT error_code
IanBenzMaxim 6:a8c83a2e6fa4 125 writeDataOnlyWithStop(span<const uint_least8_t> data,
IanBenzMaxim 0:f77ad7f72d04 126 uint_least8_t * wr_status = NULL);
IanBenzMaxim 0:f77ad7f72d04 127
IanBenzMaxim 7:471901a04573 128 /// @brief Write, Read Data With Stop command.
IanBenzMaxim 0:f77ad7f72d04 129 /// @details Output on I2C:
IanBenzMaxim 0:f77ad7f72d04 130 /// S, Slave Address + Write, Write Data [1-255],
IanBenzMaxim 0:f77ad7f72d04 131 /// Sr, Address + Read, Read Data [1-255], P (NACK last read byte)
IanBenzMaxim 0:f77ad7f72d04 132 /// @param[in] I2C_addr
IanBenzMaxim 0:f77ad7f72d04 133 /// I2C slave address. The least significant bit of the I2C address
IanBenzMaxim 0:f77ad7f72d04 134 /// is automatically cleared and set by the command.
IanBenzMaxim 6:a8c83a2e6fa4 135 /// @param[in] write_data I2C data to write with length 1-255.
IanBenzMaxim 6:a8c83a2e6fa4 136 /// @param[out] read_data I2C data that was read with length 1-255.
IanBenzMaxim 0:f77ad7f72d04 137 /// @param[out] wr_status
IanBenzMaxim 0:f77ad7f72d04 138 /// Indicates which write byte NACK’d. A value of 00h indicates all bytes
IanBenzMaxim 0:f77ad7f72d04 139 /// were acknowledged by the slave. A non-zero value indicates the byte number
IanBenzMaxim 0:f77ad7f72d04 140 /// that NACK’d. May be set to NULL.
IanBenzMaxim 0:f77ad7f72d04 141 MaximInterface_EXPORT error_code writeReadDataWithStop(
IanBenzMaxim 6:a8c83a2e6fa4 142 uint_least8_t I2C_addr, span<const uint_least8_t> write_data,
IanBenzMaxim 6:a8c83a2e6fa4 143 span<uint_least8_t> read_data, uint_least8_t * wr_status = NULL);
IanBenzMaxim 0:f77ad7f72d04 144
IanBenzMaxim 7:471901a04573 145 /// @brief Read Data With Stop command.
IanBenzMaxim 0:f77ad7f72d04 146 /// @details Output on I2C:
IanBenzMaxim 0:f77ad7f72d04 147 /// S, Slave Address + Read, Read Data [1-255], P (NACK last read byte)
IanBenzMaxim 0:f77ad7f72d04 148 /// @param[in] I2C_addr
IanBenzMaxim 0:f77ad7f72d04 149 /// I2C slave address. The least significant bit of the I2C address
IanBenzMaxim 0:f77ad7f72d04 150 /// is automatically set by the command.
IanBenzMaxim 6:a8c83a2e6fa4 151 /// @param[out] data I2C data that was read with length 1-255.
IanBenzMaxim 0:f77ad7f72d04 152 MaximInterface_EXPORT error_code readDataWithStop(uint_least8_t I2C_addr,
IanBenzMaxim 6:a8c83a2e6fa4 153 span<uint_least8_t> data);
IanBenzMaxim 0:f77ad7f72d04 154
IanBenzMaxim 0:f77ad7f72d04 155 /// Write to Configuration Register of DS28E17.
IanBenzMaxim 0:f77ad7f72d04 156 MaximInterface_EXPORT error_code writeConfigReg(I2CSpeed speed);
IanBenzMaxim 0:f77ad7f72d04 157
IanBenzMaxim 7:471901a04573 158 /// @brief Read the Configuration Register of DS28E17.
IanBenzMaxim 0:f77ad7f72d04 159 /// @param[out] speed Speed read from configuration register.
IanBenzMaxim 0:f77ad7f72d04 160 MaximInterface_EXPORT error_code readConfigReg(I2CSpeed & speed);
IanBenzMaxim 0:f77ad7f72d04 161
IanBenzMaxim 7:471901a04573 162 /// @brief Put the device into a low current mode.
IanBenzMaxim 0:f77ad7f72d04 163 /// @details All 1-Wire communication is ignored until woken up. Immediately
IanBenzMaxim 0:f77ad7f72d04 164 /// after the command, the device monitors the WAKEUP input pin and exits
IanBenzMaxim 0:f77ad7f72d04 165 /// sleep mode on a rising edge.
IanBenzMaxim 0:f77ad7f72d04 166 MaximInterface_EXPORT error_code enableSleepMode();
IanBenzMaxim 0:f77ad7f72d04 167
IanBenzMaxim 7:471901a04573 168 /// @brief Read the Device Revision of DS28E17.
IanBenzMaxim 0:f77ad7f72d04 169 /// @details The upper nibble is the major revision,
IanBenzMaxim 0:f77ad7f72d04 170 /// and the lower nibble is the minor revision.
IanBenzMaxim 0:f77ad7f72d04 171 /// @param[out] rev Device Revision.
IanBenzMaxim 0:f77ad7f72d04 172 MaximInterface_EXPORT error_code readDeviceRevision(uint_least8_t & rev);
IanBenzMaxim 0:f77ad7f72d04 173
IanBenzMaxim 0:f77ad7f72d04 174 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 175
IanBenzMaxim 0:f77ad7f72d04 176 private:
IanBenzMaxim 0:f77ad7f72d04 177 enum Command {
IanBenzMaxim 0:f77ad7f72d04 178 WriteDataWithStopCmd = 0x4B,
IanBenzMaxim 0:f77ad7f72d04 179 WriteDataNoStopCmd = 0x5A,
IanBenzMaxim 0:f77ad7f72d04 180 WriteDataOnlyCmd = 0x69,
IanBenzMaxim 0:f77ad7f72d04 181 WriteDataOnlyWithStopCmd = 0x78,
IanBenzMaxim 0:f77ad7f72d04 182 ReadDataWithStopCmd = 0x87,
IanBenzMaxim 0:f77ad7f72d04 183 WriteReadDataWithStopCmd = 0x2D,
IanBenzMaxim 0:f77ad7f72d04 184 WriteConfigurationCmd = 0xD2,
IanBenzMaxim 0:f77ad7f72d04 185 ReadConfigurationCmd = 0xE1,
IanBenzMaxim 0:f77ad7f72d04 186 EnableSleepModeCmd = 0x1E,
IanBenzMaxim 0:f77ad7f72d04 187 ReadDeviceRevisionCmd = 0xC3
IanBenzMaxim 0:f77ad7f72d04 188 };
IanBenzMaxim 0:f77ad7f72d04 189
IanBenzMaxim 0:f77ad7f72d04 190 error_code sendPacket(Command command, const uint_least8_t * I2C_addr,
IanBenzMaxim 6:a8c83a2e6fa4 191 span<const uint_least8_t> write_data,
IanBenzMaxim 6:a8c83a2e6fa4 192 span<uint_least8_t> read_data,
IanBenzMaxim 0:f77ad7f72d04 193 uint_least8_t * wr_status);
IanBenzMaxim 0:f77ad7f72d04 194
IanBenzMaxim 0:f77ad7f72d04 195 SelectRom selectRom;
IanBenzMaxim 0:f77ad7f72d04 196 OneWireMaster * master;
IanBenzMaxim 0:f77ad7f72d04 197 };
IanBenzMaxim 0:f77ad7f72d04 198
IanBenzMaxim 0:f77ad7f72d04 199 inline error_code make_error_code(DS28E17::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 200 return error_code(e, DS28E17::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 201 }
IanBenzMaxim 0:f77ad7f72d04 202
IanBenzMaxim 0:f77ad7f72d04 203 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 204
IanBenzMaxim 0:f77ad7f72d04 205 #endif