Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS2482_DS2484.hpp@10:de4b8812877d, 2020-01-06 (annotated)

Committer:
reARMnimator
Date:
Mon Jan 06 15:54:55 2020 +0000
Revision:
10:de4b8812877d
Parent:
7:471901a04573 
Fixed inappropriate include path.

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