Morpheus / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

hal/i2c_api.h@20:06bbf6d2334c, 2016-04-22 (annotated)

Committer:
screamer
Date:
Fri Apr 22 13:40:25 2016 +0100
Revision:
20:06bbf6d2334c
Parent:
0:9c59db1fbc9e 
Update library references

Who changed what in which revision?

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