PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/hal/i2c_api.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_API_H
phungductung 0:aa3fc5ad02f7 17 #define MBED_I2C_API_H
phungductung 0:aa3fc5ad02f7 18
phungductung 0:aa3fc5ad02f7 19 #include "device.h"
phungductung 0:aa3fc5ad02f7 20 #include "buffer.h"
phungductung 0:aa3fc5ad02f7 21 #include "dma_api.h"
phungductung 0:aa3fc5ad02f7 22
phungductung 0:aa3fc5ad02f7 23 #if DEVICE_I2C
phungductung 0:aa3fc5ad02f7 24
phungductung 0:aa3fc5ad02f7 25 /**
phungductung 0:aa3fc5ad02f7 26 * @defgroup I2CEvents I2C Events Macros
phungductung 0:aa3fc5ad02f7 27 *
phungductung 0:aa3fc5ad02f7 28 * @{
phungductung 0:aa3fc5ad02f7 29 */
phungductung 0:aa3fc5ad02f7 30 #define I2C_EVENT_ERROR (1 << 1)
phungductung 0:aa3fc5ad02f7 31 #define I2C_EVENT_ERROR_NO_SLAVE (1 << 2)
phungductung 0:aa3fc5ad02f7 32 #define I2C_EVENT_TRANSFER_COMPLETE (1 << 3)
phungductung 0:aa3fc5ad02f7 33 #define I2C_EVENT_TRANSFER_EARLY_NACK (1 << 4)
phungductung 0:aa3fc5ad02f7 34 #define I2C_EVENT_ALL (I2C_EVENT_ERROR | I2C_EVENT_TRANSFER_COMPLETE | I2C_EVENT_ERROR_NO_SLAVE | I2C_EVENT_TRANSFER_EARLY_NACK)
phungductung 0:aa3fc5ad02f7 35
phungductung 0:aa3fc5ad02f7 36 /**@}*/
phungductung 0:aa3fc5ad02f7 37
phungductung 0:aa3fc5ad02f7 38 #if DEVICE_I2C_ASYNCH
phungductung 0:aa3fc5ad02f7 39 /** Asynch i2c hal structure
phungductung 0:aa3fc5ad02f7 40 */
phungductung 0:aa3fc5ad02f7 41 typedef struct {
phungductung 0:aa3fc5ad02f7 42 struct i2c_s i2c; /**< Target specific i2c structure */
phungductung 0:aa3fc5ad02f7 43 struct buffer_s tx_buff; /**< Tx buffer */
phungductung 0:aa3fc5ad02f7 44 struct buffer_s rx_buff; /**< Rx buffer */
phungductung 0:aa3fc5ad02f7 45 } i2c_t;
phungductung 0:aa3fc5ad02f7 46
phungductung 0:aa3fc5ad02f7 47 #else
phungductung 0:aa3fc5ad02f7 48 /** Non-asynch i2c hal structure
phungductung 0:aa3fc5ad02f7 49 */
phungductung 0:aa3fc5ad02f7 50 typedef struct i2c_s i2c_t;
phungductung 0:aa3fc5ad02f7 51
phungductung 0:aa3fc5ad02f7 52 #endif
phungductung 0:aa3fc5ad02f7 53
phungductung 0:aa3fc5ad02f7 54 enum {
phungductung 0:aa3fc5ad02f7 55 I2C_ERROR_NO_SLAVE = -1,
phungductung 0:aa3fc5ad02f7 56 I2C_ERROR_BUS_BUSY = -2
phungductung 0:aa3fc5ad02f7 57 };
phungductung 0:aa3fc5ad02f7 58
phungductung 0:aa3fc5ad02f7 59 #ifdef __cplusplus
phungductung 0:aa3fc5ad02f7 60 extern "C" {
phungductung 0:aa3fc5ad02f7 61 #endif
phungductung 0:aa3fc5ad02f7 62
phungductung 0:aa3fc5ad02f7 63 /**
phungductung 0:aa3fc5ad02f7 64 * \defgroup GeneralI2C I2C Configuration Functions
phungductung 0:aa3fc5ad02f7 65 * @{
phungductung 0:aa3fc5ad02f7 66 */
phungductung 0:aa3fc5ad02f7 67
phungductung 0:aa3fc5ad02f7 68 /** Initialize the I2C peripheral. It sets the default parameters for I2C
phungductung 0:aa3fc5ad02f7 69 * peripheral, and configure its specifieds pins.
phungductung 0:aa3fc5ad02f7 70 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 71 * @param sda The sda pin
phungductung 0:aa3fc5ad02f7 72 * @param scl The scl pin
phungductung 0:aa3fc5ad02f7 73 */
phungductung 0:aa3fc5ad02f7 74 void i2c_init(i2c_t *obj, PinName sda, PinName scl);
phungductung 0:aa3fc5ad02f7 75
phungductung 0:aa3fc5ad02f7 76 /** Configure the I2C frequency.
phungductung 0:aa3fc5ad02f7 77 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 78 * @param hz Frequency in Hz
phungductung 0:aa3fc5ad02f7 79 */
phungductung 0:aa3fc5ad02f7 80 void i2c_frequency(i2c_t *obj, int hz);
phungductung 0:aa3fc5ad02f7 81
phungductung 0:aa3fc5ad02f7 82 /** Send START command.
phungductung 0:aa3fc5ad02f7 83 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 84 */
phungductung 0:aa3fc5ad02f7 85 int i2c_start(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 86
phungductung 0:aa3fc5ad02f7 87 /** Send STOP command.
phungductung 0:aa3fc5ad02f7 88 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 89 */
phungductung 0:aa3fc5ad02f7 90 int i2c_stop(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 91
phungductung 0:aa3fc5ad02f7 92 /** Blocking reading data.
phungductung 0:aa3fc5ad02f7 93 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 94 * @param address 7-bit address (last bit is 1)
phungductung 0:aa3fc5ad02f7 95 * @param data The buffer for receiving
phungductung 0:aa3fc5ad02f7 96 * @param length Number of bytes to read
phungductung 0:aa3fc5ad02f7 97 * @param stop Stop to be generated after the transfer is done
phungductung 0:aa3fc5ad02f7 98 * @return Number of read bytes
phungductung 0:aa3fc5ad02f7 99 */
phungductung 0:aa3fc5ad02f7 100 int i2c_read(i2c_t *obj, int address, char *data, int length, int stop);
phungductung 0:aa3fc5ad02f7 101
phungductung 0:aa3fc5ad02f7 102 /** Blocking sending data.
phungductung 0:aa3fc5ad02f7 103 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 104 * @param address 7-bit address (last bit is 0)
phungductung 0:aa3fc5ad02f7 105 * @param data The buffer for sending
phungductung 0:aa3fc5ad02f7 106 * @param length Number of bytes to wrte
phungductung 0:aa3fc5ad02f7 107 * @param stop Stop to be generated after the transfer is done
phungductung 0:aa3fc5ad02f7 108 * @return Number of written bytes
phungductung 0:aa3fc5ad02f7 109 */
phungductung 0:aa3fc5ad02f7 110 int i2c_write(i2c_t *obj, int address, const char *data, int length, int stop);
phungductung 0:aa3fc5ad02f7 111
phungductung 0:aa3fc5ad02f7 112 /** Reset I2C peripheral. TODO: The action here. Most of the implementation sends stop().
phungductung 0:aa3fc5ad02f7 113 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 114 */
phungductung 0:aa3fc5ad02f7 115 void i2c_reset(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 116
phungductung 0:aa3fc5ad02f7 117 /** Read one byte.
phungductung 0:aa3fc5ad02f7 118 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 119 * @param last Acknoledge
phungductung 0:aa3fc5ad02f7 120 * @return The read byte
phungductung 0:aa3fc5ad02f7 121 */
phungductung 0:aa3fc5ad02f7 122 int i2c_byte_read(i2c_t *obj, int last);
phungductung 0:aa3fc5ad02f7 123
phungductung 0:aa3fc5ad02f7 124 /** Write one byte.
phungductung 0:aa3fc5ad02f7 125 * @param obj The i2c object
phungductung 0:aa3fc5ad02f7 126 * @param data Byte to be written
phungductung 0:aa3fc5ad02f7 127 * @return 0 if NAK was received, 1 if ACK was received, 2 for timeout.
phungductung 0:aa3fc5ad02f7 128 */
phungductung 0:aa3fc5ad02f7 129 int i2c_byte_write(i2c_t *obj, int data);
phungductung 0:aa3fc5ad02f7 130
phungductung 0:aa3fc5ad02f7 131 /**@}*/
phungductung 0:aa3fc5ad02f7 132
phungductung 0:aa3fc5ad02f7 133 #if DEVICE_I2CSLAVE
phungductung 0:aa3fc5ad02f7 134
phungductung 0:aa3fc5ad02f7 135 /**
phungductung 0:aa3fc5ad02f7 136 * \defgroup SynchI2C Synchronous I2C Hardware Abstraction Layer for slave
phungductung 0:aa3fc5ad02f7 137 * @{
phungductung 0:aa3fc5ad02f7 138 */
phungductung 0:aa3fc5ad02f7 139
phungductung 0:aa3fc5ad02f7 140 /** Configure I2C as slave or master.
phungductung 0:aa3fc5ad02f7 141 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 142 * @return non-zero if a value is available
phungductung 0:aa3fc5ad02f7 143 */
phungductung 0:aa3fc5ad02f7 144 void i2c_slave_mode(i2c_t *obj, int enable_slave);
phungductung 0:aa3fc5ad02f7 145
phungductung 0:aa3fc5ad02f7 146 /** Check to see if the I2C slave has been addressed.
phungductung 0:aa3fc5ad02f7 147 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 148 * @return The status - 1 - read addresses, 2 - write to all slaves,
phungductung 0:aa3fc5ad02f7 149 * 3 write addressed, 0 - the slave has not been addressed
phungductung 0:aa3fc5ad02f7 150 */
phungductung 0:aa3fc5ad02f7 151 int i2c_slave_receive(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 152
phungductung 0:aa3fc5ad02f7 153 /** Configure I2C as slave or master.
phungductung 0:aa3fc5ad02f7 154 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 155 * @return non-zero if a value is available
phungductung 0:aa3fc5ad02f7 156 */
phungductung 0:aa3fc5ad02f7 157 int i2c_slave_read(i2c_t *obj, char *data, int length);
phungductung 0:aa3fc5ad02f7 158
phungductung 0:aa3fc5ad02f7 159 /** Configure I2C as slave or master.
phungductung 0:aa3fc5ad02f7 160 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 161 * @return non-zero if a value is available
phungductung 0:aa3fc5ad02f7 162 */
phungductung 0:aa3fc5ad02f7 163 int i2c_slave_write(i2c_t *obj, const char *data, int length);
phungductung 0:aa3fc5ad02f7 164
phungductung 0:aa3fc5ad02f7 165 /** Configure I2C address.
phungductung 0:aa3fc5ad02f7 166 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 167 * @param idx Currently not used
phungductung 0:aa3fc5ad02f7 168 * @param address The address to be set
phungductung 0:aa3fc5ad02f7 169 * @param mask Currently not used
phungductung 0:aa3fc5ad02f7 170 */
phungductung 0:aa3fc5ad02f7 171 void i2c_slave_address(i2c_t *obj, int idx, uint32_t address, uint32_t mask);
phungductung 0:aa3fc5ad02f7 172
phungductung 0:aa3fc5ad02f7 173 #endif
phungductung 0:aa3fc5ad02f7 174
phungductung 0:aa3fc5ad02f7 175 /**@}*/
phungductung 0:aa3fc5ad02f7 176
phungductung 0:aa3fc5ad02f7 177 #if DEVICE_I2C_ASYNCH
phungductung 0:aa3fc5ad02f7 178
phungductung 0:aa3fc5ad02f7 179 /**
phungductung 0:aa3fc5ad02f7 180 * \defgroup AsynchI2C Asynchronous I2C Hardware Abstraction Layer
phungductung 0:aa3fc5ad02f7 181 * @{
phungductung 0:aa3fc5ad02f7 182 */
phungductung 0:aa3fc5ad02f7 183
phungductung 0:aa3fc5ad02f7 184 /** Start i2c asynchronous transfer.
phungductung 0:aa3fc5ad02f7 185 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 186 * @param tx The buffer to send
phungductung 0:aa3fc5ad02f7 187 * @param tx_length The number of words to transmit
phungductung 0:aa3fc5ad02f7 188 * @param rx The buffer to receive
phungductung 0:aa3fc5ad02f7 189 * @param rx_length The number of words to receive
phungductung 0:aa3fc5ad02f7 190 * @param address The address to be set - 7bit or 9 bit
phungductung 0:aa3fc5ad02f7 191 * @param stop If true, stop will be generated after the transfer is done
phungductung 0:aa3fc5ad02f7 192 * @param handler The I2C IRQ handler to be set
phungductung 0:aa3fc5ad02f7 193 * @param hint DMA hint usage
phungductung 0:aa3fc5ad02f7 194 */
phungductung 0:aa3fc5ad02f7 195 void i2c_transfer_asynch(i2c_t *obj, const void *tx, size_t tx_length, void *rx, size_t rx_length, uint32_t address, uint32_t stop, uint32_t handler, uint32_t event, DMAUsage hint);
phungductung 0:aa3fc5ad02f7 196
phungductung 0:aa3fc5ad02f7 197 /** The asynchronous IRQ handler
phungductung 0:aa3fc5ad02f7 198 * @param obj The I2C object which holds the transfer information
phungductung 0:aa3fc5ad02f7 199 * @return event flags if a transfer termination condition was met or 0 otherwise.
phungductung 0:aa3fc5ad02f7 200 */
phungductung 0:aa3fc5ad02f7 201 uint32_t i2c_irq_handler_asynch(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 202
phungductung 0:aa3fc5ad02f7 203 /** Attempts to determine if I2C peripheral is already in use.
phungductung 0:aa3fc5ad02f7 204 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 205 * @return non-zero if the I2C module is active or zero if it is not
phungductung 0:aa3fc5ad02f7 206 */
phungductung 0:aa3fc5ad02f7 207 uint8_t i2c_active(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 208
phungductung 0:aa3fc5ad02f7 209 /** Abort ongoing asynchronous transaction.
phungductung 0:aa3fc5ad02f7 210 * @param obj The I2C object
phungductung 0:aa3fc5ad02f7 211 */
phungductung 0:aa3fc5ad02f7 212 void i2c_abort_asynch(i2c_t *obj);
phungductung 0:aa3fc5ad02f7 213
phungductung 0:aa3fc5ad02f7 214 #endif
phungductung 0:aa3fc5ad02f7 215
phungductung 0:aa3fc5ad02f7 216 /**@}*/
phungductung 0:aa3fc5ad02f7 217
phungductung 0:aa3fc5ad02f7 218 #ifdef __cplusplus
phungductung 0:aa3fc5ad02f7 219 }
phungductung 0:aa3fc5ad02f7 220 #endif
phungductung 0:aa3fc5ad02f7 221
phungductung 0:aa3fc5ad02f7 222 #endif
phungductung 0:aa3fc5ad02f7 223
phungductung 0:aa3fc5ad02f7 224 #endif