Maxim Integrated / OneWire

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.

OneWire_Masters/OneWireMaster.h@48:6f9208ae280e, 2016-04-07 (annotated)

Committer:
IanBenzMaxim
Date:
Thu Apr 07 11:26:20 2016 -0500
Revision:
48:6f9208ae280e
Parent:
47:307dc45952db
Child:
49:36954b62f503
Fix narrowing warning. Add comments to ISha256MacCoprocessor.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 5:ce108eeb878d 1 /******************************************************************//**
j3 5:ce108eeb878d 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 5:ce108eeb878d 3 *
j3 5:ce108eeb878d 4 * Permission is hereby granted, free of charge, to any person obtaining a
j3 5:ce108eeb878d 5 * copy of this software and associated documentation files (the "Software"),
j3 5:ce108eeb878d 6 * to deal in the Software without restriction, including without limitation
j3 5:ce108eeb878d 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 5:ce108eeb878d 8 * and/or sell copies of the Software, and to permit persons to whom the
j3 5:ce108eeb878d 9 * Software is furnished to do so, subject to the following conditions:
j3 5:ce108eeb878d 10 *
j3 5:ce108eeb878d 11 * The above copyright notice and this permission notice shall be included
j3 5:ce108eeb878d 12 * in all copies or substantial portions of the Software.
j3 5:ce108eeb878d 13 *
j3 5:ce108eeb878d 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 5:ce108eeb878d 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 5:ce108eeb878d 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 5:ce108eeb878d 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 5:ce108eeb878d 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 5:ce108eeb878d 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 5:ce108eeb878d 20 * OTHER DEALINGS IN THE SOFTWARE.
j3 5:ce108eeb878d 21 *
j3 5:ce108eeb878d 22 * Except as contained in this notice, the name of Maxim Integrated
j3 5:ce108eeb878d 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 5:ce108eeb878d 24 * Products, Inc. Branding Policy.
j3 5:ce108eeb878d 25 *
j3 5:ce108eeb878d 26 * The mere transfer of this software does not imply any licenses
j3 5:ce108eeb878d 27 * of trade secrets, proprietary technology, copyrights, patents,
j3 5:ce108eeb878d 28 * trademarks, maskwork rights, or any other form of intellectual
j3 5:ce108eeb878d 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 5:ce108eeb878d 30 * ownership rights.
j3 5:ce108eeb878d 31 **********************************************************************/
j3 5:ce108eeb878d 32
j3 5:ce108eeb878d 33
j3 15:f6cb0d906fb6 34 #ifndef ONEWIREMASTER_H
j3 15:f6cb0d906fb6 35 #define ONEWIREMASTER_H
j3 5:ce108eeb878d 36
IanBenzMaxim 27:d5aaefa252f1 37 #include <cstdint>
IanBenzMaxim 27:d5aaefa252f1 38 #include <cstddef>
j3 5:ce108eeb878d 39
IanBenzMaxim 32:bce180b544ed 40 #include "RomId.hpp"
j3 5:ce108eeb878d 41
IanBenzMaxim 48:6f9208ae280e 42 /// Base class for all 1-Wire Masters.
j3 23:e8e403d61359 43 class OneWireMaster
IanBenzMaxim 27:d5aaefa252f1 44 {
IanBenzMaxim 24:8942d8478d68 45 public:
j3 23:e8e403d61359 46
IanBenzMaxim 48:6f9208ae280e 47 /// Speed of the 1-Wire bus
IanBenzMaxim 32:bce180b544ed 48 enum OWSpeed
j3 23:e8e403d61359 49 {
j3 23:e8e403d61359 50 SPEED_STANDARD = 0x00,
j3 23:e8e403d61359 51 SPEED_OVERDRIVE = 0x01
j3 23:e8e403d61359 52 };
j3 23:e8e403d61359 53
IanBenzMaxim 48:6f9208ae280e 54 /// Level of the 1-Wire bus
IanBenzMaxim 32:bce180b544ed 55 enum OWLevel
j3 23:e8e403d61359 56 {
j3 23:e8e403d61359 57 LEVEL_NORMAL = 0x00,
j3 23:e8e403d61359 58 LEVEL_STRONG = 0x02
j3 23:e8e403d61359 59 };
j3 23:e8e403d61359 60
IanBenzMaxim 48:6f9208ae280e 61 /// Search direction for the Triplet
IanBenzMaxim 32:bce180b544ed 62 enum SearchDirection
IanBenzMaxim 32:bce180b544ed 63 {
IanBenzMaxim 32:bce180b544ed 64 DIRECTION_WRITE_ZERO = 0,
IanBenzMaxim 32:bce180b544ed 65 DIRECTION_WRITE_ONE = 1
IanBenzMaxim 32:bce180b544ed 66 };
IanBenzMaxim 32:bce180b544ed 67
IanBenzMaxim 48:6f9208ae280e 68 /// Result of all 1-Wire commands
j3 23:e8e403d61359 69 enum CmdResult
j3 23:e8e403d61359 70 {
j3 23:e8e403d61359 71 Success,
j3 23:e8e403d61359 72 CommunicationWriteError,
j3 23:e8e403d61359 73 CommunicationReadError,
j3 23:e8e403d61359 74 TimeoutError,
j3 23:e8e403d61359 75 OperationFailure
j3 23:e8e403d61359 76 };
j3 23:e8e403d61359 77
IanBenzMaxim 48:6f9208ae280e 78 /// State used by all ROM ID search functions.
IanBenzMaxim 32:bce180b544ed 79 struct SearchState
IanBenzMaxim 32:bce180b544ed 80 {
IanBenzMaxim 32:bce180b544ed 81 RomId romId;
IanBenzMaxim 32:bce180b544ed 82 std::uint8_t last_discrepancy;
IanBenzMaxim 32:bce180b544ed 83 std::uint8_t last_family_discrepancy;
IanBenzMaxim 32:bce180b544ed 84 bool last_device_flag;
IanBenzMaxim 32:bce180b544ed 85
IanBenzMaxim 48:6f9208ae280e 86 /// Reset to the search state to start at the beginning.
IanBenzMaxim 32:bce180b544ed 87 void reset()
IanBenzMaxim 32:bce180b544ed 88 {
IanBenzMaxim 32:bce180b544ed 89 last_discrepancy = 0;
IanBenzMaxim 32:bce180b544ed 90 last_device_flag = false;
IanBenzMaxim 32:bce180b544ed 91 last_family_discrepancy = 0;
IanBenzMaxim 32:bce180b544ed 92 romId.reset();
IanBenzMaxim 32:bce180b544ed 93 }
IanBenzMaxim 32:bce180b544ed 94
IanBenzMaxim 32:bce180b544ed 95 SearchState() { reset(); }
IanBenzMaxim 32:bce180b544ed 96 };
IanBenzMaxim 32:bce180b544ed 97
IanBenzMaxim 48:6f9208ae280e 98 /// Perform a CRC16 calculation.
IanBenzMaxim 48:6f9208ae280e 99 /// @param CRC16 Beginning state of the CRC generator.
IanBenzMaxim 48:6f9208ae280e 100 /// @param data Data to pass though the CRC generator.
IanBenzMaxim 48:6f9208ae280e 101 /// @returns The calculated CRC16.
IanBenzMaxim 27:d5aaefa252f1 102 static std::uint16_t calculateCRC16(std::uint16_t CRC16, std::uint16_t data);
j3 17:b646b1e3970b 103
IanBenzMaxim 48:6f9208ae280e 104 /// Perform a CRC calculation with variable length data.
IanBenzMaxim 48:6f9208ae280e 105 /// @param[in] data Data array to pass through the CRC generator.
IanBenzMaxim 48:6f9208ae280e 106 /// @param data_offset Offset of the data array to begin processing.
IanBenzMaxim 48:6f9208ae280e 107 /// @param data_len Length of the data array to process.
IanBenzMaxim 48:6f9208ae280e 108 /// @param crc Beginning state of the CRC generator.
IanBenzMaxim 48:6f9208ae280e 109 /// @returns The calculated CRC16.
IanBenzMaxim 27:d5aaefa252f1 110 static std::uint16_t calculateCRC16(const std::uint8_t * data, std::size_t data_offset, std::size_t data_len, std::uint16_t crc = 0);
j3 17:b646b1e3970b 111
IanBenzMaxim 48:6f9208ae280e 112 /// Allow freeing through a base class pointer.
IanBenzMaxim 26:a361e3f42ba5 113 virtual ~OneWireMaster() { }
IanBenzMaxim 26:a361e3f42ba5 114
j3 23:e8e403d61359 115
j3 23:e8e403d61359 116 /**********************************************************//**
j3 23:e8e403d61359 117 * @brief OWInitMaster()
j3 23:e8e403d61359 118 *
j3 23:e8e403d61359 119 * @details Initiializes particular master being instaniated.
j3 23:e8e403d61359 120 * Added to interface to provide a common 'init' function between
j3 23:e8e403d61359 121 * all masters
j3 23:e8e403d61359 122 *
j3 23:e8e403d61359 123 * On Entry:
j3 23:e8e403d61359 124 *
j3 23:e8e403d61359 125 * On Exit:
j3 23:e8e403d61359 126 *
j3 23:e8e403d61359 127 **************************************************************/
j3 23:e8e403d61359 128 virtual CmdResult OWInitMaster(void) = 0;
j3 23:e8e403d61359 129
j3 23:e8e403d61359 130
j3 23:e8e403d61359 131 /**********************************************************//**
j3 23:e8e403d61359 132 * @brief OWReset()
j3 23:e8e403d61359 133 *
j3 23:e8e403d61359 134 * @details Reset all of the devices on the 1-Wire Net and return
j3 23:e8e403d61359 135 * the result.
j3 23:e8e403d61359 136 *
j3 23:e8e403d61359 137 * On Entry:
j3 23:e8e403d61359 138 *
j3 23:e8e403d61359 139 * On Exit:
j3 23:e8e403d61359 140 *
IanBenzMaxim 47:307dc45952db 141 * @returns OperationFailure if reset was performed but no
IanBenzMaxim 47:307dc45952db 142 * presence pulse was detected.
j3 23:e8e403d61359 143 **************************************************************/
j3 23:e8e403d61359 144 virtual CmdResult OWReset(void) = 0;
j3 23:e8e403d61359 145
j3 23:e8e403d61359 146
j3 23:e8e403d61359 147 /**********************************************************//**
j3 23:e8e403d61359 148 * @brief OWTouchBit()
j3 23:e8e403d61359 149 *
j3 23:e8e403d61359 150 * @details Send 1 bit of communication to the 1-Wire Net and return
j3 23:e8e403d61359 151 * the result 1 bit read from the 1-Wire Net. The
j3 23:e8e403d61359 152 * parameter 'sendbit' least significant bit is used and
j3 23:e8e403d61359 153 * the least significant bit of the result is the return
j3 23:e8e403d61359 154 * bit.
j3 23:e8e403d61359 155 *
j3 23:e8e403d61359 156 * On Entry:
j3 23:e8e403d61359 157 * @param[in] 'sendbit' - the least significant bit is the bit to send
j3 23:e8e403d61359 158 *
j3 23:e8e403d61359 159 * On Exit:
j3 23:e8e403d61359 160 *
j3 23:e8e403d61359 161 **************************************************************/
IanBenzMaxim 32:bce180b544ed 162 virtual CmdResult OWTouchBit(std::uint8_t & sendrecvbit, OWLevel after_level) = 0;
j3 23:e8e403d61359 163
j3 23:e8e403d61359 164
j3 23:e8e403d61359 165 /**********************************************************//**
j3 23:e8e403d61359 166 * @brief OWWRiteByte()
j3 23:e8e403d61359 167 *
j3 23:e8e403d61359 168 * @details Send 8 bits of communication to the 1-Wire Net and
j3 23:e8e403d61359 169 * verify that the 8 bits read from the 1-Wire Net is the
j3 23:e8e403d61359 170 * same (write operation).The parameter 'sendbyte' least
j3 23:e8e403d61359 171 * significant 8 bits are used.
j3 23:e8e403d61359 172 *
j3 23:e8e403d61359 173 * On Entry:
j3 23:e8e403d61359 174 * @param[in] 'sendbyte' - 8 bits to send (least significant byte)
j3 23:e8e403d61359 175 *
j3 23:e8e403d61359 176 * On Exit:
j3 23:e8e403d61359 177 *
j3 23:e8e403d61359 178 **************************************************************/
IanBenzMaxim 32:bce180b544ed 179 virtual CmdResult OWWriteByte(std::uint8_t sendbyte, OWLevel after_level) = 0;
j3 23:e8e403d61359 180
j3 23:e8e403d61359 181
j3 23:e8e403d61359 182 /**********************************************************//**
j3 23:e8e403d61359 183 * @brief OWReadByte()
j3 23:e8e403d61359 184 *
j3 23:e8e403d61359 185 * @details Send 8 bits of read communication to the 1-Wire Net
j3 23:e8e403d61359 186 * and return the result 8 bits read from the 1-Wire Net.
j3 23:e8e403d61359 187 *
j3 23:e8e403d61359 188 * On Entry:
j3 23:e8e403d61359 189 *
j3 23:e8e403d61359 190 * On Exit:
j3 23:e8e403d61359 191 *
j3 23:e8e403d61359 192 **************************************************************/
IanBenzMaxim 32:bce180b544ed 193 virtual CmdResult OWReadByte(std::uint8_t & recvbyte, OWLevel after_level) = 0;
j3 23:e8e403d61359 194
j3 23:e8e403d61359 195
j3 23:e8e403d61359 196 /**********************************************************//**
j3 23:e8e403d61359 197 * @brief OWWriteBlock()
j3 23:e8e403d61359 198 *
j3 23:e8e403d61359 199 * @details complements OWBlock, writes 'tran_len' bytes from
j3 23:e8e403d61359 200 * 'tran_buf' to 1-wire Net.
j3 23:e8e403d61359 201 *
j3 23:e8e403d61359 202 * On Entry:
j3 23:e8e403d61359 203 * @param[in] tran_buf - pointer to data to write
j3 23:e8e403d61359 204 * @param[in] tran_len - number of bytes to write
j3 23:e8e403d61359 205 *
j3 23:e8e403d61359 206 * On Exit:
j3 23:e8e403d61359 207 *
j3 23:e8e403d61359 208 **************************************************************/
IanBenzMaxim 27:d5aaefa252f1 209 virtual CmdResult OWWriteBlock(const std::uint8_t *tran_buf, std::uint8_t tran_len) = 0;
j3 23:e8e403d61359 210
j3 15:f6cb0d906fb6 211
j3 23:e8e403d61359 212 /**********************************************************//**
j3 23:e8e403d61359 213 * @brief OWReadBlock()
j3 23:e8e403d61359 214 *
j3 23:e8e403d61359 215 * @details complements OWBlock, reads 'recv_len' bytes from
j3 23:e8e403d61359 216 * 1-wire Net and puts them in 'recv_buf'.
j3 23:e8e403d61359 217 *
j3 23:e8e403d61359 218 * On Entry:
j3 23:e8e403d61359 219 * @param[in] recv_buf - pointer to receive buffer
j3 23:e8e403d61359 220 * @param[in] recv_len - number of bytes to read
j3 23:e8e403d61359 221 *
j3 23:e8e403d61359 222 * On Exit:
IanBenzMaxim 47:307dc45952db 223 *
j3 23:e8e403d61359 224 **************************************************************/
IanBenzMaxim 27:d5aaefa252f1 225 virtual CmdResult OWReadBlock(std::uint8_t *rx_buf, std::uint8_t rx_len) = 0;
j3 23:e8e403d61359 226
j3 23:e8e403d61359 227
j3 23:e8e403d61359 228 /**********************************************************//**
IanBenzMaxim 32:bce180b544ed 229 * @brief OWSetSpeed()
j3 23:e8e403d61359 230 *
j3 23:e8e403d61359 231 * @details Set the 1-Wire Net communication speed.
j3 23:e8e403d61359 232 *
j3 23:e8e403d61359 233 * On Entry:
j3 23:e8e403d61359 234 * @param[in] 'new_speed' - new speed defined as
j3 23:e8e403d61359 235 * MODE_STANDARD 0x00
j3 23:e8e403d61359 236 * MODE_OVERDRIVE 0x01
j3 23:e8e403d61359 237 *
j3 23:e8e403d61359 238 * On Exit:
j3 23:e8e403d61359 239 *
j3 23:e8e403d61359 240 **************************************************************/
IanBenzMaxim 32:bce180b544ed 241 virtual CmdResult OWSetSpeed(OWSpeed new_speed) = 0;
IanBenzMaxim 32:bce180b544ed 242
j3 15:f6cb0d906fb6 243
j3 23:e8e403d61359 244 /**********************************************************//**
IanBenzMaxim 32:bce180b544ed 245 * @brief OWSetLevel()
j3 23:e8e403d61359 246 *
j3 23:e8e403d61359 247 * @details Set the 1-Wire Net line level pull-up to normal. The
j3 23:e8e403d61359 248 * ds2484 does only allows enabling strong pull-up on a
j3 23:e8e403d61359 249 * bit or byte event. Consequently this function only
j3 23:e8e403d61359 250 * allows the MODE_STANDARD argument. To enable strong
j3 23:e8e403d61359 251 * pull-up use OWWriteBytePower or OWReadBitPower.
j3 23:e8e403d61359 252 *
j3 23:e8e403d61359 253 * On Entry:
j3 23:e8e403d61359 254 * @param[in] 'new_level' - new level defined as
j3 23:e8e403d61359 255 * MODE_STANDARD 0x00
j3 23:e8e403d61359 256 *
j3 23:e8e403d61359 257 * On Exit:
j3 23:e8e403d61359 258 *
j3 23:e8e403d61359 259 **************************************************************/
IanBenzMaxim 32:bce180b544ed 260 virtual CmdResult OWSetLevel(OWLevel new_level) = 0;
IanBenzMaxim 32:bce180b544ed 261
IanBenzMaxim 32:bce180b544ed 262
IanBenzMaxim 47:307dc45952db 263 /**********************************************************//**
IanBenzMaxim 47:307dc45952db 264 * @brief OWTriplet()
IanBenzMaxim 47:307dc45952db 265 *
IanBenzMaxim 47:307dc45952db 266 * @details Perform one bit of a 1-Wire search. This command
IanBenzMaxim 47:307dc45952db 267 * does two read bits and one write bit. The write bit is either
IanBenzMaxim 47:307dc45952db 268 * the default direction (all device have same bit) or in case
IanBenzMaxim 47:307dc45952db 269 * of a discrepancy, the 'search_direction' parameter is used.
IanBenzMaxim 47:307dc45952db 270 *
IanBenzMaxim 47:307dc45952db 271 * @param[in,out] search_direction
IanBenzMaxim 47:307dc45952db 272 * Input with desired direction in case both read bits are zero.
IanBenzMaxim 47:307dc45952db 273 * Output with direction taken based on read bits.
IanBenzMaxim 47:307dc45952db 274 *
IanBenzMaxim 47:307dc45952db 275 * @param[out] sbr Bit result of first read operation.
IanBenzMaxim 47:307dc45952db 276 * @param[out] tsb Bit result of second read operation.
IanBenzMaxim 47:307dc45952db 277 **************************************************************/
IanBenzMaxim 32:bce180b544ed 278 virtual CmdResult OWTriplet(SearchDirection & search_direction, std::uint8_t & sbr, std::uint8_t & tsb);
IanBenzMaxim 32:bce180b544ed 279
IanBenzMaxim 48:6f9208ae280e 280 /// OWWriteBit()
IanBenzMaxim 48:6f9208ae280e 281 CmdResult OWWriteBit(std::uint8_t sendbit, OWLevel after_level) { return OWTouchBit(sendbit, after_level); }
IanBenzMaxim 32:bce180b544ed 282
IanBenzMaxim 48:6f9208ae280e 283 /// OWReadBit()
IanBenzMaxim 32:bce180b544ed 284 CmdResult OWReadBit(std::uint8_t & recvbit, OWLevel after_level) { recvbit = 0x01; return OWTouchBit(recvbit, after_level); }
j3 23:e8e403d61359 285
IanBenzMaxim 48:6f9208ae280e 286 // Alternate forms of read and write functions
IanBenzMaxim 27:d5aaefa252f1 287 CmdResult OWWriteBit(std::uint8_t sendbit) { return OWWriteBit(sendbit, LEVEL_NORMAL); }
IanBenzMaxim 27:d5aaefa252f1 288 CmdResult OWReadBit(std::uint8_t & recvbit) { return OWReadBit(recvbit, LEVEL_NORMAL); }
IanBenzMaxim 27:d5aaefa252f1 289 CmdResult OWWriteBitPower(std::uint8_t sendbit) { return OWWriteBit(sendbit, LEVEL_STRONG); }
IanBenzMaxim 27:d5aaefa252f1 290 CmdResult OWReadBitPower(std::uint8_t & recvbit) { return OWReadBit(recvbit, LEVEL_STRONG); }
IanBenzMaxim 27:d5aaefa252f1 291 CmdResult OWWriteByte(std::uint8_t sendbyte) { return OWWriteByte(sendbyte, LEVEL_NORMAL); }
IanBenzMaxim 27:d5aaefa252f1 292 CmdResult OWReadByte(std::uint8_t & recvbyte) { return OWReadByte(recvbyte, LEVEL_NORMAL); }
IanBenzMaxim 27:d5aaefa252f1 293 CmdResult OWWriteBytePower(std::uint8_t sendbyte) { return OWWriteByte(sendbyte, LEVEL_STRONG); }
IanBenzMaxim 27:d5aaefa252f1 294 CmdResult OWReadBytePower(std::uint8_t & recvbyte) { return OWReadByte(recvbyte, LEVEL_STRONG); }
j3 23:e8e403d61359 295
j3 23:e8e403d61359 296 /**********************************************************//**
j3 23:e8e403d61359 297 * @brief OWFirst()
j3 23:e8e403d61359 298 *
j3 23:e8e403d61359 299 * @details Find the 'first' devices on the 1-Wire network
j3 23:e8e403d61359 300 *
j3 23:e8e403d61359 301 * On Entry:
j3 23:e8e403d61359 302 *
j3 23:e8e403d61359 303 * On Exit:
j3 23:e8e403d61359 304 *
j3 23:e8e403d61359 305 **************************************************************/
IanBenzMaxim 32:bce180b544ed 306 CmdResult OWFirst(SearchState & searchState);
j3 23:e8e403d61359 307
j3 23:e8e403d61359 308 /**********************************************************//**
j3 23:e8e403d61359 309 * @brief OWNext()
j3 23:e8e403d61359 310 *
j3 23:e8e403d61359 311 * @details Find the 'next' devices on the 1-Wire network
j3 23:e8e403d61359 312 *
j3 23:e8e403d61359 313 * On Entry:
j3 23:e8e403d61359 314 *
j3 23:e8e403d61359 315 * On Exit:
j3 23:e8e403d61359 316 *
j3 23:e8e403d61359 317 **************************************************************/
IanBenzMaxim 32:bce180b544ed 318 CmdResult OWNext(SearchState & searchState);
j3 23:e8e403d61359 319
j3 23:e8e403d61359 320 /**********************************************************//**
j3 23:e8e403d61359 321 * @brief OWVerify()
j3 23:e8e403d61359 322 *
j3 23:e8e403d61359 323 * @details Verify the device with the ROM number in ROM_NO buffer
j3 23:e8e403d61359 324 * is present.
j3 23:e8e403d61359 325 *
j3 23:e8e403d61359 326 * On Entry:
j3 23:e8e403d61359 327 *
j3 23:e8e403d61359 328 * On Exit:
j3 23:e8e403d61359 329 *
j3 23:e8e403d61359 330 **************************************************************/
IanBenzMaxim 24:8942d8478d68 331 CmdResult OWVerify(const RomId & romId);
j3 23:e8e403d61359 332
j3 23:e8e403d61359 333 /**********************************************************//**
j3 23:e8e403d61359 334 * @brief OWTargetSetup()
j3 23:e8e403d61359 335 *
j3 23:e8e403d61359 336 * @details Setup the search to find the device type 'family_code'
j3 23:e8e403d61359 337 * on the next call to OWNext() if it is present.
j3 23:e8e403d61359 338 *
j3 23:e8e403d61359 339 * On Entry:
j3 23:e8e403d61359 340 * @param[in] family_code - family code of device
j3 23:e8e403d61359 341 *
j3 23:e8e403d61359 342 * On Exit:
j3 23:e8e403d61359 343 *
j3 23:e8e403d61359 344 **************************************************************/
IanBenzMaxim 32:bce180b544ed 345 void OWTargetSetup(SearchState & searchState);
j3 23:e8e403d61359 346
j3 23:e8e403d61359 347 /**********************************************************//**
j3 23:e8e403d61359 348 * @brief OWFamilySkipSetup()
j3 23:e8e403d61359 349 *
j3 23:e8e403d61359 350 * @details Setup the search to skip the current device type on the
j3 23:e8e403d61359 351 * next call to OWNext().
j3 23:e8e403d61359 352 *
j3 23:e8e403d61359 353 * On Entry:
j3 23:e8e403d61359 354 *
j3 23:e8e403d61359 355 * On Exit:
j3 23:e8e403d61359 356 *
j3 23:e8e403d61359 357 **************************************************************/
IanBenzMaxim 32:bce180b544ed 358 void OWFamilySkipSetup(SearchState & searchState);
j3 15:f6cb0d906fb6 359
j3 23:e8e403d61359 360 /**********************************************************//**
j3 23:e8e403d61359 361 * @brief OWReadROM()
j3 23:e8e403d61359 362 *
j3 23:e8e403d61359 363 * @details Only use this command with a single drop bus, data
j3 23:e8e403d61359 364 * collisions will occur if more than 1 device on bus.
j3 23:e8e403d61359 365 * Issues READ_ROM command, slave device will respond with ROM ID.
j3 23:e8e403d61359 366 *
j3 23:e8e403d61359 367 * On Entry:
j3 23:e8e403d61359 368 *
j3 23:e8e403d61359 369 * On Exit:
j3 23:e8e403d61359 370 *
j3 23:e8e403d61359 371 **************************************************************/
IanBenzMaxim 24:8942d8478d68 372 CmdResult OWReadROM(RomId & romId);
j3 23:e8e403d61359 373
j3 23:e8e403d61359 374 /**********************************************************//**
j3 23:e8e403d61359 375 * @brief OWSkipROM()
j3 23:e8e403d61359 376 *
j3 23:e8e403d61359 377 * @details Issue SKIP_ROM command on 1-wire bus
j3 23:e8e403d61359 378 *
j3 23:e8e403d61359 379 * On Entry:
j3 23:e8e403d61359 380 *
j3 23:e8e403d61359 381 * On Exit:
j3 23:e8e403d61359 382 *
j3 23:e8e403d61359 383 **************************************************************/
IanBenzMaxim 24:8942d8478d68 384 CmdResult OWSkipROM(void);
j3 23:e8e403d61359 385
j3 23:e8e403d61359 386 /**********************************************************//**
j3 23:e8e403d61359 387 * @brief OWMatchROM()
j3 23:e8e403d61359 388 *
j3 23:e8e403d61359 389 * @details Issues MATCH_ROM command on 1-wire bus and then sends
j3 23:e8e403d61359 390 * the rom id in _rom_number
j3 23:e8e403d61359 391 *
j3 23:e8e403d61359 392 * On Entry:
j3 23:e8e403d61359 393 *
j3 23:e8e403d61359 394 * On Exit:
j3 23:e8e403d61359 395 *
j3 23:e8e403d61359 396 **************************************************************/
IanBenzMaxim 24:8942d8478d68 397 CmdResult OWMatchROM(const RomId & romId);
j3 23:e8e403d61359 398
j3 23:e8e403d61359 399 /**********************************************************//**
j3 23:e8e403d61359 400 * @brief OWOverdriveSkipROM()
j3 23:e8e403d61359 401 *
j3 23:e8e403d61359 402 * @details Issues OVERDRIVE_SKIP rom command. DS248X OW speed
j3 23:e8e403d61359 403 * is set to SPEED_OVERDRIVE
j3 23:e8e403d61359 404 *
j3 23:e8e403d61359 405 * On Entry:
j3 23:e8e403d61359 406 *
j3 23:e8e403d61359 407 * On Exit:
j3 23:e8e403d61359 408 *
j3 23:e8e403d61359 409 **************************************************************/
IanBenzMaxim 24:8942d8478d68 410 CmdResult OWOverdriveSkipROM(void);
j3 15:f6cb0d906fb6 411
j3 23:e8e403d61359 412 /**********************************************************//**
j3 23:e8e403d61359 413 * @brief OWOverdriveMatchROM()
j3 23:e8e403d61359 414 *
j3 23:e8e403d61359 415 * @details Issues OVERDRIVE_MATCH rom command. DS248X OW speed
j3 23:e8e403d61359 416 * is set to SPEED_OVERDRIVE
j3 23:e8e403d61359 417 *
j3 23:e8e403d61359 418 * On Entry:
j3 23:e8e403d61359 419 *
j3 23:e8e403d61359 420 * On Exit:
j3 23:e8e403d61359 421 *
j3 23:e8e403d61359 422 **************************************************************/
IanBenzMaxim 24:8942d8478d68 423 CmdResult OWOverdriveMatchROM(const RomId & romId);
j3 23:e8e403d61359 424
j3 23:e8e403d61359 425 /**********************************************************//**
j3 23:e8e403d61359 426 * @brief OWResume()
j3 23:e8e403d61359 427 *
j3 23:e8e403d61359 428 * @details Issues RESUME command, very usefull. Is like skip
j3 23:e8e403d61359 429 * on a multidrop bus, however you must first select the device
j3 23:e8e403d61359 430 * you want to interface with using a MATCH, or SEARCH. The
j3 23:e8e403d61359 431 * device stays selected until another device is selected,
j3 23:e8e403d61359 432 * see slave datasheet for detailed explanation.
j3 23:e8e403d61359 433 *
j3 23:e8e403d61359 434 * On Entry:
j3 23:e8e403d61359 435 *
j3 23:e8e403d61359 436 * On Exit:
j3 23:e8e403d61359 437 *
j3 23:e8e403d61359 438 **************************************************************/
IanBenzMaxim 24:8942d8478d68 439 CmdResult OWResume(void);
IanBenzMaxim 21:00c94aeb533e 440
IanBenzMaxim 32:bce180b544ed 441 /**********************************************************//**
IanBenzMaxim 32:bce180b544ed 442 * @brief OWSearch()
IanBenzMaxim 32:bce180b544ed 443 *
IanBenzMaxim 32:bce180b544ed 444 * @details The 'OWSearch' function does a general search. This
IanBenzMaxim 32:bce180b544ed 445 * function continues from the previous search state. The
IanBenzMaxim 32:bce180b544ed 446 * search state can be reset by using the 'OWFirst'
IanBenzMaxim 32:bce180b544ed 447 * function. This function contains one parameter
IanBenzMaxim 32:bce180b544ed 448 * 'alarm_only'. When 'alarm_only' is TRUE (1) the find
IanBenzMaxim 32:bce180b544ed 449 * alarm command 0xEC is sent instead of the normal search
IanBenzMaxim 32:bce180b544ed 450 * command 0xF0. Using the find alarm command 0xEC will
IanBenzMaxim 32:bce180b544ed 451 * limit the search to only 1-Wire devices that are in an
IanBenzMaxim 32:bce180b544ed 452 * 'alarm' state.
IanBenzMaxim 32:bce180b544ed 453 *
IanBenzMaxim 32:bce180b544ed 454 * On Entry:
IanBenzMaxim 32:bce180b544ed 455 *
IanBenzMaxim 32:bce180b544ed 456 * On Exit:
IanBenzMaxim 32:bce180b544ed 457 *
IanBenzMaxim 32:bce180b544ed 458 **************************************************************/
IanBenzMaxim 32:bce180b544ed 459 CmdResult OWSearch(SearchState & searchState);
j3 15:f6cb0d906fb6 460 };
j3 15:f6cb0d906fb6 461
IanBenzMaxim 47:307dc45952db 462 #endif /*ONEWIREMASTER_H*/