Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/I2C.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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