Merge branch 'feature/12' into develop

Author: suikan4github

CHANGELOG.md

@@ -4,13 +4,16 @@ History of the project development
 ## [Unreleased] yyyy-mm-zz
 The issue #16 changes its public member function. But it is referred internally from ::rpp_driver::Adau1361 class. Not called by user program. Then, the major version number is not needed to change. 
 
+The issue #12 removed public class I2cMasterInterface. But it is referred internal only for Unit test. So, the major version number is not needed to change. 
+
 ### Added
 - [Issue #13](https://github.com/suikan4github/rpp_driver/issues/13)  Exclude Mock definition from the GCov coverage. 
 ### Changed
 - [Issue #10](https://github.com/suikan4github/rpp_driver/issues/10) Cover APIs of the Raspberry Pi Pico SDK.
 - [Issue #15](https://github.com/suikan4github/rpp_driver/issues/15) Remove the redundant parameter check code from ConfigureSRC() 
 - [Issue #16](https://github.com/suikan4github/rpp_driver/issues/16) Change the member function name from ConfigureSRC() to ConfigureSrc().
 ### Deprecated
+- [Issue #12](https://github.com/suikan4github/rpp_driver/issues/12)  Is I2cMasterInterface needed?  
 ### Removed
 ### Fixed
 - [Issue #11](https://github.com/suikan4github/rpp_driver/issues/11) Fails to compile in MSVC. 

src/codec/adau1361.cpp

@@ -13,7 +13,7 @@
 
 #include <assert.h>
 
-#include "i2c/i2cmasterinterface.hpp"
+#include "i2c/i2cmaster.hpp"
 
 // Macro for easy-to-read
 #define CODEC_SYSLOG(fmt, ...) \

src/codec/adau1361.hpp

@@ -10,7 +10,7 @@
 #ifndef PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_
 #define PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_
 
-#include <i2c/i2cmasterinterface.hpp>
+#include <i2c/i2cmaster.hpp>
 
 #include "adau1361lower.hpp"
 namespace rpp_driver {

src/codec/adau1361lower.cpp

@@ -4,8 +4,8 @@
 
 #include <algorithm>
 
-rpp_driver::Adau1361Lower::Adau1361Lower(
-    ::rpp_driver::I2cMasterInterface& controller, unsigned int i2c_device_addr)
+rpp_driver::Adau1361Lower::Adau1361Lower(::rpp_driver::I2cMaster& controller,
+                                         unsigned int i2c_device_addr)
     : i2c_(controller), device_addr_(i2c_device_addr) {
   assert((0x3C > device_addr_) &&
          "ADAU1361 I2C Address must be lower than 0x3C.");

src/codec/adau1361lower.hpp

@@ -54,7 +54,7 @@ class Adau1361Lower {
    * @param i2c_device_addr ADAU1361A 7bits I2C device address. Refer device
    * deta sheet for details.
    */
-  Adau1361Lower(::rpp_driver::I2cMasterInterface& controller,
+  Adau1361Lower(::rpp_driver::I2cMaster& controller,
                 unsigned int i2c_device_addr);
   Adau1361Lower() = delete;
   virtual ~Adau1361Lower() {}
@@ -224,7 +224,7 @@ class Adau1361Lower {
 
  protected:
   /// @brief Internal variable to hold the I2C controller variable.
-  ::rpp_driver::I2cMasterInterface& i2c_;
+  ::rpp_driver::I2cMaster& i2c_;
   /// @brief Internal variable to hold the I2C device address.
   const unsigned int device_addr_;
 };
@@ -234,7 +234,7 @@ class Adau1361Lower {
 // GCOVR_EXCL_START
 class MockAdau1361Lower : public Adau1361Lower {
  public:
-  explicit MockAdau1361Lower(::rpp_driver::I2cMasterInterface& controller)
+  explicit MockAdau1361Lower(::rpp_driver::I2cMaster& controller)
       : Adau1361Lower(controller, 0x3A) {};
   MOCK_METHOD2(SendCommand, void(const uint8_t command[], int size));
   MOCK_METHOD2(SendCommandTable, void(const uint8_t table[][3], int rows));

src/codec/umbadau1361lower.hpp

@@ -32,7 +32,7 @@ class UmbAdau1361Lower : public Adau1361Lower {
    * @param i2c_device_addr ADAU1361A 7bits I2C device address. Refer device
    * deta sheet for details.
    */
-  UmbAdau1361Lower(::rpp_driver::I2cMasterInterface& controller,
+  UmbAdau1361Lower(::rpp_driver::I2cMaster& controller,
                    unsigned int i2c_device_addr)
       : Adau1361Lower(controller, i2c_device_addr) {}
   UmbAdau1361Lower() = delete;

src/i2c/i2cmaster.hpp

@@ -25,7 +25,6 @@ typedef int i2c_inst_t;
 #define GPIO_FUNC_I2C 11
 #endif  // __has_include(<hardware/i2c.h>)
 
-#include "i2c/i2cmasterinterface.hpp"
 #include "sdk/sdkwrapper.hpp"
 
 namespace rpp_driver {
@@ -43,7 +42,7 @@ namespace rpp_driver {
  * the restart condition, set this parameter to true.
  *
  */
-class I2cMaster : public I2cMasterInterface {
+class I2cMaster {
  public:
   /**
    * @brief Initialize the given I2C port and setup the pins.
@@ -77,8 +76,7 @@ class I2cMaster : public I2cMasterInterface {
    * not acknowledged or no device present.
    */
 
-  int ReadBlocking(uint8_t addr, uint8_t *dst, size_t len,
-                   bool nostop) override;
+  virtual int ReadBlocking(uint8_t addr, uint8_t *dst, size_t len, bool nostop);
   /**
    * @brief Attempt to write specified number of bytes to address, blocking.
    * @param addr 7-bit address of device to write to
@@ -90,21 +88,41 @@ class I2cMaster : public I2cMasterInterface {
    * @returns Number of bytes written, or PICO_ERROR_GENERIC
    * if address not acknowledged, no device present.
    */
-  int WriteBlocking(uint8_t addr, const uint8_t *src, size_t len,
-                    bool nostop) override;
+  virtual int WriteBlocking(uint8_t addr, const uint8_t *src, size_t len,
+                            bool nostop);
 
   /**
    * @brief Check wether device at specified I2C address exists or not.
    * @param addr 7-bit address of device to read from
    * @returns true if exist, false if not exist.
    */
 
-  bool IsDeviceExisting(uint8_t addr) override;
+  virtual bool IsDeviceExisting(uint8_t addr);
 
  private:
   i2c_inst_t &i2c_;
   SdkWrapper &sdk_;
+};  // I2cMaster
+
+#if __has_include(<gmock/gmock.h>)
+// GCOVR_EXCL_START
+class MockI2cMaster : public I2cMaster {
+ private:
+  i2c_inst_t dummy_i2c = 3;
+
+ public:
+  MockI2cMaster(SdkWrapper &sdk)
+      : I2cMaster(sdk, dummy_i2c, 100'000, 10, 11) {
+        };  // Sdk wrapper and dummy parameters.
+  MOCK_METHOD4(ReadBlocking,
+               int(uint8_t addr, uint8_t *dst, size_t len, bool nostop));
+  MOCK_METHOD4(WriteBlocking,
+               int(uint8_t addr, const uint8_t *src, size_t len, bool nostop));
+  MOCK_METHOD1(IsDeviceExisting, bool(uint8_t addr));
 };
+// GCOVR_EXCL_STOP
+#endif  // __has_include(<gmock/gmock.h>)
+
 };  // namespace rpp_driver
 
 #endif /* PICO_DRIVER_SRC_I2C_I2CMASATER_HPP_ */

src/i2c/i2cmasterinterface.hpp

@@ -3,23 +3,26 @@
 
 #include "codec/adau1361.hpp"
 #include "codec/umbadau1361lower.hpp"
-#include "i2c/i2cmasterinterface.hpp"
+#include "i2c/i2cmaster.hpp"
 
 class Adau1361Test : public ::testing::Test {
  protected:
   virtual void SetUp() {
-    codec_lower_ = new ::rpp_driver::MockAdau1361Lower(i2c_);
+    i2c_ = new ::rpp_driver::MockI2cMaster(sdk_);
+    codec_lower_ = new ::rpp_driver::MockAdau1361Lower(*i2c_);
     codec_ = new ::rpp_driver::Adau1361(fs_, master_clk_, *codec_lower_);
   }
 
   virtual void TearDown() {
     delete codec_;
     delete codec_lower_;
+    delete i2c_;
   }
 
   uint fs_ = 48000;
   uint master_clk_ = 12000000;
-  ::rpp_driver::MockI2cMasterInterface i2c_;
+  ::rpp_driver::SdkWrapper sdk_;
+  ::rpp_driver::MockI2cMaster *i2c_;
   ::rpp_driver::MockAdau1361Lower *codec_lower_;
   ::rpp_driver::Adau1361 *codec_;
 };