mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/i2c_api.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 162

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup hal */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 156:ff21514d8981 4 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 5 * Copyright (c) 2006-2015 ARM Limited
AnnaBridge 156:ff21514d8981 6 *
AnnaBridge 156:ff21514d8981 7 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 8 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 9 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 12 *
AnnaBridge 156:ff21514d8981 13 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 14 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 16 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 17 * limitations under the License.
AnnaBridge 156:ff21514d8981 18 */
AnnaBridge 156:ff21514d8981 19 #ifndef MBED_I2C_API_H
AnnaBridge 156:ff21514d8981 20 #define MBED_I2C_API_H
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #include "device.h"
AnnaBridge 156:ff21514d8981 23 #include "hal/buffer.h"
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 #if DEVICE_I2C_ASYNCH
AnnaBridge 156:ff21514d8981 26 #include "hal/dma_api.h"
AnnaBridge 156:ff21514d8981 27 #endif
AnnaBridge 156:ff21514d8981 28
AnnaBridge 156:ff21514d8981 29 #if DEVICE_I2C
AnnaBridge 156:ff21514d8981 30
AnnaBridge 156:ff21514d8981 31 /**
AnnaBridge 156:ff21514d8981 32 * @defgroup hal_I2CEvents I2C Events Macros
AnnaBridge 156:ff21514d8981 33 *
AnnaBridge 156:ff21514d8981 34 * @{
AnnaBridge 156:ff21514d8981 35 */
AnnaBridge 156:ff21514d8981 36 #define I2C_EVENT_ERROR (1 << 1)
AnnaBridge 156:ff21514d8981 37 #define I2C_EVENT_ERROR_NO_SLAVE (1 << 2)
AnnaBridge 156:ff21514d8981 38 #define I2C_EVENT_TRANSFER_COMPLETE (1 << 3)
AnnaBridge 156:ff21514d8981 39 #define I2C_EVENT_TRANSFER_EARLY_NACK (1 << 4)
AnnaBridge 156:ff21514d8981 40 #define I2C_EVENT_ALL (I2C_EVENT_ERROR | I2C_EVENT_TRANSFER_COMPLETE | I2C_EVENT_ERROR_NO_SLAVE | I2C_EVENT_TRANSFER_EARLY_NACK)
AnnaBridge 156:ff21514d8981 41
AnnaBridge 156:ff21514d8981 42 /**@}*/
AnnaBridge 156:ff21514d8981 43
AnnaBridge 156:ff21514d8981 44 #if DEVICE_I2C_ASYNCH
AnnaBridge 156:ff21514d8981 45 /** Asynch I2C HAL structure
AnnaBridge 156:ff21514d8981 46 */
AnnaBridge 156:ff21514d8981 47 typedef struct {
AnnaBridge 156:ff21514d8981 48 struct i2c_s i2c; /**< Target specific I2C structure */
AnnaBridge 156:ff21514d8981 49 struct buffer_s tx_buff; /**< Tx buffer */
AnnaBridge 156:ff21514d8981 50 struct buffer_s rx_buff; /**< Rx buffer */
AnnaBridge 156:ff21514d8981 51 } i2c_t;
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 #else
AnnaBridge 156:ff21514d8981 54 /** Non-asynch I2C HAL structure
AnnaBridge 156:ff21514d8981 55 */
AnnaBridge 156:ff21514d8981 56 typedef struct i2c_s i2c_t;
AnnaBridge 156:ff21514d8981 57
AnnaBridge 156:ff21514d8981 58 #endif
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 enum {
AnnaBridge 156:ff21514d8981 61 I2C_ERROR_NO_SLAVE = -1,
AnnaBridge 156:ff21514d8981 62 I2C_ERROR_BUS_BUSY = -2
AnnaBridge 156:ff21514d8981 63 };
AnnaBridge 156:ff21514d8981 64
AnnaBridge 156:ff21514d8981 65 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 66 extern "C" {
AnnaBridge 156:ff21514d8981 67 #endif
AnnaBridge 156:ff21514d8981 68
AnnaBridge 156:ff21514d8981 69 /**
AnnaBridge 156:ff21514d8981 70 * \defgroup hal_GeneralI2C I2C Configuration Functions
AnnaBridge 156:ff21514d8981 71 * @{
AnnaBridge 156:ff21514d8981 72 */
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 /** Initialize the I2C peripheral. It sets the default parameters for I2C
AnnaBridge 156:ff21514d8981 75 * peripheral, and configures its specifieds pins.
AnnaBridge 156:ff21514d8981 76 *
AnnaBridge 156:ff21514d8981 77 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 78 * @param sda The sda pin
AnnaBridge 156:ff21514d8981 79 * @param scl The scl pin
AnnaBridge 156:ff21514d8981 80 */
AnnaBridge 156:ff21514d8981 81 void i2c_init(i2c_t *obj, PinName sda, PinName scl);
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 /** Configure the I2C frequency
AnnaBridge 156:ff21514d8981 84 *
AnnaBridge 156:ff21514d8981 85 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 86 * @param hz Frequency in Hz
AnnaBridge 156:ff21514d8981 87 */
AnnaBridge 156:ff21514d8981 88 void i2c_frequency(i2c_t *obj, int hz);
AnnaBridge 156:ff21514d8981 89
AnnaBridge 156:ff21514d8981 90 /** Send START command
AnnaBridge 156:ff21514d8981 91 *
AnnaBridge 156:ff21514d8981 92 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 93 */
AnnaBridge 156:ff21514d8981 94 int i2c_start(i2c_t *obj);
AnnaBridge 156:ff21514d8981 95
AnnaBridge 156:ff21514d8981 96 /** Send STOP command
AnnaBridge 156:ff21514d8981 97 *
AnnaBridge 156:ff21514d8981 98 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 99 */
AnnaBridge 156:ff21514d8981 100 int i2c_stop(i2c_t *obj);
AnnaBridge 156:ff21514d8981 101
AnnaBridge 156:ff21514d8981 102 /** Blocking reading data
AnnaBridge 156:ff21514d8981 103 *
AnnaBridge 156:ff21514d8981 104 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 105 * @param address 7-bit address (last bit is 1)
AnnaBridge 156:ff21514d8981 106 * @param data The buffer for receiving
AnnaBridge 156:ff21514d8981 107 * @param length Number of bytes to read
AnnaBridge 156:ff21514d8981 108 * @param stop Stop to be generated after the transfer is done
AnnaBridge 156:ff21514d8981 109 * @return Number of read bytes
AnnaBridge 156:ff21514d8981 110 */
AnnaBridge 156:ff21514d8981 111 int i2c_read(i2c_t *obj, int address, char *data, int length, int stop);
AnnaBridge 156:ff21514d8981 112
AnnaBridge 156:ff21514d8981 113 /** Blocking sending data
AnnaBridge 156:ff21514d8981 114 *
AnnaBridge 156:ff21514d8981 115 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 116 * @param address 7-bit address (last bit is 0)
AnnaBridge 156:ff21514d8981 117 * @param data The buffer for sending
AnnaBridge 156:ff21514d8981 118 * @param length Number of bytes to write
AnnaBridge 156:ff21514d8981 119 * @param stop Stop to be generated after the transfer is done
AnnaBridge 156:ff21514d8981 120 * @return
AnnaBridge 156:ff21514d8981 121 * zero or non-zero - Number of written bytes
AnnaBridge 156:ff21514d8981 122 * negative - I2C_ERROR_XXX status
AnnaBridge 156:ff21514d8981 123 */
AnnaBridge 156:ff21514d8981 124 int i2c_write(i2c_t *obj, int address, const char *data, int length, int stop);
AnnaBridge 156:ff21514d8981 125
AnnaBridge 156:ff21514d8981 126 /** Reset I2C peripheral. TODO: The action here. Most of the implementation sends stop()
AnnaBridge 156:ff21514d8981 127 *
AnnaBridge 156:ff21514d8981 128 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 129 */
AnnaBridge 156:ff21514d8981 130 void i2c_reset(i2c_t *obj);
AnnaBridge 156:ff21514d8981 131
AnnaBridge 156:ff21514d8981 132 /** Read one byte
AnnaBridge 156:ff21514d8981 133 *
AnnaBridge 156:ff21514d8981 134 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 135 * @param last Acknoledge
AnnaBridge 156:ff21514d8981 136 * @return The read byte
AnnaBridge 156:ff21514d8981 137 */
AnnaBridge 156:ff21514d8981 138 int i2c_byte_read(i2c_t *obj, int last);
AnnaBridge 156:ff21514d8981 139
AnnaBridge 156:ff21514d8981 140 /** Write one byte
AnnaBridge 156:ff21514d8981 141 *
AnnaBridge 156:ff21514d8981 142 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 143 * @param data Byte to be written
AnnaBridge 156:ff21514d8981 144 * @return 0 if NAK was received, 1 if ACK was received, 2 for timeout.
AnnaBridge 156:ff21514d8981 145 */
AnnaBridge 156:ff21514d8981 146 int i2c_byte_write(i2c_t *obj, int data);
AnnaBridge 156:ff21514d8981 147
AnnaBridge 156:ff21514d8981 148 /**@}*/
AnnaBridge 156:ff21514d8981 149
AnnaBridge 156:ff21514d8981 150 #if DEVICE_I2CSLAVE
AnnaBridge 156:ff21514d8981 151
AnnaBridge 156:ff21514d8981 152 /**
AnnaBridge 156:ff21514d8981 153 * \defgroup SynchI2C Synchronous I2C Hardware Abstraction Layer for slave
AnnaBridge 156:ff21514d8981 154 * @{
AnnaBridge 156:ff21514d8981 155 */
AnnaBridge 156:ff21514d8981 156
AnnaBridge 156:ff21514d8981 157 /** Configure I2C as slave or master.
AnnaBridge 156:ff21514d8981 158 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 159 * @param enable_slave Enable i2c hardware so you can receive events with ::i2c_slave_receive
AnnaBridge 156:ff21514d8981 160 * @return non-zero if a value is available
AnnaBridge 156:ff21514d8981 161 */
AnnaBridge 156:ff21514d8981 162 void i2c_slave_mode(i2c_t *obj, int enable_slave);
AnnaBridge 156:ff21514d8981 163
AnnaBridge 156:ff21514d8981 164 /** Check to see if the I2C slave has been addressed.
AnnaBridge 156:ff21514d8981 165 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 166 * @return The status - 1 - read addresses, 2 - write to all slaves,
AnnaBridge 156:ff21514d8981 167 * 3 write addressed, 0 - the slave has not been addressed
AnnaBridge 156:ff21514d8981 168 */
AnnaBridge 156:ff21514d8981 169 int i2c_slave_receive(i2c_t *obj);
AnnaBridge 156:ff21514d8981 170
AnnaBridge 156:ff21514d8981 171 /** Configure I2C as slave or master.
AnnaBridge 156:ff21514d8981 172 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 173 * @param data The buffer for receiving
AnnaBridge 156:ff21514d8981 174 * @param length Number of bytes to read
AnnaBridge 156:ff21514d8981 175 * @return non-zero if a value is available
AnnaBridge 156:ff21514d8981 176 */
AnnaBridge 156:ff21514d8981 177 int i2c_slave_read(i2c_t *obj, char *data, int length);
AnnaBridge 156:ff21514d8981 178
AnnaBridge 156:ff21514d8981 179 /** Configure I2C as slave or master.
AnnaBridge 156:ff21514d8981 180 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 181 * @param data The buffer for sending
AnnaBridge 156:ff21514d8981 182 * @param length Number of bytes to write
AnnaBridge 156:ff21514d8981 183 * @return non-zero if a value is available
AnnaBridge 156:ff21514d8981 184 */
AnnaBridge 156:ff21514d8981 185 int i2c_slave_write(i2c_t *obj, const char *data, int length);
AnnaBridge 156:ff21514d8981 186
AnnaBridge 156:ff21514d8981 187 /** Configure I2C address.
AnnaBridge 156:ff21514d8981 188 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 189 * @param idx Currently not used
AnnaBridge 156:ff21514d8981 190 * @param address The address to be set
AnnaBridge 156:ff21514d8981 191 * @param mask Currently not used
AnnaBridge 156:ff21514d8981 192 */
AnnaBridge 156:ff21514d8981 193 void i2c_slave_address(i2c_t *obj, int idx, uint32_t address, uint32_t mask);
AnnaBridge 156:ff21514d8981 194
AnnaBridge 156:ff21514d8981 195 #endif
AnnaBridge 156:ff21514d8981 196
AnnaBridge 156:ff21514d8981 197 /**@}*/
AnnaBridge 156:ff21514d8981 198
AnnaBridge 156:ff21514d8981 199 #if DEVICE_I2C_ASYNCH
AnnaBridge 156:ff21514d8981 200
AnnaBridge 156:ff21514d8981 201 /**
AnnaBridge 156:ff21514d8981 202 * \defgroup hal_AsynchI2C Asynchronous I2C Hardware Abstraction Layer
AnnaBridge 156:ff21514d8981 203 * @{
AnnaBridge 156:ff21514d8981 204 */
AnnaBridge 156:ff21514d8981 205
AnnaBridge 156:ff21514d8981 206 /** Start I2C asynchronous transfer
AnnaBridge 156:ff21514d8981 207 *
AnnaBridge 156:ff21514d8981 208 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 209 * @param tx The transmit buffer
AnnaBridge 156:ff21514d8981 210 * @param tx_length The number of bytes to transmit
AnnaBridge 156:ff21514d8981 211 * @param rx The receive buffer
AnnaBridge 156:ff21514d8981 212 * @param rx_length The number of bytes to receive
AnnaBridge 156:ff21514d8981 213 * @param address The address to be set - 7bit or 9bit
AnnaBridge 156:ff21514d8981 214 * @param stop If true, stop will be generated after the transfer is done
AnnaBridge 156:ff21514d8981 215 * @param handler The I2C IRQ handler to be set
AnnaBridge 156:ff21514d8981 216 * @param event Event mask for the transfer. See \ref hal_I2CEvents
AnnaBridge 156:ff21514d8981 217 * @param hint DMA hint usage
AnnaBridge 156:ff21514d8981 218 */
AnnaBridge 156:ff21514d8981 219 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);
AnnaBridge 156:ff21514d8981 220
AnnaBridge 156:ff21514d8981 221 /** The asynchronous IRQ handler
AnnaBridge 156:ff21514d8981 222 *
AnnaBridge 156:ff21514d8981 223 * @param obj The I2C object which holds the transfer information
AnnaBridge 156:ff21514d8981 224 * @return Event flags if a transfer termination condition was met, otherwise return 0.
AnnaBridge 156:ff21514d8981 225 */
AnnaBridge 156:ff21514d8981 226 uint32_t i2c_irq_handler_asynch(i2c_t *obj);
AnnaBridge 156:ff21514d8981 227
AnnaBridge 156:ff21514d8981 228 /** Attempts to determine if the I2C peripheral is already in use
AnnaBridge 156:ff21514d8981 229 *
AnnaBridge 156:ff21514d8981 230 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 231 * @return Non-zero if the I2C module is active or zero if it is not
AnnaBridge 156:ff21514d8981 232 */
AnnaBridge 156:ff21514d8981 233 uint8_t i2c_active(i2c_t *obj);
AnnaBridge 156:ff21514d8981 234
AnnaBridge 156:ff21514d8981 235 /** Abort asynchronous transfer
AnnaBridge 156:ff21514d8981 236 *
AnnaBridge 156:ff21514d8981 237 * This function does not perform any check - that should happen in upper layers.
AnnaBridge 156:ff21514d8981 238 * @param obj The I2C object
AnnaBridge 156:ff21514d8981 239 */
AnnaBridge 156:ff21514d8981 240 void i2c_abort_asynch(i2c_t *obj);
AnnaBridge 156:ff21514d8981 241
AnnaBridge 156:ff21514d8981 242 #endif
AnnaBridge 156:ff21514d8981 243
AnnaBridge 156:ff21514d8981 244 /**@}*/
AnnaBridge 156:ff21514d8981 245
AnnaBridge 156:ff21514d8981 246 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 247 }
AnnaBridge 156:ff21514d8981 248 #endif
AnnaBridge 156:ff21514d8981 249
AnnaBridge 156:ff21514d8981 250 #endif
AnnaBridge 156:ff21514d8981 251
AnnaBridge 156:ff21514d8981 252 #endif
AnnaBridge 156:ff21514d8981 253
AnnaBridge 156:ff21514d8981 254 /** @}*/