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

MaximInterfaceMbed/I2CMaster.cpp

Committer:
IanBenzMaxim
Date:
2019-09-16
Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578

File content as of revision 8:5ea891c7d1a1:

/*******************************************************************************
* 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"),
* 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 "I2CMaster.hpp"

namespace MaximInterfaceMbed {

using namespace MaximInterfaceCore;

Result<void> I2CMaster::start(uint_least8_t address) {
  i2c->start();
  return writeByte(address);
}

Result<void> I2CMaster::stop() {
  i2c->stop();
  return none;
}

Result<void> I2CMaster::writeByte(uint_least8_t data) {
  return (i2c->write(data) == 1) ? makeResult(none) : NackError;
}

Result<void> I2CMaster::writePacket(uint_least8_t address,
                                    span<const uint_least8_t> data,
                                    DoStop doStop) {
  const Result<void> result =
      (i2c->write(address, reinterpret_cast<const char *>(data.data()),
                  data.size(), doStop != Stop) == 0)
          ? makeResult(none)
          : NackError;
  if (doStop == StopOnError && !result) {
    i2c->stop();
  }
  return result;
}

Result<uint_least8_t> I2CMaster::readByte(DoAck doAck) {
  return i2c->read(doAck == Ack);
}

Result<void> I2CMaster::readPacket(uint_least8_t address,
                                   span<uint_least8_t> data, DoStop doStop) {
  const Result<void> result =
      (i2c->read(address, reinterpret_cast<char *>(data.data()), data.size(),
                 doStop != Stop) == 0)
          ? makeResult(none)
          : NackError;
  if (doStop == StopOnError && !result) {
    i2c->stop();
  }
  return result;
}

} // namespace MaximInterfaceMbed