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/OneWireMaster.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 "Error.hpp"
IanBenzMaxim 7:9cd16581b578 34 #include "OneWireMaster.hpp"
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 37
IanBenzMaxim 7:9cd16581b578 38 static const int maxBitNum = 7;
IanBenzMaxim 7:9cd16581b578 39
IanBenzMaxim 7:9cd16581b578 40 error_code OneWireMaster::writeByteSetLevel(uint_least8_t sendByte,
IanBenzMaxim 7:9cd16581b578 41 Level afterLevel) {
IanBenzMaxim 7:9cd16581b578 42 error_code result;
IanBenzMaxim 7:9cd16581b578 43 for (int bitNum = 0; (bitNum <= maxBitNum) && !result; ++bitNum) {
IanBenzMaxim 7:9cd16581b578 44 result = writeBitSetLevel(((sendByte >> bitNum) & 1) == 1,
IanBenzMaxim 7:9cd16581b578 45 (bitNum == maxBitNum) ? afterLevel : NormalLevel);
IanBenzMaxim 7:9cd16581b578 46 }
IanBenzMaxim 7:9cd16581b578 47 return result;
IanBenzMaxim 7:9cd16581b578 48 }
IanBenzMaxim 7:9cd16581b578 49
IanBenzMaxim 7:9cd16581b578 50 error_code OneWireMaster::readByteSetLevel(uint_least8_t & recvByte,
IanBenzMaxim 7:9cd16581b578 51 Level afterLevel) {
IanBenzMaxim 7:9cd16581b578 52 recvByte = 0;
IanBenzMaxim 7:9cd16581b578 53 error_code result;
IanBenzMaxim 7:9cd16581b578 54 for (int bitNum = 0; bitNum <= maxBitNum; ++bitNum) {
IanBenzMaxim 7:9cd16581b578 55 bool recvBit;
IanBenzMaxim 7:9cd16581b578 56 result = readBitSetLevel(recvBit,
IanBenzMaxim 7:9cd16581b578 57 (bitNum == maxBitNum) ? afterLevel : NormalLevel);
IanBenzMaxim 7:9cd16581b578 58 if (result) {
IanBenzMaxim 7:9cd16581b578 59 break;
IanBenzMaxim 7:9cd16581b578 60 }
IanBenzMaxim 7:9cd16581b578 61 if (recvBit) {
IanBenzMaxim 7:9cd16581b578 62 recvByte |= (1 << bitNum);
IanBenzMaxim 7:9cd16581b578 63 }
IanBenzMaxim 7:9cd16581b578 64 }
IanBenzMaxim 7:9cd16581b578 65 return result;
IanBenzMaxim 7:9cd16581b578 66 }
IanBenzMaxim 7:9cd16581b578 67
IanBenzMaxim 7:9cd16581b578 68 error_code OneWireMaster::writeBlock(span<const uint_least8_t> sendBuf) {
IanBenzMaxim 7:9cd16581b578 69 error_code result;
IanBenzMaxim 7:9cd16581b578 70 for (span<const uint_least8_t>::index_type i = 0;
IanBenzMaxim 7:9cd16581b578 71 i < sendBuf.size() && !result; ++i) {
IanBenzMaxim 7:9cd16581b578 72 result = writeByte(sendBuf[i]);
IanBenzMaxim 7:9cd16581b578 73 }
IanBenzMaxim 7:9cd16581b578 74 return result;
IanBenzMaxim 7:9cd16581b578 75 }
IanBenzMaxim 7:9cd16581b578 76
IanBenzMaxim 7:9cd16581b578 77 error_code OneWireMaster::readBlock(span<uint_least8_t> recvBuf) {
IanBenzMaxim 7:9cd16581b578 78 error_code result;
IanBenzMaxim 7:9cd16581b578 79 for (span<uint_least8_t>::index_type i = 0; i < recvBuf.size() && !result;
IanBenzMaxim 7:9cd16581b578 80 ++i) {
IanBenzMaxim 7:9cd16581b578 81 result = readByte(recvBuf[i]);
IanBenzMaxim 7:9cd16581b578 82 }
IanBenzMaxim 7:9cd16581b578 83 return result;
IanBenzMaxim 7:9cd16581b578 84 }
IanBenzMaxim 7:9cd16581b578 85
IanBenzMaxim 7:9cd16581b578 86 error_code OneWireMaster::triplet(TripletData & data) {
IanBenzMaxim 7:9cd16581b578 87 error_code result = readBit(data.readBit);
IanBenzMaxim 7:9cd16581b578 88 if (!result) {
IanBenzMaxim 7:9cd16581b578 89 result = readBit(data.readBitComplement);
IanBenzMaxim 7:9cd16581b578 90 }
IanBenzMaxim 7:9cd16581b578 91 if (!result) {
IanBenzMaxim 7:9cd16581b578 92 if (data.readBit) {
IanBenzMaxim 7:9cd16581b578 93 data.writeBit = 1;
IanBenzMaxim 7:9cd16581b578 94 } else if (data.readBitComplement) {
IanBenzMaxim 7:9cd16581b578 95 data.writeBit = 0;
IanBenzMaxim 7:9cd16581b578 96 }
IanBenzMaxim 7:9cd16581b578 97 // else: use data.writeBit parameter
IanBenzMaxim 7:9cd16581b578 98 result = writeBit(data.writeBit);
IanBenzMaxim 7:9cd16581b578 99 }
IanBenzMaxim 7:9cd16581b578 100 return result;
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 7:9cd16581b578 102
IanBenzMaxim 7:9cd16581b578 103 const error_category & OneWireMaster::errorCategory() {
IanBenzMaxim 7:9cd16581b578 104 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 105 public:
IanBenzMaxim 7:9cd16581b578 106 virtual const char * name() const { return "OneWireMaster"; }
IanBenzMaxim 7:9cd16581b578 107
IanBenzMaxim 7:9cd16581b578 108 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 109 switch (condition) {
IanBenzMaxim 7:9cd16581b578 110 case NoSlaveError:
IanBenzMaxim 7:9cd16581b578 111 return "No Slave Error";
IanBenzMaxim 7:9cd16581b578 112
IanBenzMaxim 7:9cd16581b578 113 case ShortDetectedError:
IanBenzMaxim 7:9cd16581b578 114 return "Short Detected Error";
IanBenzMaxim 7:9cd16581b578 115
IanBenzMaxim 7:9cd16581b578 116 case InvalidSpeedError:
IanBenzMaxim 7:9cd16581b578 117 return "Invalid Speed Error";
IanBenzMaxim 7:9cd16581b578 118
IanBenzMaxim 7:9cd16581b578 119 case InvalidLevelError:
IanBenzMaxim 7:9cd16581b578 120 return "Invalid Level Error";
IanBenzMaxim 7:9cd16581b578 121
IanBenzMaxim 7:9cd16581b578 122 default:
IanBenzMaxim 7:9cd16581b578 123 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 124 }
IanBenzMaxim 7:9cd16581b578 125 }
IanBenzMaxim 7:9cd16581b578 126 } instance;
IanBenzMaxim 7:9cd16581b578 127 return instance;
IanBenzMaxim 7:9cd16581b578 128 }
IanBenzMaxim 7:9cd16581b578 129
IanBenzMaxim 7:9cd16581b578 130 } // namespace MaximInterfaceCore