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

MaximInterfaceCore/LoggingI2CMaster.cpp@7:9cd16581b578, 2019-07-22 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Jul 22 11:44:07 2019 -0500
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
Updated to version 1.9.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 7:9cd16581b578 2 * Copyright (C) 2017 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 <utility>
IanBenzMaxim 7:9cd16581b578 34 #include "HexConversions.hpp"
IanBenzMaxim 7:9cd16581b578 35 #include "LoggingI2CMaster.hpp"
IanBenzMaxim 7:9cd16581b578 36
IanBenzMaxim 7:9cd16581b578 37 using std::string;
IanBenzMaxim 7:9cd16581b578 38
IanBenzMaxim 7:9cd16581b578 39 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 40
IanBenzMaxim 7:9cd16581b578 41 static const char startString[] = "S ";
IanBenzMaxim 7:9cd16581b578 42 static const char stopString[] = "P";
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 7:9cd16581b578 44 static string formatDataString(span<const uint_least8_t> data, bool read) {
IanBenzMaxim 7:9cd16581b578 45 string dataBuilder;
IanBenzMaxim 7:9cd16581b578 46 for (span<const uint_least8_t>::index_type i = 0; i < data.size(); ++i) {
IanBenzMaxim 7:9cd16581b578 47 if (read) {
IanBenzMaxim 7:9cd16581b578 48 dataBuilder.append(1, '[');
IanBenzMaxim 7:9cd16581b578 49 }
IanBenzMaxim 7:9cd16581b578 50 dataBuilder.append(byteArrayToHexString(data.subspan(i, 1)));
IanBenzMaxim 7:9cd16581b578 51 if (read) {
IanBenzMaxim 7:9cd16581b578 52 dataBuilder.append(1, ']');
IanBenzMaxim 7:9cd16581b578 53 }
IanBenzMaxim 7:9cd16581b578 54 dataBuilder.append(1, ' ');
IanBenzMaxim 7:9cd16581b578 55 }
IanBenzMaxim 7:9cd16581b578 56 return dataBuilder;
IanBenzMaxim 7:9cd16581b578 57 }
IanBenzMaxim 7:9cd16581b578 58
IanBenzMaxim 7:9cd16581b578 59 void LoggingI2CMaster::tryWriteMessage() {
IanBenzMaxim 7:9cd16581b578 60 if (writeMessage) {
IanBenzMaxim 7:9cd16581b578 61 writeMessage(messageBuilder);
IanBenzMaxim 7:9cd16581b578 62 }
IanBenzMaxim 7:9cd16581b578 63 messageBuilder.clear();
IanBenzMaxim 7:9cd16581b578 64 }
IanBenzMaxim 7:9cd16581b578 65
IanBenzMaxim 7:9cd16581b578 66 error_code LoggingI2CMaster::start(uint_least8_t address) {
IanBenzMaxim 7:9cd16581b578 67 messageBuilder.append(startString);
IanBenzMaxim 7:9cd16581b578 68 messageBuilder.append(formatDataString(make_span(&address, 1), false));
IanBenzMaxim 7:9cd16581b578 69 return I2CMasterDecorator::start(address);
IanBenzMaxim 7:9cd16581b578 70 }
IanBenzMaxim 7:9cd16581b578 71
IanBenzMaxim 7:9cd16581b578 72 error_code LoggingI2CMaster::stop() {
IanBenzMaxim 7:9cd16581b578 73 messageBuilder.append(stopString);
IanBenzMaxim 7:9cd16581b578 74 tryWriteMessage();
IanBenzMaxim 7:9cd16581b578 75 return I2CMasterDecorator::stop();
IanBenzMaxim 7:9cd16581b578 76 }
IanBenzMaxim 7:9cd16581b578 77
IanBenzMaxim 7:9cd16581b578 78 error_code LoggingI2CMaster::writeByte(uint_least8_t data) {
IanBenzMaxim 7:9cd16581b578 79 messageBuilder.append(formatDataString(make_span(&data, 1), false));
IanBenzMaxim 7:9cd16581b578 80 return I2CMasterDecorator::writeByte(data);
IanBenzMaxim 7:9cd16581b578 81 }
IanBenzMaxim 7:9cd16581b578 82
IanBenzMaxim 7:9cd16581b578 83 error_code LoggingI2CMaster::writeBlock(span<const uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 84 messageBuilder.append(formatDataString(data, false));
IanBenzMaxim 7:9cd16581b578 85 return I2CMasterDecorator::writeBlock(data);
IanBenzMaxim 7:9cd16581b578 86 }
IanBenzMaxim 7:9cd16581b578 87
IanBenzMaxim 7:9cd16581b578 88 error_code LoggingI2CMaster::doWritePacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 89 span<const uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 90 bool sendStop) {
IanBenzMaxim 7:9cd16581b578 91 messageBuilder.append(startString);
IanBenzMaxim 7:9cd16581b578 92 messageBuilder.append(formatDataString(make_span(&address, 1), false));
IanBenzMaxim 7:9cd16581b578 93 error_code result =
IanBenzMaxim 7:9cd16581b578 94 I2CMasterDecorator::doWritePacket(address, data, sendStop);
IanBenzMaxim 7:9cd16581b578 95 if (!result) {
IanBenzMaxim 7:9cd16581b578 96 messageBuilder.append(formatDataString(data, false));
IanBenzMaxim 7:9cd16581b578 97 }
IanBenzMaxim 7:9cd16581b578 98 if (sendStop || result) {
IanBenzMaxim 7:9cd16581b578 99 messageBuilder.append(stopString);
IanBenzMaxim 7:9cd16581b578 100 tryWriteMessage();
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 7:9cd16581b578 102 return result;
IanBenzMaxim 7:9cd16581b578 103 }
IanBenzMaxim 7:9cd16581b578 104
IanBenzMaxim 7:9cd16581b578 105 error_code LoggingI2CMaster::readByte(AckStatus status, uint_least8_t & data) {
IanBenzMaxim 7:9cd16581b578 106 error_code result = I2CMasterDecorator::readByte(status, data);
IanBenzMaxim 7:9cd16581b578 107 if (!result) {
IanBenzMaxim 7:9cd16581b578 108 messageBuilder.append(formatDataString(make_span(&data, 1), true));
IanBenzMaxim 7:9cd16581b578 109 }
IanBenzMaxim 7:9cd16581b578 110 return result;
IanBenzMaxim 7:9cd16581b578 111 }
IanBenzMaxim 7:9cd16581b578 112
IanBenzMaxim 7:9cd16581b578 113 error_code LoggingI2CMaster::readBlock(AckStatus status,
IanBenzMaxim 7:9cd16581b578 114 span<uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 115 error_code result = I2CMasterDecorator::readBlock(status, data);
IanBenzMaxim 7:9cd16581b578 116 if (!result) {
IanBenzMaxim 7:9cd16581b578 117 messageBuilder.append(formatDataString(data, true));
IanBenzMaxim 7:9cd16581b578 118 }
IanBenzMaxim 7:9cd16581b578 119 return result;
IanBenzMaxim 7:9cd16581b578 120 }
IanBenzMaxim 7:9cd16581b578 121
IanBenzMaxim 7:9cd16581b578 122 error_code LoggingI2CMaster::doReadPacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 123 span<uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 124 bool sendStop) {
IanBenzMaxim 7:9cd16581b578 125 messageBuilder.append(startString);
IanBenzMaxim 7:9cd16581b578 126 messageBuilder.append(formatDataString(make_span(&address, 1), false));
IanBenzMaxim 7:9cd16581b578 127 error_code result = I2CMasterDecorator::doReadPacket(address, data, sendStop);
IanBenzMaxim 7:9cd16581b578 128 if (!result) {
IanBenzMaxim 7:9cd16581b578 129 messageBuilder.append(formatDataString(data, true));
IanBenzMaxim 7:9cd16581b578 130 }
IanBenzMaxim 7:9cd16581b578 131 if (sendStop || result) {
IanBenzMaxim 7:9cd16581b578 132 messageBuilder.append(stopString);
IanBenzMaxim 7:9cd16581b578 133 tryWriteMessage();
IanBenzMaxim 7:9cd16581b578 134 }
IanBenzMaxim 7:9cd16581b578 135 return result;
IanBenzMaxim 7:9cd16581b578 136 }
IanBenzMaxim 7:9cd16581b578 137
IanBenzMaxim 7:9cd16581b578 138 } // namespace MaximInterfaceCore