Merge branch 'release/v1.1.0'

Author: suikan4github

.github/workflows/ctest.yaml

@@ -22,9 +22,11 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         build: [Release, Debug]
+        target: [x64, win32]
         compiler: [gcc, clang, msvc]
         exclude:
           - {os: ubuntu-latest, compiler: msvc}
+          - {os: ubuntu-latest, target: win32}
           - {os: windows-latest, compiler: gcc}
           - {os: windows-latest, compiler: clang}
 
@@ -58,19 +60,25 @@ jobs:
 
       # Configuration for MSVC
       - name: Configuration for and build msvc
-        if:  matrix.compiler == 'msvc'
+        if:  matrix.compiler == 'msvc' 
         uses: threeal/cmake-action@v2.0.0
         with: 
           c-compiler: cl
           cxx-compiler: cl
+          args : -A ${{ matrix.target }}
           build-args: --config ${{ matrix.build }} 
 
       - name: Test
         uses: threeal/ctest-action@v1.1.0
 
       - name: Check Test Coverage
-        if:  ${{matrix.compiler == 'gcc' && matrix.build == 'Debug'}}
+        if:  matrix.compiler == 'gcc' && matrix.build == 'Debug'
         uses: threeal/gcovr-action@v1.1.0
         with:
           coveralls-send: true
-          excludes:  build/* test/* 
+          excludes:  |
+            build/* 
+            test/* 
+            src/sdk/mocksdkwrapper.hpp 
+            src/sdk/pico_sdk_apistub.cpp
+

CHANGELOG.md

@@ -10,6 +10,34 @@ History of the project development
 ### Security
 ### Known Issue
 
+## [v1.1.0] 2024-10-21
+Update to the v1.0.0. The major change is the SdkWrapper class. This class is now generated by script instead of manual programming. 
+
+- 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().
+- [Issue #21](https://github.com/suikan4github/rpp_driver/issues/21) Add usege of the mock for each class description.
+- [Issue #22](https://github.com/suikan4github/rpp_driver/issues/22) Refactor the test_i2cmaster.cpp to use the fixture.
+### 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. 
+- [Issue #14](https://github.com/suikan4github/rpp_driver/issues/14)  Clean up Internal include directive.   
+- [Issue #17](https://github.com/suikan4github/rpp_driver/issues/17) The mock of the GpioBasic has the wrong definition. 
+- [Issue #18](https://github.com/suikan4github/rpp_driver/issues/18) The constructor of the MockI2sSlaveDuplex.hpp is missing.
+- [Issue #19](https://github.com/suikan4github/rpp_driver/issues/19) The Mock of the rpp_driver::Adau1361 is missing.
+- [Issue #20](https://github.com/suikan4github/rpp_driver/issues/20) Redundant section in README.md 
+- [Issue #23](https://github.com/suikan4github/rpp_driver/issues/23) Make SdkWrapper member functions and SDK API Stub conditional. 
+### Security
+### Known Issue
+
 ## [v1.0.0] 2024-10-03
 ### Release note. 
 First official release of the rpp_driver ( Raspberry Pi Pico Driver) class library. This release contains : 

Doxyfile

@@ -1037,7 +1037,10 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                =    src/sdk/scripts \
+                            src/sdk/mocksdkwrapper.hpp \
+                            src/sdk/pico_sdk_headers.h \
+                            src/sdk/pico_api_alternate_defs.hpp	
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

README.md

@@ -1,21 +1,21 @@
-# Raspberry Pi Pico Driver class collection
+# Raspberry Pi Pico driver class collection
 A Collection of the Raspberry Pi [Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/)/[Pico2](https://www.raspberrypi.com/products/raspberry-pi-pico-2/) classes. Also, a [SDK API](https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#group_sm_config_1gaed7a6e7dc4f1979c7c62e4773df8c79b) wrapper class is provided. 
 
-An online [HTML documentation](https://suikan4github.github.io/rpp_driver/) is available for the details.  
+An online [HTML documentation](https://suikan4github.github.io/rpp_driver/) is available for the details of the APIs.  
 
 # Details
-This class collection ( or class library ) encapsule the certain data inside class. And it also allows you to use the dependency-injection inside your project. So, you can test your code with [Google Test](https://github.com/google/googletest) before testing on the target hardware. 
+This class collection ( or class library ) encapsules the certain data structure of Pico SDK behind the classes. And it also allows programmers to use the dependency-injection in their projects. So, programmers can test their code with [Google Test](https://github.com/google/googletest) before testing on the target hardware. 
 
-These classes are provided in this version. 
+The following classes are provided in this version. 
 
-| Class                           | Header file          | Description |
-|---------------------------------|----                  |----------------------------- |
-| ::rpp_driver::SdkWrapper        | sdkwrapper.hpp       | Wrapper class of Pico SDK    |
-| ::rpp_driver::GpioBasic         | gpiobasic.hpp        | Basic GPIO controller        |
-| ::rpp_driver::I2cMaster         | i2cmaster.hpp        | I2C Master controller        |
-| ::rpp_driver::I2sSlaveDuplex    | i2sslaveduplex.hpp   | Polling based PIO I2S driver |
-| ::rpp_driver::Adau1361          | adau1361.hpp         | Audio CODEC driver           |
-| ::rpp_driver::UmbAdau1361Lower  | umbadau1361lower.hpp | CODEC lower driver dedicated to UMB-ADAU1361-A board |
+| Class                           | Header file                | Description |
+|---------------------------------|----                        |----------------------------- |
+| ::rpp_driver::SdkWrapper        | sdk/sdkwrapper.hpp         | Wrapper class of Pico SDK    |
+| ::rpp_driver::GpioBasic         | gpio/gpiobasic.hpp         | Basic GPIO controller        |
+| ::rpp_driver::I2cMaster         | i2c/i2cmaster.hpp          | I2C Master controller        |
+| ::rpp_driver::I2sSlaveDuplex    | i2s/i2sslaveduplex.hpp     | Polling based PIO I2S driver |
+| ::rpp_driver::Adau1361          | codec/adau1361.hpp         | Audio CODEC driver           |
+| ::rpp_driver::UmbAdau1361Lower  | codec/umbadau1361lower.hpp | CODEC lower driver dedicated to UMB-ADAU1361-A board |
 
 
 ## How to obtain this project
@@ -29,30 +29,27 @@ git clone --recursive https://github.com/suikan4github/rpp_driver.git
 
 ## How to obtain the sample programs
 
-The newest copy of the sample program project is found in the [GitHub repository](https://github.com/suikan4github/rpp_driver-sample). 
+The newest copy of the sample programs are found in the [GitHub repository](https://github.com/suikan4github/rpp_driver-sample). 
 
 Run the following command to obtain the sample from CLI:
 ```sh
 git clone --recursive https://github.com/suikan4github/rpp_driver-sample.git
 ```
 
-## Sample codes
-You can obtain sample applications from [rpp-driver_sample](https://github.com/suikan4github/rpp_driver-sample) repository.
-
 
 # Tools and building
-## Installing tool
-To build the samples or test, you need to install the build tools. 
-The installation of Ubuntu is : 
+## How to install the tools
+To build the sample program and/or test program, you need to install the build tools. 
+The followings are the command to install these tools on Ubuntu.
 
 ```sh
 apt-get -y update
-apt-get -y install build-essential cmake ninja-build git doxygen
+apt-get -y install build-essential cmake ninja-build git 
 apt-get -y install gcc-arm-none-eabi libnewlib-arm-none-eabi
 apt-get -y install doxygen graphviz
 ```
 
-## Building the tests
+## How to build the tests
 The driver classes are tested by GoogleTest and fff. Follow the procedure to build the tests. 
 
 From the repository root ( where this README.md stays), run the following commands. 
@@ -62,7 +59,7 @@ cmake -B build -S . -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++
 cmake --build build --config Debug --target all
 ```
 
-## Building document
+## How to build the document
 An API document is provided as HTML files. 
 To obtain it, run doxygen at the project root ( where the README.md exists).
 
@@ -81,14 +78,12 @@ add_subdirectory(rpp_driver)
 
 ```
 target_link_libraries(${PROJECT_NAME}  pico_stdlib 
-                                        hardware_i2c
-                                        hardware_pio
                                         rpp_driver)
 ```
 
-Note : Whichever you use PIO/I2C or not, you need to link these libraries. 
+Note : Beside of rpp_driver, link the Raspberry Pi Pico SDK libraries as needed. 
 
-By linking library, the include path for the include files are set automatically. 
+By linking rpp_driver library, the include path for the source code are set automatically. 
 
 # License
 This project is provided under [MIT License](LICENSE). 

src/CMakeLists.txt

@@ -4,6 +4,8 @@ cmake_minimum_required(VERSION 3.13)
 # These declaration works for both UNIX/Win and bare metal. 
 
 add_library(rpp_driver INTERFACE)
+        target_include_directories(rpp_driver INTERFACE .)
+
 
 # Win/Unix specific option. 
 if((${WIN32}) OR (${UNIX}))    

src/codec/CMakeLists.txt

@@ -5,4 +5,3 @@ target_sources(rpp_driver INTERFACE
                 adau1361.cpp
                 adau1361lower.cpp
                 umbadau1361lower.cpp)
-target_include_directories(rpp_driver INTERFACE .)

src/codec/adau1361.cpp

@@ -4,6 +4,7 @@
  *  Created on: 2018/05/11
  *      Author: Seiichi "Suikan" Horie
  */
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
 
 // GCC/Clang : Promote the switch-enum warning to error.
 // MSVC : ignored.
@@ -13,7 +14,7 @@
 
 #include <assert.h>
 
-#include "i2cmasterinterface.hpp"
+#include "i2c/i2cmaster.hpp"
 
 // Macro for easy-to-read
 #define CODEC_SYSLOG(fmt, ...) \
@@ -55,7 +56,7 @@ void ::rpp_driver::Adau1361::Start(void) {
   // Enable core to start operation.
   adau1361_lower_.EnableCore();
   // Set SRC for the right FS.
-  adau1361_lower_.ConfigureSRC(fs_);
+  adau1361_lower_.ConfigureSrc(fs_);
   // Board independent register initialization.
   adau1361_lower_.InitializeRegisters();
   // Board dependent register initialization.
@@ -134,3 +135,5 @@ void ::rpp_driver::Adau1361::Mute(CodecChannel channel, bool mute) {
   }
   CODEC_SYSLOG("Leave.")
 }
+
+#endif  // __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)

src/codec/adau1361.hpp

@@ -9,8 +9,9 @@
 
 #ifndef PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_
 #define PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
 
-#include <i2cmasterinterface.hpp>
+#include <i2c/i2cmaster.hpp>
 
 #include "adau1361lower.hpp"
 namespace rpp_driver {
@@ -40,6 +41,44 @@ namespace rpp_driver {
       kMClock,       // Master clock of UMB-ADAU1361-A[Hz].
       codec_lower);  // Inject Codec lower part dependency.
  * ```
+ * ### Usage of mock
+ * In the case of the testing of the user program which uses this class,
+ * a programmer can use the pre-defined mock class ::rpp_driver::MockAdau1361
+ * inside adau1361.hpp.
+ *
+ * ```cpp
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "codec/adau1361.hpp"
+#include "codec/umbadau1361lower.hpp"
+#include "i2c/i2cmaster.hpp"
+
+
+class UserCodeTest : public ::testing::Test {
+ protected:
+  virtual void SetUp() {
+    mock_i2c_ = new ::rpp_driver::MockI2cMaster(mock_sdk_);
+    mock_codec_lower_ = new ::rpp_driver::MockAdau1361Lower(*mock_i2c_);
+    mock_codec_ = new ::rpp_driver::MockAdau1361(*mock_codec_lower_);
+  }
+
+  virtual void TearDown() {
+    delete mock_codec_;
+    delete mock_codec_lower_;
+    delete mock_i2c_;
+  }
+
+  ::rpp_driver::SdkWrapper mock_sdk_;
+  ::rpp_driver::MockI2cMaster *mock_i2c_;
+  ::rpp_driver::MockAdau1361Lower *mock_codec_lower_;
+  ::rpp_driver::MockAdau1361 *mock_codec_;
+};
+
+TEST_F(UserCodeTest, foo) {
+  // Write Test code here.
+}
+ * ```
  */
 class Adau1361 {
  public:
@@ -159,6 +198,26 @@ class Adau1361 {
   bool line_output_mute_;
   bool hp_output_mute_;  // headphone
 };
+
+#if __has_include(<gmock/gmock.h>)
+// GCOVR_EXCL_START
+class MockAdau1361 : public Adau1361 {
+ public:
+  MockAdau1361(Adau1361Lower& adau1361_lower)
+      : Adau1361(48'000, 12'000'000, adau1361_lower) {
+  }  // with dummy fs and dummy mclock
+
+  MOCK_METHOD0(Start, void(void));
+  MOCK_METHOD3(SetGain,
+               void(CodecChannel channel, float left_gain, float right_gain));
+  MOCK_METHOD2(Mute, void(CodecChannel channel, bool mute));
+  MOCK_METHOD1(Mute, void(CodecChannel channel));
+};
+// GCOVR_EXCL_STOP
+#endif  // __has_include(<gmock/gmock.h>)
+
 }  // namespace rpp_driver
 
+#endif  // __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
+
 #endif /* PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_ */

src/codec/adau1361lower.cpp

@@ -1,11 +1,13 @@
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
+
 #include "adau1361lower.hpp"
 
 #include <assert.h>
 
 #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.");
@@ -511,11 +513,7 @@ void ::rpp_driver::Adau1361Lower::InitializeRegisters() {
 }
 
 // Set the converter clock.
-void ::rpp_driver::Adau1361Lower::ConfigureSRC(unsigned int fs) {
-  assert((fs == 24000 || fs == 32000 || fs == 48000 || fs == 96000 ||
-          fs == 22050 || fs == 44100 || fs == 88200) &&
-         "Bad Fs");
-
+void ::rpp_driver::Adau1361Lower::ConfigureSrc(unsigned int fs) {
   switch (fs) {
     case 22050:
     case 24000: {
@@ -549,7 +547,7 @@ void ::rpp_driver::Adau1361Lower::ConfigureSRC(unsigned int fs) {
       break;
     }
     default:
-      assert(false);
+      assert(false && "Bad Fs");
   }
 }
 
@@ -769,3 +767,5 @@ void ::rpp_driver::Adau1361Lower::SetHpOutputGain(float left_gain,
   // SET RHPVOL : R30
   SendCommand(txbuf, 3);
 }
+
+#endif  // __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)