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/RunCommand.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) 2018 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 "crc.hpp"
IanBenzMaxim 7:9cd16581b578 34 #include "Error.hpp"
IanBenzMaxim 7:9cd16581b578 35 #include "I2CMaster.hpp"
IanBenzMaxim 7:9cd16581b578 36 #include "OneWireMaster.hpp"
IanBenzMaxim 7:9cd16581b578 37 #include "RunCommand.hpp"
IanBenzMaxim 7:9cd16581b578 38 #include "Sleep.hpp"
IanBenzMaxim 7:9cd16581b578 39
IanBenzMaxim 7:9cd16581b578 40 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 41
IanBenzMaxim 7:9cd16581b578 42 const error_category & RunCommandWithOneWireMaster::errorCategory() {
IanBenzMaxim 7:9cd16581b578 43 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 44 public:
IanBenzMaxim 7:9cd16581b578 45 virtual const char * name() const { return "RunCommandWithOneWireMaster"; }
IanBenzMaxim 7:9cd16581b578 46
IanBenzMaxim 7:9cd16581b578 47 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 48 switch (condition) {
IanBenzMaxim 7:9cd16581b578 49 case CrcError:
IanBenzMaxim 7:9cd16581b578 50 return "CRC Error";
IanBenzMaxim 7:9cd16581b578 51
IanBenzMaxim 7:9cd16581b578 52 case InvalidResponseError:
IanBenzMaxim 7:9cd16581b578 53 return "Invalid Response Error";
IanBenzMaxim 7:9cd16581b578 54 }
IanBenzMaxim 7:9cd16581b578 55 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 56 }
IanBenzMaxim 7:9cd16581b578 57 } instance;
IanBenzMaxim 7:9cd16581b578 58 return instance;
IanBenzMaxim 7:9cd16581b578 59 }
IanBenzMaxim 7:9cd16581b578 60
IanBenzMaxim 7:9cd16581b578 61 error_code RunCommandWithOneWireMaster::
IanBenzMaxim 7:9cd16581b578 62 operator()(span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 7:9cd16581b578 63 span<uint_least8_t> & response) const {
IanBenzMaxim 7:9cd16581b578 64 // Write request.
IanBenzMaxim 7:9cd16581b578 65 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 66 if (result) {
IanBenzMaxim 7:9cd16581b578 67 return result;
IanBenzMaxim 7:9cd16581b578 68 }
IanBenzMaxim 7:9cd16581b578 69 uint_least8_t xpcBuffer[2] = {0x66,
IanBenzMaxim 7:9cd16581b578 70 static_cast<uint_least8_t>(request.size())};
IanBenzMaxim 7:9cd16581b578 71 result = master->writeBlock(xpcBuffer);
IanBenzMaxim 7:9cd16581b578 72 if (result) {
IanBenzMaxim 7:9cd16581b578 73 return result;
IanBenzMaxim 7:9cd16581b578 74 }
IanBenzMaxim 7:9cd16581b578 75 result = master->writeBlock(request);
IanBenzMaxim 7:9cd16581b578 76 if (result) {
IanBenzMaxim 7:9cd16581b578 77 return result;
IanBenzMaxim 7:9cd16581b578 78 }
IanBenzMaxim 7:9cd16581b578 79 uint_fast16_t expectedCrc =
IanBenzMaxim 7:9cd16581b578 80 calculateCrc16(calculateCrc16(xpcBuffer), request) ^ 0xFFFFu;
IanBenzMaxim 7:9cd16581b578 81 result = master->readBlock(xpcBuffer);
IanBenzMaxim 7:9cd16581b578 82 if (result) {
IanBenzMaxim 7:9cd16581b578 83 return result;
IanBenzMaxim 7:9cd16581b578 84 }
IanBenzMaxim 7:9cd16581b578 85 if (expectedCrc !=
IanBenzMaxim 7:9cd16581b578 86 ((static_cast<uint_fast16_t>(xpcBuffer[1]) << 8) | xpcBuffer[0])) {
IanBenzMaxim 7:9cd16581b578 87 return make_error_code(CrcError);
IanBenzMaxim 7:9cd16581b578 88 }
IanBenzMaxim 7:9cd16581b578 89 result = master->writeBytePower(0xAA);
IanBenzMaxim 7:9cd16581b578 90 if (result) {
IanBenzMaxim 7:9cd16581b578 91 return result;
IanBenzMaxim 7:9cd16581b578 92 }
IanBenzMaxim 7:9cd16581b578 93
IanBenzMaxim 7:9cd16581b578 94 // Wait for device to process.
IanBenzMaxim 7:9cd16581b578 95 sleep->invoke(delayTime);
IanBenzMaxim 7:9cd16581b578 96
IanBenzMaxim 7:9cd16581b578 97 // Read response.
IanBenzMaxim 7:9cd16581b578 98 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 99 if (result) {
IanBenzMaxim 7:9cd16581b578 100 return result;
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 7:9cd16581b578 102 result = master->readBlock(xpcBuffer);
IanBenzMaxim 7:9cd16581b578 103 if (result) {
IanBenzMaxim 7:9cd16581b578 104 return result;
IanBenzMaxim 7:9cd16581b578 105 }
IanBenzMaxim 7:9cd16581b578 106 if (xpcBuffer[1] > response.size()) {
IanBenzMaxim 7:9cd16581b578 107 return make_error_code(InvalidResponseError);
IanBenzMaxim 7:9cd16581b578 108 }
IanBenzMaxim 7:9cd16581b578 109 response = response.first(xpcBuffer[1]);
IanBenzMaxim 7:9cd16581b578 110 result = master->readBlock(response);
IanBenzMaxim 7:9cd16581b578 111 if (result) {
IanBenzMaxim 7:9cd16581b578 112 return result;
IanBenzMaxim 7:9cd16581b578 113 }
IanBenzMaxim 7:9cd16581b578 114 expectedCrc =
IanBenzMaxim 7:9cd16581b578 115 calculateCrc16(calculateCrc16(make_span(xpcBuffer + 1, 1)), response) ^
IanBenzMaxim 7:9cd16581b578 116 0xFFFFu;
IanBenzMaxim 7:9cd16581b578 117 result = master->readBlock(xpcBuffer);
IanBenzMaxim 7:9cd16581b578 118 if (result) {
IanBenzMaxim 7:9cd16581b578 119 return result;
IanBenzMaxim 7:9cd16581b578 120 }
IanBenzMaxim 7:9cd16581b578 121 if (expectedCrc !=
IanBenzMaxim 7:9cd16581b578 122 ((static_cast<uint_fast16_t>(xpcBuffer[1]) << 8) | xpcBuffer[0])) {
IanBenzMaxim 7:9cd16581b578 123 return make_error_code(CrcError);
IanBenzMaxim 7:9cd16581b578 124 }
IanBenzMaxim 7:9cd16581b578 125 return result;
IanBenzMaxim 7:9cd16581b578 126 }
IanBenzMaxim 7:9cd16581b578 127
IanBenzMaxim 7:9cd16581b578 128 const error_category & RunCommandWithI2CMaster::errorCategory() {
IanBenzMaxim 7:9cd16581b578 129 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 130 public:
IanBenzMaxim 7:9cd16581b578 131 virtual const char * name() const { return "RunCommandWithI2CMaster"; }
IanBenzMaxim 7:9cd16581b578 132
IanBenzMaxim 7:9cd16581b578 133 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 134 switch (condition) {
IanBenzMaxim 7:9cd16581b578 135 case InvalidResponseError:
IanBenzMaxim 7:9cd16581b578 136 return "Invalid Response Error";
IanBenzMaxim 7:9cd16581b578 137 }
IanBenzMaxim 7:9cd16581b578 138 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 139 }
IanBenzMaxim 7:9cd16581b578 140 } instance;
IanBenzMaxim 7:9cd16581b578 141 return instance;
IanBenzMaxim 7:9cd16581b578 142 }
IanBenzMaxim 7:9cd16581b578 143
IanBenzMaxim 7:9cd16581b578 144 error_code RunCommandWithI2CMaster::
IanBenzMaxim 7:9cd16581b578 145 operator()(span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 7:9cd16581b578 146 span<uint_least8_t> & response) const {
IanBenzMaxim 7:9cd16581b578 147 // Write request.
IanBenzMaxim 7:9cd16581b578 148 error_code result = master->start(address_);
IanBenzMaxim 7:9cd16581b578 149 if (result == make_error_condition(I2CMaster::NackError) && address_ != 0) {
IanBenzMaxim 7:9cd16581b578 150 result = master->start(0);
IanBenzMaxim 7:9cd16581b578 151 }
IanBenzMaxim 7:9cd16581b578 152 if (result) {
IanBenzMaxim 7:9cd16581b578 153 master->stop();
IanBenzMaxim 7:9cd16581b578 154 return result;
IanBenzMaxim 7:9cd16581b578 155 }
IanBenzMaxim 7:9cd16581b578 156 if (!request.empty()) {
IanBenzMaxim 7:9cd16581b578 157 result = master->writeByte(request[0]);
IanBenzMaxim 7:9cd16581b578 158 if (result) {
IanBenzMaxim 7:9cd16581b578 159 master->stop();
IanBenzMaxim 7:9cd16581b578 160 return result;
IanBenzMaxim 7:9cd16581b578 161 }
IanBenzMaxim 7:9cd16581b578 162 request = request.subspan(1);
IanBenzMaxim 7:9cd16581b578 163 if (!request.empty()) {
IanBenzMaxim 7:9cd16581b578 164 result = master->writeByte(static_cast<uint_least8_t>(request.size()));
IanBenzMaxim 7:9cd16581b578 165 if (result) {
IanBenzMaxim 7:9cd16581b578 166 master->stop();
IanBenzMaxim 7:9cd16581b578 167 return result;
IanBenzMaxim 7:9cd16581b578 168 }
IanBenzMaxim 7:9cd16581b578 169 result = master->writeBlock(request);
IanBenzMaxim 7:9cd16581b578 170 if (result) {
IanBenzMaxim 7:9cd16581b578 171 master->stop();
IanBenzMaxim 7:9cd16581b578 172 return result;
IanBenzMaxim 7:9cd16581b578 173 }
IanBenzMaxim 7:9cd16581b578 174 }
IanBenzMaxim 7:9cd16581b578 175 }
IanBenzMaxim 7:9cd16581b578 176 result = master->stop();
IanBenzMaxim 7:9cd16581b578 177 if (result) {
IanBenzMaxim 7:9cd16581b578 178 return result;
IanBenzMaxim 7:9cd16581b578 179 }
IanBenzMaxim 7:9cd16581b578 180
IanBenzMaxim 7:9cd16581b578 181 // Wait for device to process.
IanBenzMaxim 7:9cd16581b578 182 sleep->invoke(delayTime);
IanBenzMaxim 7:9cd16581b578 183
IanBenzMaxim 7:9cd16581b578 184 // Read response.
IanBenzMaxim 7:9cd16581b578 185 result = master->start(address_ | 1);
IanBenzMaxim 7:9cd16581b578 186 if (result) {
IanBenzMaxim 7:9cd16581b578 187 master->stop();
IanBenzMaxim 7:9cd16581b578 188 return result;
IanBenzMaxim 7:9cd16581b578 189 }
IanBenzMaxim 7:9cd16581b578 190 uint_least8_t length;
IanBenzMaxim 7:9cd16581b578 191 result = master->readByte(I2CMaster::Ack, length);
IanBenzMaxim 7:9cd16581b578 192 if (result) {
IanBenzMaxim 7:9cd16581b578 193 master->stop();
IanBenzMaxim 7:9cd16581b578 194 return result;
IanBenzMaxim 7:9cd16581b578 195 }
IanBenzMaxim 7:9cd16581b578 196 if (length > response.size()) {
IanBenzMaxim 7:9cd16581b578 197 master->stop();
IanBenzMaxim 7:9cd16581b578 198 return make_error_code(InvalidResponseError);
IanBenzMaxim 7:9cd16581b578 199 }
IanBenzMaxim 7:9cd16581b578 200 response = response.first(length);
IanBenzMaxim 7:9cd16581b578 201 result = master->readBlock(I2CMaster::Nack, response);
IanBenzMaxim 7:9cd16581b578 202 if (result) {
IanBenzMaxim 7:9cd16581b578 203 master->stop();
IanBenzMaxim 7:9cd16581b578 204 return result;
IanBenzMaxim 7:9cd16581b578 205 }
IanBenzMaxim 7:9cd16581b578 206 result = master->stop();
IanBenzMaxim 7:9cd16581b578 207 return result;
IanBenzMaxim 7:9cd16581b578 208 }
IanBenzMaxim 7:9cd16581b578 209
IanBenzMaxim 7:9cd16581b578 210 } // namespace MaximInterfaceCore