I2CMaster.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 MaximInterfaceMbed_I2CMaster_hpp
00034 #define MaximInterfaceMbed_I2CMaster_hpp
00035 
00036 #include <MaximInterfaceCore/I2CMaster.hpp>
00037 #include <mbed-os/drivers/I2C.h>
00038 
00039 namespace MaximInterfaceMbed {
00040 
00041 /// Wrapper for mbed::I2C.
00042 class I2CMaster : public MaximInterfaceCore::I2CMaster {
00043 public:
00044   explicit I2CMaster(mbed::I2C & i2c) : i2c(&i2c) {}
00045 
00046   void setI2C(mbed::I2C & i2c) { this->i2c = &i2c; }
00047 
00048   virtual MaximInterfaceCore::Result<void> start(uint_least8_t address);
00049 
00050   virtual MaximInterfaceCore::Result<void> stop();
00051 
00052   virtual MaximInterfaceCore::Result<void> writeByte(uint_least8_t data);
00053 
00054   virtual MaximInterfaceCore::Result<void>
00055   writePacket(uint_least8_t address,
00056               MaximInterfaceCore::span<const uint_least8_t> data,
00057               DoStop doStop);
00058 
00059   virtual MaximInterfaceCore::Result<uint_least8_t> readByte(DoAck doAck);
00060 
00061   virtual MaximInterfaceCore::Result<void>
00062   readPacket(uint_least8_t address,
00063              MaximInterfaceCore::span<uint_least8_t> data, DoStop doStop);
00064 
00065 private:
00066   mbed::I2C * i2c;
00067 };
00068 
00069 } // namespace MaximInterfaceMbed
00070 
00071 #endif