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.cpp@7:9cd16581b578, 2019-07-22 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Jul 22 11:44:07 2019 -0500
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
Updated to version 1.9.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 7:9cd16581b578 2 * Copyright (C) 2017 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 7:9cd16581b578 33 #include "Error.hpp"
IanBenzMaxim 7:9cd16581b578 34 #include "I2CMaster.hpp"
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 37
IanBenzMaxim 7:9cd16581b578 38 error_code I2CMaster::writeBlock(span<const uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 39 error_code result;
IanBenzMaxim 7:9cd16581b578 40 for (span<const uint_least8_t>::index_type i = 0;
IanBenzMaxim 7:9cd16581b578 41 i < data.size() && !result; ++i) {
IanBenzMaxim 7:9cd16581b578 42 result = writeByte(data[i]);
IanBenzMaxim 7:9cd16581b578 43 }
IanBenzMaxim 7:9cd16581b578 44 return result;
IanBenzMaxim 7:9cd16581b578 45 }
IanBenzMaxim 7:9cd16581b578 46
IanBenzMaxim 7:9cd16581b578 47 error_code I2CMaster::doWritePacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 48 span<const uint_least8_t> data,
IanBenzMaxim 7:9cd16581b578 49 bool sendStop) {
IanBenzMaxim 7:9cd16581b578 50 error_code result = start(address & 0xFE);
IanBenzMaxim 7:9cd16581b578 51 if (!result) {
IanBenzMaxim 7:9cd16581b578 52 result = writeBlock(data);
IanBenzMaxim 7:9cd16581b578 53 }
IanBenzMaxim 7:9cd16581b578 54 if (sendStop) {
IanBenzMaxim 7:9cd16581b578 55 error_code stopResult = stop();
IanBenzMaxim 7:9cd16581b578 56 if (!result) {
IanBenzMaxim 7:9cd16581b578 57 result = stopResult;
IanBenzMaxim 7:9cd16581b578 58 }
IanBenzMaxim 7:9cd16581b578 59 }
IanBenzMaxim 7:9cd16581b578 60 return result;
IanBenzMaxim 7:9cd16581b578 61 }
IanBenzMaxim 7:9cd16581b578 62
IanBenzMaxim 7:9cd16581b578 63 error_code I2CMaster::readBlock(AckStatus status, span<uint_least8_t> data) {
IanBenzMaxim 7:9cd16581b578 64 error_code result;
IanBenzMaxim 7:9cd16581b578 65 for (span<uint_least8_t>::index_type i = 0; i < data.size() && !result; ++i) {
IanBenzMaxim 7:9cd16581b578 66 result = readByte(i == (data.size() - 1) ? status : Ack, data[i]);
IanBenzMaxim 7:9cd16581b578 67 }
IanBenzMaxim 7:9cd16581b578 68 return result;
IanBenzMaxim 7:9cd16581b578 69 }
IanBenzMaxim 7:9cd16581b578 70
IanBenzMaxim 7:9cd16581b578 71 error_code I2CMaster::doReadPacket(uint_least8_t address,
IanBenzMaxim 7:9cd16581b578 72 span<uint_least8_t> data, bool sendStop) {
IanBenzMaxim 7:9cd16581b578 73 error_code result = start(address | 0x01);
IanBenzMaxim 7:9cd16581b578 74 if (!result) {
IanBenzMaxim 7:9cd16581b578 75 result = readBlock(Nack, data);
IanBenzMaxim 7:9cd16581b578 76 }
IanBenzMaxim 7:9cd16581b578 77 if (sendStop) {
IanBenzMaxim 7:9cd16581b578 78 error_code stopResult = stop();
IanBenzMaxim 7:9cd16581b578 79 if (!result) {
IanBenzMaxim 7:9cd16581b578 80 result = stopResult;
IanBenzMaxim 7:9cd16581b578 81 }
IanBenzMaxim 7:9cd16581b578 82 }
IanBenzMaxim 7:9cd16581b578 83 return result;
IanBenzMaxim 7:9cd16581b578 84 }
IanBenzMaxim 7:9cd16581b578 85
IanBenzMaxim 7:9cd16581b578 86 const error_category & I2CMaster::errorCategory() {
IanBenzMaxim 7:9cd16581b578 87 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 88 public:
IanBenzMaxim 7:9cd16581b578 89 virtual const char * name() const { return "I2CMaster"; }
IanBenzMaxim 7:9cd16581b578 90
IanBenzMaxim 7:9cd16581b578 91 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 92 switch (condition) {
IanBenzMaxim 7:9cd16581b578 93 case NackError:
IanBenzMaxim 7:9cd16581b578 94 return "Nack Error";
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 7:9cd16581b578 96 default:
IanBenzMaxim 7:9cd16581b578 97 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 98 }
IanBenzMaxim 7:9cd16581b578 99 }
IanBenzMaxim 7:9cd16581b578 100 } instance;
IanBenzMaxim 7:9cd16581b578 101 return instance;
IanBenzMaxim 7:9cd16581b578 102 }
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 } // namespace MaximInterfaceCore