guiguitant théo / greenhouse1

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:   mbed

lorawan-SP/mbed/hal/i2c_api.h@0:3fc4a1072bca, 2019-03-28 (annotated)

Committer:
guiguitt
Date:
Thu Mar 28 09:26:33 2019 +0000
Revision:
0:3fc4a1072bca
programme LoRaWan

Who changed what in which revision?

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