Aleksandrs Gumenuks / MaximInterface_Extended

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed_DS28EC20_GPIO

Devices/DS2482_DS2484.hpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Child:
6:a8c83a2e6fa4
Initial commit.

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_DS2482_DS2484
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_DS2482_DS2484
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <MaximInterface/Links/OneWireMaster.hpp>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/I2CMaster.hpp>
IanBenzMaxim 0:f77ad7f72d04 38 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 0:f77ad7f72d04 39
IanBenzMaxim 0:f77ad7f72d04 40 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 41
IanBenzMaxim 0:f77ad7f72d04 42 /// Interface to the DS2484, DS2482-100, DS2482-101, DS2482-800 1-Wire masters.
IanBenzMaxim 0:f77ad7f72d04 43 class DS2482_DS2484 : public OneWireMaster {
IanBenzMaxim 0:f77ad7f72d04 44 public:
IanBenzMaxim 0:f77ad7f72d04 45 enum ErrorValue { HardwareError = 1, ArgumentOutOfRangeError };
IanBenzMaxim 0:f77ad7f72d04 46
IanBenzMaxim 0:f77ad7f72d04 47 /// Represents a device configuration.
IanBenzMaxim 0:f77ad7f72d04 48 class Config {
IanBenzMaxim 0:f77ad7f72d04 49 public:
IanBenzMaxim 0:f77ad7f72d04 50 /// Default construct with power-on config.
IanBenzMaxim 0:f77ad7f72d04 51 explicit Config(uint_least8_t readByte = optionAPU)
IanBenzMaxim 0:f77ad7f72d04 52 : readByte_(readByte & 0xF) {}
IanBenzMaxim 0:f77ad7f72d04 53
IanBenzMaxim 0:f77ad7f72d04 54 /// @{
IanBenzMaxim 0:f77ad7f72d04 55 /// 1-Wire Speed
IanBenzMaxim 0:f77ad7f72d04 56 bool get1WS() const { return (readByte_ & option1WS) == option1WS; }
IanBenzMaxim 0:f77ad7f72d04 57 void set1WS(bool new1WS) {
IanBenzMaxim 0:f77ad7f72d04 58 if (new1WS) {
IanBenzMaxim 0:f77ad7f72d04 59 readByte_ |= option1WS;
IanBenzMaxim 0:f77ad7f72d04 60 } else {
IanBenzMaxim 0:f77ad7f72d04 61 readByte_ &= ~option1WS;
IanBenzMaxim 0:f77ad7f72d04 62 }
IanBenzMaxim 0:f77ad7f72d04 63 }
IanBenzMaxim 0:f77ad7f72d04 64 /// @}
IanBenzMaxim 0:f77ad7f72d04 65
IanBenzMaxim 0:f77ad7f72d04 66 /// @{
IanBenzMaxim 0:f77ad7f72d04 67 /// Strong Pullup
IanBenzMaxim 0:f77ad7f72d04 68 bool getSPU() const { return (readByte_ & optionSPU) == optionSPU; }
IanBenzMaxim 0:f77ad7f72d04 69 void setSPU(bool newSPU) {
IanBenzMaxim 0:f77ad7f72d04 70 if (newSPU) {
IanBenzMaxim 0:f77ad7f72d04 71 readByte_ |= optionSPU;
IanBenzMaxim 0:f77ad7f72d04 72 } else {
IanBenzMaxim 0:f77ad7f72d04 73 readByte_ &= ~optionSPU;
IanBenzMaxim 0:f77ad7f72d04 74 }
IanBenzMaxim 0:f77ad7f72d04 75 }
IanBenzMaxim 0:f77ad7f72d04 76 /// @}
IanBenzMaxim 0:f77ad7f72d04 77
IanBenzMaxim 0:f77ad7f72d04 78 /// @{
IanBenzMaxim 0:f77ad7f72d04 79 /// 1-Wire Power Down
IanBenzMaxim 0:f77ad7f72d04 80 bool getPDN() const { return (readByte_ & optionPDN) == optionPDN; }
IanBenzMaxim 0:f77ad7f72d04 81 void setPDN(bool newPDN) {
IanBenzMaxim 0:f77ad7f72d04 82 if (newPDN) {
IanBenzMaxim 0:f77ad7f72d04 83 readByte_ |= optionPDN;
IanBenzMaxim 0:f77ad7f72d04 84 } else {
IanBenzMaxim 0:f77ad7f72d04 85 readByte_ &= ~optionPDN;
IanBenzMaxim 0:f77ad7f72d04 86 }
IanBenzMaxim 0:f77ad7f72d04 87 }
IanBenzMaxim 0:f77ad7f72d04 88 /// @}
IanBenzMaxim 0:f77ad7f72d04 89
IanBenzMaxim 0:f77ad7f72d04 90 /// @{
IanBenzMaxim 0:f77ad7f72d04 91 /// Active Pullup
IanBenzMaxim 0:f77ad7f72d04 92 bool getAPU() const { return (readByte_ & optionAPU) == optionAPU; }
IanBenzMaxim 0:f77ad7f72d04 93 void setAPU(bool newAPU) {
IanBenzMaxim 0:f77ad7f72d04 94 if (newAPU) {
IanBenzMaxim 0:f77ad7f72d04 95 readByte_ |= optionAPU;
IanBenzMaxim 0:f77ad7f72d04 96 } else {
IanBenzMaxim 0:f77ad7f72d04 97 readByte_ &= ~optionAPU;
IanBenzMaxim 0:f77ad7f72d04 98 }
IanBenzMaxim 0:f77ad7f72d04 99 }
IanBenzMaxim 0:f77ad7f72d04 100 /// @}
IanBenzMaxim 0:f77ad7f72d04 101
IanBenzMaxim 0:f77ad7f72d04 102 /// Byte representation that is read from the device.
IanBenzMaxim 0:f77ad7f72d04 103 uint_least8_t readByte() const { return readByte_; }
IanBenzMaxim 0:f77ad7f72d04 104
IanBenzMaxim 0:f77ad7f72d04 105 private:
IanBenzMaxim 0:f77ad7f72d04 106 static const unsigned int option1WS = 0x8;
IanBenzMaxim 0:f77ad7f72d04 107 static const unsigned int optionSPU = 0x4;
IanBenzMaxim 0:f77ad7f72d04 108 static const unsigned int optionPDN = 0x2;
IanBenzMaxim 0:f77ad7f72d04 109 static const unsigned int optionAPU = 0x1;
IanBenzMaxim 0:f77ad7f72d04 110
IanBenzMaxim 0:f77ad7f72d04 111 uint_least8_t readByte_;
IanBenzMaxim 0:f77ad7f72d04 112 };
IanBenzMaxim 0:f77ad7f72d04 113
IanBenzMaxim 0:f77ad7f72d04 114 void setI2CMaster(I2CMaster & i2cMaster) { this->i2cMaster = &i2cMaster; }
IanBenzMaxim 0:f77ad7f72d04 115 uint_least8_t i2cAddress() const { return i2cAddress_; }
IanBenzMaxim 0:f77ad7f72d04 116 void setI2CAddress(uint_least8_t i2cAddress) {
IanBenzMaxim 0:f77ad7f72d04 117 this->i2cAddress_ = i2cAddress;
IanBenzMaxim 0:f77ad7f72d04 118 }
IanBenzMaxim 0:f77ad7f72d04 119
IanBenzMaxim 0:f77ad7f72d04 120 /// Initialize hardware for use.
IanBenzMaxim 0:f77ad7f72d04 121 MaximInterface_EXPORT error_code initialize(Config config = Config());
IanBenzMaxim 0:f77ad7f72d04 122
IanBenzMaxim 0:f77ad7f72d04 123 /// Write a new configuration to the device.
IanBenzMaxim 0:f77ad7f72d04 124 /// @param[in] config New configuration to write.
IanBenzMaxim 0:f77ad7f72d04 125 MaximInterface_EXPORT error_code writeConfig(Config config);
IanBenzMaxim 0:f77ad7f72d04 126
IanBenzMaxim 0:f77ad7f72d04 127 /// @note Perform a 1-Wire triplet using the device command.
IanBenzMaxim 0:f77ad7f72d04 128 MaximInterface_EXPORT virtual error_code triplet(TripletData & data);
IanBenzMaxim 0:f77ad7f72d04 129
IanBenzMaxim 0:f77ad7f72d04 130 MaximInterface_EXPORT virtual error_code reset();
IanBenzMaxim 0:f77ad7f72d04 131 MaximInterface_EXPORT virtual error_code touchBitSetLevel(bool & sendRecvBit,
IanBenzMaxim 0:f77ad7f72d04 132 Level afterLevel);
IanBenzMaxim 0:f77ad7f72d04 133 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 134 readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
IanBenzMaxim 0:f77ad7f72d04 135 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 136 writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
IanBenzMaxim 0:f77ad7f72d04 137 MaximInterface_EXPORT virtual error_code setSpeed(Speed newSpeed);
IanBenzMaxim 0:f77ad7f72d04 138 MaximInterface_EXPORT virtual error_code setLevel(Level newLevel);
IanBenzMaxim 0:f77ad7f72d04 139
IanBenzMaxim 0:f77ad7f72d04 140 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 141
IanBenzMaxim 0:f77ad7f72d04 142 protected:
IanBenzMaxim 0:f77ad7f72d04 143 DS2482_DS2484(I2CMaster & i2cMaster, uint_least8_t i2cAddress)
IanBenzMaxim 0:f77ad7f72d04 144 : i2cMaster(&i2cMaster), i2cAddress_(i2cAddress) {}
IanBenzMaxim 0:f77ad7f72d04 145
IanBenzMaxim 0:f77ad7f72d04 146 /// @note Allow marking const since not public.
IanBenzMaxim 0:f77ad7f72d04 147 error_code sendCommand(uint_least8_t cmd) const;
IanBenzMaxim 0:f77ad7f72d04 148
IanBenzMaxim 0:f77ad7f72d04 149 /// @note Allow marking const since not public.
IanBenzMaxim 0:f77ad7f72d04 150 error_code sendCommand(uint_least8_t cmd, uint_least8_t param) const;
IanBenzMaxim 0:f77ad7f72d04 151
IanBenzMaxim 0:f77ad7f72d04 152 /// Reads a register from the device.
IanBenzMaxim 0:f77ad7f72d04 153 /// @param reg Register to read from.
IanBenzMaxim 0:f77ad7f72d04 154 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 0:f77ad7f72d04 155 error_code readRegister(uint_least8_t reg, uint_least8_t & buf) const;
IanBenzMaxim 0:f77ad7f72d04 156
IanBenzMaxim 0:f77ad7f72d04 157 /// Reads the current register from the device.
IanBenzMaxim 0:f77ad7f72d04 158 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 0:f77ad7f72d04 159 error_code readRegister(uint_least8_t & buf) const;
IanBenzMaxim 0:f77ad7f72d04 160
IanBenzMaxim 0:f77ad7f72d04 161 private:
IanBenzMaxim 0:f77ad7f72d04 162 /// Performs a soft reset on the device.
IanBenzMaxim 0:f77ad7f72d04 163 /// @note This is not a 1-Wire Reset.
IanBenzMaxim 0:f77ad7f72d04 164 error_code resetDevice();
IanBenzMaxim 0:f77ad7f72d04 165
IanBenzMaxim 0:f77ad7f72d04 166 /// Polls the device status waiting for the 1-Wire Busy bit (1WB) to be cleared.
IanBenzMaxim 0:f77ad7f72d04 167 /// @param[out] pStatus Optionally retrieve the status byte when 1WB cleared.
IanBenzMaxim 0:f77ad7f72d04 168 /// @returns Success or TimeoutError if poll limit reached.
IanBenzMaxim 0:f77ad7f72d04 169 error_code pollBusy(uint_least8_t * pStatus = NULL);
IanBenzMaxim 0:f77ad7f72d04 170
IanBenzMaxim 0:f77ad7f72d04 171 /// Ensure that the desired 1-Wire level is set in the configuration.
IanBenzMaxim 0:f77ad7f72d04 172 /// @param level Desired 1-Wire level.
IanBenzMaxim 0:f77ad7f72d04 173 error_code configureLevel(Level level);
IanBenzMaxim 0:f77ad7f72d04 174
IanBenzMaxim 0:f77ad7f72d04 175 I2CMaster * i2cMaster;
IanBenzMaxim 0:f77ad7f72d04 176 uint_least8_t i2cAddress_;
IanBenzMaxim 0:f77ad7f72d04 177 Config curConfig;
IanBenzMaxim 0:f77ad7f72d04 178 };
IanBenzMaxim 0:f77ad7f72d04 179
IanBenzMaxim 0:f77ad7f72d04 180 inline error_code make_error_code(DS2482_DS2484::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 181 return error_code(e, DS2482_DS2484::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 182 }
IanBenzMaxim 0:f77ad7f72d04 183
IanBenzMaxim 0:f77ad7f72d04 184 class DS2482_100 : public DS2482_DS2484 {
IanBenzMaxim 0:f77ad7f72d04 185 public:
IanBenzMaxim 0:f77ad7f72d04 186 DS2482_100(I2CMaster & i2c_bus, uint_least8_t adrs)
IanBenzMaxim 0:f77ad7f72d04 187 : DS2482_DS2484(i2c_bus, adrs) {}
IanBenzMaxim 0:f77ad7f72d04 188 };
IanBenzMaxim 0:f77ad7f72d04 189
IanBenzMaxim 0:f77ad7f72d04 190 /// DS2482-800 I2C to 1-Wire Master
IanBenzMaxim 0:f77ad7f72d04 191 class DS2482_800 : public DS2482_DS2484 {
IanBenzMaxim 0:f77ad7f72d04 192 public:
IanBenzMaxim 0:f77ad7f72d04 193 DS2482_800(I2CMaster & i2c_bus, uint_least8_t adrs)
IanBenzMaxim 0:f77ad7f72d04 194 : DS2482_DS2484(i2c_bus, adrs) {}
IanBenzMaxim 0:f77ad7f72d04 195
IanBenzMaxim 0:f77ad7f72d04 196 /// Select the active 1-Wire channel.
IanBenzMaxim 0:f77ad7f72d04 197 /// @param channel Channel number to select from 0 to 7.
IanBenzMaxim 0:f77ad7f72d04 198 MaximInterface_EXPORT error_code selectChannel(int channel);
IanBenzMaxim 0:f77ad7f72d04 199 };
IanBenzMaxim 0:f77ad7f72d04 200
IanBenzMaxim 0:f77ad7f72d04 201 /// DS2484 I2C to 1-Wire Master
IanBenzMaxim 0:f77ad7f72d04 202 class DS2484 : public DS2482_DS2484 {
IanBenzMaxim 0:f77ad7f72d04 203 public:
IanBenzMaxim 0:f77ad7f72d04 204 /// 1-Wire port adjustment parameters.
IanBenzMaxim 0:f77ad7f72d04 205 /// @note See datasheet page 13.
IanBenzMaxim 0:f77ad7f72d04 206 enum PortParameter {
IanBenzMaxim 0:f77ad7f72d04 207 tRSTL = 0,
IanBenzMaxim 0:f77ad7f72d04 208 tRSTL_OD,
IanBenzMaxim 0:f77ad7f72d04 209 tMSP,
IanBenzMaxim 0:f77ad7f72d04 210 tMSP_OD,
IanBenzMaxim 0:f77ad7f72d04 211 tW0L,
IanBenzMaxim 0:f77ad7f72d04 212 tW0L_OD,
IanBenzMaxim 0:f77ad7f72d04 213 tREC0, // OD N/A
IanBenzMaxim 0:f77ad7f72d04 214 RWPU = 8 // OD N/A
IanBenzMaxim 0:f77ad7f72d04 215 };
IanBenzMaxim 0:f77ad7f72d04 216
IanBenzMaxim 0:f77ad7f72d04 217 explicit DS2484(I2CMaster & i2c_bus, uint_least8_t adrs = 0x30)
IanBenzMaxim 0:f77ad7f72d04 218 : DS2482_DS2484(i2c_bus, adrs) {}
IanBenzMaxim 0:f77ad7f72d04 219
IanBenzMaxim 0:f77ad7f72d04 220 /// Adjust 1-Wire port parameters.
IanBenzMaxim 0:f77ad7f72d04 221 /// @param param Parameter to adjust.
IanBenzMaxim 0:f77ad7f72d04 222 /// @param val New parameter value to set. Consult datasheet for value mappings.
IanBenzMaxim 0:f77ad7f72d04 223 MaximInterface_EXPORT error_code adjustPort(PortParameter param, int val);
IanBenzMaxim 0:f77ad7f72d04 224 };
IanBenzMaxim 0:f77ad7f72d04 225
IanBenzMaxim 0:f77ad7f72d04 226 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 227
IanBenzMaxim 0:f77ad7f72d04 228 #endif