mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/i2c_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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