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

MaximInterfaceCore/OneWireMaster.cpp

Committer:
IanBenzMaxim
Date:
2019-07-22
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1

File content as of revision 7:9cd16581b578:

/*******************************************************************************
* 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 "Error.hpp"
#include "OneWireMaster.hpp"

namespace MaximInterfaceCore {

static const int maxBitNum = 7;

error_code OneWireMaster::writeByteSetLevel(uint_least8_t sendByte,
                                            Level afterLevel) {
  error_code result;
  for (int bitNum = 0; (bitNum <= maxBitNum) && !result; ++bitNum) {
    result = writeBitSetLevel(((sendByte >> bitNum) & 1) == 1,
                              (bitNum == maxBitNum) ? afterLevel : NormalLevel);
  }
  return result;
}

error_code OneWireMaster::readByteSetLevel(uint_least8_t & recvByte,
                                           Level afterLevel) {
  recvByte = 0;
  error_code result;
  for (int bitNum = 0; bitNum <= maxBitNum; ++bitNum) {
    bool recvBit;
    result = readBitSetLevel(recvBit,
                             (bitNum == maxBitNum) ? afterLevel : NormalLevel);
    if (result) {
      break;
    }
    if (recvBit) {
      recvByte |= (1 << bitNum);
    }
  }
  return result;
}

error_code OneWireMaster::writeBlock(span<const uint_least8_t> sendBuf) {
  error_code result;
  for (span<const uint_least8_t>::index_type i = 0;
       i < sendBuf.size() && !result; ++i) {
    result = writeByte(sendBuf[i]);
  }
  return result;
}

error_code OneWireMaster::readBlock(span<uint_least8_t> recvBuf) {
  error_code result;
  for (span<uint_least8_t>::index_type i = 0; i < recvBuf.size() && !result;
       ++i) {
    result = readByte(recvBuf[i]);
  }
  return result;
}

error_code OneWireMaster::triplet(TripletData & data) {
  error_code result = readBit(data.readBit);
  if (!result) {
    result = readBit(data.readBitComplement);
  }
  if (!result) {
    if (data.readBit) {
      data.writeBit = 1;
    } else if (data.readBitComplement) {
      data.writeBit = 0;
    }
    // else: use data.writeBit parameter
    result = writeBit(data.writeBit);
  }
  return result;
}

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

    virtual std::string message(int condition) const {
      switch (condition) {
      case NoSlaveError:
        return "No Slave Error";

      case ShortDetectedError:
        return "Short Detected Error";

      case InvalidSpeedError:
        return "Invalid Speed Error";

      case InvalidLevelError:
        return "Invalid Level Error";

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

} // namespace MaximInterfaceCore