OneWireMaster.cpp

00001 /*******************************************************************************
00002 * Copyright (C) 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 "Error.hpp"
00034 #include "OneWireMaster.hpp"
00035 
00036 #define TRY MaximInterfaceCore_TRY
00037 #define TRY_VALUE MaximInterfaceCore_TRY_VALUE
00038 
00039 namespace MaximInterfaceCore {
00040 
00041 static const int maxBitNum = 7;
00042 
00043 Result<void> OneWireMaster::writeByteSetLevel(uint_least8_t sendByte,
00044                                               Level afterLevel) {
00045   for (int bitNum = 0; bitNum <= maxBitNum; ++bitNum) {
00046     TRY(writeBitSetLevel(((sendByte >> bitNum) & 1) == 1,
00047                          (bitNum == maxBitNum) ? afterLevel : NormalLevel));
00048   }
00049   return none;
00050 }
00051 
00052 Result<uint_least8_t> OneWireMaster::readByteSetLevel(Level afterLevel) {
00053   uint_least8_t recvByte = 0;
00054   for (int bitNum = 0; bitNum <= maxBitNum; ++bitNum) {
00055     bool recvBit;
00056     TRY_VALUE(recvBit, readBitSetLevel((bitNum == maxBitNum) ? afterLevel
00057                                                              : NormalLevel));
00058     if (recvBit) {
00059       recvByte |= (1 << bitNum);
00060     }
00061   }
00062   return recvByte;
00063 }
00064 
00065 Result<void> OneWireMaster::writeBlock(span<const uint_least8_t> sendBuf) {
00066   for (span<const uint_least8_t>::index_type i = 0; i < sendBuf.size(); ++i) {
00067     TRY(writeByte(sendBuf[i]));
00068   }
00069   return none;
00070 }
00071 
00072 Result<void> OneWireMaster::readBlock(span<uint_least8_t> recvBuf) {
00073   for (span<uint_least8_t>::index_type i = 0; i < recvBuf.size(); ++i) {
00074     TRY_VALUE(recvBuf[i], readByte());
00075   }
00076   return none;
00077 }
00078 
00079 Result<OneWireMaster::TripletData> OneWireMaster::triplet(bool sendBit) {
00080   TripletData data;
00081   TRY_VALUE(data.readBit, readBit());
00082   TRY_VALUE(data.readBitComplement, readBit());
00083   if (data.readBit) {
00084     data.writeBit = 1;
00085   } else if (data.readBitComplement) {
00086     data.writeBit = 0;
00087   } else {
00088     data.writeBit = sendBit;
00089   }
00090   TRY(writeBit(data.writeBit));
00091   return data;
00092 }
00093 
00094 const error_category & OneWireMaster::errorCategory() {
00095   static class : public error_category {
00096   public:
00097     virtual const char * name() const {
00098       return "MaximInterfaceCore.OneWireMaster";
00099     }
00100 
00101     virtual std::string message(int condition) const {
00102       switch (condition) {
00103       case NoSlaveError:
00104         return "No Slave Error";
00105 
00106       case ShortDetectedError:
00107         return "Short Detected Error";
00108 
00109       case InvalidSpeedError:
00110         return "Invalid Speed Error";
00111 
00112       case InvalidLevelError:
00113         return "Invalid Level Error";
00114       }
00115       return defaultErrorMessage(condition);
00116     }
00117   } instance;
00118   return instance;
00119 }
00120 
00121 } // namespace MaximInterfaceCore