File content as of revision 0:f77ad7f72d04:

/*******************************************************************************
* 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.
*******************************************************************************/

#include <algorithm>
#include <MaximInterface/Links/OneWireMaster.hpp>
#include <MaximInterface/Utilities/Error.hpp>
#include "DS2431.hpp"

namespace MaximInterface {

enum Command {
  WriteScratchpad = 0x0F,
  ReadScratchpad = 0xAA,
  CopyScratchpad = 0x55,
  ReadMemory = 0xF0
};

error_code writeMemory(DS2431 & device, DS2431::Address targetAddress,
                       const DS2431::Scratchpad & data) {
  error_code result = device.writeScratchpad(targetAddress, data);
  if (result) {
    return result;
  }
  DS2431::Scratchpad readData;
  uint_least8_t esByte;
  result = device.readScratchpad(readData, esByte);
  if (result) {
    return result;
  }
  result = device.copyScratchpad(targetAddress, esByte);
  return result;
}

error_code DS2431::readMemory(Address beginAddress, uint_least8_t * data,
                              size_t dataLen) const {
  error_code owmResult = selectRom(*master);
  if (owmResult) {
    return owmResult;
  }
  const uint_least8_t sendBlock[] = {ReadMemory, beginAddress, 0x00};
  owmResult =
      master->writeBlock(sendBlock, sizeof(sendBlock) / sizeof(sendBlock[0]));
  if (owmResult) {
    return owmResult;
  }
  owmResult = master->readBlock(data, dataLen);
  return owmResult;
}

error_code DS2431::writeScratchpad(Address targetAddress,
                                   const Scratchpad & data) {
  error_code owmResult = selectRom(*master);
  if (owmResult) {
    return owmResult;
  }
  array<uint_least8_t, 3 + Scratchpad::csize> block = {WriteScratchpad,
                                                       targetAddress, 0x00};
  std::copy(data.begin(), data.end(), block.begin() + 3);
  owmResult = master->writeBlock(block.data(), block.size());
  if (owmResult) {
    return owmResult;
  }
  const uint_fast16_t calculatedCrc =
      calculateCrc16(block.data(), block.size()) ^ 0xFFFFU;
  owmResult = master->readBlock(block.data(), 2);
  if (owmResult) {
    return owmResult;
  }
  if (calculatedCrc !=
      ((static_cast<uint_fast16_t>(block[1]) << 8) | block[0])) {
    owmResult = make_error_code(CrcError);
  }
  return owmResult;
}

error_code DS2431::readScratchpad(Scratchpad & data, uint_least8_t & esByte) {
  typedef array<uint_least8_t, 6 + Scratchpad::csize> Block;

  error_code owmResult = selectRom(*master);
  if (owmResult) {
    return owmResult;
  }
  Block block = {ReadScratchpad};
  owmResult = master->writeByte(block.front());
  if (owmResult) {
    return owmResult;
  }
  owmResult = master->readBlock(block.data() + 1, block.size() - 1);
  if (owmResult) {
    return owmResult;
  }
  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(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 {
    owmResult = make_error_code(CrcError);
  }
  return owmResult;
}

error_code DS2431::copyScratchpad(Address targetAddress, uint_least8_t esByte) {
  error_code owmResult = selectRom(*master);
  if (owmResult) {
    return owmResult;
  }
  uint_least8_t block[] = {CopyScratchpad, targetAddress, 0x00};
  owmResult = master->writeBlock(block, sizeof(block) / sizeof(block[0]));
  if (owmResult) {
    return owmResult;
  }
  owmResult = master->writeByteSetLevel(esByte, OneWireMaster::StrongLevel);
  if (owmResult) {
    return owmResult;
  }
  (*sleep)(10);
  owmResult = master->setLevel(OneWireMaster::NormalLevel);
  if (owmResult) {
    return owmResult;
  }
  owmResult = master->readByte(block[0]);
  if (owmResult) {
    return owmResult;
  }
  if (block[0] != 0xAA) {
    owmResult = make_error_code(OperationFailure);
  }
  return owmResult;
}

const error_category & DS2431::errorCategory() {
  static class : public error_category {
  public:
    virtual const char * name() const { return "DS2431"; }

    virtual std::string message(int condition) const {
      switch (condition) {
      case CrcError:
        return "CRC Error";

      case OperationFailure:
        return "Operation Failure";

      default:
        return defaultErrorMessage(condition);
      }
    }
  } instance;
  return instance;
}

} // namespace MaximInterface