Maxim Integrated / MaximInterface

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@8:5ea891c7d1a1, 2019-09-16 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Sep 16 11:13:37 2019 -0500
Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578 
Updated to version 2.0.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 7:9cd16581b578 33 #include "I2CMaster.hpp"
IanBenzMaxim 7:9cd16581b578 34
IanBenzMaxim 7:9cd16581b578 35 namespace MaximInterfaceMbed {
IanBenzMaxim 7:9cd16581b578 36
IanBenzMaxim 7:9cd16581b578 37 using namespace MaximInterfaceCore;
IanBenzMaxim 7:9cd16581b578 38
IanBenzMaxim 8:5ea891c7d1a1 39 Result<void> I2CMaster::start(uint_least8_t address) {
IanBenzMaxim 7:9cd16581b578 40 i2c->start();
IanBenzMaxim 7:9cd16581b578 41 return writeByte(address);
IanBenzMaxim 7:9cd16581b578 42 }
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 8:5ea891c7d1a1 44 Result<void> I2CMaster::stop() {
IanBenzMaxim 7:9cd16581b578 45 i2c->stop();
IanBenzMaxim 8:5ea891c7d1a1 46 return none;
IanBenzMaxim 7:9cd16581b578 47 }
IanBenzMaxim 7:9cd16581b578 48
IanBenzMaxim 8:5ea891c7d1a1 49 Result<void> I2CMaster::writeByte(uint_least8_t data) {
IanBenzMaxim 8:5ea891c7d1a1 50 return (i2c->write(data) == 1) ? makeResult(none) : NackError;
IanBenzMaxim 7:9cd16581b578 51 }
IanBenzMaxim 7:9cd16581b578 52
IanBenzMaxim 8:5ea891c7d1a1 53 Result<void> I2CMaster::writePacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 54 span<const uint_least8_t> data,
IanBenzMaxim 8:5ea891c7d1a1 55 DoStop doStop) {
IanBenzMaxim 8:5ea891c7d1a1 56 const Result<void> result =
IanBenzMaxim 8:5ea891c7d1a1 57 (i2c->write(address, reinterpret_cast<const char *>(data.data()),
IanBenzMaxim 8:5ea891c7d1a1 58 data.size(), doStop != Stop) == 0)
IanBenzMaxim 8:5ea891c7d1a1 59 ? makeResult(none)
IanBenzMaxim 8:5ea891c7d1a1 60 : NackError;
IanBenzMaxim 8:5ea891c7d1a1 61 if (doStop == StopOnError && !result) {
IanBenzMaxim 8:5ea891c7d1a1 62 i2c->stop();
IanBenzMaxim 8:5ea891c7d1a1 63 }
IanBenzMaxim 8:5ea891c7d1a1 64 return result;
IanBenzMaxim 7:9cd16581b578 65 }
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 8:5ea891c7d1a1 67 Result<uint_least8_t> I2CMaster::readByte(DoAck doAck) {
IanBenzMaxim 8:5ea891c7d1a1 68 return i2c->read(doAck == Ack);
IanBenzMaxim 7:9cd16581b578 69 }
IanBenzMaxim 7:9cd16581b578 70
IanBenzMaxim 8:5ea891c7d1a1 71 Result<void> I2CMaster::readPacket(uint_least8_t address,
IanBenzMaxim 8:5ea891c7d1a1 72 span<uint_least8_t> data, DoStop doStop) {
IanBenzMaxim 8:5ea891c7d1a1 73 const Result<void> result =
IanBenzMaxim 8:5ea891c7d1a1 74 (i2c->read(address, reinterpret_cast<char *>(data.data()), data.size(),
IanBenzMaxim 8:5ea891c7d1a1 75 doStop != Stop) == 0)
IanBenzMaxim 8:5ea891c7d1a1 76 ? makeResult(none)
IanBenzMaxim 8:5ea891c7d1a1 77 : NackError;
IanBenzMaxim 8:5ea891c7d1a1 78 if (doStop == StopOnError && !result) {
IanBenzMaxim 8:5ea891c7d1a1 79 i2c->stop();
IanBenzMaxim 8:5ea891c7d1a1 80 }
IanBenzMaxim 8:5ea891c7d1a1 81 return result;
IanBenzMaxim 7:9cd16581b578 82 }
IanBenzMaxim 7:9cd16581b578 83
IanBenzMaxim 7:9cd16581b578 84 } // namespace MaximInterfaceMbed