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