OneWireMaster.cpp

00001 /*******************************************************************************
00002 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #include <MaximInterface/Utilities/Error.hpp>
00034 #include "OneWireMaster.hpp"
00035 
00036 namespace MaximInterface {
00037 
00038 static const int maxBitNum = 7;
00039 
00040 error_code OneWireMaster::writeByteSetLevel(uint_least8_t sendByte,
00041                                             Level afterLevel) {
00042   error_code result;
00043   for (int bitNum = 0; (bitNum <= maxBitNum) && !result; ++bitNum) {
00044     result = writeBitSetLevel(((sendByte >> bitNum) & 1) == 1,
00045                               (bitNum == maxBitNum) ? afterLevel : NormalLevel);
00046   }
00047   return result;
00048 }
00049 
00050 error_code OneWireMaster::readByteSetLevel(uint_least8_t & recvByte,
00051                                            Level afterLevel) {
00052   recvByte = 0;
00053   error_code result;
00054   for (int bitNum = 0; bitNum <= maxBitNum; ++bitNum) {
00055     bool recvBit;
00056     result = readBitSetLevel(recvBit,
00057                              (bitNum == maxBitNum) ? afterLevel : NormalLevel);
00058     if (result) {
00059       break;
00060     }
00061     if (recvBit) {
00062       recvByte |= (1 << bitNum);
00063     }
00064   }
00065   return result;
00066 }
00067 
00068 error_code OneWireMaster::writeBlock(span<const uint_least8_t> sendBuf) {
00069   error_code result;
00070   for (span<const uint_least8_t>::index_type i = 0;
00071        i < sendBuf.size() && !result; ++i) {
00072     result = writeByte(sendBuf[i]);
00073   }
00074   return result;
00075 }
00076 
00077 error_code OneWireMaster::readBlock(span<uint_least8_t> recvBuf) {
00078   error_code result;
00079   for (span<uint_least8_t>::index_type i = 0; i < recvBuf.size() && !result;
00080        ++i) {
00081     result = readByte(recvBuf[i]);
00082   }
00083   return result;
00084 }
00085 
00086 error_code OneWireMaster::triplet(TripletData & data) {
00087   error_code result = readBit(data.readBit);
00088   if (!result) {
00089     result = readBit(data.readBitComplement);
00090   }
00091   if (!result) {
00092     if (data.readBit) {
00093       data.writeBit = 1;
00094     } else if (data.readBitComplement) {
00095       data.writeBit = 0;
00096     }
00097     // else: use data.writeBit parameter
00098     result = writeBit(data.writeBit);
00099   }
00100   return result;
00101 }
00102 
00103 const error_category & OneWireMaster::errorCategory() {
00104   static class : public error_category {
00105   public:
00106     virtual const char * name() const { return "OneWireMaster"; }
00107 
00108     virtual std::string message(int condition) const {
00109       switch (condition) {
00110       case NoSlaveError:
00111         return "No Slave Error";
00112 
00113       case ShortDetectedError:
00114         return "Short Detected Error";
00115 
00116       case InvalidSpeedError:
00117         return "Invalid Speed Error";
00118 
00119       case InvalidLevelError:
00120         return "Invalid Level Error";
00121 
00122       default:
00123         return defaultErrorMessage(condition);
00124       }
00125     }
00126   } instance;
00127   return instance;
00128 }
00129 
00130 } // namespace MaximInterface