LoggingI2CMaster.hpp

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 #ifndef MaximInterfaceCore_LoggingI2CMaster_hpp
00034 #define MaximInterfaceCore_LoggingI2CMaster_hpp
00035 
00036 #include <string>
00037 #include "Config.hpp"
00038 #include "I2CMasterDecorator.hpp"
00039 #include "WriteMessage.hpp"
00040 
00041 namespace MaximInterfaceCore {
00042 
00043 class LoggingI2CMaster : public I2CMasterDecorator {
00044 public:
00045   explicit LoggingI2CMaster(I2CMaster & i2c,
00046                             const WriteMessage & writeMessage = WriteMessage())
00047       : I2CMasterDecorator(i2c), writeMessage(writeMessage), messageBuilder() {}
00048 
00049   void setWriteMessage(const WriteMessage & writeMessage) {
00050     this->writeMessage = writeMessage;
00051   }
00052 
00053   MaximInterfaceCore_EXPORT virtual Result<void> start(uint_least8_t address);
00054 
00055   MaximInterfaceCore_EXPORT virtual Result<void> stop();
00056 
00057   MaximInterfaceCore_EXPORT virtual Result<void> writeByte(uint_least8_t data);
00058 
00059   MaximInterfaceCore_EXPORT virtual Result<void>
00060   writeBlock(span<const uint_least8_t> data);
00061 
00062   MaximInterfaceCore_EXPORT virtual Result<void>
00063   writePacket(uint_least8_t address, span<const uint_least8_t> data,
00064               DoStop doStop);
00065 
00066   MaximInterfaceCore_EXPORT virtual Result<uint_least8_t> readByte(DoAck doAck);
00067 
00068   MaximInterfaceCore_EXPORT virtual Result<void>
00069   readBlock(span<uint_least8_t> data, DoAck doAck);
00070 
00071   MaximInterfaceCore_EXPORT virtual Result<void>
00072   readPacket(uint_least8_t address, span<uint_least8_t> data, DoStop doStop);
00073 
00074 private:
00075   void tryWriteMessage();
00076 
00077   WriteMessage writeMessage;
00078   std::string messageBuilder;
00079 };
00080 
00081 } // namespace MaximInterfaceCore
00082 
00083 #endif