I2CMaster.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 "I2CMaster.hpp"
00035 
00036 namespace MaximInterfaceCore {
00037 
00038 Result<void> I2CMaster::writeBlock(span<const uint_least8_t> data) {
00039   for (span<const uint_least8_t>::index_type i = 0; i < data.size(); ++i) {
00040     MaximInterfaceCore_TRY(writeByte(data[i]));
00041   }
00042   return none;
00043 }
00044 
00045 Result<void> I2CMaster::writePacket(uint_least8_t address,
00046                                     span<const uint_least8_t> data,
00047                                     DoStop doStop) {
00048   Result<void> result = start(address & 0xFE);
00049   if (result) {
00050     result = writeBlock(data);
00051   }
00052   if (doStop == Stop || (doStop == StopOnError && !result)) {
00053     const Result<void> stopResult = stop();
00054     if (result) {
00055       result = stopResult;
00056     }
00057   }
00058   return result;
00059 }
00060 
00061 Result<void> I2CMaster::readBlock(span<uint_least8_t> data, DoAck doAck) {
00062   for (span<uint_least8_t>::index_type i = 0; i < data.size(); ++i) {
00063     MaximInterfaceCore_TRY_VALUE(
00064         data[i], readByte(i == (data.size() - 1) ? doAck : Ack));
00065   }
00066   return none;
00067 }
00068 
00069 Result<void> I2CMaster::readPacket(uint_least8_t address,
00070                                    span<uint_least8_t> data, DoStop doStop) {
00071   Result<void> result = start(address | 0x01);
00072   if (result) {
00073     result = readBlock(data, Nack);
00074   }
00075   if (doStop == Stop || (doStop == StopOnError && !result)) {
00076     const Result<void> stopResult = stop();
00077     if (result) {
00078       result = stopResult;
00079     }
00080   }
00081   return result;
00082 }
00083 
00084 const error_category & I2CMaster::errorCategory() {
00085   static class : public error_category {
00086   public:
00087     virtual const char * name() const {
00088       return "MaximInterfaceCore.I2CMaster";
00089     }
00090 
00091     virtual std::string message(int condition) const {
00092       switch (condition) {
00093       case NackError:
00094         return "Nack Error";
00095       }
00096       return defaultErrorMessage(condition);
00097     }
00098   } instance;
00099   return instance;
00100 }
00101 
00102 } // namespace MaximInterfaceCore