PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/I2C.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:e87aa4c49e95 1 /* mbed Microcontroller Library
phungductung 0:e87aa4c49e95 2 * Copyright (c) 2006-2015 ARM Limited
phungductung 0:e87aa4c49e95 3 *
phungductung 0:e87aa4c49e95 4 * Licensed under the Apache License, Version 2.0 (the "License");
phungductung 0:e87aa4c49e95 5 * you may not use this file except in compliance with the License.
phungductung 0:e87aa4c49e95 6 * You may obtain a copy of the License at
phungductung 0:e87aa4c49e95 7 *
phungductung 0:e87aa4c49e95 8 * http://www.apache.org/licenses/LICENSE-2.0
phungductung 0:e87aa4c49e95 9 *
phungductung 0:e87aa4c49e95 10 * Unless required by applicable law or agreed to in writing, software
phungductung 0:e87aa4c49e95 11 * distributed under the License is distributed on an "AS IS" BASIS,
phungductung 0:e87aa4c49e95 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
phungductung 0:e87aa4c49e95 13 * See the License for the specific language governing permissions and
phungductung 0:e87aa4c49e95 14 * limitations under the License.
phungductung 0:e87aa4c49e95 15 */
phungductung 0:e87aa4c49e95 16 #ifndef MBED_I2C_H
phungductung 0:e87aa4c49e95 17 #define MBED_I2C_H
phungductung 0:e87aa4c49e95 18
phungductung 0:e87aa4c49e95 19 #include "platform.h"
phungductung 0:e87aa4c49e95 20
phungductung 0:e87aa4c49e95 21 #if DEVICE_I2C
phungductung 0:e87aa4c49e95 22
phungductung 0:e87aa4c49e95 23 #include "i2c_api.h"
phungductung 0:e87aa4c49e95 24
phungductung 0:e87aa4c49e95 25 #if DEVICE_I2C_ASYNCH
phungductung 0:e87aa4c49e95 26 #include "CThunk.h"
phungductung 0:e87aa4c49e95 27 #include "dma_api.h"
phungductung 0:e87aa4c49e95 28 #include "FunctionPointer.h"
phungductung 0:e87aa4c49e95 29 #endif
phungductung 0:e87aa4c49e95 30
phungductung 0:e87aa4c49e95 31 namespace mbed {
phungductung 0:e87aa4c49e95 32
phungductung 0:e87aa4c49e95 33 /** An I2C Master, used for communicating with I2C slave devices
phungductung 0:e87aa4c49e95 34 *
phungductung 0:e87aa4c49e95 35 * Example:
phungductung 0:e87aa4c49e95 36 * @code
phungductung 0:e87aa4c49e95 37 * // Read from I2C slave at address 0x62
phungductung 0:e87aa4c49e95 38 *
phungductung 0:e87aa4c49e95 39 * #include "mbed.h"
phungductung 0:e87aa4c49e95 40 *
phungductung 0:e87aa4c49e95 41 * I2C i2c(p28, p27);
phungductung 0:e87aa4c49e95 42 *
phungductung 0:e87aa4c49e95 43 * int main() {
phungductung 0:e87aa4c49e95 44 * int address = 0x62;
phungductung 0:e87aa4c49e95 45 * char data[2];
phungductung 0:e87aa4c49e95 46 * i2c.read(address, data, 2);
phungductung 0:e87aa4c49e95 47 * }
phungductung 0:e87aa4c49e95 48 * @endcode
phungductung 0:e87aa4c49e95 49 */
phungductung 0:e87aa4c49e95 50 class I2C {
phungductung 0:e87aa4c49e95 51
phungductung 0:e87aa4c49e95 52 public:
phungductung 0:e87aa4c49e95 53 enum RxStatus {
phungductung 0:e87aa4c49e95 54 NoData,
phungductung 0:e87aa4c49e95 55 MasterGeneralCall,
phungductung 0:e87aa4c49e95 56 MasterWrite,
phungductung 0:e87aa4c49e95 57 MasterRead
phungductung 0:e87aa4c49e95 58 };
phungductung 0:e87aa4c49e95 59
phungductung 0:e87aa4c49e95 60 enum Acknowledge {
phungductung 0:e87aa4c49e95 61 NoACK = 0,
phungductung 0:e87aa4c49e95 62 ACK = 1
phungductung 0:e87aa4c49e95 63 };
phungductung 0:e87aa4c49e95 64
phungductung 0:e87aa4c49e95 65 /** Create an I2C Master interface, connected to the specified pins
phungductung 0:e87aa4c49e95 66 *
phungductung 0:e87aa4c49e95 67 * @param sda I2C data line pin
phungductung 0:e87aa4c49e95 68 * @param scl I2C clock line pin
phungductung 0:e87aa4c49e95 69 */
phungductung 0:e87aa4c49e95 70 I2C(PinName sda, PinName scl);
phungductung 0:e87aa4c49e95 71
phungductung 0:e87aa4c49e95 72 /** Set the frequency of the I2C interface
phungductung 0:e87aa4c49e95 73 *
phungductung 0:e87aa4c49e95 74 * @param hz The bus frequency in hertz
phungductung 0:e87aa4c49e95 75 */
phungductung 0:e87aa4c49e95 76 void frequency(int hz);
phungductung 0:e87aa4c49e95 77
phungductung 0:e87aa4c49e95 78 /** Read from an I2C slave
phungductung 0:e87aa4c49e95 79 *
phungductung 0:e87aa4c49e95 80 * Performs a complete read transaction. The bottom bit of
phungductung 0:e87aa4c49e95 81 * the address is forced to 1 to indicate a read.
phungductung 0:e87aa4c49e95 82 *
phungductung 0:e87aa4c49e95 83 * @param address 8-bit I2C slave address [ addr | 1 ]
phungductung 0:e87aa4c49e95 84 * @param data Pointer to the byte-array to read data in to
phungductung 0:e87aa4c49e95 85 * @param length Number of bytes to read
phungductung 0:e87aa4c49e95 86 * @param repeated Repeated start, true - don't send stop at end
phungductung 0:e87aa4c49e95 87 *
phungductung 0:e87aa4c49e95 88 * @returns
phungductung 0:e87aa4c49e95 89 * 0 on success (ack),
phungductung 0:e87aa4c49e95 90 * non-0 on failure (nack)
phungductung 0:e87aa4c49e95 91 */
phungductung 0:e87aa4c49e95 92 int read(int address, char *data, int length, bool repeated = false);
phungductung 0:e87aa4c49e95 93
phungductung 0:e87aa4c49e95 94 /** Read a single byte from the I2C bus
phungductung 0:e87aa4c49e95 95 *
phungductung 0:e87aa4c49e95 96 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
phungductung 0:e87aa4c49e95 97 *
phungductung 0:e87aa4c49e95 98 * @returns
phungductung 0:e87aa4c49e95 99 * the byte read
phungductung 0:e87aa4c49e95 100 */
phungductung 0:e87aa4c49e95 101 int read(int ack);
phungductung 0:e87aa4c49e95 102
phungductung 0:e87aa4c49e95 103 /** Write to an I2C slave
phungductung 0:e87aa4c49e95 104 *
phungductung 0:e87aa4c49e95 105 * Performs a complete write transaction. The bottom bit of
phungductung 0:e87aa4c49e95 106 * the address is forced to 0 to indicate a write.
phungductung 0:e87aa4c49e95 107 *
phungductung 0:e87aa4c49e95 108 * @param address 8-bit I2C slave address [ addr | 0 ]
phungductung 0:e87aa4c49e95 109 * @param data Pointer to the byte-array data to send
phungductung 0:e87aa4c49e95 110 * @param length Number of bytes to send
phungductung 0:e87aa4c49e95 111 * @param repeated Repeated start, true - do not send stop at end
phungductung 0:e87aa4c49e95 112 *
phungductung 0:e87aa4c49e95 113 * @returns
phungductung 0:e87aa4c49e95 114 * 0 on success (ack),
phungductung 0:e87aa4c49e95 115 * non-0 on failure (nack)
phungductung 0:e87aa4c49e95 116 */
phungductung 0:e87aa4c49e95 117 int write(int address, const char *data, int length, bool repeated = false);
phungductung 0:e87aa4c49e95 118
phungductung 0:e87aa4c49e95 119 /** Write single byte out on the I2C bus
phungductung 0:e87aa4c49e95 120 *
phungductung 0:e87aa4c49e95 121 * @param data data to write out on bus
phungductung 0:e87aa4c49e95 122 *
phungductung 0:e87aa4c49e95 123 * @returns
phungductung 0:e87aa4c49e95 124 * '1' if an ACK was received,
phungductung 0:e87aa4c49e95 125 * '0' otherwise
phungductung 0:e87aa4c49e95 126 */
phungductung 0:e87aa4c49e95 127 int write(int data);
phungductung 0:e87aa4c49e95 128
phungductung 0:e87aa4c49e95 129 /** Creates a start condition on the I2C bus
phungductung 0:e87aa4c49e95 130 */
phungductung 0:e87aa4c49e95 131
phungductung 0:e87aa4c49e95 132 void start(void);
phungductung 0:e87aa4c49e95 133
phungductung 0:e87aa4c49e95 134 /** Creates a stop condition on the I2C bus
phungductung 0:e87aa4c49e95 135 */
phungductung 0:e87aa4c49e95 136 void stop(void);
phungductung 0:e87aa4c49e95 137
phungductung 0:e87aa4c49e95 138 #if DEVICE_I2C_ASYNCH
phungductung 0:e87aa4c49e95 139
phungductung 0:e87aa4c49e95 140 /** Start non-blocking I2C transfer.
phungductung 0:e87aa4c49e95 141 *
phungductung 0:e87aa4c49e95 142 * @param address 8/10 bit I2c slave address
phungductung 0:e87aa4c49e95 143 * @param tx_buffer The TX buffer with data to be transfered
phungductung 0:e87aa4c49e95 144 * @param tx_length The length of TX buffer in bytes
phungductung 0:e87aa4c49e95 145 * @param rx_buffer The RX buffer which is used for received data
phungductung 0:e87aa4c49e95 146 * @param rx_length The length of RX buffer in bytes
phungductung 0:e87aa4c49e95 147 * @param event The logical OR of events to modify
phungductung 0:e87aa4c49e95 148 * @param callback The event callback function
phungductung 0:e87aa4c49e95 149 * @param repeated Repeated start, true - do not send stop at end
phungductung 0:e87aa4c49e95 150 * @return Zero if the transfer has started, or -1 if I2C peripheral is busy
phungductung 0:e87aa4c49e95 151 */
phungductung 0:e87aa4c49e95 152 int transfer(int address, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, const event_callback_t& callback, int event = I2C_EVENT_TRANSFER_COMPLETE, bool repeated = false);
phungductung 0:e87aa4c49e95 153
phungductung 0:e87aa4c49e95 154 /** Abort the on-going I2C transfer
phungductung 0:e87aa4c49e95 155 */
phungductung 0:e87aa4c49e95 156 void abort_transfer();
phungductung 0:e87aa4c49e95 157 protected:
phungductung 0:e87aa4c49e95 158 void irq_handler_asynch(void);
phungductung 0:e87aa4c49e95 159 event_callback_t _callback;
phungductung 0:e87aa4c49e95 160 CThunk<I2C> _irq;
phungductung 0:e87aa4c49e95 161 DMAUsage _usage;
phungductung 0:e87aa4c49e95 162 #endif
phungductung 0:e87aa4c49e95 163
phungductung 0:e87aa4c49e95 164 protected:
phungductung 0:e87aa4c49e95 165 void aquire();
phungductung 0:e87aa4c49e95 166
phungductung 0:e87aa4c49e95 167 i2c_t _i2c;
phungductung 0:e87aa4c49e95 168 static I2C *_owner;
phungductung 0:e87aa4c49e95 169 int _hz;
phungductung 0:e87aa4c49e95 170 };
phungductung 0:e87aa4c49e95 171
phungductung 0:e87aa4c49e95 172 } // namespace mbed
phungductung 0:e87aa4c49e95 173
phungductung 0:e87aa4c49e95 174 #endif
phungductung 0:e87aa4c49e95 175
phungductung 0:e87aa4c49e95 176 #endif