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/DS2465/DS2465.hpp@72:6892702709ee, 2016-05-09 (annotated)

Committer:
IanBenzMaxim
Date:
Mon May 09 16:20:56 2016 -0500
Revision:
72:6892702709ee
Parent:
71:562f5c702094 
Use distinct names to prevent hiding of overloads in derived classes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 21:00c94aeb533e 1 #ifndef DS2465_H
IanBenzMaxim 21:00c94aeb533e 2 #define DS2465_H
IanBenzMaxim 21:00c94aeb533e 3
IanBenzMaxim 21:00c94aeb533e 4 #include "OneWire_Masters/OneWireMaster.h"
IanBenzMaxim 21:00c94aeb533e 5 #include "OneWire_Masters/ISha256MacCoprocessor.hpp"
IanBenzMaxim 21:00c94aeb533e 6
IanBenzMaxim 47:307dc45952db 7 namespace mbed { class I2C; }
IanBenzMaxim 27:d5aaefa252f1 8
IanBenzMaxim 49:36954b62f503 9 /// Interface to the DS2465 1-Wire master and SHA-256 coprocessor.
IanBenzMaxim 21:00c94aeb533e 10 class DS2465 : public OneWireMaster, public ISha256MacCoprocessor
IanBenzMaxim 21:00c94aeb533e 11 {
IanBenzMaxim 32:bce180b544ed 12 public:
IanBenzMaxim 47:307dc45952db 13 /// Delay required after writing an EEPROM segment.
IanBenzMaxim 47:307dc45952db 14 static const unsigned int eepromSegmentWriteDelayMs = 10;
IanBenzMaxim 47:307dc45952db 15 /// Delay required after writing an EEPROM page such as the secret memory.
IanBenzMaxim 47:307dc45952db 16 static const unsigned int eepromPageWriteDelayMs = 8 * eepromSegmentWriteDelayMs;
IanBenzMaxim 47:307dc45952db 17 /// Delay required for a SHA computation to complete.
IanBenzMaxim 47:307dc45952db 18 static const unsigned int shaComputationDelayMs = 2;
IanBenzMaxim 47:307dc45952db 19
IanBenzMaxim 47:307dc45952db 20 /// Page region to use for swapping.
IanBenzMaxim 21:00c94aeb533e 21 enum PageRegion
IanBenzMaxim 21:00c94aeb533e 22 {
IanBenzMaxim 21:00c94aeb533e 23 REGION_FULL_PAGE = 0x03,
IanBenzMaxim 21:00c94aeb533e 24 REGION_FIRST_HALF = 0x01,
IanBenzMaxim 21:00c94aeb533e 25 REGION_SECOND_HALF = 0x02
IanBenzMaxim 21:00c94aeb533e 26 };
IanBenzMaxim 21:00c94aeb533e 27
IanBenzMaxim 47:307dc45952db 28 /// Starting memory addresses.
IanBenzMaxim 21:00c94aeb533e 29 enum MemoryAddr
IanBenzMaxim 21:00c94aeb533e 30 {
IanBenzMaxim 21:00c94aeb533e 31 ADDR_SPAD = 0x00,
IanBenzMaxim 21:00c94aeb533e 32 ADDR_CMD_REG = 0x60,
IanBenzMaxim 21:00c94aeb533e 33 ADDR_STATUS_REG = 0x61,
IanBenzMaxim 21:00c94aeb533e 34 ADDR_DATA_REG = 0x62,
IanBenzMaxim 21:00c94aeb533e 35 ADDR_MAC_READ = 0x63,
IanBenzMaxim 21:00c94aeb533e 36 ADDR_SHA_SELECT_REG = 0x66,
IanBenzMaxim 21:00c94aeb533e 37 ADDR_WCFG_REG = 0x67,
IanBenzMaxim 24:8942d8478d68 38 ADDR_TRSTL_REG = 0x68,
IanBenzMaxim 24:8942d8478d68 39 ADDR_TMSP_REG = 0x69,
IanBenzMaxim 24:8942d8478d68 40 ADDR_TW0L_REG = 0x6A,
IanBenzMaxim 24:8942d8478d68 41 ADDR_TREC0_REG = 0x6B,
IanBenzMaxim 24:8942d8478d68 42 ADDR_RWPU_REG = 0x6C,
IanBenzMaxim 24:8942d8478d68 43 ADDR_TW1L_REG = 0x6D,
IanBenzMaxim 21:00c94aeb533e 44 ADDR_USER_MEM_PAGE_0 = 0x80,
IanBenzMaxim 21:00c94aeb533e 45 ADDR_USER_MEM_PAGE_1 = 0xA0
IanBenzMaxim 21:00c94aeb533e 46 };
IanBenzMaxim 21:00c94aeb533e 47
IanBenzMaxim 47:307dc45952db 48 /// Represents a DS2465 configuration.
IanBenzMaxim 69:f915c4c59a69 49 class Config
IanBenzMaxim 69:f915c4c59a69 50 {
IanBenzMaxim 69:f915c4c59a69 51 public:
IanBenzMaxim 69:f915c4c59a69 52 /// @{
IanBenzMaxim 69:f915c4c59a69 53 /// 1-Wire Speed
IanBenzMaxim 71:562f5c702094 54 bool get1WS() const { return m_1WS; }
IanBenzMaxim 71:562f5c702094 55 void set1WS(bool new1WS) { m_1WS = new1WS; }
IanBenzMaxim 69:f915c4c59a69 56 /// @}
IanBenzMaxim 32:bce180b544ed 57
IanBenzMaxim 69:f915c4c59a69 58 /// @{
IanBenzMaxim 69:f915c4c59a69 59 /// Strong Pullup
IanBenzMaxim 71:562f5c702094 60 bool getSPU() const { return m_SPU; }
IanBenzMaxim 71:562f5c702094 61 void setSPU(bool newSPU) { m_SPU = newSPU; }
IanBenzMaxim 69:f915c4c59a69 62 /// @}
IanBenzMaxim 69:f915c4c59a69 63
IanBenzMaxim 69:f915c4c59a69 64 /// @{
IanBenzMaxim 69:f915c4c59a69 65 /// 1-Wire Power Down
IanBenzMaxim 71:562f5c702094 66 bool getPDN() const { return m_PDN; }
IanBenzMaxim 71:562f5c702094 67 void setPDN(bool newPDN) { m_PDN = newPDN; }
IanBenzMaxim 69:f915c4c59a69 68 /// @}
IanBenzMaxim 69:f915c4c59a69 69
IanBenzMaxim 69:f915c4c59a69 70 /// @{
IanBenzMaxim 69:f915c4c59a69 71 /// Active Pullup
IanBenzMaxim 71:562f5c702094 72 bool getAPU() const { return m_APU; }
IanBenzMaxim 71:562f5c702094 73 void setAPU(bool newAPU) { m_APU = newAPU; }
IanBenzMaxim 69:f915c4c59a69 74 /// @}
IanBenzMaxim 69:f915c4c59a69 75
IanBenzMaxim 47:307dc45952db 76 /// Byte representation that is read from the DS2465.
IanBenzMaxim 32:bce180b544ed 77 std::uint8_t readByte() const;
IanBenzMaxim 47:307dc45952db 78 /// Byte respresentation that is written to the DS2465.
IanBenzMaxim 32:bce180b544ed 79 std::uint8_t writeByte() const;
IanBenzMaxim 32:bce180b544ed 80
IanBenzMaxim 47:307dc45952db 81 /// Reset to the power-on default config.
IanBenzMaxim 32:bce180b544ed 82 void reset();
IanBenzMaxim 32:bce180b544ed 83 Config() { reset(); }
IanBenzMaxim 69:f915c4c59a69 84
IanBenzMaxim 69:f915c4c59a69 85 private:
IanBenzMaxim 71:562f5c702094 86 bool m_1WS, m_SPU, m_PDN, m_APU;
IanBenzMaxim 32:bce180b544ed 87 };
IanBenzMaxim 32:bce180b544ed 88
IanBenzMaxim 47:307dc45952db 89 /// @param I2C_interface Configured I2C communication interface for DS2465.
IanBenzMaxim 47:307dc45952db 90 /// @param I2C_address I2C bus address of the DS2465 in mbed format.
IanBenzMaxim 27:d5aaefa252f1 91 DS2465(mbed::I2C & I2C_interface, std::uint8_t I2C_address);
IanBenzMaxim 21:00c94aeb533e 92
IanBenzMaxim 21:00c94aeb533e 93 // Const member functions should not change the settings of the DS2465 or affect the state of the 1-Wire bus.
IanBenzMaxim 21:00c94aeb533e 94 // Read pointer, scratchpad, MAC output register, and command register on the DS2465 are considered mutable.
IanBenzMaxim 21:00c94aeb533e 95
IanBenzMaxim 47:307dc45952db 96 /// Performs a soft reset on the DS2465. This is NOT a 1-Wire Reset.
IanBenzMaxim 47:307dc45952db 97 OneWireMaster::CmdResult reset(void);
IanBenzMaxim 47:307dc45952db 98
IanBenzMaxim 47:307dc45952db 99 /// Write a new configuration to the DS2465.
IanBenzMaxim 47:307dc45952db 100 /// @param[in] config New configuration to write.
IanBenzMaxim 47:307dc45952db 101 /// @param verify Verify that the configuration was written successfully.
IanBenzMaxim 34:11fffbe98ef9 102 OneWireMaster::CmdResult writeConfig(const Config & config, bool verify);
IanBenzMaxim 47:307dc45952db 103
IanBenzMaxim 47:307dc45952db 104 /// Read the current DS2465 configuration.
IanBenzMaxim 47:307dc45952db 105 /// @returns The cached current configuration.
IanBenzMaxim 69:f915c4c59a69 106 Config currentConfig() const { return m_curConfig; }
IanBenzMaxim 21:00c94aeb533e 107
IanBenzMaxim 21:00c94aeb533e 108 // DS2465 Memory Commands
IanBenzMaxim 47:307dc45952db 109
IanBenzMaxim 47:307dc45952db 110 /// Read memory from the DS2465
IanBenzMaxim 47:307dc45952db 111 /// @param addr Address to begin reading from.
IanBenzMaxim 47:307dc45952db 112 /// @param[out] buf Buffer to hold read data.
IanBenzMaxim 47:307dc45952db 113 /// @param bufLen Length of buffer, buf, and number of bytes to read.
IanBenzMaxim 47:307dc45952db 114 /// @param skipSetPointer Assume that the read pointer is already set to the correct address.
IanBenzMaxim 34:11fffbe98ef9 115 OneWireMaster::CmdResult readMemory(std::uint8_t addr, std::uint8_t * buf, std::size_t bufLen, bool skipSetPointer = false) const;
IanBenzMaxim 47:307dc45952db 116
IanBenzMaxim 47:307dc45952db 117 /// Write to SRAM memory on the DS2465
IanBenzMaxim 47:307dc45952db 118 /// @param addr Address to begin writing to.
IanBenzMaxim 47:307dc45952db 119 /// @param[in] buf Buffer containing the data to write.
IanBenzMaxim 47:307dc45952db 120 /// @param bufLen Length of buffer, buf, and number of bytes to write.
IanBenzMaxim 34:11fffbe98ef9 121 OneWireMaster::CmdResult writeMemory(std::uint8_t addr, const std::uint8_t * buf, std::size_t bufLen) { return cWriteMemory(addr, buf, bufLen); }
IanBenzMaxim 47:307dc45952db 122
IanBenzMaxim 47:307dc45952db 123 /// Write data to the scratchpad area of the DS2465
IanBenzMaxim 47:307dc45952db 124 /// @param[in] buf Buffer containing the data to write.
IanBenzMaxim 47:307dc45952db 125 /// @param bufLen Length of buffer, buf, and the number of bytes to write.
IanBenzMaxim 34:11fffbe98ef9 126 OneWireMaster::CmdResult writeScratchpad(const std::uint8_t * buf, std::size_t bufLen) const { return cWriteMemory(ADDR_SPAD, buf, bufLen); }
IanBenzMaxim 47:307dc45952db 127
IanBenzMaxim 47:307dc45952db 128 /// Copy the scratchpad contents to an EEPROM memory page.
IanBenzMaxim 47:307dc45952db 129 /// @param pageNum Page number to copy to.
IanBenzMaxim 47:307dc45952db 130 OneWireMaster::CmdResult copyScratchpadToPage(unsigned int pageNum) { return copyScratchpad(false, pageNum, false, 0); }
IanBenzMaxim 47:307dc45952db 131
IanBenzMaxim 47:307dc45952db 132 /// Copy the scratchpad contents to an EEPROM memory segment.
IanBenzMaxim 47:307dc45952db 133 /// @param pageNum Page number to copy to.
IanBenzMaxim 47:307dc45952db 134 /// @param segmentNum Segment number to copy to.
IanBenzMaxim 47:307dc45952db 135 OneWireMaster::CmdResult copyScratchpadToSegment(unsigned int pageNum, unsigned int segmentNum) { return copyScratchpad(false, pageNum, true, segmentNum); }
IanBenzMaxim 47:307dc45952db 136
IanBenzMaxim 47:307dc45952db 137 /// Copy the scratchpad contents to the secret EEPROM memory page.
IanBenzMaxim 47:307dc45952db 138 OneWireMaster::CmdResult copyScratchpadToSecret() { return copyScratchpad(true, 0, false, 0); }
IanBenzMaxim 21:00c94aeb533e 139
IanBenzMaxim 21:00c94aeb533e 140 // 1-Wire Master Commands
IanBenzMaxim 21:00c94aeb533e 141 virtual OneWireMaster::CmdResult OWInitMaster(void);
IanBenzMaxim 47:307dc45952db 142 virtual OneWireMaster::CmdResult OWReset(void);
IanBenzMaxim 72:6892702709ee 143 virtual OneWireMaster::CmdResult OWTouchBitSetLevel(std::uint8_t & sendrecvbit, OWLevel after_level);
IanBenzMaxim 72:6892702709ee 144 virtual OneWireMaster::CmdResult OWReadByteSetLevel(std::uint8_t & recvbyte, OWLevel after_level);
IanBenzMaxim 72:6892702709ee 145 virtual OneWireMaster::CmdResult OWWriteByteSetLevel(std::uint8_t sendbyte, OWLevel after_level);
IanBenzMaxim 27:d5aaefa252f1 146 virtual OneWireMaster::CmdResult OWReadBlock(std::uint8_t *rx_buf, std::uint8_t rx_len);
IanBenzMaxim 27:d5aaefa252f1 147 virtual OneWireMaster::CmdResult OWWriteBlock(const std::uint8_t *tran_buf, std::uint8_t tran_len);
IanBenzMaxim 32:bce180b544ed 148 virtual OneWireMaster::CmdResult OWSetSpeed(OWSpeed new_speed);
IanBenzMaxim 48:6f9208ae280e 149 /// @note The DS2465 only supports enabling strong pullup following a 1-Wire read or write operation.
IanBenzMaxim 48:6f9208ae280e 150 virtual OneWireMaster::CmdResult OWSetLevel(OWLevel new_level);
IanBenzMaxim 32:bce180b544ed 151 virtual OneWireMaster::CmdResult OWTriplet(SearchDirection & search_direction, std::uint8_t & sbr, std::uint8_t & tsb);
IanBenzMaxim 21:00c94aeb533e 152
IanBenzMaxim 47:307dc45952db 153 /// Write the last computed MAC to the 1-Wire bus
IanBenzMaxim 47:307dc45952db 154 OneWireMaster::CmdResult OWWriteBlockMac();
IanBenzMaxim 47:307dc45952db 155
IanBenzMaxim 47:307dc45952db 156 // DS2465 Coprocessor Commands
IanBenzMaxim 47:307dc45952db 157
IanBenzMaxim 47:307dc45952db 158 /// Compute Next Master Secret with scratchpad data.
IanBenzMaxim 47:307dc45952db 159 OneWireMaster::CmdResult computeNextMasterSecret() { return computeNextMasterSecret(false, 0, REGION_FULL_PAGE); }
IanBenzMaxim 47:307dc45952db 160
IanBenzMaxim 47:307dc45952db 161 /// Compute Next Master Secret with page swapping.
IanBenzMaxim 47:307dc45952db 162 /// @param pageNum Page number to swap in.
IanBenzMaxim 47:307dc45952db 163 /// @param region Region of the page to swap in.
IanBenzMaxim 47:307dc45952db 164 OneWireMaster::CmdResult computeNextMasterSecretSwap(unsigned int pageNum, PageRegion region) { return computeNextMasterSecret(true, pageNum, region); }
IanBenzMaxim 47:307dc45952db 165
IanBenzMaxim 47:307dc45952db 166 /// Compute Write MAC with scratchpad data.
IanBenzMaxim 47:307dc45952db 167 /// @param regwrite True if writing to a register or false if regular memory.
IanBenzMaxim 47:307dc45952db 168 OneWireMaster::CmdResult computeWriteMac(bool regwrite) const { return computeWriteMac(regwrite, false, 0, 0); }
IanBenzMaxim 47:307dc45952db 169
IanBenzMaxim 47:307dc45952db 170 /// Compute Write MAC with page swapping.
IanBenzMaxim 47:307dc45952db 171 /// @param regwrite True if writing to a register or false if regular memory.
IanBenzMaxim 47:307dc45952db 172 /// @param pageNum Page number to swap in.
IanBenzMaxim 47:307dc45952db 173 /// @param segmentNum Segment number to swap in.
IanBenzMaxim 47:307dc45952db 174 OneWireMaster::CmdResult computeWriteMacSwap(bool regwrite, unsigned int pageNum, unsigned int segmentNum) const { return computeWriteMac(regwrite, true, pageNum, segmentNum); }
IanBenzMaxim 47:307dc45952db 175
IanBenzMaxim 47:307dc45952db 176 /// Compute Slave Secret (S-Secret) with scratchpad data.
IanBenzMaxim 47:307dc45952db 177 OneWireMaster::CmdResult computeSlaveSecret() { return computeSlaveSecret(false, 0, REGION_FULL_PAGE); }
IanBenzMaxim 47:307dc45952db 178
IanBenzMaxim 47:307dc45952db 179 /// Compute Slave Secret (S-Secret) with page swapping.
IanBenzMaxim 47:307dc45952db 180 /// @param pageNum Page number to swap in.
IanBenzMaxim 47:307dc45952db 181 /// @param region Region of the page to swap in.
IanBenzMaxim 47:307dc45952db 182 OneWireMaster::CmdResult computeSlaveSecretSwap(unsigned int pageNum, PageRegion region) { return computeSlaveSecret(true, pageNum, region); }
IanBenzMaxim 47:307dc45952db 183
IanBenzMaxim 47:307dc45952db 184 /// Compute Authentication MAC with scratchpad data.
IanBenzMaxim 47:307dc45952db 185 OneWireMaster::CmdResult computeAuthMac() const { return computeAuthMac(false, 0, REGION_FULL_PAGE); }
IanBenzMaxim 47:307dc45952db 186
IanBenzMaxim 47:307dc45952db 187 /// Compute Authentication MAC with page swapping.
IanBenzMaxim 47:307dc45952db 188 /// @param pageNum Page number to swap in.
IanBenzMaxim 47:307dc45952db 189 /// @param region Region of the page to swap in.
IanBenzMaxim 47:307dc45952db 190 OneWireMaster::CmdResult computeAuthMacSwap(unsigned int pageNum, PageRegion region) const { return computeAuthMac(true, pageNum, region); }
IanBenzMaxim 21:00c94aeb533e 191
IanBenzMaxim 33:a4c015046956 192 // ISha256MacCoprocessor Commands
IanBenzMaxim 48:6f9208ae280e 193 virtual ISha256MacCoprocessor::CmdResult setMasterSecret(const Secret & masterSecret);
IanBenzMaxim 48:6f9208ae280e 194 virtual ISha256MacCoprocessor::CmdResult computeSlaveSecret(const DevicePage & devicePage, const DeviceScratchpad & deviceScratchpad, const SlaveSecretData & slaveSecretData);
IanBenzMaxim 33:a4c015046956 195 virtual ISha256MacCoprocessor::CmdResult computeWriteMac(const WriteMacData & writeMacData, Mac & mac) const;
IanBenzMaxim 33:a4c015046956 196 virtual ISha256MacCoprocessor::CmdResult computeAuthMac(const DevicePage & devicePage, const DeviceScratchpad & challenge, const AuthMacData & authMacData, Mac & mac) const;
IanBenzMaxim 21:00c94aeb533e 197
IanBenzMaxim 47:307dc45952db 198 private:
IanBenzMaxim 27:d5aaefa252f1 199 mbed::I2C & m_I2C_interface;
IanBenzMaxim 21:00c94aeb533e 200 std::uint8_t m_I2C_address;
IanBenzMaxim 24:8942d8478d68 201 Config m_curConfig;
IanBenzMaxim 21:00c94aeb533e 202
IanBenzMaxim 47:307dc45952db 203 /// Polls the DS2465 status waiting for the 1-Wire Busy bit (1WB) to be cleared.
IanBenzMaxim 47:307dc45952db 204 /// @param[out] pStatus Optionally retrive the status byte when 1WB cleared.
IanBenzMaxim 47:307dc45952db 205 /// @returns Success or TimeoutError if poll limit reached.
IanBenzMaxim 34:11fffbe98ef9 206 OneWireMaster::CmdResult pollBusy(std::uint8_t * pStatus = NULL);
IanBenzMaxim 47:307dc45952db 207
IanBenzMaxim 47:307dc45952db 208 /// Ensure that the desired 1-Wire level is set in the configuration.
IanBenzMaxim 47:307dc45952db 209 /// @param level Desired 1-Wire level.
IanBenzMaxim 34:11fffbe98ef9 210 OneWireMaster::CmdResult configureLevel(OWLevel level);
IanBenzMaxim 47:307dc45952db 211
IanBenzMaxim 47:307dc45952db 212 /// Const version of writeMemory() for internal use.
IanBenzMaxim 47:307dc45952db 213 OneWireMaster::CmdResult cWriteMemory(std::uint8_t addr, const std::uint8_t * buf, std::size_t bufLen) const;
IanBenzMaxim 47:307dc45952db 214
IanBenzMaxim 47:307dc45952db 215 // Legacy implementations
IanBenzMaxim 47:307dc45952db 216 OneWireMaster::CmdResult OWWriteBlock(bool tx_mac, const std::uint8_t *tran_buf, std::uint8_t tran_len);
IanBenzMaxim 47:307dc45952db 217 OneWireMaster::CmdResult copyScratchpad(bool destSecret, unsigned int pageNum, bool notFull, unsigned int segmentNum);
IanBenzMaxim 47:307dc45952db 218 OneWireMaster::CmdResult computeNextMasterSecret(bool swap, unsigned int pageNum, PageRegion region);
IanBenzMaxim 47:307dc45952db 219 OneWireMaster::CmdResult computeWriteMac(bool regwrite, bool swap, unsigned int pageNum, unsigned int segmentNum) const;
IanBenzMaxim 47:307dc45952db 220 OneWireMaster::CmdResult computeSlaveSecret(bool swap, unsigned int pageNum, PageRegion region);
IanBenzMaxim 47:307dc45952db 221 OneWireMaster::CmdResult computeAuthMac(bool swap, unsigned int pageNum, PageRegion region) const;
IanBenzMaxim 21:00c94aeb533e 222 };
IanBenzMaxim 21:00c94aeb533e 223
IanBenzMaxim 21:00c94aeb533e 224 #endif