Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

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