Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/I2C.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 2 * Copyright (c) 2006-2015 ARM Limited
ommpy 0:d383e2dee0f7 3 * SPDX-License-Identifier: Apache-2.0
ommpy 0:d383e2dee0f7 4 *
ommpy 0:d383e2dee0f7 5 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 6 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 7 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 8 *
ommpy 0:d383e2dee0f7 9 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 10 *
ommpy 0:d383e2dee0f7 11 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 12 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 14 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 15 * limitations under the License.
ommpy 0:d383e2dee0f7 16 */
ommpy 0:d383e2dee0f7 17 #ifndef MBED_I2C_H
ommpy 0:d383e2dee0f7 18 #define MBED_I2C_H
ommpy 0:d383e2dee0f7 19
ommpy 0:d383e2dee0f7 20 #include "platform/platform.h"
ommpy 0:d383e2dee0f7 21 #include "hal/gpio_api.h"
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 #if DEVICE_I2C || defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 24
ommpy 0:d383e2dee0f7 25 #include "hal/i2c_api.h"
ommpy 0:d383e2dee0f7 26 #include "platform/SingletonPtr.h"
ommpy 0:d383e2dee0f7 27 #include "platform/PlatformMutex.h"
ommpy 0:d383e2dee0f7 28 #include "platform/NonCopyable.h"
ommpy 0:d383e2dee0f7 29
ommpy 0:d383e2dee0f7 30 #if DEVICE_I2C_ASYNCH
ommpy 0:d383e2dee0f7 31 #include "platform/CThunk.h"
ommpy 0:d383e2dee0f7 32 #include "hal/dma_api.h"
ommpy 0:d383e2dee0f7 33 #include "platform/FunctionPointer.h"
ommpy 0:d383e2dee0f7 34 #endif
ommpy 0:d383e2dee0f7 35
ommpy 0:d383e2dee0f7 36 namespace mbed {
ommpy 0:d383e2dee0f7 37 /** \addtogroup drivers */
ommpy 0:d383e2dee0f7 38
ommpy 0:d383e2dee0f7 39 /** An I2C Master, used for communicating with I2C slave devices
ommpy 0:d383e2dee0f7 40 *
ommpy 0:d383e2dee0f7 41 * @note Synchronization level: Thread safe
ommpy 0:d383e2dee0f7 42 *
ommpy 0:d383e2dee0f7 43 * Example:
ommpy 0:d383e2dee0f7 44 * @code
ommpy 0:d383e2dee0f7 45 * Read temperature from LM75BD
ommpy 0:d383e2dee0f7 46 * #include "mbed.h"
ommpy 0:d383e2dee0f7 47 * I2C i2c(I2C_SDA , I2C_SCL);
ommpy 0:d383e2dee0f7 48 * const int addr7bit = 0x48; // 7-bit I2C address
ommpy 0:d383e2dee0f7 49 * const int addr8bit = 0x48 << 1; // 8-bit I2C address, 0x90
ommpy 0:d383e2dee0f7 50 *
ommpy 0:d383e2dee0f7 51 * int main() {
ommpy 0:d383e2dee0f7 52 * char cmd[2];
ommpy 0:d383e2dee0f7 53 * while (1) {
ommpy 0:d383e2dee0f7 54 * cmd[0] = 0x01;
ommpy 0:d383e2dee0f7 55 * cmd[1] = 0x00;
ommpy 0:d383e2dee0f7 56 *
ommpy 0:d383e2dee0f7 57 * // read and write takes the 8-bit version of the address.
ommpy 0:d383e2dee0f7 58 * // set up configuration register (at 0x01)
ommpy 0:d383e2dee0f7 59 * i2c.write(addr8bit, cmd, 2);
ommpy 0:d383e2dee0f7 60 *
ommpy 0:d383e2dee0f7 61 * wait(0.5);
ommpy 0:d383e2dee0f7 62 *
ommpy 0:d383e2dee0f7 63 * // read temperature register
ommpy 0:d383e2dee0f7 64 * cmd[0] = 0x00;
ommpy 0:d383e2dee0f7 65 * i2c.write(addr8bit, cmd, 1);
ommpy 0:d383e2dee0f7 66 * i2c.read( addr8bit, cmd, 2);
ommpy 0:d383e2dee0f7 67 *
ommpy 0:d383e2dee0f7 68 * float tmp = (float((cmd[0]<<8)|cmd[1]) / 256.0);
ommpy 0:d383e2dee0f7 69 * printf("Temp = %.2f\n", tmp);
ommpy 0:d383e2dee0f7 70 * }
ommpy 0:d383e2dee0f7 71 * }
ommpy 0:d383e2dee0f7 72 * @endcode
ommpy 0:d383e2dee0f7 73 * @ingroup drivers
ommpy 0:d383e2dee0f7 74 */
ommpy 0:d383e2dee0f7 75 class I2C : private NonCopyable<I2C> {
ommpy 0:d383e2dee0f7 76
ommpy 0:d383e2dee0f7 77 public:
ommpy 0:d383e2dee0f7 78 enum RxStatus {
ommpy 0:d383e2dee0f7 79 NoData,
ommpy 0:d383e2dee0f7 80 MasterGeneralCall,
ommpy 0:d383e2dee0f7 81 MasterWrite,
ommpy 0:d383e2dee0f7 82 MasterRead
ommpy 0:d383e2dee0f7 83 };
ommpy 0:d383e2dee0f7 84
ommpy 0:d383e2dee0f7 85 enum Acknowledge {
ommpy 0:d383e2dee0f7 86 NoACK = 0,
ommpy 0:d383e2dee0f7 87 ACK = 1
ommpy 0:d383e2dee0f7 88 };
ommpy 0:d383e2dee0f7 89
ommpy 0:d383e2dee0f7 90 /** Create an I2C Master interface, connected to the specified pins
ommpy 0:d383e2dee0f7 91 *
ommpy 0:d383e2dee0f7 92 * @param sda I2C data line pin
ommpy 0:d383e2dee0f7 93 * @param scl I2C clock line pin
ommpy 0:d383e2dee0f7 94 */
ommpy 0:d383e2dee0f7 95 I2C(PinName sda, PinName scl);
ommpy 0:d383e2dee0f7 96
ommpy 0:d383e2dee0f7 97 /** Set the frequency of the I2C interface
ommpy 0:d383e2dee0f7 98 *
ommpy 0:d383e2dee0f7 99 * @param hz The bus frequency in hertz
ommpy 0:d383e2dee0f7 100 */
ommpy 0:d383e2dee0f7 101 void frequency(int hz);
ommpy 0:d383e2dee0f7 102
ommpy 0:d383e2dee0f7 103 /** Read from an I2C slave
ommpy 0:d383e2dee0f7 104 *
ommpy 0:d383e2dee0f7 105 * Performs a complete read transaction. The bottom bit of
ommpy 0:d383e2dee0f7 106 * the address is forced to 1 to indicate a read.
ommpy 0:d383e2dee0f7 107 *
ommpy 0:d383e2dee0f7 108 * @param address 8-bit I2C slave address [ addr | 1 ]
ommpy 0:d383e2dee0f7 109 * @param data Pointer to the byte-array to read data in to
ommpy 0:d383e2dee0f7 110 * @param length Number of bytes to read
ommpy 0:d383e2dee0f7 111 * @param repeated Repeated start, true - don't send stop at end
ommpy 0:d383e2dee0f7 112 * default value is false.
ommpy 0:d383e2dee0f7 113 *
ommpy 0:d383e2dee0f7 114 * @returns
ommpy 0:d383e2dee0f7 115 * 0 on success (ack),
ommpy 0:d383e2dee0f7 116 * nonzero on failure (nack)
ommpy 0:d383e2dee0f7 117 */
ommpy 0:d383e2dee0f7 118 int read(int address, char *data, int length, bool repeated = false);
ommpy 0:d383e2dee0f7 119
ommpy 0:d383e2dee0f7 120 /** Read a single byte from the I2C bus
ommpy 0:d383e2dee0f7 121 *
ommpy 0:d383e2dee0f7 122 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
ommpy 0:d383e2dee0f7 123 *
ommpy 0:d383e2dee0f7 124 * @returns
ommpy 0:d383e2dee0f7 125 * the byte read
ommpy 0:d383e2dee0f7 126 */
ommpy 0:d383e2dee0f7 127 int read(int ack);
ommpy 0:d383e2dee0f7 128
ommpy 0:d383e2dee0f7 129 /** Write to an I2C slave
ommpy 0:d383e2dee0f7 130 *
ommpy 0:d383e2dee0f7 131 * Performs a complete write transaction. The bottom bit of
ommpy 0:d383e2dee0f7 132 * the address is forced to 0 to indicate a write.
ommpy 0:d383e2dee0f7 133 *
ommpy 0:d383e2dee0f7 134 * @param address 8-bit I2C slave address [ addr | 0 ]
ommpy 0:d383e2dee0f7 135 * @param data Pointer to the byte-array data to send
ommpy 0:d383e2dee0f7 136 * @param length Number of bytes to send
ommpy 0:d383e2dee0f7 137 * @param repeated Repeated start, true - do not send stop at end
ommpy 0:d383e2dee0f7 138 * default value is false.
ommpy 0:d383e2dee0f7 139 *
ommpy 0:d383e2dee0f7 140 * @returns
ommpy 0:d383e2dee0f7 141 * 0 on success (ack),
ommpy 0:d383e2dee0f7 142 * nonzero on failure (nack)
ommpy 0:d383e2dee0f7 143 */
ommpy 0:d383e2dee0f7 144 int write(int address, const char *data, int length, bool repeated = false);
ommpy 0:d383e2dee0f7 145
ommpy 0:d383e2dee0f7 146 /** Write single byte out on the I2C bus
ommpy 0:d383e2dee0f7 147 *
ommpy 0:d383e2dee0f7 148 * @param data data to write out on bus
ommpy 0:d383e2dee0f7 149 *
ommpy 0:d383e2dee0f7 150 * @returns
ommpy 0:d383e2dee0f7 151 * '0' - NAK was received
ommpy 0:d383e2dee0f7 152 * '1' - ACK was received,
ommpy 0:d383e2dee0f7 153 * '2' - timeout
ommpy 0:d383e2dee0f7 154 */
ommpy 0:d383e2dee0f7 155 int write(int data);
ommpy 0:d383e2dee0f7 156
ommpy 0:d383e2dee0f7 157 /** Creates a start condition on the I2C bus
ommpy 0:d383e2dee0f7 158 */
ommpy 0:d383e2dee0f7 159 void start(void);
ommpy 0:d383e2dee0f7 160
ommpy 0:d383e2dee0f7 161 /** Creates a stop condition on the I2C bus
ommpy 0:d383e2dee0f7 162 */
ommpy 0:d383e2dee0f7 163 void stop(void);
ommpy 0:d383e2dee0f7 164
ommpy 0:d383e2dee0f7 165 /** Acquire exclusive access to this I2C bus
ommpy 0:d383e2dee0f7 166 */
ommpy 0:d383e2dee0f7 167 virtual void lock(void);
ommpy 0:d383e2dee0f7 168
ommpy 0:d383e2dee0f7 169 /** Release exclusive access to this I2C bus
ommpy 0:d383e2dee0f7 170 */
ommpy 0:d383e2dee0f7 171 virtual void unlock(void);
ommpy 0:d383e2dee0f7 172
ommpy 0:d383e2dee0f7 173 virtual ~I2C()
ommpy 0:d383e2dee0f7 174 {
ommpy 0:d383e2dee0f7 175 // Do nothing
ommpy 0:d383e2dee0f7 176 }
ommpy 0:d383e2dee0f7 177
ommpy 0:d383e2dee0f7 178 #if DEVICE_I2C_ASYNCH
ommpy 0:d383e2dee0f7 179
ommpy 0:d383e2dee0f7 180 /** Start nonblocking I2C transfer.
ommpy 0:d383e2dee0f7 181 *
ommpy 0:d383e2dee0f7 182 * This function locks the deep sleep until any event has occurred
ommpy 0:d383e2dee0f7 183 *
ommpy 0:d383e2dee0f7 184 * @param address 8/10 bit I2C slave address
ommpy 0:d383e2dee0f7 185 * @param tx_buffer The TX buffer with data to be transferred
ommpy 0:d383e2dee0f7 186 * @param tx_length The length of TX buffer in bytes
ommpy 0:d383e2dee0f7 187 * @param rx_buffer The RX buffer, which is used for received data
ommpy 0:d383e2dee0f7 188 * @param rx_length The length of RX buffer in bytes
ommpy 0:d383e2dee0f7 189 * @param event The logical OR of events to modify
ommpy 0:d383e2dee0f7 190 * @param callback The event callback function
ommpy 0:d383e2dee0f7 191 * @param repeated Repeated start, true - do not send stop at end
ommpy 0:d383e2dee0f7 192 * default value is false.
ommpy 0:d383e2dee0f7 193 *
ommpy 0:d383e2dee0f7 194 * @returns Zero if the transfer has started, or -1 if I2C peripheral is busy
ommpy 0:d383e2dee0f7 195 */
ommpy 0:d383e2dee0f7 196 int transfer(int address, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, const event_callback_t &callback, int event = I2C_EVENT_TRANSFER_COMPLETE, bool repeated = false);
ommpy 0:d383e2dee0f7 197
ommpy 0:d383e2dee0f7 198 /** Abort the ongoing I2C transfer
ommpy 0:d383e2dee0f7 199 */
ommpy 0:d383e2dee0f7 200 void abort_transfer();
ommpy 0:d383e2dee0f7 201
ommpy 0:d383e2dee0f7 202 #if !defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 203 protected:
ommpy 0:d383e2dee0f7 204 /** Lock deep sleep only if it is not yet locked */
ommpy 0:d383e2dee0f7 205 void lock_deep_sleep();
ommpy 0:d383e2dee0f7 206
ommpy 0:d383e2dee0f7 207 /** Unlock deep sleep only if it has been locked */
ommpy 0:d383e2dee0f7 208 void unlock_deep_sleep();
ommpy 0:d383e2dee0f7 209
ommpy 0:d383e2dee0f7 210 void irq_handler_asynch(void);
ommpy 0:d383e2dee0f7 211 event_callback_t _callback;
ommpy 0:d383e2dee0f7 212 CThunk<I2C> _irq;
ommpy 0:d383e2dee0f7 213 DMAUsage _usage;
ommpy 0:d383e2dee0f7 214 bool _deep_sleep_locked;
ommpy 0:d383e2dee0f7 215 #endif
ommpy 0:d383e2dee0f7 216 #endif
ommpy 0:d383e2dee0f7 217
ommpy 0:d383e2dee0f7 218 #if !defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 219 protected:
ommpy 0:d383e2dee0f7 220 void aquire();
ommpy 0:d383e2dee0f7 221
ommpy 0:d383e2dee0f7 222 i2c_t _i2c;
ommpy 0:d383e2dee0f7 223 static I2C *_owner;
ommpy 0:d383e2dee0f7 224 int _hz;
ommpy 0:d383e2dee0f7 225 static SingletonPtr<PlatformMutex> _mutex;
ommpy 0:d383e2dee0f7 226 PinName _sda;
ommpy 0:d383e2dee0f7 227 PinName _scl;
ommpy 0:d383e2dee0f7 228
ommpy 0:d383e2dee0f7 229 private:
ommpy 0:d383e2dee0f7 230 /** Recover I2C bus, when stuck with SDA low
ommpy 0:d383e2dee0f7 231 * @note : Initialization of I2C bus is required after this API.
ommpy 0:d383e2dee0f7 232 *
ommpy 0:d383e2dee0f7 233 * @param sda I2C data line pin
ommpy 0:d383e2dee0f7 234 * @param scl I2C clock line pin
ommpy 0:d383e2dee0f7 235 *
ommpy 0:d383e2dee0f7 236 * @returns
ommpy 0:d383e2dee0f7 237 * '0' - Successfully recovered
ommpy 0:d383e2dee0f7 238 * 'I2C_ERROR_BUS_BUSY' - In case of failure
ommpy 0:d383e2dee0f7 239 *
ommpy 0:d383e2dee0f7 240 */
ommpy 0:d383e2dee0f7 241 int recover(PinName sda, PinName scl);
ommpy 0:d383e2dee0f7 242 #endif
ommpy 0:d383e2dee0f7 243 };
ommpy 0:d383e2dee0f7 244
ommpy 0:d383e2dee0f7 245 } // namespace mbed
ommpy 0:d383e2dee0f7 246
ommpy 0:d383e2dee0f7 247 #endif
ommpy 0:d383e2dee0f7 248
ommpy 0:d383e2dee0f7 249 #endif