1-Wire® library for mbed. Complete 1-Wire library that supports our silicon masters along with a bit-bang master on the MAX32600MBED platform with one common interface for mbed. Slave support has also been included and more slaves will be added as time permits.

Dependents:   MAXREFDES131_Qt_Demo MAX32630FTHR_iButton_uSD_Logger MAX32630FTHR_DS18B20_uSD_Logger MAXREFDES130_131_Demo ... more

Superseded by MaximInterface.

Committer:
IanBenzMaxim
Date:
Mon May 16 15:18:09 2016 -0500
Revision:
78:0cbbac7f2016
Parent:
76:84e6c4994e29
Child:
79:7f22823a5a2d
Code cleanup.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 1:91e52f8ab8bf 1 /******************************************************************//**
j3 1:91e52f8ab8bf 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 1:91e52f8ab8bf 3 *
j3 1:91e52f8ab8bf 4 * Permission is hereby granted, free of charge, to any person obtaining a
j3 1:91e52f8ab8bf 5 * copy of this software and associated documentation files (the "Software"),
j3 1:91e52f8ab8bf 6 * to deal in the Software without restriction, including without limitation
j3 1:91e52f8ab8bf 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 1:91e52f8ab8bf 8 * and/or sell copies of the Software, and to permit persons to whom the
j3 1:91e52f8ab8bf 9 * Software is furnished to do so, subject to the following conditions:
j3 1:91e52f8ab8bf 10 *
j3 1:91e52f8ab8bf 11 * The above copyright notice and this permission notice shall be included
j3 1:91e52f8ab8bf 12 * in all copies or substantial portions of the Software.
j3 1:91e52f8ab8bf 13 *
j3 1:91e52f8ab8bf 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 1:91e52f8ab8bf 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 1:91e52f8ab8bf 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 1:91e52f8ab8bf 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 1:91e52f8ab8bf 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 1:91e52f8ab8bf 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 1:91e52f8ab8bf 20 * OTHER DEALINGS IN THE SOFTWARE.
j3 1:91e52f8ab8bf 21 *
j3 1:91e52f8ab8bf 22 * Except as contained in this notice, the name of Maxim Integrated
j3 1:91e52f8ab8bf 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 1:91e52f8ab8bf 24 * Products, Inc. Branding Policy.
j3 1:91e52f8ab8bf 25 *
j3 1:91e52f8ab8bf 26 * The mere transfer of this software does not imply any licenses
j3 1:91e52f8ab8bf 27 * of trade secrets, proprietary technology, copyrights, patents,
j3 1:91e52f8ab8bf 28 * trademarks, maskwork rights, or any other form of intellectual
j3 1:91e52f8ab8bf 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 1:91e52f8ab8bf 30 * ownership rights.
j3 1:91e52f8ab8bf 31 **********************************************************************/
j3 1:91e52f8ab8bf 32
IanBenzMaxim 73:2cecc1372acc 33 #include "DS248x.h"
IanBenzMaxim 73:2cecc1372acc 34 #include "I2C.h"
j3 1:91e52f8ab8bf 35
IanBenzMaxim 76:84e6c4994e29 36 using OneWire::OneWireMaster;
IanBenzMaxim 76:84e6c4994e29 37 using OneWire::DS248x;
j3 1:91e52f8ab8bf 38
IanBenzMaxim 78:0cbbac7f2016 39 /// DS248x Status Bits
IanBenzMaxim 78:0cbbac7f2016 40 enum StatusBit
IanBenzMaxim 69:f915c4c59a69 41 {
IanBenzMaxim 78:0cbbac7f2016 42 Status_1WB = 0x01,
IanBenzMaxim 78:0cbbac7f2016 43 Status_PPD = 0x02,
IanBenzMaxim 78:0cbbac7f2016 44 Status_SD = 0x04,
IanBenzMaxim 78:0cbbac7f2016 45 Status_LL = 0x08,
IanBenzMaxim 78:0cbbac7f2016 46 Status_RST = 0x10,
IanBenzMaxim 78:0cbbac7f2016 47 Status_SBR = 0x20,
IanBenzMaxim 78:0cbbac7f2016 48 Status_TSB = 0x40,
IanBenzMaxim 78:0cbbac7f2016 49 Status_DIR = 0x80
IanBenzMaxim 69:f915c4c59a69 50 };
IanBenzMaxim 69:f915c4c59a69 51
IanBenzMaxim 69:f915c4c59a69 52 static const int I2C_WRITE_OK = 0;
IanBenzMaxim 69:f915c4c59a69 53 static const int I2C_READ_OK = 0;
IanBenzMaxim 69:f915c4c59a69 54
IanBenzMaxim 73:2cecc1372acc 55 uint8_t DS248x::Config::readByte() const
IanBenzMaxim 69:f915c4c59a69 56 {
IanBenzMaxim 74:23be10c32fa3 57 uint8_t config = 0;
IanBenzMaxim 74:23be10c32fa3 58 if (get1WS())
IanBenzMaxim 74:23be10c32fa3 59 {
IanBenzMaxim 74:23be10c32fa3 60 config |= 0x08;
IanBenzMaxim 74:23be10c32fa3 61 }
IanBenzMaxim 74:23be10c32fa3 62 if (getSPU())
IanBenzMaxim 74:23be10c32fa3 63 {
IanBenzMaxim 74:23be10c32fa3 64 config |= 0x04;
IanBenzMaxim 74:23be10c32fa3 65 }
IanBenzMaxim 74:23be10c32fa3 66 if (getPDN())
IanBenzMaxim 74:23be10c32fa3 67 {
IanBenzMaxim 74:23be10c32fa3 68 config |= 0x02;
IanBenzMaxim 74:23be10c32fa3 69 }
IanBenzMaxim 74:23be10c32fa3 70 if (getAPU())
IanBenzMaxim 74:23be10c32fa3 71 {
IanBenzMaxim 74:23be10c32fa3 72 config |= 0x01;
IanBenzMaxim 74:23be10c32fa3 73 }
IanBenzMaxim 74:23be10c32fa3 74 return config;
IanBenzMaxim 69:f915c4c59a69 75 }
IanBenzMaxim 69:f915c4c59a69 76
IanBenzMaxim 73:2cecc1372acc 77 uint8_t DS248x::Config::writeByte() const
IanBenzMaxim 69:f915c4c59a69 78 {
IanBenzMaxim 74:23be10c32fa3 79 uint8_t config = readByte();
IanBenzMaxim 74:23be10c32fa3 80 return ((~config << 4) | config);
IanBenzMaxim 69:f915c4c59a69 81 }
IanBenzMaxim 69:f915c4c59a69 82
IanBenzMaxim 73:2cecc1372acc 83 void DS248x::Config::reset()
IanBenzMaxim 69:f915c4c59a69 84 {
IanBenzMaxim 74:23be10c32fa3 85 set1WS(false);
IanBenzMaxim 74:23be10c32fa3 86 setSPU(false);
IanBenzMaxim 74:23be10c32fa3 87 setPDN(false);
IanBenzMaxim 74:23be10c32fa3 88 setAPU(true);
IanBenzMaxim 69:f915c4c59a69 89 }
IanBenzMaxim 69:f915c4c59a69 90
IanBenzMaxim 73:2cecc1372acc 91 DS248x::DS248x(mbed::I2C & i2c_bus, uint8_t adrs)
IanBenzMaxim 75:8b627804927c 92 :m_p_i2c_bus(&i2c_bus), m_adrs(adrs), m_i2c_owner(false)
IanBenzMaxim 73:2cecc1372acc 93 {
IanBenzMaxim 69:f915c4c59a69 94
j3 1:91e52f8ab8bf 95 }
j3 1:91e52f8ab8bf 96
IanBenzMaxim 73:2cecc1372acc 97 DS248x::DS248x(PinName sda, PinName scl, uint8_t adrs)
IanBenzMaxim 75:8b627804927c 98 : m_p_i2c_bus(new mbed::I2C(sda, scl)), m_adrs(adrs), m_i2c_owner(true)
IanBenzMaxim 73:2cecc1372acc 99 {
j3 1:91e52f8ab8bf 100
j3 1:91e52f8ab8bf 101 }
j3 1:91e52f8ab8bf 102
IanBenzMaxim 73:2cecc1372acc 103 DS248x::~DS248x()
j3 1:91e52f8ab8bf 104 {
IanBenzMaxim 75:8b627804927c 105 if (m_i2c_owner)
j3 1:91e52f8ab8bf 106 {
IanBenzMaxim 75:8b627804927c 107 delete m_p_i2c_bus;
j3 1:91e52f8ab8bf 108 }
j3 1:91e52f8ab8bf 109 }
j3 1:91e52f8ab8bf 110
IanBenzMaxim 73:2cecc1372acc 111 OneWireMaster::CmdResult DS248x::OWInitMaster(void)
j3 14:7b2886a50321 112 {
IanBenzMaxim 69:f915c4c59a69 113 OneWireMaster::CmdResult result;
j3 14:7b2886a50321 114
IanBenzMaxim 69:f915c4c59a69 115 // reset DS2465
j3 17:b646b1e3970b 116 result = reset();
IanBenzMaxim 69:f915c4c59a69 117 if (result != OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 118 {
IanBenzMaxim 74:23be10c32fa3 119 return result;
IanBenzMaxim 74:23be10c32fa3 120 }
IanBenzMaxim 69:f915c4c59a69 121
IanBenzMaxim 69:f915c4c59a69 122 // write the default configuration setup
IanBenzMaxim 69:f915c4c59a69 123 Config defaultConfig;
IanBenzMaxim 69:f915c4c59a69 124 result = writeConfig(defaultConfig, true);
j3 17:b646b1e3970b 125 return result;
j3 2:02d228c25fd4 126 }
j3 2:02d228c25fd4 127
IanBenzMaxim 73:2cecc1372acc 128 OneWireMaster::CmdResult DS248x::reset(void)
IanBenzMaxim 74:23be10c32fa3 129 {
j3 2:02d228c25fd4 130 // Device Reset
j3 2:02d228c25fd4 131 // S AD,0 [A] DRST [A] Sr AD,1 [A] [SS] A\ P
j3 2:02d228c25fd4 132 // [] indicates from slave
j3 2:02d228c25fd4 133 // SS status byte to read to verify state
IanBenzMaxim 74:23be10c32fa3 134
IanBenzMaxim 74:23be10c32fa3 135 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 136 uint8_t buf;
IanBenzMaxim 74:23be10c32fa3 137
IanBenzMaxim 75:8b627804927c 138 result = sendCommand(DeviceResetCmd);
IanBenzMaxim 74:23be10c32fa3 139
IanBenzMaxim 74:23be10c32fa3 140 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 141 {
IanBenzMaxim 74:23be10c32fa3 142 result = readRegister(StatusReg, buf, true);
IanBenzMaxim 74:23be10c32fa3 143 }
IanBenzMaxim 69:f915c4c59a69 144
IanBenzMaxim 74:23be10c32fa3 145 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 146 {
IanBenzMaxim 74:23be10c32fa3 147 if ((buf & 0xF7) != 0x10)
IanBenzMaxim 74:23be10c32fa3 148 {
IanBenzMaxim 74:23be10c32fa3 149 result = OneWireMaster::OperationFailure;
IanBenzMaxim 74:23be10c32fa3 150 }
IanBenzMaxim 74:23be10c32fa3 151 }
IanBenzMaxim 69:f915c4c59a69 152
IanBenzMaxim 74:23be10c32fa3 153 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 154 {
IanBenzMaxim 74:23be10c32fa3 155 OWReset(); // do a command to get 1-Wire master reset out of holding state
IanBenzMaxim 74:23be10c32fa3 156 }
IanBenzMaxim 74:23be10c32fa3 157
IanBenzMaxim 74:23be10c32fa3 158 return result;
j3 2:02d228c25fd4 159 }
j3 2:02d228c25fd4 160
IanBenzMaxim 73:2cecc1372acc 161 OneWireMaster::CmdResult DS248x::selectChannel(uint8_t channel)
j3 2:02d228c25fd4 162 {
j3 23:e8e403d61359 163 OneWireMaster::CmdResult result;
IanBenzMaxim 69:f915c4c59a69 164 uint8_t ch, ch_read;
IanBenzMaxim 74:23be10c32fa3 165
j3 2:02d228c25fd4 166 // Channel Select (Case A)
j3 2:02d228c25fd4 167 // S AD,0 [A] CHSL [A] CC [A] Sr AD,1 [A] [RR] A\ P
j3 2:02d228c25fd4 168 // [] indicates from slave
j3 2:02d228c25fd4 169 // CC channel value
j3 2:02d228c25fd4 170 // RR channel read back
IanBenzMaxim 74:23be10c32fa3 171
j3 2:02d228c25fd4 172 switch (channel)
j3 2:02d228c25fd4 173 {
IanBenzMaxim 74:23be10c32fa3 174 default:
IanBenzMaxim 74:23be10c32fa3 175 case 0:
IanBenzMaxim 74:23be10c32fa3 176 ch = 0xF0;
IanBenzMaxim 74:23be10c32fa3 177 ch_read = 0xB8;
IanBenzMaxim 74:23be10c32fa3 178 break;
IanBenzMaxim 74:23be10c32fa3 179 case 1:
IanBenzMaxim 74:23be10c32fa3 180 ch = 0xE1;
IanBenzMaxim 74:23be10c32fa3 181 ch_read = 0xB1;
IanBenzMaxim 74:23be10c32fa3 182 break;
IanBenzMaxim 74:23be10c32fa3 183 case 2:
IanBenzMaxim 74:23be10c32fa3 184 ch = 0xD2;
IanBenzMaxim 74:23be10c32fa3 185 ch_read = 0xAA;
IanBenzMaxim 74:23be10c32fa3 186 break;
IanBenzMaxim 74:23be10c32fa3 187 case 3:
IanBenzMaxim 74:23be10c32fa3 188 ch = 0xC3;
IanBenzMaxim 74:23be10c32fa3 189 ch_read = 0xA3;
IanBenzMaxim 74:23be10c32fa3 190 break;
IanBenzMaxim 74:23be10c32fa3 191 case 4:
IanBenzMaxim 74:23be10c32fa3 192 ch = 0xB4;
IanBenzMaxim 74:23be10c32fa3 193 ch_read = 0x9C;
IanBenzMaxim 74:23be10c32fa3 194 break;
IanBenzMaxim 74:23be10c32fa3 195 case 5:
IanBenzMaxim 74:23be10c32fa3 196 ch = 0xA5;
IanBenzMaxim 74:23be10c32fa3 197 ch_read = 0x95;
IanBenzMaxim 74:23be10c32fa3 198 break;
IanBenzMaxim 74:23be10c32fa3 199 case 6:
IanBenzMaxim 74:23be10c32fa3 200 ch = 0x96;
IanBenzMaxim 74:23be10c32fa3 201 ch_read = 0x8E;
IanBenzMaxim 74:23be10c32fa3 202 break;
IanBenzMaxim 74:23be10c32fa3 203 case 7:
IanBenzMaxim 74:23be10c32fa3 204 ch = 0x87;
IanBenzMaxim 74:23be10c32fa3 205 ch_read = 0x87;
IanBenzMaxim 74:23be10c32fa3 206 break;
j3 2:02d228c25fd4 207 };
IanBenzMaxim 74:23be10c32fa3 208
IanBenzMaxim 75:8b627804927c 209 result = sendCommand(ChannelSelectCmd, ch);
IanBenzMaxim 69:f915c4c59a69 210 if (result == OneWireMaster::Success)
j3 17:b646b1e3970b 211 {
IanBenzMaxim 73:2cecc1372acc 212 result = readRegister(ChannelSelectReg, ch, true);
IanBenzMaxim 69:f915c4c59a69 213 if (result == OneWireMaster::Success)
j3 17:b646b1e3970b 214 {
j3 17:b646b1e3970b 215 // check for failure due to incorrect read back of channel
IanBenzMaxim 69:f915c4c59a69 216 if (ch != ch_read)
j3 17:b646b1e3970b 217 {
j3 23:e8e403d61359 218 result = OneWireMaster::OperationFailure;
j3 17:b646b1e3970b 219 }
j3 2:02d228c25fd4 220 }
j3 2:02d228c25fd4 221 }
IanBenzMaxim 74:23be10c32fa3 222
j3 17:b646b1e3970b 223 return result;
j3 1:91e52f8ab8bf 224 }
j3 1:91e52f8ab8bf 225
IanBenzMaxim 73:2cecc1372acc 226 OneWireMaster::CmdResult DS248x::adjustOwPort(OwAdjustParam param, uint8_t val)
j3 1:91e52f8ab8bf 227 {
j3 23:e8e403d61359 228 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 229
IanBenzMaxim 69:f915c4c59a69 230 uint8_t read_port_config;
IanBenzMaxim 69:f915c4c59a69 231 uint8_t control_byte;
IanBenzMaxim 69:f915c4c59a69 232
IanBenzMaxim 69:f915c4c59a69 233 control_byte = (((param & 0x0F) << 4) | (val & 0x0F));
IanBenzMaxim 74:23be10c32fa3 234
IanBenzMaxim 75:8b627804927c 235 result = sendCommand(AdjustOwPortCmd, control_byte);
IanBenzMaxim 69:f915c4c59a69 236 if (result != Success)
IanBenzMaxim 74:23be10c32fa3 237 {
IanBenzMaxim 26:a361e3f42ba5 238 return result;
IanBenzMaxim 74:23be10c32fa3 239 }
IanBenzMaxim 74:23be10c32fa3 240
IanBenzMaxim 73:2cecc1372acc 241 result = readRegister(PortConfigReg, read_port_config, true);
IanBenzMaxim 69:f915c4c59a69 242 if (result != Success)
IanBenzMaxim 74:23be10c32fa3 243 {
IanBenzMaxim 69:f915c4c59a69 244 return result;
IanBenzMaxim 74:23be10c32fa3 245 }
IanBenzMaxim 74:23be10c32fa3 246
IanBenzMaxim 74:23be10c32fa3 247 if ((control_byte & 0x0F) != read_port_config)
IanBenzMaxim 74:23be10c32fa3 248 {
IanBenzMaxim 69:f915c4c59a69 249 result = OneWireMaster::OperationFailure;
IanBenzMaxim 74:23be10c32fa3 250 }
IanBenzMaxim 74:23be10c32fa3 251
IanBenzMaxim 69:f915c4c59a69 252 return result;
IanBenzMaxim 69:f915c4c59a69 253 }
IanBenzMaxim 69:f915c4c59a69 254
IanBenzMaxim 75:8b627804927c 255 OneWireMaster::CmdResult DS248x::OWTriplet(SearchDirection & searchDirection, uint8_t & sbr, uint8_t & tsb)
IanBenzMaxim 69:f915c4c59a69 256 {
IanBenzMaxim 69:f915c4c59a69 257 // 1-Wire Triplet (Case B)
IanBenzMaxim 69:f915c4c59a69 258 // S AD,0 [A] 1WT [A] SS [A] Sr AD,1 [A] [Status] A [Status] A\ P
IanBenzMaxim 69:f915c4c59a69 259 // \--------/
IanBenzMaxim 69:f915c4c59a69 260 // Repeat until 1WB bit has changed to 0
IanBenzMaxim 69:f915c4c59a69 261 // [] indicates from slave
IanBenzMaxim 69:f915c4c59a69 262 // SS indicates byte containing search direction bit value in msbit
IanBenzMaxim 69:f915c4c59a69 263
IanBenzMaxim 74:23be10c32fa3 264 OneWireMaster::CmdResult result;
IanBenzMaxim 75:8b627804927c 265 result = sendCommand(OwTripletCmd, (uint8_t)((searchDirection == WriteOne) ? 0x80 : 0x00));
IanBenzMaxim 69:f915c4c59a69 266 if (result == OneWireMaster::Success)
IanBenzMaxim 69:f915c4c59a69 267 {
IanBenzMaxim 74:23be10c32fa3 268 uint8_t status;
IanBenzMaxim 74:23be10c32fa3 269 result = pollBusy(&status);
IanBenzMaxim 74:23be10c32fa3 270 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 271 {
IanBenzMaxim 74:23be10c32fa3 272 // check bit results in status byte
IanBenzMaxim 78:0cbbac7f2016 273 sbr = ((status & Status_SBR) == Status_SBR);
IanBenzMaxim 78:0cbbac7f2016 274 tsb = ((status & Status_TSB) == Status_TSB);
IanBenzMaxim 78:0cbbac7f2016 275 searchDirection = ((status & Status_DIR) == Status_DIR) ? WriteOne : WriteZero;
IanBenzMaxim 74:23be10c32fa3 276 }
IanBenzMaxim 69:f915c4c59a69 277 }
IanBenzMaxim 74:23be10c32fa3 278 return result;
IanBenzMaxim 69:f915c4c59a69 279 }
IanBenzMaxim 69:f915c4c59a69 280
IanBenzMaxim 75:8b627804927c 281 OneWireMaster::CmdResult DS248x::OWReset()
IanBenzMaxim 69:f915c4c59a69 282 {
IanBenzMaxim 69:f915c4c59a69 283 // 1-Wire reset (Case B)
IanBenzMaxim 69:f915c4c59a69 284 // S AD,0 [A] 1WRS [A] Sr AD,1 [A] [Status] A [Status] A\ P
IanBenzMaxim 69:f915c4c59a69 285 // \--------/
IanBenzMaxim 69:f915c4c59a69 286 // Repeat until 1WB bit has changed to 0
IanBenzMaxim 69:f915c4c59a69 287 // [] indicates from slave
IanBenzMaxim 69:f915c4c59a69 288
IanBenzMaxim 74:23be10c32fa3 289 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 290 uint8_t buf;
IanBenzMaxim 74:23be10c32fa3 291
IanBenzMaxim 75:8b627804927c 292 result = sendCommand(OwResetCmd);
IanBenzMaxim 74:23be10c32fa3 293
IanBenzMaxim 74:23be10c32fa3 294 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 295 {
IanBenzMaxim 74:23be10c32fa3 296 result = pollBusy(&buf);
IanBenzMaxim 74:23be10c32fa3 297 }
IanBenzMaxim 69:f915c4c59a69 298
IanBenzMaxim 74:23be10c32fa3 299 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 300 {
IanBenzMaxim 74:23be10c32fa3 301 // check for presence detect
IanBenzMaxim 78:0cbbac7f2016 302 if ((buf & Status_PPD) != Status_PPD)
IanBenzMaxim 74:23be10c32fa3 303 {
IanBenzMaxim 74:23be10c32fa3 304 result = OneWireMaster::OperationFailure;
IanBenzMaxim 74:23be10c32fa3 305 }
IanBenzMaxim 74:23be10c32fa3 306 }
IanBenzMaxim 69:f915c4c59a69 307
IanBenzMaxim 74:23be10c32fa3 308 return result;
IanBenzMaxim 69:f915c4c59a69 309 }
IanBenzMaxim 69:f915c4c59a69 310
IanBenzMaxim 75:8b627804927c 311 OneWireMaster::CmdResult DS248x::OWTouchBitSetLevel(uint8_t & sendRecvBit, OWLevel afterLevel)
IanBenzMaxim 69:f915c4c59a69 312 {
j3 2:02d228c25fd4 313 // 1-Wire bit (Case B)
j3 2:02d228c25fd4 314 // S AD,0 [A] 1WSB [A] BB [A] Sr AD,1 [A] [Status] A [Status] A\ P
j3 2:02d228c25fd4 315 // \--------/
j3 2:02d228c25fd4 316 // Repeat until 1WB bit has changed to 0
j3 2:02d228c25fd4 317 // [] indicates from slave
j3 2:02d228c25fd4 318 // BB indicates byte containing bit value in msbit
j3 2:02d228c25fd4 319
IanBenzMaxim 74:23be10c32fa3 320 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 321
IanBenzMaxim 75:8b627804927c 322 result = configureLevel(afterLevel);
IanBenzMaxim 74:23be10c32fa3 323 if (result != OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 324 {
IanBenzMaxim 74:23be10c32fa3 325 return result;
IanBenzMaxim 74:23be10c32fa3 326 }
IanBenzMaxim 74:23be10c32fa3 327
IanBenzMaxim 74:23be10c32fa3 328 uint8_t status;
IanBenzMaxim 74:23be10c32fa3 329
IanBenzMaxim 75:8b627804927c 330 result = sendCommand(OwSingleBitCmd, (uint8_t)(sendRecvBit ? 0x80 : 0x00));
IanBenzMaxim 74:23be10c32fa3 331
IanBenzMaxim 74:23be10c32fa3 332 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 333 {
IanBenzMaxim 74:23be10c32fa3 334 result = pollBusy(&status);
IanBenzMaxim 74:23be10c32fa3 335 }
IanBenzMaxim 74:23be10c32fa3 336
IanBenzMaxim 74:23be10c32fa3 337 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 338 {
IanBenzMaxim 78:0cbbac7f2016 339 sendRecvBit = (status & Status_SBR);
IanBenzMaxim 74:23be10c32fa3 340 }
IanBenzMaxim 74:23be10c32fa3 341
IanBenzMaxim 69:f915c4c59a69 342 return result;
j3 1:91e52f8ab8bf 343 }
j3 1:91e52f8ab8bf 344
IanBenzMaxim 75:8b627804927c 345 OneWireMaster::CmdResult DS248x::OWWriteByteSetLevel(uint8_t sendByte, OWLevel afterLevel)
j3 1:91e52f8ab8bf 346 {
j3 2:02d228c25fd4 347 // 1-Wire Write Byte (Case B)
j3 2:02d228c25fd4 348 // S AD,0 [A] 1WWB [A] DD [A] Sr AD,1 [A] [Status] A [Status] A\ P
j3 2:02d228c25fd4 349 // \--------/
j3 2:02d228c25fd4 350 // Repeat until 1WB bit has changed to 0
j3 2:02d228c25fd4 351 // [] indicates from slave
j3 2:02d228c25fd4 352 // DD data to write
j3 2:02d228c25fd4 353
IanBenzMaxim 74:23be10c32fa3 354 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 355
IanBenzMaxim 75:8b627804927c 356 result = configureLevel(afterLevel);
IanBenzMaxim 74:23be10c32fa3 357 if (result != OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 358 {
IanBenzMaxim 74:23be10c32fa3 359 return result;
IanBenzMaxim 74:23be10c32fa3 360 }
IanBenzMaxim 74:23be10c32fa3 361
IanBenzMaxim 75:8b627804927c 362 result = sendCommand(OwWriteByteCmd, sendByte);
IanBenzMaxim 74:23be10c32fa3 363 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 364 {
IanBenzMaxim 74:23be10c32fa3 365 result = pollBusy();
IanBenzMaxim 74:23be10c32fa3 366 }
IanBenzMaxim 74:23be10c32fa3 367
IanBenzMaxim 69:f915c4c59a69 368 return result;
j3 1:91e52f8ab8bf 369 }
j3 1:91e52f8ab8bf 370
IanBenzMaxim 75:8b627804927c 371 OneWireMaster::CmdResult DS248x::OWReadByteSetLevel(uint8_t & recvByte, OWLevel afterLevel)
j3 1:91e52f8ab8bf 372 {
IanBenzMaxim 69:f915c4c59a69 373 // 1-Wire Read Bytes (Case C)
IanBenzMaxim 69:f915c4c59a69 374 // S AD,0 [A] 1WRB [A] Sr AD,1 [A] [Status] A [Status] A\
IanBenzMaxim 69:f915c4c59a69 375 // \--------/
IanBenzMaxim 69:f915c4c59a69 376 // Repeat until 1WB bit has changed to 0
IanBenzMaxim 69:f915c4c59a69 377 // Sr AD,0 [A] SRP [A] E1 [A] Sr AD,1 [A] DD A\ P
IanBenzMaxim 69:f915c4c59a69 378 //
IanBenzMaxim 69:f915c4c59a69 379 // [] indicates from slave
IanBenzMaxim 69:f915c4c59a69 380 // DD data read
IanBenzMaxim 26:a361e3f42ba5 381
IanBenzMaxim 74:23be10c32fa3 382 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 383 uint8_t buf;
IanBenzMaxim 74:23be10c32fa3 384
IanBenzMaxim 75:8b627804927c 385 result = configureLevel(afterLevel);
IanBenzMaxim 74:23be10c32fa3 386 if (result != OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 387 {
IanBenzMaxim 74:23be10c32fa3 388 return result;
IanBenzMaxim 74:23be10c32fa3 389 }
IanBenzMaxim 74:23be10c32fa3 390
IanBenzMaxim 75:8b627804927c 391 result = sendCommand(OwReadByteCmd);
IanBenzMaxim 69:f915c4c59a69 392
IanBenzMaxim 74:23be10c32fa3 393 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 394 {
IanBenzMaxim 74:23be10c32fa3 395 result = pollBusy();
IanBenzMaxim 74:23be10c32fa3 396 }
IanBenzMaxim 69:f915c4c59a69 397
IanBenzMaxim 74:23be10c32fa3 398 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 399 {
IanBenzMaxim 74:23be10c32fa3 400 result = readRegister(ReadDataReg, buf);
IanBenzMaxim 74:23be10c32fa3 401 }
IanBenzMaxim 74:23be10c32fa3 402
IanBenzMaxim 74:23be10c32fa3 403 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 404 {
IanBenzMaxim 75:8b627804927c 405 recvByte = buf;
IanBenzMaxim 74:23be10c32fa3 406 }
IanBenzMaxim 74:23be10c32fa3 407
IanBenzMaxim 74:23be10c32fa3 408 return result;
j3 17:b646b1e3970b 409 }
j3 17:b646b1e3970b 410
IanBenzMaxim 75:8b627804927c 411 OneWireMaster::CmdResult DS248x::OWSetSpeed(OWSpeed newSpeed)
j3 1:91e52f8ab8bf 412 {
IanBenzMaxim 74:23be10c32fa3 413 // Requested speed is already set
IanBenzMaxim 75:8b627804927c 414 if (m_curConfig.get1WS() == (newSpeed == OverdriveSpeed))
IanBenzMaxim 74:23be10c32fa3 415 {
IanBenzMaxim 74:23be10c32fa3 416 return OneWireMaster::Success;
IanBenzMaxim 74:23be10c32fa3 417 }
j3 2:02d228c25fd4 418
IanBenzMaxim 74:23be10c32fa3 419 // set the speed
IanBenzMaxim 74:23be10c32fa3 420 Config newConfig = m_curConfig;
IanBenzMaxim 75:8b627804927c 421 newConfig.set1WS(newSpeed == OverdriveSpeed);
IanBenzMaxim 74:23be10c32fa3 422
IanBenzMaxim 74:23be10c32fa3 423 // write the new config
IanBenzMaxim 74:23be10c32fa3 424 return writeConfig(newConfig, true);
j3 1:91e52f8ab8bf 425 }
j3 1:91e52f8ab8bf 426
IanBenzMaxim 75:8b627804927c 427 OneWireMaster::CmdResult DS248x::OWSetLevel(OWLevel newLevel)
j3 1:91e52f8ab8bf 428 {
IanBenzMaxim 75:8b627804927c 429 if (newLevel == StrongLevel)
IanBenzMaxim 73:2cecc1372acc 430 {
IanBenzMaxim 69:f915c4c59a69 431 return OneWireMaster::OperationFailure;
IanBenzMaxim 74:23be10c32fa3 432 }
IanBenzMaxim 74:23be10c32fa3 433
IanBenzMaxim 75:8b627804927c 434 return configureLevel(newLevel);
IanBenzMaxim 21:00c94aeb533e 435 }
IanBenzMaxim 21:00c94aeb533e 436
IanBenzMaxim 73:2cecc1372acc 437 OneWireMaster::CmdResult DS248x::writeConfig(const Config & config, bool verify)
j3 6:1faafa0b3cd7 438 {
IanBenzMaxim 74:23be10c32fa3 439 uint8_t configBuf;
IanBenzMaxim 74:23be10c32fa3 440 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 441
IanBenzMaxim 74:23be10c32fa3 442 configBuf = config.writeByte();
IanBenzMaxim 75:8b627804927c 443 result = sendCommand(WriteDeviceConfigCmd, configBuf);
IanBenzMaxim 74:23be10c32fa3 444 if (verify)
IanBenzMaxim 74:23be10c32fa3 445 {
IanBenzMaxim 74:23be10c32fa3 446 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 447 {
IanBenzMaxim 74:23be10c32fa3 448 result = readRegister(ConfigReg, configBuf);
IanBenzMaxim 74:23be10c32fa3 449 }
IanBenzMaxim 74:23be10c32fa3 450 if (result == OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 451 {
IanBenzMaxim 74:23be10c32fa3 452 if (configBuf != config.readByte())
IanBenzMaxim 74:23be10c32fa3 453 {
IanBenzMaxim 74:23be10c32fa3 454 result = OneWireMaster::OperationFailure;
IanBenzMaxim 74:23be10c32fa3 455 }
IanBenzMaxim 74:23be10c32fa3 456 }
IanBenzMaxim 74:23be10c32fa3 457 }
IanBenzMaxim 74:23be10c32fa3 458
IanBenzMaxim 69:f915c4c59a69 459 if (result == OneWireMaster::Success)
IanBenzMaxim 69:f915c4c59a69 460 {
IanBenzMaxim 74:23be10c32fa3 461 m_curConfig = config;
IanBenzMaxim 69:f915c4c59a69 462 }
IanBenzMaxim 69:f915c4c59a69 463
IanBenzMaxim 74:23be10c32fa3 464 return result;
IanBenzMaxim 69:f915c4c59a69 465 }
IanBenzMaxim 69:f915c4c59a69 466
IanBenzMaxim 73:2cecc1372acc 467 OneWireMaster::CmdResult DS248x::readRegister(Register reg, uint8_t & buf, bool skipSetPointer) const
IanBenzMaxim 69:f915c4c59a69 468 {
IanBenzMaxim 69:f915c4c59a69 469 CmdResult result;
IanBenzMaxim 75:8b627804927c 470 result = sendCommand(SetReadPointerCmd, reg);
IanBenzMaxim 69:f915c4c59a69 471 if (result == Success)
IanBenzMaxim 69:f915c4c59a69 472 {
IanBenzMaxim 75:8b627804927c 473 if (m_p_i2c_bus->read(m_adrs, reinterpret_cast<char *>(&buf), 1) != I2C_READ_OK)
IanBenzMaxim 73:2cecc1372acc 474 {
IanBenzMaxim 69:f915c4c59a69 475 result = CommunicationReadError;
IanBenzMaxim 74:23be10c32fa3 476 }
IanBenzMaxim 69:f915c4c59a69 477 }
IanBenzMaxim 69:f915c4c59a69 478 return result;
IanBenzMaxim 69:f915c4c59a69 479 }
IanBenzMaxim 69:f915c4c59a69 480
IanBenzMaxim 73:2cecc1372acc 481 OneWireMaster::CmdResult DS248x::pollBusy(uint8_t * pStatus)
IanBenzMaxim 69:f915c4c59a69 482 {
IanBenzMaxim 74:23be10c32fa3 483 const unsigned int pollLimit = 200;
IanBenzMaxim 74:23be10c32fa3 484
IanBenzMaxim 74:23be10c32fa3 485 OneWireMaster::CmdResult result;
IanBenzMaxim 74:23be10c32fa3 486 uint8_t status;
IanBenzMaxim 74:23be10c32fa3 487 unsigned int pollCount = 0;
IanBenzMaxim 69:f915c4c59a69 488
IanBenzMaxim 74:23be10c32fa3 489 do
IanBenzMaxim 74:23be10c32fa3 490 {
IanBenzMaxim 74:23be10c32fa3 491 result = readRegister(StatusReg, status, true);
IanBenzMaxim 74:23be10c32fa3 492 if (result != OneWireMaster::Success)
IanBenzMaxim 74:23be10c32fa3 493 {
IanBenzMaxim 74:23be10c32fa3 494 return result;
IanBenzMaxim 74:23be10c32fa3 495 }
IanBenzMaxim 74:23be10c32fa3 496 if (pStatus != NULL)
IanBenzMaxim 74:23be10c32fa3 497 {
IanBenzMaxim 74:23be10c32fa3 498 *pStatus = status;
IanBenzMaxim 74:23be10c32fa3 499 }
IanBenzMaxim 74:23be10c32fa3 500 if (pollCount++ >= pollLimit)
IanBenzMaxim 74:23be10c32fa3 501 {
IanBenzMaxim 74:23be10c32fa3 502 return OneWireMaster::TimeoutError;
IanBenzMaxim 74:23be10c32fa3 503 }
IanBenzMaxim 78:0cbbac7f2016 504 } while (status & Status_1WB);
IanBenzMaxim 69:f915c4c59a69 505
IanBenzMaxim 74:23be10c32fa3 506 return OneWireMaster::Success;
IanBenzMaxim 69:f915c4c59a69 507 }
IanBenzMaxim 69:f915c4c59a69 508
IanBenzMaxim 73:2cecc1372acc 509 OneWireMaster::CmdResult DS248x::configureLevel(OWLevel level)
IanBenzMaxim 69:f915c4c59a69 510 {
IanBenzMaxim 69:f915c4c59a69 511 OneWireMaster::CmdResult result;
IanBenzMaxim 75:8b627804927c 512 if (m_curConfig.getSPU() != (level == StrongLevel))
IanBenzMaxim 69:f915c4c59a69 513 {
IanBenzMaxim 69:f915c4c59a69 514 Config newConfig = m_curConfig;
IanBenzMaxim 75:8b627804927c 515 newConfig.setSPU(level == StrongLevel);
IanBenzMaxim 69:f915c4c59a69 516 result = writeConfig(newConfig, true);
IanBenzMaxim 69:f915c4c59a69 517 }
IanBenzMaxim 69:f915c4c59a69 518 else
IanBenzMaxim 69:f915c4c59a69 519 {
IanBenzMaxim 69:f915c4c59a69 520 result = OneWireMaster::Success;
IanBenzMaxim 69:f915c4c59a69 521 }
IanBenzMaxim 69:f915c4c59a69 522 return result;
IanBenzMaxim 69:f915c4c59a69 523 }
IanBenzMaxim 69:f915c4c59a69 524
IanBenzMaxim 75:8b627804927c 525 OneWireMaster::CmdResult DS248x::sendCommand(Command cmd) const
IanBenzMaxim 69:f915c4c59a69 526 {
IanBenzMaxim 69:f915c4c59a69 527 CmdResult result;
IanBenzMaxim 75:8b627804927c 528 if (m_p_i2c_bus->write(m_adrs, reinterpret_cast<const char *>(&cmd), 1) == I2C_WRITE_OK)
IanBenzMaxim 73:2cecc1372acc 529 {
IanBenzMaxim 69:f915c4c59a69 530 result = Success;
IanBenzMaxim 74:23be10c32fa3 531 }
IanBenzMaxim 69:f915c4c59a69 532 else
IanBenzMaxim 73:2cecc1372acc 533 {
IanBenzMaxim 69:f915c4c59a69 534 result = CommunicationWriteError;
IanBenzMaxim 74:23be10c32fa3 535 }
IanBenzMaxim 69:f915c4c59a69 536 return result;
IanBenzMaxim 69:f915c4c59a69 537 }
IanBenzMaxim 69:f915c4c59a69 538
IanBenzMaxim 75:8b627804927c 539 OneWireMaster::CmdResult DS248x::sendCommand(Command cmd, uint8_t param) const
IanBenzMaxim 69:f915c4c59a69 540 {
IanBenzMaxim 69:f915c4c59a69 541 CmdResult result;
IanBenzMaxim 69:f915c4c59a69 542 char buf[2] = { cmd, param };
IanBenzMaxim 75:8b627804927c 543 if (m_p_i2c_bus->write(m_adrs, buf, 2) == I2C_WRITE_OK)
IanBenzMaxim 73:2cecc1372acc 544 {
IanBenzMaxim 69:f915c4c59a69 545 result = Success;
IanBenzMaxim 74:23be10c32fa3 546 }
IanBenzMaxim 69:f915c4c59a69 547 else
IanBenzMaxim 73:2cecc1372acc 548 {
IanBenzMaxim 69:f915c4c59a69 549 result = CommunicationWriteError;
IanBenzMaxim 74:23be10c32fa3 550 }
IanBenzMaxim 69:f915c4c59a69 551 return result;
IanBenzMaxim 69:f915c4c59a69 552 }