Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Committer:
IanBenzMaxim
Date:
Thu Jan 11 13:50:39 2018 -0600
Revision:
3:f818ea5172ed
Parent:
0:f77ad7f72d04
Child:
6:a8c83a2e6fa4
Updated to version 1.1.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:f77ad7f72d04 1 /*******************************************************************************
IanBenzMaxim 0:f77ad7f72d04 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:f77ad7f72d04 3 *
IanBenzMaxim 0:f77ad7f72d04 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:f77ad7f72d04 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:f77ad7f72d04 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:f77ad7f72d04 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:f77ad7f72d04 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:f77ad7f72d04 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:f77ad7f72d04 10 *
IanBenzMaxim 0:f77ad7f72d04 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:f77ad7f72d04 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:f77ad7f72d04 13 *
IanBenzMaxim 0:f77ad7f72d04 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:f77ad7f72d04 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:f77ad7f72d04 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:f77ad7f72d04 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:f77ad7f72d04 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:f77ad7f72d04 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:f77ad7f72d04 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:f77ad7f72d04 21 *
IanBenzMaxim 0:f77ad7f72d04 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:f77ad7f72d04 25 *
IanBenzMaxim 0:f77ad7f72d04 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:f77ad7f72d04 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:f77ad7f72d04 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:f77ad7f72d04 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:f77ad7f72d04 30 * ownership rights.
IanBenzMaxim 0:f77ad7f72d04 31 *******************************************************************************/
IanBenzMaxim 0:f77ad7f72d04 32
IanBenzMaxim 0:f77ad7f72d04 33 #include <utility>
IanBenzMaxim 0:f77ad7f72d04 34 #include <MaximInterface/Utilities/HexConversions.hpp>
IanBenzMaxim 0:f77ad7f72d04 35 #include "LoggingI2CMaster.hpp"
IanBenzMaxim 0:f77ad7f72d04 36
IanBenzMaxim 0:f77ad7f72d04 37 using std::string;
IanBenzMaxim 0:f77ad7f72d04 38
IanBenzMaxim 0:f77ad7f72d04 39 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 static const char startString[] = "S ";
IanBenzMaxim 0:f77ad7f72d04 42 static const char stopString[] = "P";
IanBenzMaxim 0:f77ad7f72d04 43
IanBenzMaxim 0:f77ad7f72d04 44 static string formatDataString(const uint_least8_t * data, size_t dataSize,
IanBenzMaxim 0:f77ad7f72d04 45 bool read) {
IanBenzMaxim 0:f77ad7f72d04 46 string dataBuilder;
IanBenzMaxim 0:f77ad7f72d04 47 for (size_t i = 0; i < dataSize; i++) {
IanBenzMaxim 0:f77ad7f72d04 48 if (read) {
IanBenzMaxim 0:f77ad7f72d04 49 dataBuilder.append(1, '[');
IanBenzMaxim 0:f77ad7f72d04 50 }
IanBenzMaxim 0:f77ad7f72d04 51 dataBuilder.append(byteArrayToHexString(data + i, 1));
IanBenzMaxim 0:f77ad7f72d04 52 if (read) {
IanBenzMaxim 0:f77ad7f72d04 53 dataBuilder.append(1, ']');
IanBenzMaxim 0:f77ad7f72d04 54 }
IanBenzMaxim 0:f77ad7f72d04 55 dataBuilder.append(1, ' ');
IanBenzMaxim 0:f77ad7f72d04 56 }
IanBenzMaxim 0:f77ad7f72d04 57 return dataBuilder;
IanBenzMaxim 0:f77ad7f72d04 58 }
IanBenzMaxim 0:f77ad7f72d04 59
IanBenzMaxim 0:f77ad7f72d04 60 void LoggingI2CMaster::tryWriteMessage() {
IanBenzMaxim 0:f77ad7f72d04 61 if (writeMessage) {
IanBenzMaxim 0:f77ad7f72d04 62 writeMessage(messageBuilder);
IanBenzMaxim 0:f77ad7f72d04 63 }
IanBenzMaxim 0:f77ad7f72d04 64 messageBuilder.clear();
IanBenzMaxim 0:f77ad7f72d04 65 }
IanBenzMaxim 0:f77ad7f72d04 66
IanBenzMaxim 0:f77ad7f72d04 67 error_code LoggingI2CMaster::start(uint_least8_t address) {
IanBenzMaxim 0:f77ad7f72d04 68 messageBuilder.append(startString);
IanBenzMaxim 0:f77ad7f72d04 69 messageBuilder.append(formatDataString(&address, 1, false));
IanBenzMaxim 0:f77ad7f72d04 70 return I2CMasterDecorator::start(address);
IanBenzMaxim 0:f77ad7f72d04 71 }
IanBenzMaxim 0:f77ad7f72d04 72
IanBenzMaxim 0:f77ad7f72d04 73 error_code LoggingI2CMaster::stop() {
IanBenzMaxim 0:f77ad7f72d04 74 messageBuilder.append(stopString);
IanBenzMaxim 0:f77ad7f72d04 75 tryWriteMessage();
IanBenzMaxim 0:f77ad7f72d04 76 return I2CMasterDecorator::stop();
IanBenzMaxim 0:f77ad7f72d04 77 }
IanBenzMaxim 0:f77ad7f72d04 78
IanBenzMaxim 0:f77ad7f72d04 79 error_code LoggingI2CMaster::writeByte(uint_least8_t data) {
IanBenzMaxim 0:f77ad7f72d04 80 messageBuilder.append(formatDataString(&data, 1, false));
IanBenzMaxim 0:f77ad7f72d04 81 return I2CMasterDecorator::writeByte(data);
IanBenzMaxim 0:f77ad7f72d04 82 }
IanBenzMaxim 0:f77ad7f72d04 83
IanBenzMaxim 0:f77ad7f72d04 84 error_code LoggingI2CMaster::writeBlock(const uint_least8_t * data,
IanBenzMaxim 0:f77ad7f72d04 85 size_t dataLen) {
IanBenzMaxim 0:f77ad7f72d04 86 messageBuilder.append(formatDataString(data, dataLen, false));
IanBenzMaxim 0:f77ad7f72d04 87 return I2CMasterDecorator::writeBlock(data, dataLen);
IanBenzMaxim 0:f77ad7f72d04 88 }
IanBenzMaxim 0:f77ad7f72d04 89
IanBenzMaxim 3:f818ea5172ed 90 error_code LoggingI2CMaster::writePacketImpl(uint_least8_t address,
IanBenzMaxim 3:f818ea5172ed 91 const uint_least8_t * data,
IanBenzMaxim 3:f818ea5172ed 92 size_t dataLen, bool sendStop) {
IanBenzMaxim 0:f77ad7f72d04 93 messageBuilder.append(startString);
IanBenzMaxim 0:f77ad7f72d04 94 messageBuilder.append(formatDataString(&address, 1, false));
IanBenzMaxim 0:f77ad7f72d04 95 error_code result =
IanBenzMaxim 3:f818ea5172ed 96 I2CMasterDecorator::writePacketImpl(address, data, dataLen, sendStop);
IanBenzMaxim 0:f77ad7f72d04 97 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 98 messageBuilder.append(formatDataString(data, dataLen, false));
IanBenzMaxim 0:f77ad7f72d04 99 }
IanBenzMaxim 0:f77ad7f72d04 100 if (sendStop || result) {
IanBenzMaxim 0:f77ad7f72d04 101 messageBuilder.append(stopString);
IanBenzMaxim 0:f77ad7f72d04 102 tryWriteMessage();
IanBenzMaxim 0:f77ad7f72d04 103 }
IanBenzMaxim 0:f77ad7f72d04 104 return result;
IanBenzMaxim 0:f77ad7f72d04 105 }
IanBenzMaxim 0:f77ad7f72d04 106
IanBenzMaxim 0:f77ad7f72d04 107 error_code LoggingI2CMaster::readByte(AckStatus status, uint_least8_t & data) {
IanBenzMaxim 0:f77ad7f72d04 108 error_code result = I2CMasterDecorator::readByte(status, data);
IanBenzMaxim 0:f77ad7f72d04 109 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 110 messageBuilder.append(formatDataString(&data, 1, true));
IanBenzMaxim 0:f77ad7f72d04 111 }
IanBenzMaxim 0:f77ad7f72d04 112 return result;
IanBenzMaxim 0:f77ad7f72d04 113 }
IanBenzMaxim 0:f77ad7f72d04 114
IanBenzMaxim 0:f77ad7f72d04 115 error_code LoggingI2CMaster::readBlock(AckStatus status, uint_least8_t * data,
IanBenzMaxim 0:f77ad7f72d04 116 size_t dataLen) {
IanBenzMaxim 0:f77ad7f72d04 117 error_code result = I2CMasterDecorator::readBlock(status, data, dataLen);
IanBenzMaxim 0:f77ad7f72d04 118 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 119 messageBuilder.append(formatDataString(data, dataLen, true));
IanBenzMaxim 0:f77ad7f72d04 120 }
IanBenzMaxim 0:f77ad7f72d04 121 return result;
IanBenzMaxim 0:f77ad7f72d04 122 }
IanBenzMaxim 0:f77ad7f72d04 123
IanBenzMaxim 3:f818ea5172ed 124 error_code LoggingI2CMaster::readPacketImpl(uint_least8_t address,
IanBenzMaxim 3:f818ea5172ed 125 uint_least8_t * data,
IanBenzMaxim 3:f818ea5172ed 126 size_t dataLen, bool sendStop) {
IanBenzMaxim 0:f77ad7f72d04 127 messageBuilder.append(startString);
IanBenzMaxim 0:f77ad7f72d04 128 messageBuilder.append(formatDataString(&address, 1, false));
IanBenzMaxim 0:f77ad7f72d04 129 error_code result =
IanBenzMaxim 3:f818ea5172ed 130 I2CMasterDecorator::readPacketImpl(address, data, dataLen, sendStop);
IanBenzMaxim 0:f77ad7f72d04 131 if (!result) {
IanBenzMaxim 0:f77ad7f72d04 132 messageBuilder.append(formatDataString(data, dataLen, true));
IanBenzMaxim 0:f77ad7f72d04 133 }
IanBenzMaxim 0:f77ad7f72d04 134 if (sendStop || result) {
IanBenzMaxim 0:f77ad7f72d04 135 messageBuilder.append(stopString);
IanBenzMaxim 0:f77ad7f72d04 136 tryWriteMessage();
IanBenzMaxim 0:f77ad7f72d04 137 }
IanBenzMaxim 0:f77ad7f72d04 138 return result;
IanBenzMaxim 0:f77ad7f72d04 139 }
IanBenzMaxim 0:f77ad7f72d04 140
IanBenzMaxim 0:f77ad7f72d04 141 } // namespace MaximInterface