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