Mike Fruge / OneWire

Implementation of 1-Wire with added Alarm Search Functionality

Dependents:   Max32630_One_Wire_Interface

OneWire_Masters/DS2465/DS2465.hpp@26:a361e3f42ba5, 2016-03-23 (annotated)

Committer:
IanBenzMaxim
Date:
Wed Mar 23 15:25:40 2016 -0500
Revision:
26:a361e3f42ba5
Parent:
24:8942d8478d68
Child:
27:d5aaefa252f1
Rework the OneWireMaster virtual interface for simplicity.

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 "mbed.h"
IanBenzMaxim 21:00c94aeb533e 5 #include "OneWire_Masters/OneWireMaster.h"
IanBenzMaxim 21:00c94aeb533e 6 #include "OneWire_Masters/ISha256MacCoprocessor.hpp"
IanBenzMaxim 21:00c94aeb533e 7
IanBenzMaxim 21:00c94aeb533e 8 class DS2465 : public OneWireMaster, public ISha256MacCoprocessor
IanBenzMaxim 21:00c94aeb533e 9 {
IanBenzMaxim 21:00c94aeb533e 10 public:
IanBenzMaxim 21:00c94aeb533e 11 enum Direction
IanBenzMaxim 21:00c94aeb533e 12 {
IanBenzMaxim 21:00c94aeb533e 13 DIRECTION_WRITE_ZERO = 0,
IanBenzMaxim 21:00c94aeb533e 14 DIRECTION_WRITE_ONE = 1
IanBenzMaxim 21:00c94aeb533e 15 };
IanBenzMaxim 21:00c94aeb533e 16
IanBenzMaxim 21:00c94aeb533e 17 enum PageRegion
IanBenzMaxim 21:00c94aeb533e 18 {
IanBenzMaxim 21:00c94aeb533e 19 REGION_FULL_PAGE = 0x03,
IanBenzMaxim 21:00c94aeb533e 20 REGION_FIRST_HALF = 0x01,
IanBenzMaxim 21:00c94aeb533e 21 REGION_SECOND_HALF = 0x02
IanBenzMaxim 21:00c94aeb533e 22 };
IanBenzMaxim 21:00c94aeb533e 23
IanBenzMaxim 21:00c94aeb533e 24 enum MemoryAddr
IanBenzMaxim 21:00c94aeb533e 25 {
IanBenzMaxim 21:00c94aeb533e 26 ADDR_SPAD = 0x00,
IanBenzMaxim 21:00c94aeb533e 27 ADDR_CMD_REG = 0x60,
IanBenzMaxim 21:00c94aeb533e 28 ADDR_STATUS_REG = 0x61,
IanBenzMaxim 21:00c94aeb533e 29 ADDR_DATA_REG = 0x62,
IanBenzMaxim 21:00c94aeb533e 30 ADDR_MAC_READ = 0x63,
IanBenzMaxim 21:00c94aeb533e 31 ADDR_SHA_SELECT_REG = 0x66,
IanBenzMaxim 21:00c94aeb533e 32 ADDR_WCFG_REG = 0x67,
IanBenzMaxim 24:8942d8478d68 33 ADDR_TRSTL_REG = 0x68,
IanBenzMaxim 24:8942d8478d68 34 ADDR_TMSP_REG = 0x69,
IanBenzMaxim 24:8942d8478d68 35 ADDR_TW0L_REG = 0x6A,
IanBenzMaxim 24:8942d8478d68 36 ADDR_TREC0_REG = 0x6B,
IanBenzMaxim 24:8942d8478d68 37 ADDR_RWPU_REG = 0x6C,
IanBenzMaxim 24:8942d8478d68 38 ADDR_TW1L_REG = 0x6D,
IanBenzMaxim 21:00c94aeb533e 39 ADDR_USER_MEM_PAGE_0 = 0x80,
IanBenzMaxim 21:00c94aeb533e 40 ADDR_USER_MEM_PAGE_1 = 0xA0
IanBenzMaxim 21:00c94aeb533e 41 };
IanBenzMaxim 21:00c94aeb533e 42
IanBenzMaxim 21:00c94aeb533e 43 DS2465(I2C & I2C_interface, std::uint8_t I2C_address);
IanBenzMaxim 21:00c94aeb533e 44
IanBenzMaxim 21:00c94aeb533e 45 // Const member functions should not change the settings of the DS2465 or affect the state of the 1-Wire bus.
IanBenzMaxim 21:00c94aeb533e 46 // Read pointer, scratchpad, MAC output register, and command register on the DS2465 are considered mutable.
IanBenzMaxim 21:00c94aeb533e 47
IanBenzMaxim 21:00c94aeb533e 48 //Misc. Functions
IanBenzMaxim 21:00c94aeb533e 49 OneWireMaster::CmdResult Detect(void);
IanBenzMaxim 21:00c94aeb533e 50 OneWireMaster::CmdResult Reset(void); // Resets DS2465 (NOTE: This is NOT a 1-Wire Reset)
IanBenzMaxim 21:00c94aeb533e 51
IanBenzMaxim 21:00c94aeb533e 52 // DS2465 Memory Commands
IanBenzMaxim 21:00c94aeb533e 53 OneWireMaster::CmdResult ReadMemory(std::uint8_t addr, std::uint8_t * buf, size_t bufLen, bool skip_set_pointer = false) const;
IanBenzMaxim 24:8942d8478d68 54 OneWireMaster::CmdResult WriteMemory(std::uint8_t addr, const std::uint8_t * buf, std::size_t bufLen) { return CWriteMemory(addr, buf, bufLen); }
IanBenzMaxim 24:8942d8478d68 55 OneWireMaster::CmdResult WriteScratchpad(const std::uint8_t * buf, std::size_t bufLen) const { return CWriteMemory(ADDR_SPAD, buf, bufLen); }
IanBenzMaxim 21:00c94aeb533e 56 OneWireMaster::CmdResult CopyScratchpad(bool dest_secret, unsigned int pageNum, bool notFull, unsigned int segmentNum);
IanBenzMaxim 21:00c94aeb533e 57
IanBenzMaxim 21:00c94aeb533e 58 // 1-Wire Master Commands
IanBenzMaxim 21:00c94aeb533e 59 virtual OneWireMaster::CmdResult OWInitMaster(void);
IanBenzMaxim 21:00c94aeb533e 60 virtual OneWireMaster::CmdResult OWReset(void); // Issues a 1-Wire Reset Pulse
IanBenzMaxim 26:a361e3f42ba5 61 virtual OneWireMaster::CmdResult OWTouchBit(uint8_t & sendrecvbit, OW_LEVEL after_level);
IanBenzMaxim 26:a361e3f42ba5 62 virtual OneWireMaster::CmdResult OWReadByte(uint8_t & recvbyte, OW_LEVEL after_level);
IanBenzMaxim 26:a361e3f42ba5 63 virtual OneWireMaster::CmdResult OWWriteByte(uint8_t sendbyte, OW_LEVEL after_level);
IanBenzMaxim 24:8942d8478d68 64 virtual OneWireMaster::CmdResult OWReadBlock(uint8_t *rx_buf, uint8_t rx_len);
IanBenzMaxim 24:8942d8478d68 65 virtual OneWireMaster::CmdResult OWWriteBlock(const uint8_t *tran_buf, uint8_t tran_len);
IanBenzMaxim 24:8942d8478d68 66 OneWireMaster::CmdResult OWWriteBlock(bool tx_mac, const uint8_t *tran_buf, uint8_t tran_len);
IanBenzMaxim 26:a361e3f42ba5 67 virtual OneWireMaster::CmdResult OWSpeed(OW_SPEED new_speed);
IanBenzMaxim 26:a361e3f42ba5 68 virtual OneWireMaster::CmdResult OWLevel(OW_LEVEL new_level);
IanBenzMaxim 26:a361e3f42ba5 69 virtual OneWireMaster::CmdResult OWSearch(RomId & romId);
IanBenzMaxim 24:8942d8478d68 70
IanBenzMaxim 26:a361e3f42ba5 71 OneWireMaster::CmdResult ConfigurePowerDown(bool pdn_enable);
IanBenzMaxim 26:a361e3f42ba5 72 OneWireMaster::CmdResult ConfigureAPU(bool apu_enable);
IanBenzMaxim 26:a361e3f42ba5 73 OneWireMaster::CmdResult ConfigureSPU(bool spu_enable);
IanBenzMaxim 26:a361e3f42ba5 74 OneWireMaster::CmdResult Triplet(Direction search_direction, uint8_t & status);
IanBenzMaxim 21:00c94aeb533e 75
IanBenzMaxim 21:00c94aeb533e 76 //DS2465 Coprocessor Commands
IanBenzMaxim 21:00c94aeb533e 77 OneWireMaster::CmdResult Compute_NextMasterSecret(bool swap, unsigned int pageNum, PageRegion region);
IanBenzMaxim 21:00c94aeb533e 78 OneWireMaster::CmdResult Compute_WriteMAC(bool regwrite, bool swap, unsigned int pageNum, unsigned int segmentNum) const;
IanBenzMaxim 21:00c94aeb533e 79 OneWireMaster::CmdResult Compute_SSecret(bool swap, unsigned int pageNum, PageRegion region);
IanBenzMaxim 21:00c94aeb533e 80 OneWireMaster::CmdResult Compute_AuthMAC(bool swap, unsigned int pageNum, PageRegion region) const;
IanBenzMaxim 21:00c94aeb533e 81
IanBenzMaxim 21:00c94aeb533e 82 virtual ISha256MacCoprocessor::CmdResult setMasterSecret(const std::uint8_t (&secret)[ISha256MacCoprocessor::secret_len]);
IanBenzMaxim 21:00c94aeb533e 83 virtual ISha256MacCoprocessor::CmdResult ComputeAndRead_WriteMAC(const std::uint8_t (&WriteMAC_data)[WriteMAC_data_len], std::uint8_t (&mac)[mac_len]) const;
IanBenzMaxim 21:00c94aeb533e 84 virtual ISha256MacCoprocessor::CmdResult ComputeAndRead_AuthMAC(const std::uint8_t (&devicePage)[devicePage_len], const std::uint8_t (&challenge)[deviceScratchpad_len],
IanBenzMaxim 21:00c94aeb533e 85 const std::uint8_t (&AuthMAC_data)[AuthMAC_data_len], std::uint8_t (&mac)[mac_len]) const;
IanBenzMaxim 21:00c94aeb533e 86 virtual ISha256MacCoprocessor::CmdResult Compute_SSecret(const std::uint8_t (&devicePage)[devicePage_len],
IanBenzMaxim 21:00c94aeb533e 87 const std::uint8_t (&deviceScratchpad)[deviceScratchpad_len], const std::uint8_t (&SSecret_data)[SSecret_data_len]);
IanBenzMaxim 21:00c94aeb533e 88
IanBenzMaxim 21:00c94aeb533e 89 private:
IanBenzMaxim 24:8942d8478d68 90 struct Config
IanBenzMaxim 24:8942d8478d68 91 {
IanBenzMaxim 24:8942d8478d68 92 bool c1WS, cSPU, cPDN, cAPU;
IanBenzMaxim 24:8942d8478d68 93
IanBenzMaxim 24:8942d8478d68 94 std::uint8_t readByte() const;
IanBenzMaxim 24:8942d8478d68 95 std::uint8_t writeByte() const;
IanBenzMaxim 24:8942d8478d68 96
IanBenzMaxim 24:8942d8478d68 97 void reset();
IanBenzMaxim 24:8942d8478d68 98 Config() { reset(); }
IanBenzMaxim 24:8942d8478d68 99 };
IanBenzMaxim 21:00c94aeb533e 100
IanBenzMaxim 21:00c94aeb533e 101 I2C & m_I2C_interface;
IanBenzMaxim 21:00c94aeb533e 102 std::uint8_t m_I2C_address;
IanBenzMaxim 24:8942d8478d68 103 Config m_curConfig;
IanBenzMaxim 21:00c94aeb533e 104
IanBenzMaxim 24:8942d8478d68 105 OneWireMaster::CmdResult CWriteMemory(std::uint8_t addr, const std::uint8_t * buf, std::size_t bufLen) const;
IanBenzMaxim 24:8942d8478d68 106 OneWireMaster::CmdResult WriteConfig(const Config & config);
IanBenzMaxim 24:8942d8478d68 107 OneWireMaster::CmdResult PollBusy(uint8_t * pStatus = NULL);
IanBenzMaxim 21:00c94aeb533e 108 };
IanBenzMaxim 21:00c94aeb533e 109
IanBenzMaxim 21:00c94aeb533e 110 #endif