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@34:11fffbe98ef9, 2016-04-01 (annotated)

Committer:
IanBenzMaxim
Date:
Fri Apr 01 09:29:55 2016 -0500
Revision:
34:11fffbe98ef9
Parent:
33:a4c015046956
Child:
35:5d23395628f6
Continue code cleanup of DS2465 and DS28E15_22_25.

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 27:d5aaefa252f1 7 namespace mbed
IanBenzMaxim 27:d5aaefa252f1 8 {
IanBenzMaxim 27:d5aaefa252f1 9 class I2C;
IanBenzMaxim 27:d5aaefa252f1 10 }
IanBenzMaxim 27:d5aaefa252f1 11
IanBenzMaxim 21:00c94aeb533e 12 class DS2465 : public OneWireMaster, public ISha256MacCoprocessor
IanBenzMaxim 21:00c94aeb533e 13 {
IanBenzMaxim 32:bce180b544ed 14 public:
IanBenzMaxim 21:00c94aeb533e 15 enum PageRegion
IanBenzMaxim 21:00c94aeb533e 16 {
IanBenzMaxim 21:00c94aeb533e 17 REGION_FULL_PAGE = 0x03,
IanBenzMaxim 21:00c94aeb533e 18 REGION_FIRST_HALF = 0x01,
IanBenzMaxim 21:00c94aeb533e 19 REGION_SECOND_HALF = 0x02
IanBenzMaxim 21:00c94aeb533e 20 };
IanBenzMaxim 21:00c94aeb533e 21
IanBenzMaxim 21:00c94aeb533e 22 enum MemoryAddr
IanBenzMaxim 21:00c94aeb533e 23 {
IanBenzMaxim 21:00c94aeb533e 24 ADDR_SPAD = 0x00,
IanBenzMaxim 21:00c94aeb533e 25 ADDR_CMD_REG = 0x60,
IanBenzMaxim 21:00c94aeb533e 26 ADDR_STATUS_REG = 0x61,
IanBenzMaxim 21:00c94aeb533e 27 ADDR_DATA_REG = 0x62,
IanBenzMaxim 21:00c94aeb533e 28 ADDR_MAC_READ = 0x63,
IanBenzMaxim 21:00c94aeb533e 29 ADDR_SHA_SELECT_REG = 0x66,
IanBenzMaxim 21:00c94aeb533e 30 ADDR_WCFG_REG = 0x67,
IanBenzMaxim 24:8942d8478d68 31 ADDR_TRSTL_REG = 0x68,
IanBenzMaxim 24:8942d8478d68 32 ADDR_TMSP_REG = 0x69,
IanBenzMaxim 24:8942d8478d68 33 ADDR_TW0L_REG = 0x6A,
IanBenzMaxim 24:8942d8478d68 34 ADDR_TREC0_REG = 0x6B,
IanBenzMaxim 24:8942d8478d68 35 ADDR_RWPU_REG = 0x6C,
IanBenzMaxim 24:8942d8478d68 36 ADDR_TW1L_REG = 0x6D,
IanBenzMaxim 21:00c94aeb533e 37 ADDR_USER_MEM_PAGE_0 = 0x80,
IanBenzMaxim 21:00c94aeb533e 38 ADDR_USER_MEM_PAGE_1 = 0xA0
IanBenzMaxim 21:00c94aeb533e 39 };
IanBenzMaxim 21:00c94aeb533e 40
IanBenzMaxim 32:bce180b544ed 41 struct Config
IanBenzMaxim 32:bce180b544ed 42 {
IanBenzMaxim 32:bce180b544ed 43 bool c1WS, cSPU, cPDN, cAPU;
IanBenzMaxim 32:bce180b544ed 44
IanBenzMaxim 32:bce180b544ed 45 std::uint8_t readByte() const;
IanBenzMaxim 32:bce180b544ed 46 std::uint8_t writeByte() const;
IanBenzMaxim 32:bce180b544ed 47
IanBenzMaxim 32:bce180b544ed 48 void reset();
IanBenzMaxim 32:bce180b544ed 49 Config() { reset(); }
IanBenzMaxim 32:bce180b544ed 50 };
IanBenzMaxim 32:bce180b544ed 51
IanBenzMaxim 27:d5aaefa252f1 52 DS2465(mbed::I2C & I2C_interface, std::uint8_t I2C_address);
IanBenzMaxim 21:00c94aeb533e 53
IanBenzMaxim 21:00c94aeb533e 54 // Const member functions should not change the settings of the DS2465 or affect the state of the 1-Wire bus.
IanBenzMaxim 21:00c94aeb533e 55 // Read pointer, scratchpad, MAC output register, and command register on the DS2465 are considered mutable.
IanBenzMaxim 21:00c94aeb533e 56
IanBenzMaxim 21:00c94aeb533e 57 //Misc. Functions
IanBenzMaxim 34:11fffbe98ef9 58 OneWireMaster::CmdResult detect();
IanBenzMaxim 34:11fffbe98ef9 59 OneWireMaster::CmdResult reset(void); // Resets DS2465 (NOTE: This is NOT a 1-Wire Reset)
IanBenzMaxim 34:11fffbe98ef9 60 OneWireMaster::CmdResult writeConfig(const Config & config, bool verify);
IanBenzMaxim 34:11fffbe98ef9 61 Config currentConfig() const;
IanBenzMaxim 21:00c94aeb533e 62
IanBenzMaxim 21:00c94aeb533e 63 // DS2465 Memory Commands
IanBenzMaxim 34:11fffbe98ef9 64 OneWireMaster::CmdResult readMemory(std::uint8_t addr, std::uint8_t * buf, std::size_t bufLen, bool skipSetPointer = false) const;
IanBenzMaxim 34:11fffbe98ef9 65 OneWireMaster::CmdResult writeMemory(std::uint8_t addr, const std::uint8_t * buf, std::size_t bufLen) { return cWriteMemory(addr, buf, bufLen); }
IanBenzMaxim 34:11fffbe98ef9 66 OneWireMaster::CmdResult writeScratchpad(const std::uint8_t * buf, std::size_t bufLen) const { return cWriteMemory(ADDR_SPAD, buf, bufLen); }
IanBenzMaxim 34:11fffbe98ef9 67 OneWireMaster::CmdResult copyScratchpad(bool destSecret, unsigned int pageNum, bool notFull, unsigned int segmentNum);
IanBenzMaxim 21:00c94aeb533e 68
IanBenzMaxim 21:00c94aeb533e 69 // 1-Wire Master Commands
IanBenzMaxim 21:00c94aeb533e 70 virtual OneWireMaster::CmdResult OWInitMaster(void);
IanBenzMaxim 21:00c94aeb533e 71 virtual OneWireMaster::CmdResult OWReset(void); // Issues a 1-Wire Reset Pulse
IanBenzMaxim 32:bce180b544ed 72 virtual OneWireMaster::CmdResult OWTouchBit(std::uint8_t & sendrecvbit, OWLevel after_level);
IanBenzMaxim 32:bce180b544ed 73 virtual OneWireMaster::CmdResult OWReadByte(std::uint8_t & recvbyte, OWLevel after_level);
IanBenzMaxim 32:bce180b544ed 74 virtual OneWireMaster::CmdResult OWWriteByte(std::uint8_t sendbyte, OWLevel after_level);
IanBenzMaxim 27:d5aaefa252f1 75 virtual OneWireMaster::CmdResult OWReadBlock(std::uint8_t *rx_buf, std::uint8_t rx_len);
IanBenzMaxim 27:d5aaefa252f1 76 virtual OneWireMaster::CmdResult OWWriteBlock(const std::uint8_t *tran_buf, std::uint8_t tran_len);
IanBenzMaxim 27:d5aaefa252f1 77 OneWireMaster::CmdResult OWWriteBlock(bool tx_mac, const std::uint8_t *tran_buf, std::uint8_t tran_len);
IanBenzMaxim 32:bce180b544ed 78 virtual OneWireMaster::CmdResult OWSetSpeed(OWSpeed new_speed);
IanBenzMaxim 32:bce180b544ed 79 virtual OneWireMaster::CmdResult OWSetLevel(OWLevel new_level);
IanBenzMaxim 24:8942d8478d68 80
IanBenzMaxim 32:bce180b544ed 81 virtual OneWireMaster::CmdResult OWTriplet(SearchDirection & search_direction, std::uint8_t & sbr, std::uint8_t & tsb);
IanBenzMaxim 21:00c94aeb533e 82
IanBenzMaxim 21:00c94aeb533e 83 //DS2465 Coprocessor Commands
IanBenzMaxim 33:a4c015046956 84 OneWireMaster::CmdResult computeNextMasterSecret(bool swap, unsigned int pageNum, PageRegion region);
IanBenzMaxim 33:a4c015046956 85 OneWireMaster::CmdResult computeWriteMac(bool regwrite, bool swap, unsigned int pageNum, unsigned int segmentNum) const;
IanBenzMaxim 33:a4c015046956 86 OneWireMaster::CmdResult computeSlaveSecret(bool swap, unsigned int pageNum, PageRegion region);
IanBenzMaxim 33:a4c015046956 87 OneWireMaster::CmdResult computeAuthMac(bool swap, unsigned int pageNum, PageRegion region) const;
IanBenzMaxim 21:00c94aeb533e 88
IanBenzMaxim 33:a4c015046956 89 // ISha256MacCoprocessor Commands
IanBenzMaxim 33:a4c015046956 90 virtual ISha256MacCoprocessor::CmdResult setMasterSecret(const Secret & secret);
IanBenzMaxim 33:a4c015046956 91 virtual ISha256MacCoprocessor::CmdResult computeWriteMac(const WriteMacData & writeMacData, Mac & mac) const;
IanBenzMaxim 33:a4c015046956 92 virtual ISha256MacCoprocessor::CmdResult computeAuthMac(const DevicePage & devicePage, const DeviceScratchpad & challenge, const AuthMacData & authMacData, Mac & mac) const;
IanBenzMaxim 33:a4c015046956 93 virtual ISha256MacCoprocessor::CmdResult computeSlaveSecret(const DevicePage & devicePage, const DeviceScratchpad & deviceScratchpad, const SlaveSecretData & slaveSecretData);
IanBenzMaxim 21:00c94aeb533e 94
IanBenzMaxim 21:00c94aeb533e 95 private:
IanBenzMaxim 34:11fffbe98ef9 96 static const unsigned int eepromWriteDelayMs = 10;
IanBenzMaxim 34:11fffbe98ef9 97 static const unsigned int shaComputationDelayMs = 2;
IanBenzMaxim 21:00c94aeb533e 98
IanBenzMaxim 27:d5aaefa252f1 99 mbed::I2C & m_I2C_interface;
IanBenzMaxim 21:00c94aeb533e 100 std::uint8_t m_I2C_address;
IanBenzMaxim 24:8942d8478d68 101 Config m_curConfig;
IanBenzMaxim 21:00c94aeb533e 102
IanBenzMaxim 34:11fffbe98ef9 103 OneWireMaster::CmdResult cWriteMemory(std::uint8_t addr, const std::uint8_t * buf, std::size_t bufLen) const;
IanBenzMaxim 34:11fffbe98ef9 104 OneWireMaster::CmdResult pollBusy(std::uint8_t * pStatus = NULL);
IanBenzMaxim 34:11fffbe98ef9 105 OneWireMaster::CmdResult configureLevel(OWLevel level);
IanBenzMaxim 21:00c94aeb533e 106 };
IanBenzMaxim 21:00c94aeb533e 107
IanBenzMaxim 21:00c94aeb533e 108 #endif