PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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