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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

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