pushed all read/write of specific types [byte, word] to the bus interface, which calls general data methods; Finished out type coverage for the readRegister() and writeRegister() overloaded methods; Added a set of overloaded writeData() methods (no register); overall simplifies the impl requirements for a bus driver; Also completed/reviewed the endian byteswap logic

Author: gigapod

src/sfTk/sfTkIBus.h

@@ -86,16 +86,69 @@ class sfTkIBus
      *  @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfTkError_t writeByte(uint8_t data) = 0;
+    sfTkError_t writeByte(uint8_t data)
+    {
+        return writeRegion(&data, sizeof(uint8_t));
+    }
+
+    /**--------------------------------------------------------------------------
+     * @brief Writes a 8-bit data value.
+     *
+     * This function writes a 8-bit data value
+     *
+     * @param data The 8-bit data value to be written.
+     * @return sfTkError_t The status of the write operation.
+     */
+    sfTkError_t writeData(uint8_t data)
+    {
+        return writeByte(data);
+    }
 
     /**--------------------------------------------------------------------------
      *  @brief Send a word to the device.
-     *  @param data Data to write.
+     *  @param data Data to write. If the byte order is different than system byteorder, data is byteswapped
      *
      *  @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfTkError_t writeWord(uint16_t data) = 0;
+    sfTkError_t writeWord(uint16_t data)
+    {
+        // byte swap?
+        if (sftk_system_byteorder() != _byteOrder)
+            data = sftk_byte_swap(data);
+
+        return writeRegion((uint8_t *)&data, sizeof(uint16_t));
+    }
+
+    /**--------------------------------------------------------------------------
+     * @brief Writes a 16-bit data value.
+     *
+     * This function writes a 16-bit data value
+     *
+     * @param data The 16-bit data value to be written. The data is byteswapped if needed.
+     * @return sfTkError_t The status of the write operation.
+     */
+    sfTkError_t writeData(uint16_t data)
+    {
+        return writeWord(data);
+    }
+
+    /**--------------------------------------------------------------------------
+     * @brief Writes a 32-bit data value.
+     *
+     * This function writes a 32-bit data value
+     *
+     * @param data The 32-bit data value to be written. The data is byteswapped if needed.
+     * @return sfTkError_t The status of the write operation.
+     */
+    sfTkError_t writeData(uint32_t data)
+    {
+        // byte swap?
+        if (sftk_system_byteorder() != _byteOrder)
+            data = sftk_byte_swap(data);
+
+        return writeRegion((uint8_t *)&data, sizeof(uint32_t));
+    }
 
     /**--------------------------------------------------------------------------
      *  @brief Send an array of data to the device.
@@ -116,7 +169,10 @@ class sfTkIBus
      *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfTkError_t writeRegisterByte(uint8_t devReg, uint8_t data) = 0;
+    sfTkError_t writeRegisterByte(uint8_t devReg, uint8_t data)
+    {
+        return writeRegisterRegion(devReg, &data, sizeof(uint8_t));
+    }
 
     // Overload version
     sfTkError_t writeRegister(uint8_t devReg, uint8_t data)
@@ -128,19 +184,51 @@ class sfTkIBus
      * @brief Write a single word (16 bit) to the given register
      *
      *   @param devReg The device's register's address.
-     *   @param data Data to write.
+     *   @param data Data to write. Note - if byte order differs, swap the data before writing.
      *
      *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0;
+    virtual sfTkError_t writeRegisterWord(uint8_t devReg, uint16_t data)
+    {
+        // swap the data?
+        if (sftk_system_byteorder() != _byteOrder)
+            data = sftk_byte_swap(data);
 
-    // Overload version
+        return writeRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint16_t));
+    }
+
+    /**
+     * @brief Writes a 16-bit data value to a specified device register.
+     *
+     * This function writes a 16-bit data value to a specified device register.
+     * If the system byte order differs from the byte order expected by the device,
+     * the data value is byte-swapped before being written.
+     *
+     * @param devReg The register address to write to.
+     * @param data The 16-bit data value to write.
+     * @return sfTkError_t Error code indicating the success or failure of the operation.
+     */
     sfTkError_t writeRegister(uint8_t devReg, uint16_t data)
     {
         return writeRegisterWord(devReg, data);
     }
 
+    /**
+     * @brief Writes a 32-bit data value to a specified device register.
+     *
+     * This function writes a 32-bit data value to a specified device register.
+     * If the system byte order differs from the byte order expected by the device,
+     * the data value is byte-swapped before being written.
+     *
+     * @param devReg The register address to write to.
+     * @param data The 32-bit data value to write.
+     * @return sfTkError_t Error code indicating the success or failure of the operation.
+     */
+    sfTkError_t writeRegister(uint8_t devReg, const uint32_t data)
+    {
+        return writeRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint32_t));
+    }
     /**--------------------------------------------------------------------------
      *  @brief Writes a number of bytes starting at the given register's address.
      *
@@ -177,6 +265,46 @@ class sfTkIBus
         return writeRegister16Region(devReg, data, length);
     }
 
+    /**
+     * @brief Writes a 16-bit data value to a specified device register.
+     *
+     * This function writes a 16-bit data value to a specified device register.
+     * If the system byte order differs from the byte order expected by the device,
+     * the data value is byte-swapped before being written.
+     *
+     * @param devReg The register address to write to.
+     * @param data The 16-bit data value to write.
+     * @return sfTkError_t Error code indicating the success or failure of the operation.
+     */
+    sfTkError_t writeRegister(uint16_t devReg, const uint16_t data)
+    {
+        uint16_t value = data;
+        // do we need to swap the data value? Note the address is swapped in the called writeReg16 method
+        if (sftk_system_byteorder() != _byteOrder)
+            value = sftk_byte_swap(data);
+
+        return writeRegister16Region(devReg, (const uint8_t *)&value, sizeof(uint16_t));
+    }
+    /**
+     * @brief Writes a 32-bit data value to a specified device register.
+     *
+     * This function writes a 32-bit data value to a specified device register.
+     * If the system byte order differs from the byte order expected by the device,
+     * the data value is byte-swapped before being written.
+     *
+     * @param devReg The register address to write to.
+     * @param data The 32-bit data value to write.
+     * @return sfTkError_t Error code indicating the success or failure of the operation.
+     */
+    sfTkError_t writeRegister(uint16_t devReg, const uint32_t data)
+    {
+        uint32_t value = data;
+        // do we need to swap the data value? Note the address is swapped in the called writeReg16 method
+        if (sftk_system_byteorder() != _byteOrder)
+            value = sftk_byte_swap(data);
+
+        return writeRegister16Region(devReg, (const uint8_t *)&value, sizeof(uint32_t));
+    }
     /**--------------------------------------------------------------------------
      *  @brief Writes a number of uint16's starting at the given register's 16-bit address.
      *
@@ -203,7 +331,14 @@ class sfTkIBus
      *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      *
      */
-    virtual sfTkError_t readRegisterByte(uint8_t devReg, uint8_t &data) = 0;
+    virtual sfTkError_t readRegisterByte(uint8_t devReg, uint8_t &data)
+    {
+
+        size_t nRead;
+        sfTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint8_t), nRead);
+
+        return (retval == ksfTkErrOk && nRead == sizeof(uint8_t) ? ksfTkErrOk : retval);
+    }
 
     // Overload version
     sfTkError_t readRegister(uint8_t devReg, uint8_t &data)
@@ -215,18 +350,58 @@ class sfTkIBus
      *  @brief Read a single word (16 bit) from the given register
      *
      *   @param devReg The device's register's address.
-     *   @param data Data to read.
+     *   @param data Data to read.-- the data value is byteswapped if needed
      *
      *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
      */
-    virtual sfTkError_t readRegisterWord(uint8_t devReg, uint16_t &data) = 0;
+    virtual sfTkError_t readRegisterWord(uint8_t devReg, uint16_t &data)
+    {
+        size_t nRead;
+        sfTkError_t retVal = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint16_t), nRead);
+
+        // The data is a uint32 - byte swap the result?
+        if (retVal == ksfTkErrOk && sftk_system_byteorder() != _byteOrder)
+            data = sftk_byte_swap(data);
+
+        return (retVal == ksfTkErrOk && nRead == sizeof(uint16_t) ? ksfTkErrOk : retVal);
+    }
 
     // Overload version
+    /**
+     * @brief Reads a 16-bit value from the specified device register.
+     *
+     * This function reads a 16-bit value from the register specified by `devReg`
+     * and stores the result in the provided `data` reference.
+     *
+     * @param devReg The register address to read from.
+     * @param data Reference to a variable where the read value will be stored. The data value is byteswapped if needed
+     * @return sfTkError_t Error code indicating the success or failure of the operation.
+     */
     sfTkError_t readRegister(uint8_t devReg, uint16_t &data)
     {
         return readRegisterWord(devReg, data);
     }
 
+    /**--------------------------------------------------------------------------
+     *  @brief Read a 32 bit value from the given register
+     *
+     *   @param devReg The device's register's address.
+     *   @param data Data to read.
+     *
+     *   @retval sfTkError_t -  ksfTkErrOk on successful execution.
+     */
+
+    virtual sfTkError_t readRegister(uint8_t devReg, uint32_t &data)
+    {
+        size_t nRead;
+        sfTkError_t retVal = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint32_t), nRead);
+
+        // The data is a uint32 - byte swap the result?
+        if (retVal == ksfTkErrOk && sftk_system_byteorder() != _byteOrder)
+            data = sftk_byte_swap(data);
+
+        return (retVal == ksfTkErrOk && nRead == sizeof(uint32_t) ? ksfTkErrOk : retVal);
+    }
     /**--------------------------------------------------------------------------
      *  @brief Reads a block of data from the given register.
      *
@@ -240,12 +415,48 @@ class sfTkIBus
      */
     virtual sfTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
 
-    // Overload version
+    /**
+     * @brief Reads data from a specified register.
+     *
+     * This function reads a specified number of bytes from a given register and stores the data in the provided buffer.
+     *
+     * @param reg The register address to read from.
+     * @param data Pointer to the buffer where the read data will be stored.
+     * @param numBytes The number of bytes to read from the register.
+     * @param readBytes Reference to a variable where the number of bytes actually read will be stored.
+     * @return sfTkError_t Error code indicating the success or failure of the read operation.
+     */
     sfTkError_t readRegister(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
     {
         return readRegisterRegion(reg, data, numBytes, readBytes);
     }
 
+    /**
+     * @brief Overloaded function to read a 16-bit value from the given 16-bit register address.
+     *
+     * This function reads a 16-bit value from the specified 16-bit register address.
+     *
+     * @param reg The device's 16-bit register's address.
+     * @param[out] value The 16-bit value read from the register.
+     *
+     * @return sfTkError_t Returns ksfTkErrOk on success, or an error code on failure.
+     */
+    virtual sfTkError_t readRegister(uint16_t reg, uint16_t &value)
+    {
+        size_t readBytes = 0;
+
+        // this is a reg 16 address - so call the method to manage this. Note - it manages the
+        // byte swapping of the address.
+
+        sfTkError_t retValue = readRegister16Region(reg, (uint8_t *)&value, sizeof(uint16_t), readBytes);
+
+        // The data is a uint16 - byte swap the result?
+        if (retValue == ksfTkErrOk && sftk_system_byteorder() != _byteOrder)
+            value = sftk_byte_swap(value);
+
+        return retValue;
+    }
+
     /**
      * @brief Overloaded function to read a 32-bit value from the given 16-bit register address.
      *
@@ -271,6 +482,7 @@ class sfTkIBus
 
         return retValue;
     }
+
     /**--------------------------------------------------------------------------
      *  @brief Reads a block of data from the given 16-bit register address.
      *
@@ -285,10 +497,22 @@ class sfTkIBus
     virtual sfTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
 
     // Overload version
+    /**
+     * @brief Reads a specified number of bytes from a given register.
+     *
+     * This function reads data from a 16-bit register and stores it in the provided buffer.
+     *
+     * @param reg The 16-bit register address to read from.
+     * @param data Pointer to the buffer where the read data will be stored.
+     * @param numBytes The number of bytes to read from the register.
+     * @param readBytes Reference to a variable where the number of bytes actually read will be stored.
+     * @return sfTkError_t Error code indicating the success or failure of the read operation.
+     */
     sfTkError_t readRegister(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
     {
         return readRegister16Region(reg, data, numBytes, readBytes);
     }
+
     /**--------------------------------------------------------------------------
      *  @brief Reads a block of data from the given 16-bit register address.
      *