Daniel Begasse / Mbed 2 deprecated xbee_imessage

ECE 4180 Final Project

Dependencies:   4DGL-uLCD-SE mbed

I2Cdev.cpp@2:4d9a4421fc08, 2015-12-08 (annotated)

Committer:
dbegasse
Date:
Tue Dec 08 15:44:18 2015 +0000
Revision:
2:4d9a4421fc08
Parent:
0:69cae396d104 
ECE 4180 Final Project: XBee iMessage

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dbegasse 0:69cae396d104 1 // ported from arduino library: https://github.com/jrowberg/i2cdevlib
dbegasse 0:69cae396d104 2 // written by szymon gaertig (email: szymon@gaertig.com.pl, website: szymongaertig.pl)
dbegasse 0:69cae396d104 3 // Changelog:
dbegasse 0:69cae396d104 4 // 2013-01-08 - first release
dbegasse 0:69cae396d104 5
dbegasse 0:69cae396d104 6 #include "I2Cdev.h"
dbegasse 0:69cae396d104 7
dbegasse 0:69cae396d104 8 #define useDebugSerial
dbegasse 0:69cae396d104 9
dbegasse 0:69cae396d104 10 I2Cdev::I2Cdev(): i2c(I2C_SDA,I2C_SCL), debugSerial(USBTX, USBRX)
dbegasse 0:69cae396d104 11 {
dbegasse 0:69cae396d104 12
dbegasse 0:69cae396d104 13 }
dbegasse 0:69cae396d104 14
dbegasse 0:69cae396d104 15 I2Cdev::I2Cdev(PinName i2cSda, PinName i2cScl): i2c(i2cSda,i2cScl), debugSerial(USBTX, USBRX)
dbegasse 0:69cae396d104 16 {
dbegasse 0:69cae396d104 17 i2c.frequency(100000);
dbegasse 0:69cae396d104 18 }
dbegasse 0:69cae396d104 19
dbegasse 0:69cae396d104 20 /** Read a single bit from an 8-bit device register.
dbegasse 0:69cae396d104 21 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 22 * @param regAddr Register regAddr to read from
dbegasse 0:69cae396d104 23 * @param bitNum Bit position to read (0-7)
dbegasse 0:69cae396d104 24 * @param data Container for single bit value
dbegasse 0:69cae396d104 25 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 26 * @return Status of read operation (true = success)
dbegasse 0:69cae396d104 27 */
dbegasse 0:69cae396d104 28 int8_t I2Cdev::readBit(uint8_t devAddr, uint8_t regAddr, uint8_t bitNum, uint8_t *data, uint16_t timeout) {
dbegasse 0:69cae396d104 29 uint8_t b;
dbegasse 0:69cae396d104 30 uint8_t count = readByte(devAddr, regAddr, &b, timeout);
dbegasse 0:69cae396d104 31 *data = b & (1 << bitNum);
dbegasse 0:69cae396d104 32 return count;
dbegasse 0:69cae396d104 33 }
dbegasse 0:69cae396d104 34
dbegasse 0:69cae396d104 35 /** Read a single bit from a 16-bit device register.
dbegasse 0:69cae396d104 36 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 37 * @param regAddr Register regAddr to read from
dbegasse 0:69cae396d104 38 * @param bitNum Bit position to read (0-15)
dbegasse 0:69cae396d104 39 * @param data Container for single bit value
dbegasse 0:69cae396d104 40 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 41 * @return Status of read operation (true = success)
dbegasse 0:69cae396d104 42 */
dbegasse 0:69cae396d104 43 int8_t I2Cdev::readBitW(uint8_t devAddr, uint8_t regAddr, uint8_t bitNum, uint16_t *data, uint16_t timeout) {
dbegasse 0:69cae396d104 44 uint16_t b;
dbegasse 0:69cae396d104 45 uint8_t count = readWord(devAddr, regAddr, &b, timeout);
dbegasse 0:69cae396d104 46 *data = b & (1 << bitNum);
dbegasse 0:69cae396d104 47 return count;
dbegasse 0:69cae396d104 48 }
dbegasse 0:69cae396d104 49
dbegasse 0:69cae396d104 50 /** Read multiple bits from an 8-bit device register.
dbegasse 0:69cae396d104 51 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 52 * @param regAddr Register regAddr to read from
dbegasse 0:69cae396d104 53 * @param bitStart First bit position to read (0-7)
dbegasse 0:69cae396d104 54 * @param length Number of bits to read (not more than 8)
dbegasse 0:69cae396d104 55 * @param data Container for right-aligned value (i.e. '101' read from any bitStart position will equal 0x05)
dbegasse 0:69cae396d104 56 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 57 * @return Status of read operation (true = success)
dbegasse 0:69cae396d104 58 */
dbegasse 0:69cae396d104 59 int8_t I2Cdev::readBits(uint8_t devAddr, uint8_t regAddr, uint8_t bitStart, uint8_t length, uint8_t *data, uint16_t timeout) {
dbegasse 0:69cae396d104 60 // 01101001 read byte
dbegasse 0:69cae396d104 61 // 76543210 bit numbers
dbegasse 0:69cae396d104 62 // xxx args: bitStart=4, length=3
dbegasse 0:69cae396d104 63 // 010 masked
dbegasse 0:69cae396d104 64 // -> 010 shifted
dbegasse 0:69cae396d104 65 uint8_t count, b;
dbegasse 0:69cae396d104 66 if ((count = readByte(devAddr, regAddr, &b, timeout)) != 0) {
dbegasse 0:69cae396d104 67 uint8_t mask = ((1 << length) - 1) << (bitStart - length + 1);
dbegasse 0:69cae396d104 68 b &= mask;
dbegasse 0:69cae396d104 69 b >>= (bitStart - length + 1);
dbegasse 0:69cae396d104 70 *data = b;
dbegasse 0:69cae396d104 71 }
dbegasse 0:69cae396d104 72 return count;
dbegasse 0:69cae396d104 73 }
dbegasse 0:69cae396d104 74
dbegasse 0:69cae396d104 75 /** Read multiple bits from a 16-bit device register.
dbegasse 0:69cae396d104 76 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 77 * @param regAddr Register regAddr to read from
dbegasse 0:69cae396d104 78 * @param bitStart First bit position to read (0-15)
dbegasse 0:69cae396d104 79 * @param length Number of bits to read (not more than 16)
dbegasse 0:69cae396d104 80 * @param data Container for right-aligned value (i.e. '101' read from any bitStart position will equal 0x05)
dbegasse 0:69cae396d104 81 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 82 * @return Status of read operation (1 = success, 0 = failure, -1 = timeout)
dbegasse 0:69cae396d104 83 */
dbegasse 0:69cae396d104 84 int8_t I2Cdev::readBitsW(uint8_t devAddr, uint8_t regAddr, uint8_t bitStart, uint8_t length, uint16_t *data, uint16_t timeout) {
dbegasse 0:69cae396d104 85 // 1101011001101001 read byte
dbegasse 0:69cae396d104 86 // fedcba9876543210 bit numbers
dbegasse 0:69cae396d104 87 // xxx args: bitStart=12, length=3
dbegasse 0:69cae396d104 88 // 010 masked
dbegasse 0:69cae396d104 89 // -> 010 shifted
dbegasse 0:69cae396d104 90 uint8_t count;
dbegasse 0:69cae396d104 91 uint16_t w;
dbegasse 0:69cae396d104 92 if ((count = readWord(devAddr, regAddr, &w, timeout)) != 0) {
dbegasse 0:69cae396d104 93 uint16_t mask = ((1 << length) - 1) << (bitStart - length + 1);
dbegasse 0:69cae396d104 94 w &= mask;
dbegasse 0:69cae396d104 95 w >>= (bitStart - length + 1);
dbegasse 0:69cae396d104 96 *data = w;
dbegasse 0:69cae396d104 97 }
dbegasse 0:69cae396d104 98 return count;
dbegasse 0:69cae396d104 99 }
dbegasse 0:69cae396d104 100 /** Read single byte from an 8-bit device register.
dbegasse 0:69cae396d104 101 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 102 * @param regAddr Register regAddr to read from
dbegasse 0:69cae396d104 103 * @param data Container for byte value read from device
dbegasse 0:69cae396d104 104 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 105 * @return Status of read operation (true = success)
dbegasse 0:69cae396d104 106 */
dbegasse 0:69cae396d104 107 int8_t I2Cdev::readByte(uint8_t devAddr, uint8_t regAddr, uint8_t *data, uint16_t timeout) {
dbegasse 0:69cae396d104 108
dbegasse 0:69cae396d104 109 return readBytes(devAddr, regAddr, 1, data, timeout);
dbegasse 0:69cae396d104 110 }
dbegasse 0:69cae396d104 111
dbegasse 0:69cae396d104 112 /** Read single word from a 16-bit device register.
dbegasse 0:69cae396d104 113 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 114 * @param regAddr Register regAddr to read from
dbegasse 0:69cae396d104 115 * @param data Container for word value read from device
dbegasse 0:69cae396d104 116 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 117 * @return Status of read operation (true = success)
dbegasse 0:69cae396d104 118 */
dbegasse 0:69cae396d104 119 int8_t I2Cdev::readWord(uint8_t devAddr, uint8_t regAddr, uint16_t *data, uint16_t timeout) {
dbegasse 0:69cae396d104 120 return readWords(devAddr, regAddr, 1, data, timeout);
dbegasse 0:69cae396d104 121 }
dbegasse 0:69cae396d104 122
dbegasse 0:69cae396d104 123 /** Read multiple bytes from an 8-bit device register.
dbegasse 0:69cae396d104 124 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 125 * @param regAddr First register regAddr to read from
dbegasse 0:69cae396d104 126 * @param length Number of bytes to read
dbegasse 0:69cae396d104 127 * @param data Buffer to store read data in
dbegasse 0:69cae396d104 128 * @param timeout Optional read timeout in milliseconds (0 to disable, leave off to use default class value in I2Cdev::readTimeout)
dbegasse 0:69cae396d104 129 * @return Number of bytes read (-1 indicates failure)
dbegasse 0:69cae396d104 130 */
dbegasse 0:69cae396d104 131 int8_t I2Cdev::readBytes(uint8_t devAddr, uint8_t regAddr, uint8_t length, uint8_t *data, uint16_t timeout)
dbegasse 0:69cae396d104 132 {
dbegasse 0:69cae396d104 133 char command[1];
dbegasse 0:69cae396d104 134 command[0] = regAddr;
dbegasse 0:69cae396d104 135 char *redData = (char*)malloc(length);
dbegasse 0:69cae396d104 136 i2c.write(devAddr<<1, command, 1, true);
dbegasse 0:69cae396d104 137 i2c.read(devAddr<<1, redData, length);
dbegasse 0:69cae396d104 138 for(int i =0; i < length; i++) {
dbegasse 0:69cae396d104 139 data[i] = redData[i];
dbegasse 0:69cae396d104 140 //debugSerial.printf("We read %x\n" , redData[i]);
dbegasse 0:69cae396d104 141
dbegasse 0:69cae396d104 142 }
dbegasse 0:69cae396d104 143 free (redData);
dbegasse 0:69cae396d104 144 return length;
dbegasse 0:69cae396d104 145 }
dbegasse 0:69cae396d104 146
dbegasse 0:69cae396d104 147 int8_t I2Cdev::readWords(uint8_t devAddr, uint8_t regAddr, uint8_t length, uint16_t *data, uint16_t timeout)
dbegasse 0:69cae396d104 148 {
dbegasse 0:69cae396d104 149 return 0;
dbegasse 0:69cae396d104 150 }
dbegasse 0:69cae396d104 151
dbegasse 0:69cae396d104 152 /** write a single bit in an 8-bit device register.
dbegasse 0:69cae396d104 153 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 154 * @param regAddr Register regAddr to write to
dbegasse 0:69cae396d104 155 * @param bitNum Bit position to write (0-7)
dbegasse 0:69cae396d104 156 * @param value New bit value to write
dbegasse 0:69cae396d104 157 * @return Status of operation (true = success)
dbegasse 0:69cae396d104 158 */
dbegasse 0:69cae396d104 159 bool I2Cdev::writeBit(uint8_t devAddr, uint8_t regAddr, uint8_t bitNum, uint8_t data) {
dbegasse 0:69cae396d104 160 uint8_t b;
dbegasse 0:69cae396d104 161 readByte(devAddr, regAddr, &b);
dbegasse 0:69cae396d104 162 b = (data != 0) ? (b | (1 << bitNum)) : (b & ~(1 << bitNum));
dbegasse 0:69cae396d104 163 return writeByte(devAddr, regAddr, b);
dbegasse 0:69cae396d104 164 }
dbegasse 0:69cae396d104 165
dbegasse 0:69cae396d104 166 /** write a single bit in a 16-bit device register.
dbegasse 0:69cae396d104 167 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 168 * @param regAddr Register regAddr to write to
dbegasse 0:69cae396d104 169 * @param bitNum Bit position to write (0-15)
dbegasse 0:69cae396d104 170 * @param value New bit value to write
dbegasse 0:69cae396d104 171 * @return Status of operation (true = success)
dbegasse 0:69cae396d104 172 */
dbegasse 0:69cae396d104 173 bool I2Cdev::writeBitW(uint8_t devAddr, uint8_t regAddr, uint8_t bitNum, uint16_t data) {
dbegasse 0:69cae396d104 174 uint16_t w;
dbegasse 0:69cae396d104 175 readWord(devAddr, regAddr, &w);
dbegasse 0:69cae396d104 176 w = (data != 0) ? (w | (1 << bitNum)) : (w & ~(1 << bitNum));
dbegasse 0:69cae396d104 177 return writeWord(devAddr, regAddr, w);
dbegasse 0:69cae396d104 178 }
dbegasse 0:69cae396d104 179
dbegasse 0:69cae396d104 180 /** Write multiple bits in an 8-bit device register.
dbegasse 0:69cae396d104 181 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 182 * @param regAddr Register regAddr to write to
dbegasse 0:69cae396d104 183 * @param bitStart First bit position to write (0-7)
dbegasse 0:69cae396d104 184 * @param length Number of bits to write (not more than 8)
dbegasse 0:69cae396d104 185 * @param data Right-aligned value to write
dbegasse 0:69cae396d104 186 * @return Status of operation (true = success)
dbegasse 0:69cae396d104 187 */
dbegasse 0:69cae396d104 188 bool I2Cdev::writeBits(uint8_t devAddr, uint8_t regAddr, uint8_t bitStart, uint8_t length, uint8_t data) {
dbegasse 0:69cae396d104 189 // 010 value to write
dbegasse 0:69cae396d104 190 // 76543210 bit numbers
dbegasse 0:69cae396d104 191 // xxx args: bitStart=4, length=3
dbegasse 0:69cae396d104 192 // 00011100 mask byte
dbegasse 0:69cae396d104 193 // 10101111 original value (sample)
dbegasse 0:69cae396d104 194 // 10100011 original & ~mask
dbegasse 0:69cae396d104 195 // 10101011 masked | value
dbegasse 0:69cae396d104 196 uint8_t b;
dbegasse 0:69cae396d104 197 if (readByte(devAddr, regAddr, &b) != 0) {
dbegasse 0:69cae396d104 198 uint8_t mask = ((1 << length) - 1) << (bitStart - length + 1);
dbegasse 0:69cae396d104 199 data <<= (bitStart - length + 1); // shift data into correct position
dbegasse 0:69cae396d104 200 data &= mask; // zero all non-important bits in data
dbegasse 0:69cae396d104 201 b &= ~(mask); // zero all important bits in existing byte
dbegasse 0:69cae396d104 202 b |= data; // combine data with existing byte
dbegasse 0:69cae396d104 203 return writeByte(devAddr, regAddr, b);
dbegasse 0:69cae396d104 204 } else {
dbegasse 0:69cae396d104 205 return false;
dbegasse 0:69cae396d104 206 }
dbegasse 0:69cae396d104 207 }
dbegasse 0:69cae396d104 208
dbegasse 0:69cae396d104 209 /** Write multiple bits in a 16-bit device register.
dbegasse 0:69cae396d104 210 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 211 * @param regAddr Register regAddr to write to
dbegasse 0:69cae396d104 212 * @param bitStart First bit position to write (0-15)
dbegasse 0:69cae396d104 213 * @param length Number of bits to write (not more than 16)
dbegasse 0:69cae396d104 214 * @param data Right-aligned value to write
dbegasse 0:69cae396d104 215 * @return Status of operation (true = success)
dbegasse 0:69cae396d104 216 */
dbegasse 0:69cae396d104 217 bool I2Cdev::writeBitsW(uint8_t devAddr, uint8_t regAddr, uint8_t bitStart, uint8_t length, uint16_t data) {
dbegasse 0:69cae396d104 218 // 010 value to write
dbegasse 0:69cae396d104 219 // fedcba9876543210 bit numbers
dbegasse 0:69cae396d104 220 // xxx args: bitStart=12, length=3
dbegasse 0:69cae396d104 221 // 0001110000000000 mask byte
dbegasse 0:69cae396d104 222 // 1010111110010110 original value (sample)
dbegasse 0:69cae396d104 223 // 1010001110010110 original & ~mask
dbegasse 0:69cae396d104 224 // 1010101110010110 masked | value
dbegasse 0:69cae396d104 225 uint16_t w;
dbegasse 0:69cae396d104 226 if (readWord(devAddr, regAddr, &w) != 0) {
dbegasse 0:69cae396d104 227 uint8_t mask = ((1 << length) - 1) << (bitStart - length + 1);
dbegasse 0:69cae396d104 228 data <<= (bitStart - length + 1); // shift data into correct position
dbegasse 0:69cae396d104 229 data &= mask; // zero all non-important bits in data
dbegasse 0:69cae396d104 230 w &= ~(mask); // zero all important bits in existing word
dbegasse 0:69cae396d104 231 w |= data; // combine data with existing word
dbegasse 0:69cae396d104 232 return writeWord(devAddr, regAddr, w);
dbegasse 0:69cae396d104 233 } else {
dbegasse 0:69cae396d104 234 return false;
dbegasse 0:69cae396d104 235 }
dbegasse 0:69cae396d104 236 }
dbegasse 0:69cae396d104 237
dbegasse 0:69cae396d104 238 /** Write single byte to an 8-bit device register.
dbegasse 0:69cae396d104 239 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 240 * @param regAddr Register address to write to
dbegasse 0:69cae396d104 241 * @param data New byte value to write
dbegasse 0:69cae396d104 242 * @return Status of operation (true = success)
dbegasse 0:69cae396d104 243 */
dbegasse 0:69cae396d104 244 bool I2Cdev::writeByte(uint8_t devAddr, uint8_t regAddr, uint8_t data) {
dbegasse 0:69cae396d104 245 return writeBytes(devAddr, regAddr, 1, &data);
dbegasse 0:69cae396d104 246 }
dbegasse 0:69cae396d104 247
dbegasse 0:69cae396d104 248 /** Write single word to a 16-bit device register.
dbegasse 0:69cae396d104 249 * @param devAddr I2C slave device address
dbegasse 0:69cae396d104 250 * @param regAddr Register address to write to
dbegasse 0:69cae396d104 251 * @param data New word value to write
dbegasse 0:69cae396d104 252 * @return Status of operation (true = success)
dbegasse 0:69cae396d104 253 */
dbegasse 0:69cae396d104 254 bool I2Cdev::writeWord(uint8_t devAddr, uint8_t regAddr, uint16_t data) {
dbegasse 0:69cae396d104 255 return writeWords(devAddr, regAddr, 1, &data);
dbegasse 0:69cae396d104 256 }
dbegasse 0:69cae396d104 257
dbegasse 0:69cae396d104 258 bool I2Cdev::writeBytes(uint8_t devAddr, uint8_t regAddr, uint8_t length, uint8_t *data)
dbegasse 0:69cae396d104 259 {
dbegasse 0:69cae396d104 260 i2c.start();
dbegasse 0:69cae396d104 261 i2c.write(devAddr<<1);
dbegasse 0:69cae396d104 262 i2c.write(regAddr);
dbegasse 0:69cae396d104 263 for(int i = 0; i < length; i++) {
dbegasse 0:69cae396d104 264 i2c.write(data[i]);
dbegasse 0:69cae396d104 265 }
dbegasse 0:69cae396d104 266 i2c.stop();
dbegasse 0:69cae396d104 267 return true;
dbegasse 0:69cae396d104 268 }
dbegasse 0:69cae396d104 269
dbegasse 0:69cae396d104 270 bool I2Cdev::writeWords(uint8_t devAddr, uint8_t regAddr, uint8_t length, uint16_t *data)
dbegasse 0:69cae396d104 271 {
dbegasse 0:69cae396d104 272 return true;
dbegasse 0:69cae396d104 273 }
dbegasse 0:69cae396d104 274
dbegasse 0:69cae396d104 275 uint16_t I2Cdev::readTimeout(void)
dbegasse 0:69cae396d104 276 {
dbegasse 0:69cae396d104 277 return 0;
dbegasse 0:69cae396d104 278 }