Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/i2c_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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