Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

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

mbed-os/drivers/I2C.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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