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.

Masters/DS2465/DS2465.h@74:23be10c32fa3, 2016-05-13 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 13 07:48:35 2016 -0500
Revision:
74:23be10c32fa3
Parent:
73:2cecc1372acc
Child:
75:8b627804927c
Assimilated indentation and braces.

Who changed what in which revision?

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