type cleanups and API fixes to make sure toolkit compiles

sparkfun · Mar 15, 2024 · 15dbb5f · 15dbb5f
1 parent 02bc0f1
commit 15dbb5f
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 25 deletions.
diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h
@@ -78,7 +78,6 @@ 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.
 
@@ -101,8 +100,7 @@ class sfeTkIBus
         @retval sfeTkError_t kSTkErrOk on successful execution
 
     */
-    virtual sfeTkError_t writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) = 0;
-
+    virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) = 0;
 
     /*--------------------------------------------------------------------------
         @brief Read a single byte from the given register
@@ -150,8 +148,7 @@ class sfeTkIBus
         @retval int returns kSTkErrOk on success, or kSTkErrFail code
 
     */
-    virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes) = 0;
-
+    virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
 };
 
 //};
diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp
@@ -139,12 +139,13 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite
 //---------------------------------------------------------------------------------
 // writeRegisterRegionAddress()
 //
-// Writes an array of bytes of specified length to a given register on the 
+// Writes an array of bytes of specified length to a given register on the
 //  target address
 //
 // Returns the number of bytes written, < 0 is an error
 //
-sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length)
+sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data,
+                                                     size_t length)
 {
     if (!_i2cPort)
         return kSTkErrBusNotInit;
@@ -175,10 +176,10 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat
 //
 // Returns the number of bytes written, < 0 is an error
 //
-sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length)
+sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length)
 {
     devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff);
-    return writeRegisterRegionAddress((uint8_t*)&devReg, 2, data, length);
+    return writeRegisterRegionAddress((uint8_t *)&devReg, 2, data, length);
 }
 
 //---------------------------------------------------------------------------------
@@ -188,7 +189,8 @@ sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data,
 //
 // Returns the number of bytes written, < 0 is an error
 //
-sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes)
+sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data,
+                                                       size_t numBytes, size_t &readBytes)
 {
 
     // got port
@@ -198,7 +200,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t r
     // Buffer valid?
     if (!data)
         return kSTkErrBusNullBuffer;
-  
+
     readBytes = 0;
 
     uint16_t nOrig = numBytes; // original number of bytes.
@@ -245,7 +247,6 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t r
     return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success
 }
 
-
 //---------------------------------------------------------------------------------
 // readRegisterByte()
 //
@@ -317,9 +318,8 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size
 //
 // Returns the number of bytes read, < 0 is an error
 //
-sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes)
+sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes)
 {
-    size_t readBytes = 0;
-    devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); 
-    return readRegisterRegionAnyAddress((uint8_t*)&devReg, 2, data, numBytes, readBytes);
+    devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff);
+    return readRegisterRegionAnyAddress((uint8_t *)&devReg, 2, data, numBytes, readBytes);
 }
diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h
@@ -135,7 +135,7 @@ class sfeTkArdI2C : public sfeTkII2C
 
         @retval kStkErrOk on success
     */
-    virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
+    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.
@@ -147,8 +147,7 @@ class sfeTkArdI2C : public sfeTkII2C
         @retval sfeTkError_t kSTkErrOk on successful execution
 
     */
-    sfeTkError_t writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length);
-
+    sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length);
 
     /*--------------------------------------------------------------------------
         @brief Reads a byte of data from the given register.
@@ -200,8 +199,8 @@ class sfeTkArdI2C : public sfeTkII2C
 
         @retval int returns kSTkErrOk on success, or kSTkErrFail code
 
-    */ 
-    sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes);
+    */
+    sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes);
 
     // Buffer size chunk getter/setter
     /*--------------------------------------------------------------------------
@@ -239,7 +238,8 @@ class sfeTkArdI2C : public sfeTkII2C
   private:
     sfeTkError_t writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length);
 
-    sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes);
+    sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes,
+                                              size_t &readBytes);
 
     static constexpr size_t kDefaultBufferChunk = 32;
 

diff --git a/src/sfeTkArdSPI.h b/src/sfeTkArdSPI.h
@@ -120,7 +120,7 @@ class sfeTkArdSPI : public sfeTkISPI
 
         @retval sfeTkError_t - kSTkErrOk on success
     */
-    virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
+    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 address.
@@ -131,7 +131,7 @@ class sfeTkArdSPI : public sfeTkISPI
 
         @retval sfeTkError_t - kSTkErrOk on success
     */
-    virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length);
+    sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length);
 
     /*--------------------------------------------------------------------------
         @brief Read a single byte from the given register
@@ -179,7 +179,6 @@ class sfeTkArdSPI : public sfeTkISPI
     */
     virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes);
 
-
   protected:
     // note: The instance data is protected, allowing access if a sub-class is
     //      created to implement a special read/write routine