Merge pull request #9 from suikan4github/develop

Merge develop branch as v1.0.0

Author: suikan4github

.github/workflows/ctest.yaml

@@ -1,6 +1,6 @@
 # This is a basic workflow to help you get started with Actions
 
-name: CTest_on_push_and_pull_request
+name: Build and Test
 
 # Controls when the workflow will run
 on:
@@ -39,51 +39,38 @@ jobs:
           submodules: true
 
       # Configuration for GCC
-      - name: Configuration for gcc
+      - name: Configuration and build for gcc
         if:  matrix.compiler == 'gcc'
-        run: |
-          echo Runs-on ${{matrix.os}}, Build with ${{matrix.compiler}}
-          mkdir build
-          cd build
-          cmake ..  -DCMAKE_CXX_COMPILER=g++ -DCMAKE_C_COMPILER=gcc
+        uses: threeal/cmake-action@v2.0.0
+        with: 
+          c-compiler: gcc
+          cxx-compiler: g++
+          build-args: --config ${{ matrix.build }} 
 
       # Configuration for Clang
-      - name: Configuration for clang
+      - name: Configuration for and build clang
         if:  matrix.compiler == 'clang'
-        run: |
-          echo Runs-on ${{matrix.os}}, Build with ${{matrix.compiler}}
-          mkdir build
-          cd build
-          cmake ..  -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang
+        uses: threeal/cmake-action@v2.0.0
+        with: 
+          c-compiler: clang
+          cxx-compiler: clang++
+          build-args: --config ${{ matrix.build }} 
 
       # Configuration for MSVC
-      - name: Configuration for msvc
+      - name: Configuration for and build msvc
         if:  matrix.compiler == 'msvc'
-        run: |
-          echo "Runs-on ${{matrix.os}}, Build with ${{matrix.compiler}}"
-          mkdir build
-          cd build
-          cmake ..  -DCMAKE_CXX_COMPILER=cl -DCMAKE_C_COMPILER=cl
-
-      # Build for Linux
-      - name: Build for Linux
-        if:  matrix.os == 'ubuntu-latest'
-        run: |
-          echo Runs-on ${{matrix.os}}, ${{matrix.build}} build
-          cd build
-          cmake --build . --target all --config ${{ matrix.build }} --clean-first -j4
-
-      # Build for Windows
-      - name: Build for Windows
-        if:  matrix.os == 'windows-latest' 
-        run: |
-          echo "Runs-on ${{matrix.os}}, ${{matrix.build}} build"
-          cd build
-          cmake --build . --target all_build --config ${{ matrix.build }} --clean-first -j4
+        uses: threeal/cmake-action@v2.0.0
+        with: 
+          c-compiler: cl
+          cxx-compiler: cl
+          build-args: --config ${{ matrix.build }} 
 
       - name: Test
-        run:  |
-          cd build
-          ctest --rerun-failed --output-on-failure -j 4
-
+        uses: threeal/ctest-action@v1.1.0
 
+      - name: Check Test Coverage
+        if:  ${{matrix.compiler == 'gcc' && matrix.build == 'Debug'}}
+        uses: threeal/gcovr-action@v1.1.0
+        with:
+          coveralls-send: true
+          excludes:  build/* test/* 

CHANGELOG.md

@@ -10,8 +10,33 @@ History of the project development
 ### 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 : 
+- a limited SDK Wrapper class for the basic operation. 
+- a basic GPIO class.
+- a basic I2C master class.  
+- a duplex slave I2S class. 
+- an ADAU1361 audio codec class.
+
+### Added
+### Changed
+- [Issue #4](https://github.com/suikan4github/rpp_driver/issues/4) Add gcov support for x86 build. 
+- [Issue #5](https://github.com/suikan4github/rpp_driver/issues/5) Migrate action from hand-made to marketplace.
+- [Issue #6](https://github.com/suikan4github/rpp_driver/issues/6) Add comment string to the assertion.
+- [Issue #7](https://github.com/suikan4github/rpp_driver/issues/7) Remove default clause of adau1361.cpp and use -Wswitch-enum to detect the coverage error.
+- [Issue #8](https://github.com/suikan4github/rpp_driver/issues/8) Remove duplicated assertions in the adau1361lower.cpp.
+
+### Deprecated
+### Removed
+### Fixed
+- [Issue #3](https://github.com/suikan4github/rpp_driver/issues/3) Doxygen warning message. 
+### Security
+### Known Issue
+
 ## [v0.9.0] 2024-09-28
 Pre-release version. 
 
-[Unreleased]: https://github.com/suikan4github/rpp_driver/compare/v0.9.0...develop
+[Unreleased]: https://github.com/suikan4github/rpp_driver/compare/v1.0.0...develop
+[v1.0.0]: https://github.com/suikan4github/rpp_driver/compare/v0.9.0...v1.0.0
 [v0.9.0]: https://github.com/suikan4github/rpp_driver/compare/v0.0.0...v0.9.0

Doxyfile

@@ -983,12 +983,7 @@ INPUT_FILE_ENCODING    =
 # provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          = *.c \
-                         *.cc \
-                         *.cxx \
-                         *.cpp \
-                         *.c++ \
-                         *.java \
+FILE_PATTERNS          = *.java \
                          *.ii \
                          *.ixx \
                          *.ipp \

src/CMakeLists.txt

@@ -5,6 +5,14 @@ cmake_minimum_required(VERSION 3.13)
 
 add_library(rpp_driver INTERFACE)
 
+# Win/Unix specific option. 
+if((${WIN32}) OR (${UNIX}))    
+        target_compile_options(rpp_driver
+                                    INTERFACE
+                                    --coverage
+                                    )
+endif()
+
 add_subdirectory(codec)
 add_subdirectory(i2c)
 add_subdirectory(gpio)

src/codec/adau1361.cpp

@@ -5,6 +5,10 @@
  *      Author: Seiichi "Suikan" Horie
  */
 
+// GCC/Clang : Promote the switch-enum warning to error.
+// MSVC : ignored.
+#pragma GCC diagnostic error "-Wswitch-enum"
+
 #include "adau1361.hpp"
 
 #include <assert.h>
@@ -94,9 +98,6 @@ void ::rpp_driver::Adau1361::SetGain(CodecChannel channel, float left_gain,
       adau1361_lower_.SetHpOutputGain(hp_output_left_gain_,
                                       hp_output_right_gain_, hp_output_mute_);
       break;
-    default:
-      assert(false);
-      break;
   }
   CODEC_SYSLOG("Leave.")
 }
@@ -130,9 +131,6 @@ void ::rpp_driver::Adau1361::Mute(CodecChannel channel, bool mute) {
       adau1361_lower_.SetHpOutputGain(hp_output_left_gain_,
                                       hp_output_right_gain_, hp_output_mute_);
       break;
-    default:
-      assert(false);
-      break;
   }
   CODEC_SYSLOG("Leave.")
 }

src/codec/adau1361lower.cpp

@@ -86,10 +86,6 @@ void ::rpp_driver::Adau1361Lower::WaitPllLock(void) {
 // Configure PLL and start. Then, initiate the core and set the CODEC Fs.
 void ::rpp_driver::Adau1361Lower::ConfigurePll(unsigned int fs,
                                                unsigned int master_clock) {
-  assert((fs == 24000 || fs == 32000 || fs == 48000 || fs == 96000 ||
-          fs == 22050 || fs == 44100 || fs == 88200) &&
-         "Bad Fs");
-
   if (fs == 24000 || fs == 32000 || fs == 48000 || fs == 96000) {
     // Configure the PLL. Target PLL out is 49.152MHz = 1024xfs
     // Regarding X, R, M, N, check ADAU1361 Datasheet register R1.
@@ -446,7 +442,7 @@ void ::rpp_driver::Adau1361Lower::ConfigurePll(unsigned int fs,
     }
 
   } else {  // Fs must be checked at the top of this routine.
-    assert(false && "Wrong parameter validation");
+    assert(false && "Wrong Fs");
   }
 
 }  // ConfigurePlll

src/codec/adau1361lower.hpp

@@ -223,7 +223,9 @@ class Adau1361Lower {
   virtual void SetHpOutputGain(float left_gain, float right_gain, bool mute);
 
  protected:
+  /// @brief Internal variable to hold the I2C controller variable.
   ::rpp_driver::I2cMasterInterface& i2c_;
+  /// @brief Internal variable to hold the I2C device address.
   const unsigned int device_addr_;
 };
 

src/gpio/gpiobasic.hpp

@@ -34,15 +34,16 @@ class GpioBasic {
  public:
   /**
    * @brief Initialize the given GPIO pin and setup the pins.
+   * @param sdk Sdk wrapper to inject the dependency.
    * @param pin GPIO pin number.
    * @details
    * Receive the GPIO pin.
-   * And then, init it by ::rpp_driver::gpio_init().
+   * And then, init it by SdkWrapper::gpio_init().
    */
   GpioBasic(SdkWrapper &sdk, uint pin);
   GpioBasic() = delete;
   /**
-   * @brief deinit the GPIO by ::rpp_driver::gpio_deinit();
+   * @brief deinit the GPIO by SdkWrapper::gpio_deinit();
    */
   virtual ~GpioBasic();
   /**

src/i2c/i2cmaster.hpp

@@ -16,9 +16,12 @@
 #if __has_include(<hardware/i2c.h>)
 #include "hardware/i2c.h"
 #else
-// Alternate definition for unit test.
+/// Alternate definition for unit test.
 typedef int i2c_inst_t;
+/// Alternate definition of the return value on error for Google Test build.
 #define PICO_ERROR_GENERIC -1
+/// Alternate definition of the return value on error for I2C function number
+/// for GPIO.
 #define GPIO_FUNC_I2C 11
 #endif  // __has_include(<hardware/i2c.h>)
 
@@ -51,14 +54,14 @@ class I2cMaster : public I2cMasterInterface {
    * @param sda_pin GPIO pin #
    * @details
    * Receive the uninitialized I2C hardware by parameter i2c, and initialize
-   * it by ::rpp_driver::i2c_init().
+   * it by SdkWrapper::i2c_init().
    * And then, set given pins to I2C function, and pull them up.
    */
   I2cMaster(SdkWrapper &sdk, i2c_inst_t &i2c, uint clock_freq, uint scl_pin,
             uint sda_pin);
   I2cMaster() = delete;
   /**
-   * @brief deinit the I2C by ::rpp_driver::i2c_deinit();
+   * @brief deinit the I2C by SdkWrapper::i2c_deinit();
    */
   virtual ~I2cMaster();
   /**

src/i2c/i2cmasterinterface.hpp

@@ -16,6 +16,7 @@
 #include <stdlib.h>
 
 #if !__has_include(<hardware/i2c.h>)
+/// @brief  Alternate definition of the uint for Google Test build.
 typedef unsigned uint;
 #endif