PHung Tung / DISCO-F746_WAV_PLAYER

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 21:37:21 2019 +0000
Revision:
0:8ede47d38d10
SPKT

Who changed what in which revision?

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