Ian Hua / I2cRtosDriver

I2CRTOS Driver by Helmut Schmücker. Removed included mbed-rtos library to prevent multiple definition. Make sure to include mbed-rtos library in your program!

Fork of I2cRtosDriver by Helmut Schmücker

I2CDriver.h@1:90455d5bdd8c, 2013-04-14 (annotated)

Committer:
humlet
Date:
Sun Apr 14 06:39:04 2013 +0000
Revision:
1:90455d5bdd8c
Parent:
0:13c962fecb13
Child:
2:514105beb343
no more smoke

Who changed what in which revision?

UserRevisionLine numberNew contents of line
humlet 0:13c962fecb13 1 #ifndef I2CDRIVER_H
humlet 0:13c962fecb13 2 #define I2CDRIVER_H
humlet 0:13c962fecb13 3
humlet 0:13c962fecb13 4 #include "stdint.h"
humlet 0:13c962fecb13 5
humlet 0:13c962fecb13 6 #include "I2C.h"
humlet 0:13c962fecb13 7
humlet 0:13c962fecb13 8 #include "Thread.h"
humlet 0:13c962fecb13 9 #include "Semaphore.h"
humlet 0:13c962fecb13 10 #include "Mutex.h"
humlet 0:13c962fecb13 11
humlet 0:13c962fecb13 12 namespace mbed
humlet 0:13c962fecb13 13 {
humlet 0:13c962fecb13 14
humlet 0:13c962fecb13 15 class I2CDriver : protected I2C
humlet 0:13c962fecb13 16 {
humlet 0:13c962fecb13 17 public:
humlet 0:13c962fecb13 18 using I2C::RxStatus;
humlet 0:13c962fecb13 19 using I2C::Acknowledge;
humlet 0:13c962fecb13 20 using I2C::frequency;
humlet 0:13c962fecb13 21
humlet 0:13c962fecb13 22 /** Create an I2C Master interface, connected to the specified pins
humlet 0:13c962fecb13 23 *
humlet 0:13c962fecb13 24 * @param sda I2C data line pin
humlet 0:13c962fecb13 25 * @param scl I2C clock line pin
humlet 0:13c962fecb13 26 */
humlet 0:13c962fecb13 27 I2CDriver(PinName sda, PinName scl);
humlet 0:13c962fecb13 28
humlet 0:13c962fecb13 29 /** Read from an I2C slave
humlet 0:13c962fecb13 30 *
humlet 0:13c962fecb13 31 * Performs a complete read transaction. The bottom bit of
humlet 0:13c962fecb13 32 * the address is forced to 1 to indicate a read.
humlet 0:13c962fecb13 33 *
humlet 0:13c962fecb13 34 * @param address 8-bit I2C slave address [ addr | 1 ]
humlet 0:13c962fecb13 35 * @param data Pointer to the byte-array to read data in to
humlet 0:13c962fecb13 36 * @param length Number of bytes to read
humlet 0:13c962fecb13 37 * @param repeated Repeated start, true - don't send stop at end
humlet 0:13c962fecb13 38 *
humlet 0:13c962fecb13 39 * @returns
humlet 0:13c962fecb13 40 * 0 on success (ack),
humlet 0:13c962fecb13 41 * non-0 on failure (nack)
humlet 0:13c962fecb13 42 */
humlet 0:13c962fecb13 43 int read(int address, char *data, int length, bool repeated = false);
humlet 0:13c962fecb13 44
humlet 1:90455d5bdd8c 45 int read(int address, uint8_t regist, char *data, int length, bool repeated = false);
humlet 1:90455d5bdd8c 46
humlet 0:13c962fecb13 47 /** Read a single byte from the I2C bus
humlet 0:13c962fecb13 48 *
humlet 0:13c962fecb13 49 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
humlet 0:13c962fecb13 50 *
humlet 0:13c962fecb13 51 * @returns
humlet 0:13c962fecb13 52 * the byte read
humlet 0:13c962fecb13 53 */
humlet 0:13c962fecb13 54 int read(int ack);
humlet 0:13c962fecb13 55
humlet 0:13c962fecb13 56 /** Write to an I2C slave
humlet 0:13c962fecb13 57 *
humlet 0:13c962fecb13 58 * Performs a complete write transaction. The bottom bit of
humlet 0:13c962fecb13 59 * the address is forced to 0 to indicate a write.
humlet 0:13c962fecb13 60 *
humlet 0:13c962fecb13 61 * @param address 8-bit I2C slave address [ addr | 0 ]
humlet 0:13c962fecb13 62 * @param data Pointer to the byte-array data to send
humlet 0:13c962fecb13 63 * @param length Number of bytes to send
humlet 0:13c962fecb13 64 * @param repeated Repeated start, true - do not send stop at end
humlet 0:13c962fecb13 65 *
humlet 0:13c962fecb13 66 * @returns
humlet 0:13c962fecb13 67 * 0 on success (ack),
humlet 0:13c962fecb13 68 * non-0 on failure (nack)
humlet 0:13c962fecb13 69 */
humlet 0:13c962fecb13 70 int write(int address, const char *data, int length, bool repeated = false);
humlet 0:13c962fecb13 71
humlet 0:13c962fecb13 72 /** Write single byte out on the I2C bus
humlet 0:13c962fecb13 73 *
humlet 0:13c962fecb13 74 * @param data data to write out on bus
humlet 0:13c962fecb13 75 *
humlet 0:13c962fecb13 76 * @returns
humlet 0:13c962fecb13 77 * '1' if an ACK was received,
humlet 0:13c962fecb13 78 * '0' otherwise
humlet 0:13c962fecb13 79 */
humlet 0:13c962fecb13 80 int write(int data);
humlet 0:13c962fecb13 81
humlet 0:13c962fecb13 82 /// Creates a start condition on the I2C bus
humlet 0:13c962fecb13 83 void start(void);
humlet 0:13c962fecb13 84
humlet 0:13c962fecb13 85 ///Creates a stop condition on the I2C bus
humlet 0:13c962fecb13 86 void stop(void);
humlet 0:13c962fecb13 87
humlet 0:13c962fecb13 88 /// Wait until the i2c driver becomes available.
humlet 1:90455d5bdd8c 89 void lock() {
humlet 0:13c962fecb13 90 // if one and the same thread can lock twice, but then it needs also to unlock twice.
humlet 0:13c962fecb13 91 // exactly what we need here
humlet 1:90455d5bdd8c 92 m_channel->mutex.lock(osWaitForever);
humlet 0:13c962fecb13 93 }
humlet 0:13c962fecb13 94
humlet 0:13c962fecb13 95 /// Unlock the driver that has previously been locked by the same thread
humlet 1:90455d5bdd8c 96 void unlock() {
humlet 1:90455d5bdd8c 97 m_channel->mutex.unlock();
humlet 0:13c962fecb13 98 }
humlet 0:13c962fecb13 99
humlet 0:13c962fecb13 100
humlet 0:13c962fecb13 101 protected:
humlet 0:13c962fecb13 102
humlet 0:13c962fecb13 103 enum Command {
humlet 0:13c962fecb13 104 START,
humlet 0:13c962fecb13 105 STOP,
humlet 0:13c962fecb13 106 WRITE_BYTE,
humlet 0:13c962fecb13 107 WRITE,
humlet 0:13c962fecb13 108 READ_BYTE,
humlet 0:13c962fecb13 109 READ,
humlet 0:13c962fecb13 110 READ_FROM_REGISTER
humlet 1:90455d5bdd8c 111 };
humlet 0:13c962fecb13 112
humlet 0:13c962fecb13 113 struct Transfer {
humlet 1:90455d5bdd8c 114 osThreadId caller;
humlet 0:13c962fecb13 115 Command cmd;
humlet 0:13c962fecb13 116 int freq;
humlet 0:13c962fecb13 117 int adr;
humlet 1:90455d5bdd8c 118 uint8_t reg;
humlet 0:13c962fecb13 119 char* dta;
humlet 1:90455d5bdd8c 120 const char* wdta;
humlet 0:13c962fecb13 121 int len;
humlet 1:90455d5bdd8c 122 int ack;
humlet 0:13c962fecb13 123 bool rep;
humlet 1:90455d5bdd8c 124 int ret;
humlet 1:90455d5bdd8c 125 };
humlet 0:13c962fecb13 126
humlet 0:13c962fecb13 127 struct Channel {
humlet 1:90455d5bdd8c 128 volatile osThreadId driver;
humlet 1:90455d5bdd8c 129 rtos::Mutex mutex;
humlet 1:90455d5bdd8c 130 volatile Transfer transfer;
humlet 1:90455d5bdd8c 131 volatile int freq;
humlet 1:90455d5bdd8c 132 };
humlet 0:13c962fecb13 133
humlet 1:90455d5bdd8c 134 static const PinName c_sdas[2];
humlet 1:90455d5bdd8c 135 static const PinName c_scls[2];
humlet 0:13c962fecb13 136
humlet 1:90455d5bdd8c 137 static Channel* s_channels[2];
humlet 0:13c962fecb13 138
humlet 1:90455d5bdd8c 139 Channel* m_channel;
humlet 0:13c962fecb13 140
humlet 0:13c962fecb13 141 static void channel_0_ISR();
humlet 0:13c962fecb13 142 static void channel_1_ISR();
humlet 0:13c962fecb13 143
humlet 1:90455d5bdd8c 144 static void threadFun(void const *args);
humlet 0:13c962fecb13 145
humlet 0:13c962fecb13 146 void sendNwait();
humlet 0:13c962fecb13 147
humlet 1:90455d5bdd8c 148 };
humlet 0:13c962fecb13 149 }
humlet 0:13c962fecb13 150 #endif