PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

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