Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers I2CMaster.hpp Source File

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 MaximInterfaceCore_I2CMaster_hpp
00034 #define MaximInterfaceCore_I2CMaster_hpp
00035 
00036 #include <stdint.h>
00037 #include "Config.hpp"
00038 #include "Result.hpp"
00039 #include "span.hpp"
00040 #include "system_error.hpp"
00041 
00042 namespace MaximInterfaceCore {
00043 
00044 /// I2C master interface.
00045 class I2CMaster {
00046 public:
00047   enum ErrorValue  {
00048     NackError = 1 ///< Transaction stopped due to a NACK from the slave device.
00049   };
00050 
00051   enum DoAck { Ack, Nack };
00052 
00053   enum DoStop { Stop, StopOnError, NoStop };
00054 
00055   virtual ~I2CMaster() {}
00056 
00057   /// @brief Send start condition and address on the bus.
00058   /// @param address Address with R/W bit.
00059   virtual Result<void> start(uint_least8_t address) = 0;
00060 
00061   /// Send stop condition on the bus.
00062   virtual Result<void> stop() = 0;
00063 
00064   /// Write data byte to the bus.
00065   virtual Result<void> writeByte(uint_least8_t data) = 0;
00066 
00067   /// Write data block to the bus.
00068   MaximInterfaceCore_EXPORT virtual Result<void>
00069   writeBlock(span<const uint_least8_t> data);
00070 
00071   /// @brief Perform a complete write transaction on the bus.
00072   /// @param address Address in 8-bit format.
00073   /// @param data Data to write to the bus.
00074   /// @param doStop
00075   /// Determines whether to do a stop condition or set up a repeated start.
00076   MaximInterfaceCore_EXPORT virtual Result<void>
00077   writePacket(uint_least8_t address, span<const uint_least8_t> data,
00078               DoStop doStop);
00079 
00080   /// @brief Read data byte from the bus.
00081   /// @param doAck Determines whether an ACK or NACK is done after reading.
00082   /// @returns data Data read from the bus if successful.
00083   virtual Result<uint_least8_t> readByte(DoAck doAck) = 0;
00084 
00085   /// @brief Read data block from the bus.
00086   /// @param[out] data Data read from the bus if successful.
00087   /// @param doAck Determines whether an ACK or NACK is done after reading.
00088   MaximInterfaceCore_EXPORT virtual Result<void>
00089   readBlock(span<uint_least8_t> data, DoAck doAck);
00090 
00091   /// @brief Perform a complete read transaction on the bus.
00092   /// @param address Address in 8-bit format.
00093   /// @param[out] data Data read from the bus if successful.
00094   /// @param doStop
00095   /// Determines whether to do a stop condition or set up a repeated start.
00096   MaximInterfaceCore_EXPORT virtual Result<void>
00097   readPacket(uint_least8_t address, span<uint_least8_t> data, DoStop doStop);
00098 
00099   MaximInterfaceCore_EXPORT static const error_category & errorCategory();
00100 };
00101 
00102 template <> struct is_error_code_enum<I2CMaster::ErrorValue> : true_type {};
00103 
00104 inline error_code make_error_code(I2CMaster::ErrorValue  e) {
00105   return error_code(e, I2CMaster::errorCategory());
00106 }
00107 
00108 inline error_condition make_error_condition(I2CMaster::ErrorValue  e) {
00109   return error_condition(e, I2CMaster::errorCategory());
00110 }
00111 
00112 } // namespace MaximInterfaceCore
00113 
00114 #endif