changed the return value from writeRegisterRegion - more consistant

Author: gigapod

src/sfeTk/sfeTkIBus.h

@@ -76,10 +76,10 @@ class sfeTkIBus
         param devReg The device's register's address.
         @param data Data to write.
 
-        @retval int returns the number of bytes written, or kSTkErrFail on error
+        @retval sfeTkError_t kSTkErrOk on successful execution
 
     */
-    virtual int32_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
+    virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
 
     /*--------------------------------------------------------------------------
         @brief Read a single byte from the given register

src/sfeTkArdI2C.cpp

@@ -126,7 +126,7 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite
 //
 // Returns the number of bytes written, < 0 is an error
 //
-int32_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
+sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
 {
     if (!_i2cPort)
         return kSTkErrBusNullPtr;
@@ -135,7 +135,7 @@ int32_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, si
     _i2cPort->write(devReg);
     _i2cPort->write(data, (int)length);
 
-    return _i2cPort->endTransmission() ? length : kSTkErrOk; 
+    return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; 
 }
 
 //---------------------------------------------------------------------------------

src/sfeTkArdI2C.h

@@ -99,7 +99,7 @@ class sfeTkArdI2C : public sfeTkII2C
         @param devReg The device's register's address.
         @param data Data to write.
 
-        @retval returns  on  error on success
+        @retval returns  kStkErrOk on success
     */
     sfeTkError_t writeRegisterByte(uint8_t devReg, uint8_t data);
 
@@ -110,7 +110,7 @@ class sfeTkArdI2C : public sfeTkII2C
         @param devReg The device's register's address.
         @param data Data to write.
 
-        @retval returns  on  error on success
+        @retval returns  kStkErrOk on success
     */
     sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data);
 
@@ -123,9 +123,9 @@ class sfeTkArdI2C : public sfeTkII2C
         @param devReg The device's register's address.
         @param data Data to write.
 
-        @retval returns number of bytes written, < 0 is an error code
+        @retval kStkErrOk on success
     */
-    virtual int32_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
+    virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
 
     /*--------------------------------------------------------------------------
         @brief Reads a byte of data from the given register.
@@ -135,7 +135,7 @@ class sfeTkArdI2C : public sfeTkII2C
         @param devReg The device's register's address.
         @param data Data to read.
 
-        @retval  on  error on success
+        @retval  kStkErrOk on success
     */
     sfeTkError_t readRegisterByte(uint8_t devReg, uint8_t &data);
 
@@ -160,7 +160,7 @@ class sfeTkArdI2C : public sfeTkII2C
         @param devReg The device's register's address.
         @param data Data to write.
 
-        @retval 0 on success, < 0 on error - see error code
+        @retval kStkErrOk on success
     */
     sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes);
 

src/sfeTkArdSPI.cpp

@@ -86,7 +86,7 @@ sfeTkError_t sfeTkArdSPI::init(bool bInit)
 //
 // Writes a byte to a given register.
 //
-// Returns true on success, false on failure
+// Returns kSTkErrOk on success
 //
 sfeTkError_t sfeTkArdSPI::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite)
 {
@@ -113,7 +113,7 @@ sfeTkError_t sfeTkArdSPI::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite)
 //
 // Writes a world to a given register.
 //
-// Returns true on success, false on failure
+// Returns kSTkErrOk on success
 //
 sfeTkError_t sfeTkArdSPI::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite)
 {
@@ -124,9 +124,9 @@ sfeTkError_t sfeTkArdSPI::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite
 //
 // Writes an array of bytes to a given register on the target address
 //
-// Returns the number of bytes written, < 0 is an error
+// Returns kSTkErrOk on success
 //
-int32_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
+sfeTkError_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
 {
     if (!_spiPort)
         return kSTkErrBusNullPtr;
@@ -145,7 +145,7 @@ int32_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *data, si
     digitalWrite(cs(), HIGH);
     _spiPort->endTransaction();
 
-    return length;
+    return kSTkErrOk;
 }
 
 sfeTkError_t sfeTkArdSPI::readRegisterByte(uint8_t devReg, uint8_t &data)
@@ -162,7 +162,7 @@ sfeTkError_t sfeTkArdSPI::readRegisterWord(uint8_t devReg, uint16_t &data)
 //
 // Reads an array of bytes to a given register on the target address
 //
-// Returns the number of bytes read, < 0 is an error
+// Returns kSTkErrOk on success
 //
 sfeTkError_t sfeTkArdSPI::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes)
 {

src/sfeTkArdSPI.h

@@ -104,9 +104,9 @@ class sfeTkArdSPI : public sfeTkISPI
         @param devReg The device's register's address.
         @param data Data to write.
 
-        @retval int32_t - number of bytes written, < 0 = error value
+        @retval sfeTkError_t - kSTkErrOk on success
     */
-    virtual int32_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
+    virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
 
     /*--------------------------------------------------------------------------
         @brief Read a single byte from the given register