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@10:947d3f44e0a0, 2019-09-30 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Sep 30 09:39:32 2019 -0500
Revision:
10:947d3f44e0a0
Parent:
8:5ea891c7d1a1
Child:
11:3f3bf6bf5e6c
Updated to trunk revision 26658.

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 8:5ea891c7d1a1 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 8:5ea891c7d1a1 61 Result<span<uint_least8_t> > RunCommandWithOneWireMaster::
IanBenzMaxim 7:9cd16581b578 62 operator()(span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 63 span<uint_least8_t> response) const {
IanBenzMaxim 7:9cd16581b578 64 // Write request.
IanBenzMaxim 8:5ea891c7d1a1 65 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 66 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 67 return result.error();
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 8:5ea891c7d1a1 72 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 73 return result.error();
IanBenzMaxim 7:9cd16581b578 74 }
IanBenzMaxim 7:9cd16581b578 75 result = master->writeBlock(request);
IanBenzMaxim 8:5ea891c7d1a1 76 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 77 return result.error();
IanBenzMaxim 7:9cd16581b578 78 }
IanBenzMaxim 7:9cd16581b578 79 uint_fast16_t expectedCrc =
IanBenzMaxim 10:947d3f44e0a0 80 calculateCrc16(calculateCrc16(xpcBuffer), request) ^ 0xFFFF;
IanBenzMaxim 7:9cd16581b578 81 result = master->readBlock(xpcBuffer);
IanBenzMaxim 8:5ea891c7d1a1 82 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 83 return result.error();
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 8:5ea891c7d1a1 87 return CrcError;
IanBenzMaxim 7:9cd16581b578 88 }
IanBenzMaxim 7:9cd16581b578 89 result = master->writeBytePower(0xAA);
IanBenzMaxim 8:5ea891c7d1a1 90 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 91 return result.error();
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 8:5ea891c7d1a1 99 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 100 return result.error();
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 7:9cd16581b578 102 result = master->readBlock(xpcBuffer);
IanBenzMaxim 8:5ea891c7d1a1 103 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 104 return result.error();
IanBenzMaxim 7:9cd16581b578 105 }
IanBenzMaxim 7:9cd16581b578 106 if (xpcBuffer[1] > response.size()) {
IanBenzMaxim 8:5ea891c7d1a1 107 return InvalidResponseError;
IanBenzMaxim 7:9cd16581b578 108 }
IanBenzMaxim 7:9cd16581b578 109 response = response.first(xpcBuffer[1]);
IanBenzMaxim 7:9cd16581b578 110 result = master->readBlock(response);
IanBenzMaxim 8:5ea891c7d1a1 111 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 112 return result.error();
IanBenzMaxim 7:9cd16581b578 113 }
IanBenzMaxim 7:9cd16581b578 114 expectedCrc =
IanBenzMaxim 7:9cd16581b578 115 calculateCrc16(calculateCrc16(make_span(xpcBuffer + 1, 1)), response) ^
IanBenzMaxim 10:947d3f44e0a0 116 0xFFFF;
IanBenzMaxim 7:9cd16581b578 117 result = master->readBlock(xpcBuffer);
IanBenzMaxim 8:5ea891c7d1a1 118 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 119 return result.error();
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 8:5ea891c7d1a1 123 return CrcError;
IanBenzMaxim 7:9cd16581b578 124 }
IanBenzMaxim 8:5ea891c7d1a1 125 return response;
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 8:5ea891c7d1a1 144 Result<span<uint_least8_t> > RunCommandWithI2CMaster::
IanBenzMaxim 7:9cd16581b578 145 operator()(span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 146 span<uint_least8_t> response) const {
IanBenzMaxim 7:9cd16581b578 147 // Write request.
IanBenzMaxim 8:5ea891c7d1a1 148 Result<void> result = master->start(address_);
IanBenzMaxim 8:5ea891c7d1a1 149 if (!result && result.error() == make_error_condition(I2CMaster::NackError) &&
IanBenzMaxim 8:5ea891c7d1a1 150 address_ != 0) {
IanBenzMaxim 7:9cd16581b578 151 result = master->start(0);
IanBenzMaxim 7:9cd16581b578 152 }
IanBenzMaxim 8:5ea891c7d1a1 153 if (!result) {
IanBenzMaxim 7:9cd16581b578 154 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 155 return result.error();
IanBenzMaxim 7:9cd16581b578 156 }
IanBenzMaxim 7:9cd16581b578 157 if (!request.empty()) {
IanBenzMaxim 7:9cd16581b578 158 result = master->writeByte(request[0]);
IanBenzMaxim 8:5ea891c7d1a1 159 if (!result) {
IanBenzMaxim 7:9cd16581b578 160 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 161 return result.error();
IanBenzMaxim 7:9cd16581b578 162 }
IanBenzMaxim 7:9cd16581b578 163 request = request.subspan(1);
IanBenzMaxim 7:9cd16581b578 164 if (!request.empty()) {
IanBenzMaxim 7:9cd16581b578 165 result = master->writeByte(static_cast<uint_least8_t>(request.size()));
IanBenzMaxim 8:5ea891c7d1a1 166 if (!result) {
IanBenzMaxim 7:9cd16581b578 167 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 168 return result.error();
IanBenzMaxim 7:9cd16581b578 169 }
IanBenzMaxim 7:9cd16581b578 170 result = master->writeBlock(request);
IanBenzMaxim 8:5ea891c7d1a1 171 if (!result) {
IanBenzMaxim 7:9cd16581b578 172 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 173 return result.error();
IanBenzMaxim 7:9cd16581b578 174 }
IanBenzMaxim 7:9cd16581b578 175 }
IanBenzMaxim 7:9cd16581b578 176 }
IanBenzMaxim 7:9cd16581b578 177 result = master->stop();
IanBenzMaxim 8:5ea891c7d1a1 178 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 179 return result.error();
IanBenzMaxim 7:9cd16581b578 180 }
IanBenzMaxim 7:9cd16581b578 181
IanBenzMaxim 7:9cd16581b578 182 // Wait for device to process.
IanBenzMaxim 7:9cd16581b578 183 sleep->invoke(delayTime);
IanBenzMaxim 7:9cd16581b578 184
IanBenzMaxim 7:9cd16581b578 185 // Read response.
IanBenzMaxim 7:9cd16581b578 186 result = master->start(address_ | 1);
IanBenzMaxim 8:5ea891c7d1a1 187 if (!result) {
IanBenzMaxim 7:9cd16581b578 188 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 189 return result.error();
IanBenzMaxim 7:9cd16581b578 190 }
IanBenzMaxim 7:9cd16581b578 191 uint_least8_t length;
IanBenzMaxim 8:5ea891c7d1a1 192 if (const Result<uint_least8_t> result = master->readByte(I2CMaster::Ack)) {
IanBenzMaxim 8:5ea891c7d1a1 193 length = result.value();
IanBenzMaxim 8:5ea891c7d1a1 194 } else {
IanBenzMaxim 7:9cd16581b578 195 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 196 return result.error();
IanBenzMaxim 7:9cd16581b578 197 }
IanBenzMaxim 7:9cd16581b578 198 if (length > response.size()) {
IanBenzMaxim 7:9cd16581b578 199 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 200 return InvalidResponseError;
IanBenzMaxim 7:9cd16581b578 201 }
IanBenzMaxim 7:9cd16581b578 202 response = response.first(length);
IanBenzMaxim 8:5ea891c7d1a1 203 result = master->readBlock(response, I2CMaster::Nack);
IanBenzMaxim 8:5ea891c7d1a1 204 if (!result) {
IanBenzMaxim 7:9cd16581b578 205 master->stop();
IanBenzMaxim 8:5ea891c7d1a1 206 return result.error();
IanBenzMaxim 7:9cd16581b578 207 }
IanBenzMaxim 7:9cd16581b578 208 result = master->stop();
IanBenzMaxim 8:5ea891c7d1a1 209 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 210 return result.error();
IanBenzMaxim 8:5ea891c7d1a1 211 }
IanBenzMaxim 8:5ea891c7d1a1 212 return response;
IanBenzMaxim 7:9cd16581b578 213 }
IanBenzMaxim 7:9cd16581b578 214
IanBenzMaxim 7:9cd16581b578 215 } // namespace MaximInterfaceCore