Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceCore/I2CMaster.hpp@12:7eb41621ba22, 2020-05-29 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 29 16:19:22 2020 -0500
Revision:
12:7eb41621ba22
Parent:
8:5ea891c7d1a1 
Updated to version 2.2.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 8:5ea891c7d1a1 33 #ifndef MaximInterfaceCore_I2CMaster_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceCore_I2CMaster_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <stdint.h>
IanBenzMaxim 7:9cd16581b578 37 #include "Config.hpp"
IanBenzMaxim 8:5ea891c7d1a1 38 #include "Result.hpp"
IanBenzMaxim 7:9cd16581b578 39 #include "span.hpp"
IanBenzMaxim 7:9cd16581b578 40 #include "system_error.hpp"
IanBenzMaxim 7:9cd16581b578 41
IanBenzMaxim 7:9cd16581b578 42 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 7:9cd16581b578 44 /// I2C master interface.
IanBenzMaxim 7:9cd16581b578 45 class I2CMaster {
IanBenzMaxim 7:9cd16581b578 46 public:
IanBenzMaxim 7:9cd16581b578 47 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 48 NackError = 1 ///< Transaction stopped due to a NACK from the slave device.
IanBenzMaxim 7:9cd16581b578 49 };
IanBenzMaxim 7:9cd16581b578 50
IanBenzMaxim 8:5ea891c7d1a1 51 enum DoAck { Ack, Nack };
IanBenzMaxim 8:5ea891c7d1a1 52
IanBenzMaxim 8:5ea891c7d1a1 53 enum DoStop { Stop, StopOnError, NoStop };
IanBenzMaxim 7:9cd16581b578 54
IanBenzMaxim 7:9cd16581b578 55 virtual ~I2CMaster() {}
IanBenzMaxim 7:9cd16581b578 56
IanBenzMaxim 7:9cd16581b578 57 /// @brief Send start condition and address on the bus.
IanBenzMaxim 7:9cd16581b578 58 /// @param address Address with R/W bit.
IanBenzMaxim 8:5ea891c7d1a1 59 virtual Result<void> start(uint_least8_t address) = 0;
IanBenzMaxim 7:9cd16581b578 60
IanBenzMaxim 7:9cd16581b578 61 /// Send stop condition on the bus.
IanBenzMaxim 8:5ea891c7d1a1 62 virtual Result<void> stop() = 0;
IanBenzMaxim 7:9cd16581b578 63
IanBenzMaxim 7:9cd16581b578 64 /// Write data byte to the bus.
IanBenzMaxim 8:5ea891c7d1a1 65 virtual Result<void> writeByte(uint_least8_t data) = 0;
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 7:9cd16581b578 67 /// Write data block to the bus.
IanBenzMaxim 8:5ea891c7d1a1 68 MaximInterfaceCore_EXPORT virtual Result<void>
IanBenzMaxim 7:9cd16581b578 69 writeBlock(span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 70
IanBenzMaxim 8:5ea891c7d1a1 71 /// @brief Perform a complete write transaction on the bus.
IanBenzMaxim 7:9cd16581b578 72 /// @param address Address in 8-bit format.
IanBenzMaxim 7:9cd16581b578 73 /// @param data Data to write to the bus.
IanBenzMaxim 8:5ea891c7d1a1 74 /// @param doStop
IanBenzMaxim 8:5ea891c7d1a1 75 /// Determines whether to do a stop condition or set up a repeated start.
IanBenzMaxim 8:5ea891c7d1a1 76 MaximInterfaceCore_EXPORT virtual Result<void>
IanBenzMaxim 8:5ea891c7d1a1 77 writePacket(uint_least8_t address, span<const uint_least8_t> data,
IanBenzMaxim 8:5ea891c7d1a1 78 DoStop doStop);
IanBenzMaxim 7:9cd16581b578 79
IanBenzMaxim 7:9cd16581b578 80 /// @brief Read data byte from the bus.
IanBenzMaxim 8:5ea891c7d1a1 81 /// @param doAck Determines whether an ACK or NACK is done after reading.
IanBenzMaxim 8:5ea891c7d1a1 82 /// @returns data Data read from the bus if successful.
IanBenzMaxim 8:5ea891c7d1a1 83 virtual Result<uint_least8_t> readByte(DoAck doAck) = 0;
IanBenzMaxim 7:9cd16581b578 84
IanBenzMaxim 7:9cd16581b578 85 /// @brief Read data block from the bus.
IanBenzMaxim 7:9cd16581b578 86 /// @param[out] data Data read from the bus if successful.
IanBenzMaxim 8:5ea891c7d1a1 87 /// @param doAck Determines whether an ACK or NACK is done after reading.
IanBenzMaxim 8:5ea891c7d1a1 88 MaximInterfaceCore_EXPORT virtual Result<void>
IanBenzMaxim 8:5ea891c7d1a1 89 readBlock(span<uint_least8_t> data, DoAck doAck);
IanBenzMaxim 7:9cd16581b578 90
IanBenzMaxim 8:5ea891c7d1a1 91 /// @brief Perform a complete read transaction on the bus.
IanBenzMaxim 7:9cd16581b578 92 /// @param address Address in 8-bit format.
IanBenzMaxim 7:9cd16581b578 93 /// @param[out] data Data read from the bus if successful.
IanBenzMaxim 8:5ea891c7d1a1 94 /// @param doStop
IanBenzMaxim 8:5ea891c7d1a1 95 /// Determines whether to do a stop condition or set up a repeated start.
IanBenzMaxim 8:5ea891c7d1a1 96 MaximInterfaceCore_EXPORT virtual Result<void>
IanBenzMaxim 8:5ea891c7d1a1 97 readPacket(uint_least8_t address, span<uint_least8_t> data, DoStop doStop);
IanBenzMaxim 7:9cd16581b578 98
IanBenzMaxim 7:9cd16581b578 99 MaximInterfaceCore_EXPORT static const error_category & errorCategory();
IanBenzMaxim 8:5ea891c7d1a1 100 };
IanBenzMaxim 7:9cd16581b578 101
IanBenzMaxim 8:5ea891c7d1a1 102 template <> struct is_error_code_enum<I2CMaster::ErrorValue> : true_type {};
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 inline error_code make_error_code(I2CMaster::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 105 return error_code(e, I2CMaster::errorCategory());
IanBenzMaxim 7:9cd16581b578 106 }
IanBenzMaxim 7:9cd16581b578 107
IanBenzMaxim 7:9cd16581b578 108 inline error_condition make_error_condition(I2CMaster::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 109 return error_condition(e, I2CMaster::errorCategory());
IanBenzMaxim 7:9cd16581b578 110 }
IanBenzMaxim 7:9cd16581b578 111
IanBenzMaxim 7:9cd16581b578 112 } // namespace MaximInterfaceCore
IanBenzMaxim 7:9cd16581b578 113
IanBenzMaxim 7:9cd16581b578 114 #endif