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@0:13c962fecb13, 2013-04-13 (annotated)

Committer:
humlet
Date:
Sat Apr 13 13:37:29 2013 +0000
Revision:
0:13c962fecb13
Child:
1:90455d5bdd8c
intermediate;

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 /** Set the frequency of the I2C interface
humlet 0:13c962fecb13 30 *
humlet 0:13c962fecb13 31 * @param hz The bus frequency in hertz
humlet 0:13c962fecb13 32 */
humlet 0:13c962fecb13 33 void frequency(int hz);
humlet 0:13c962fecb13 34
humlet 0:13c962fecb13 35 /** Read from an I2C slave
humlet 0:13c962fecb13 36 *
humlet 0:13c962fecb13 37 * Performs a complete read transaction. The bottom bit of
humlet 0:13c962fecb13 38 * the address is forced to 1 to indicate a read.
humlet 0:13c962fecb13 39 *
humlet 0:13c962fecb13 40 * @param address 8-bit I2C slave address [ addr | 1 ]
humlet 0:13c962fecb13 41 * @param data Pointer to the byte-array to read data in to
humlet 0:13c962fecb13 42 * @param length Number of bytes to read
humlet 0:13c962fecb13 43 * @param repeated Repeated start, true - don't send stop at end
humlet 0:13c962fecb13 44 *
humlet 0:13c962fecb13 45 * @returns
humlet 0:13c962fecb13 46 * 0 on success (ack),
humlet 0:13c962fecb13 47 * non-0 on failure (nack)
humlet 0:13c962fecb13 48 */
humlet 0:13c962fecb13 49 int read(int address, char *data, int length, bool repeated = false);
humlet 0:13c962fecb13 50
humlet 0:13c962fecb13 51 /** Read a single byte from the I2C bus
humlet 0:13c962fecb13 52 *
humlet 0:13c962fecb13 53 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
humlet 0:13c962fecb13 54 *
humlet 0:13c962fecb13 55 * @returns
humlet 0:13c962fecb13 56 * the byte read
humlet 0:13c962fecb13 57 */
humlet 0:13c962fecb13 58 int read(int ack);
humlet 0:13c962fecb13 59
humlet 0:13c962fecb13 60 /** Write to an I2C slave
humlet 0:13c962fecb13 61 *
humlet 0:13c962fecb13 62 * Performs a complete write transaction. The bottom bit of
humlet 0:13c962fecb13 63 * the address is forced to 0 to indicate a write.
humlet 0:13c962fecb13 64 *
humlet 0:13c962fecb13 65 * @param address 8-bit I2C slave address [ addr | 0 ]
humlet 0:13c962fecb13 66 * @param data Pointer to the byte-array data to send
humlet 0:13c962fecb13 67 * @param length Number of bytes to send
humlet 0:13c962fecb13 68 * @param repeated Repeated start, true - do not send stop at end
humlet 0:13c962fecb13 69 *
humlet 0:13c962fecb13 70 * @returns
humlet 0:13c962fecb13 71 * 0 on success (ack),
humlet 0:13c962fecb13 72 * non-0 on failure (nack)
humlet 0:13c962fecb13 73 */
humlet 0:13c962fecb13 74 int write(int address, const char *data, int length, bool repeated = false);
humlet 0:13c962fecb13 75
humlet 0:13c962fecb13 76 /** Write single byte out on the I2C bus
humlet 0:13c962fecb13 77 *
humlet 0:13c962fecb13 78 * @param data data to write out on bus
humlet 0:13c962fecb13 79 *
humlet 0:13c962fecb13 80 * @returns
humlet 0:13c962fecb13 81 * '1' if an ACK was received,
humlet 0:13c962fecb13 82 * '0' otherwise
humlet 0:13c962fecb13 83 */
humlet 0:13c962fecb13 84 int write(int data);
humlet 0:13c962fecb13 85
humlet 0:13c962fecb13 86 /// Creates a start condition on the I2C bus
humlet 0:13c962fecb13 87 void start(void);
humlet 0:13c962fecb13 88
humlet 0:13c962fecb13 89 ///Creates a stop condition on the I2C bus
humlet 0:13c962fecb13 90 void stop(void);
humlet 0:13c962fecb13 91
humlet 0:13c962fecb13 92 /// Wait until the i2c driver becomes available.
humlet 0:13c962fecb13 93 void lock() {
humlet 0:13c962fecb13 94 // if one and the same thread can lock twice, but then it needs also to unlock twice.
humlet 0:13c962fecb13 95 // exactly what we need here
humlet 0:13c962fecb13 96 m_channel.mutex.lock(osWaitForever);
humlet 0:13c962fecb13 97 }
humlet 0:13c962fecb13 98
humlet 0:13c962fecb13 99 /// Unlock the driver that has previously been locked by the same thread
humlet 0:13c962fecb13 100 void osStatus unlock() {
humlet 0:13c962fecb13 101 m_channel.mutex.unlock(osWaitForever);
humlet 0:13c962fecb13 102 }
humlet 0:13c962fecb13 103
humlet 0:13c962fecb13 104
humlet 0:13c962fecb13 105 protected:
humlet 0:13c962fecb13 106
humlet 0:13c962fecb13 107 enum Command {
humlet 0:13c962fecb13 108 START,
humlet 0:13c962fecb13 109 STOP,
humlet 0:13c962fecb13 110 WRITE_BYTE,
humlet 0:13c962fecb13 111 WRITE,
humlet 0:13c962fecb13 112 READ_BYTE,
humlet 0:13c962fecb13 113 READ,
humlet 0:13c962fecb13 114 READ_FROM_REGISTER
humlet 0:13c962fecb13 115 }
humlet 0:13c962fecb13 116
humlet 0:13c962fecb13 117 struct Transfer {
humlet 0:13c962fecb13 118 Command cmd;
humlet 0:13c962fecb13 119 int freq;
humlet 0:13c962fecb13 120 int adr;
humlet 0:13c962fecb13 121 int reg;
humlet 0:13c962fecb13 122 char* dta;
humlet 0:13c962fecb13 123 int len;
humlet 0:13c962fecb13 124 bool rep;
humlet 0:13c962fecb13 125 int res;
humlet 0:13c962fecb13 126 }
humlet 0:13c962fecb13 127
humlet 0:13c962fecb13 128 struct Channel {
humlet 0:13c962fecb13 129 osThreadId caller;
humlet 0:13c962fecb13 130 osThreadId driver;
humlet 0:13c962fecb13 131 Mutex mutex;
humlet 0:13c962fecb13 132 Transfer transfer;
humlet 0:13c962fecb13 133 int freq;
humlet 0:13c962fecb13 134 }
humlet 0:13c962fecb13 135
humlet 0:13c962fecb13 136 static const PinName c_sda[]= {p9,p28};
humlet 0:13c962fecb13 137 static const PinName c_scl[]= {p10,p27};
humlet 0:13c962fecb13 138
humlet 0:13c962fecb13 139 static Channel* s_channels[2];
humlet 0:13c962fecb13 140
humlet 0:13c962fecb13 141 Channel& m_channel;
humlet 0:13c962fecb13 142
humlet 0:13c962fecb13 143 static void channel_0_ISR();
humlet 0:13c962fecb13 144 static void channel_1_ISR();
humlet 0:13c962fecb13 145
humlet 0:13c962fecb13 146 static void threadFun(void* const args);
humlet 0:13c962fecb13 147
humlet 0:13c962fecb13 148 void sendNwait();
humlet 0:13c962fecb13 149
humlet 0:13c962fecb13 150 }
humlet 0:13c962fecb13 151 }
humlet 0:13c962fecb13 152 #endif