Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578
Child:
10:947d3f44e0a0
--- a/MaximInterfaceDevices/DS2431.cpp	Mon Jul 22 11:44:07 2019 -0500
+++ b/MaximInterfaceDevices/DS2431.cpp	Mon Sep 16 11:13:37 2019 -0500
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+* Copyright (C) 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"),
@@ -39,119 +39,118 @@
 
 using namespace Core;
 
-error_code writeMemory(DS2431 & device, DS2431::Address targetAddress,
-                       DS2431::Scratchpad::const_span data) {
-  error_code result = device.writeScratchpad(targetAddress, data);
-  if (result) {
+Result<void> writeMemory(DS2431 & device, uint_least8_t targetAddress,
+                         DS2431::Scratchpad::const_span data) {
+  Result<void> result = device.writeScratchpad(targetAddress, data);
+  if (!result) {
     return result;
   }
-  DS2431::Scratchpad::array readData;
   uint_least8_t esByte;
-  result = device.readScratchpad(readData, esByte);
-  if (result) {
-    return result;
+  if (const Result<std::pair<uint_least8_t, DS2431::Scratchpad::array> >
+          scratchpad = device.readScratchpad()) {
+    esByte = scratchpad.value().first;
+  } else {
+    return scratchpad.error();
   }
   result = device.copyScratchpad(targetAddress, esByte);
   return result;
 }
 
-error_code DS2431::readMemory(Address beginAddress,
-                              span<uint_least8_t> data) const {
-  error_code result = selectRom(*master);
-  if (result) {
+Result<void> DS2431::readMemory(uint_least8_t beginAddress,
+                                span<uint_least8_t> data) const {
+  Result<void> result = selectRom(*master);
+  if (!result) {
     return result;
   }
   const uint_least8_t sendBlock[] = {0xF0, beginAddress, 0x00};
   result = master->writeBlock(sendBlock);
-  if (result) {
+  if (!result) {
     return result;
   }
   result = master->readBlock(data);
   return result;
 }
 
-error_code DS2431::writeScratchpad(Address targetAddress,
-                                   Scratchpad::const_span data) {
-  error_code result = selectRom(*master);
-  if (result) {
+Result<void> DS2431::writeScratchpad(uint_least8_t targetAddress,
+                                     Scratchpad::const_span data) {
+  Result<void> result = selectRom(*master);
+  if (!result) {
     return result;
   }
   uint_least8_t block[3 + Scratchpad::size] = {0x0F, targetAddress, 0x00};
   std::copy(data.begin(), data.end(), block + 3);
   result = master->writeBlock(block);
-  if (result) {
+  if (!result) {
     return result;
   }
   const uint_fast16_t calculatedCrc = calculateCrc16(block) ^ 0xFFFFu;
   result = master->readBlock(make_span(block, 2));
-  if (result) {
+  if (!result) {
     return result;
   }
   if (calculatedCrc !=
       ((static_cast<uint_fast16_t>(block[1]) << 8) | block[0])) {
-    result = make_error_code(CrcError);
+    result = CrcError;
   }
   return result;
 }
 
-error_code DS2431::readScratchpad(Scratchpad::span data,
-                                  uint_least8_t & esByte) {
+Result<std::pair<uint_least8_t, DS2431::Scratchpad::array> >
+DS2431::readScratchpad() const {
   typedef array<uint_least8_t, 6 + Scratchpad::size> Block;
 
-  error_code result = selectRom(*master);
-  if (result) {
-    return result;
+  Result<void> result = selectRom(*master);
+  if (!result) {
+    return result.error();
   }
   Block block = {0xAA};
   result = master->writeByte(block.front());
-  if (result) {
-    return result;
+  if (!result) {
+    return result.error();
   }
   result = master->readBlock(make_span(block).subspan(1));
-  if (result) {
-    return result;
+  if (!result) {
+    return result.error();
   }
   Block::const_iterator blockIt = block.end();
   uint_fast16_t receivedCrc = static_cast<uint_fast16_t>(*(--blockIt)) << 8;
   receivedCrc |= *(--blockIt);
   const uint_fast16_t expectedCrc =
       calculateCrc16(make_span(block.data(), block.size() - 2)) ^ 0xFFFFu;
-  if (expectedCrc == receivedCrc) {
-    Block::const_iterator blockItEnd = blockIt;
-    blockIt -= data.size();
-    std::copy(blockIt, blockItEnd, data.begin());
-    esByte = *(--blockIt);
-  } else {
-    result = make_error_code(CrcError);
+  if (expectedCrc != receivedCrc) {
+    return CrcError;
   }
-  return result;
+  std::pair<uint_least8_t, Scratchpad::array> data;
+  Block::const_iterator blockItEnd = blockIt;
+  blockIt -= data.second.size();
+  std::copy(blockIt, blockItEnd, data.second.begin());
+  data.first = *(--blockIt);
+  return data;
 }
 
-error_code DS2431::copyScratchpad(Address targetAddress, uint_least8_t esByte) {
-  error_code result = selectRom(*master);
-  if (result) {
+Result<void> DS2431::copyScratchpad(uint_least8_t targetAddress,
+                                    uint_least8_t esByte) {
+  Result<void> result = selectRom(*master);
+  if (!result) {
     return result;
   }
   uint_least8_t block[] = {0x55, targetAddress, 0x00};
   result = master->writeBlock(block);
-  if (result) {
+  if (!result) {
     return result;
   }
   result = master->writeByteSetLevel(esByte, OneWireMaster::StrongLevel);
-  if (result) {
+  if (!result) {
     return result;
   }
   sleep->invoke(10);
   result = master->setLevel(OneWireMaster::NormalLevel);
-  if (result) {
+  if (!result) {
     return result;
   }
-  result = master->readByte(block[0]);
-  if (result) {
-    return result;
-  }
+  MaximInterfaceCore_TRY_VALUE(block[0], master->readByte());
   if (block[0] != 0xAA) {
-    result = make_error_code(OperationFailure);
+    result = OperationFailure;
   }
   return result;
 }