Diff: Devices/DS2431.hpp

Revision:

0:f77ad7f72d04

Child:

6:a8c83a2e6fa4

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Devices/DS2431.hpp	Mon Nov 06 14:39:18 2017 -0600
@@ -0,0 +1,121 @@
+/*******************************************************************************
+* Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************/
+
+#ifndef MaximInterface_DS2431
+#define MaximInterface_DS2431
+
+#include <MaximInterface/Links/SelectRom.hpp>
+#include <MaximInterface/Links/Sleep.hpp>
+#include <MaximInterface/Utilities/Export.h>
+
+namespace MaximInterface {
+
+/// DS2431 1024-bit 1-Wire EEPROM
+/// @details The DS2431 is a 1024-bit, 1-Wire® EEPROM chip organized
+/// as four memory pages of 256 bits each. Data is written to an 8-byte
+/// scratchpad, verified, and then copied to the EEPROM memory. As a
+/// special feature, the four memory pages can individually be write
+/// protected or put in EPROM-emulation mode, where bits can only be
+/// changed from a 1 to a 0 state. The DS2431 communicates over the
+/// single-conductor 1-Wire bus. The communication follows the standard
+/// 1-Wire protocol. Each device has its own unalterable and unique
+/// 64-bit ROM registration number that is factory lasered into the chip.
+/// The registration number is used to address the device in a multidrop,
+/// 1-Wire net environment.
+class DS2431 {
+public:
+  enum ErrorValue { CrcError = 1, OperationFailure };
+
+  typedef array<uint_least8_t, 8> Scratchpad;
+  typedef uint_least8_t Address;
+
+  DS2431(const Sleep & sleep, OneWireMaster & master,
+         const SelectRom & selectRom)
+      : selectRom(selectRom), master(&master), sleep(&sleep) {}
+
+  void setSleep(const Sleep & sleep) { this->sleep = &sleep; }
+  void setMaster(OneWireMaster & master) { this->master = &master; }
+  void setSelectRom(const SelectRom & selectRom) {
+    this->selectRom = selectRom;
+  }
+
+  /// Reads block of data from EEPROM memory.
+  /// @param[in] beginAddress EEPROM memory address to start reading from.
+  /// @param[out] data EEPROM data read from the device.
+  /// @param[in] dataLen Length of data parameter and number of bytes to read.
+  MaximInterface_EXPORT error_code readMemory(Address beginAddress,
+                                              uint_least8_t * data,
+                                              size_t dataLen) const;
+
+  /// Writes 8 bytes to the scratchpad.
+  /// @param[in] targetAddress EEPROM memory address that this data.
+  /// will be copied to.  Must be on row boundary.
+  /// @param[in] data Data to write to scratchpad.
+  MaximInterface_EXPORT error_code writeScratchpad(Address targetAddress,
+                                                   const Scratchpad & data);
+
+  /// Reads contents of scratchpad.
+  /// @param[out] data Data read from scratchpad.
+  /// @param[out] esByte E/S byte read before scratchpad data.
+  MaximInterface_EXPORT error_code readScratchpad(Scratchpad & data,
+                                                  uint_least8_t & esByte);
+
+  /// Copies contents of scratchpad to EEPROM.
+  /// @param[in] targetAddress EEPROM memory address that scratchpad
+  /// will be copied to. Must be on row boundary.
+  /// @param[in] esByte E/S byte from preceding Read Scratchpad command.
+  MaximInterface_EXPORT error_code copyScratchpad(Address targetAddress,
+                                                  uint_least8_t esByte);
+
+  MaximInterface_EXPORT static const error_category & errorCategory();
+
+private:
+  SelectRom selectRom;
+  OneWireMaster * master;
+  const Sleep * sleep;
+};
+
+/// Writes data to EEPROM using Write Scratchpad, Read Scratchpad,
+/// and Copy Scratchpad commands.
+/// @param[in] targetAddress EEPROM memory address to start writing at.
+/// @param[in] data Data to write to EEPROM.
+MaximInterface_EXPORT error_code writeMemory(DS2431 & device,
+                                             DS2431::Address targetAddress,
+                                             const DS2431::Scratchpad & data);
+
+inline error_code make_error_code(DS2431::ErrorValue e) {
+  return error_code(e, DS2431::errorCategory());
+}
+
+} // namespace MaximInterface
+
+#endif