Added new functions

Added new functionality for reading and writing from 16-bit addressed registers. Note: The function names are likely to change as per Kirk's request/approval

Author: MadisonC-SparkFun

src/sfeTk/sfeTkIBus.h

@@ -78,6 +78,7 @@ class sfeTkIBus
     */
     virtual sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0;
 
+
     /*--------------------------------------------------------------------------
         @brief Writes a number of bytes starting at the given register's address.
 
@@ -90,6 +91,19 @@ class sfeTkIBus
     */
     virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
 
+    /*--------------------------------------------------------------------------
+        @brief Writes a number of bytes starting at the given register's 16-bit address.
+
+        @param devAddr The device's 16-bit address/pin
+        param devReg The device's register's address.
+        @param data Data to write.
+
+        @retval sfeTkError_t kSTkErrOk on successful execution
+
+    */
+    virtual sfeTkError_t write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length) = 0;
+
+
     /*--------------------------------------------------------------------------
         @brief Read a single byte from the given register
 
@@ -124,6 +138,20 @@ class sfeTkIBus
 
     */
     virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
+
+    /*--------------------------------------------------------------------------
+        @brief Reads a block of data from the given 16-bit register address.
+
+        @param reg The device's 16 bit register's address.
+        @param data Data to write.
+        @param numBytes - length of data
+        @param[out] readBytes - number of bytes read
+
+        @retval int returns kSTkErrOk on success, or kSTkErrFail code
+
+    */
+    virtual sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
+
 };
 
 //};

src/sfeTkArdI2C.cpp

@@ -155,6 +155,27 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat
     return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk;
 }
 
+//---------------------------------------------------------------------------------
+// write16BitRegisterRegion()
+//
+// Writes an array of bytes to a given 16-bit register on the target address
+//
+// Returns the number of bytes written, < 0 is an error
+//
+sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length)
+{
+    if (!_i2cPort)
+        return kSTkErrBusNotInit;
+
+    _i2cPort->beginTransmission(address());
+    _i2cPort->write((devReg >> 8) & 0xff);
+    _i2cPort->write(devReg & 0xff);
+    _i2cPort->write(data, (int)length);
+
+    return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk;
+}
+
+
 //---------------------------------------------------------------------------------
 // readRegisterByte()
 //
@@ -269,3 +290,71 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size
 
     return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success
 }
+
+
+
+
+//---------------------------------------------------------------------------------
+// read16BitRegisterRegion()
+//
+// Reads an array of bytes to a given 16-bit register on the target address
+//
+// Returns the number of bytes read, < 0 is an error
+//
+sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes)
+{
+
+    // got port
+    if (!_i2cPort)
+        return kSTkErrBusNotInit;
+
+    // Buffer valid?
+    if (!data)
+        return kSTkErrBusNullBuffer;
+  
+    readBytes = 0;
+
+    uint16_t nOrig = numBytes; // original number of bytes.
+    uint8_t nChunk;
+    uint16_t nReturned;
+    uint16_t i;              // counter in loop
+    bool bFirstInter = true; // Flag for first iteration - used to send devRegister
+
+    while (numBytes > 0)
+    {
+        if (bFirstInter)
+        {
+            _i2cPort->beginTransmission(address());
+
+            _i2cPort->write((devReg >> 8) & 0xff);
+            _i2cPort->write(devReg & 0xff);
+
+            if (_i2cPort->endTransmission(stop()) != 0)
+                return kSTkErrFail; // error with the end transmission
+
+            bFirstInter = false;
+        }
+
+        // We're chunking in data - keeping the max chunk to kMaxI2CBufferLength
+        nChunk = numBytes > _bufferChunkSize ? _bufferChunkSize : numBytes;
+
+        // Request the bytes. If this is the last chunk, always send a stop
+        nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)(nChunk == numBytes ? true : stop()));
+
+        // No data returned, no dice
+        if (nReturned == 0)
+            return kSTkErrBusUnderRead; // error
+
+        // Copy the retrieved data chunk to the current index in the data segment
+        for (i = 0; i < nReturned; i++)
+            *data++ = _i2cPort->read();
+
+        // Decrement the amount of data received from the overall data request amount
+        numBytes = numBytes - nReturned;
+
+    } // end while
+
+    readBytes = nOrig - numBytes; // Bytes read.
+
+    return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success
+}

src/sfeTkArdI2C.h

@@ -137,6 +137,19 @@ class sfeTkArdI2C : public sfeTkII2C
     */
     virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
 
+    /*--------------------------------------------------------------------------
+        @brief Writes a number of bytes starting at the given register's 16-bit address.
+
+        @param devAddr The device's 16-bit address/pin
+        param devReg The device's register's address.
+        @param data Data to write.
+
+        @retval sfeTkError_t kSTkErrOk on successful execution
+
+    */
+    sfeTkError_t write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length);
+
+
     /*--------------------------------------------------------------------------
         @brief Reads a byte of data from the given register.
 
@@ -177,6 +190,19 @@ class sfeTkArdI2C : public sfeTkII2C
     */
     sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes);
 
+    /*--------------------------------------------------------------------------
+        @brief Reads a block of data from the given 16-bit register address.
+
+        @param reg The device's 16 bit register's address.
+        @param data Data to write.
+        @param numBytes - length of data
+        @param[out] readBytes - number of bytes read
+
+        @retval int returns kSTkErrOk on success, or kSTkErrFail code
+
+    */
+    sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes);
+
     // Buffer size chunk getter/setter
     /*--------------------------------------------------------------------------
         @brief set the buffer chunk size