Initial commit with Library code, testing, examples and documentation

Signed-off-by: Josue David Hernandez Gutierrez <[email protected]>
Signed-off-by: Castulo J. Martinez <[email protected]>

Author: castulo

.github/builder/action.yml

@@ -0,0 +1,14 @@
+name: 'USB I3C* Library for Linux* OS Builder'
+description: 'Builds and test the USB I3C* Library for Linux* OS'
+inputs:
+  path:
+    description: 'Directory in the GitHub workspace where the source files can be found'
+    required: true
+  coverage_threshold:
+    description: 'The minimum unit test coverage percentage that is acceptable for the project'
+    required: true
+runs:
+  using: 'composite'
+  steps:
+    - run: ${{ github.action_path }}/run_unit_test.sh ${{ inputs.path }} ${{ inputs.coverage_threshold }}
+      shell: bash

.github/builder/run_unit_test.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+set -ex
+
+SRC_PATH=$1
+COVERAGE_THRESHOLD=$2
+
+if [ -z "$SRC_PATH" ]; then
+    echo "SRC_PATH not defined!"
+    exit 1
+fi
+
+if [ -z "$COVERAGE_THRESHOLD" ]; then
+    echo "COVERAGE_THRESHOLD not defined!"
+    exit 1
+fi
+
+pushd "$SRC_PATH"
+
+rm -fR build
+mkdir build
+
+# Run the tests in Release mode and check code coverage
+# and code style (the coverage target runs all unit tests)
+cmake -DBUILD_TESTS=ON -DCOVERAGE=ON -DDOCUMENTATION=ON -DBUILD_SAMPLES=ON -DCMAKE_BUILD_TYPE=Debug -B build/
+cmake --build build/ -- -j6
+cmake --build build/ --target coverage
+cmake --build build/ --target check_style
+
+# Make sure unit test coverage doesn't fall below the predefined threshold
+function_coverage=$(lcov --summary build/coverage/coverage.info | grep functions | cut -c 16-17)
+line_coverage=$(lcov --summary build/coverage/coverage.info | grep lines | cut -c 16-17)
+echo "The current function coverage is $(lcov --summary build/coverage/coverage.info | grep functions | cut -c 16-19)%"
+if [ "$function_coverage" -lt "$COVERAGE_THRESHOLD" ]; then
+    echo "The current function coverage falls below the $COVERAGE_THRESHOLD% threshold."
+    exit 1
+fi
+echo "The current line coverage is $(lcov --summary build/coverage/coverage.info | grep lines | cut -c 16-19)%"
+if [ "$line_coverage" -lt "$COVERAGE_THRESHOLD" ]; then
+    echo "The current line coverage falls below the $COVERAGE_THRESHOLD% threshold."
+    exit 1
+fi
+
+# Copy the coverage directory so we don't loose it
+rm -rf ./coverage
+cp -r build/coverage .
+
+# Running the various code sanitizers
+# -----------------------------------
+clean_and_build() {
+    rm -fR build
+    mkdir build
+    cmake -DBUILD_TESTS=ON -DDOCUMENTATION=OFF -DBUILD_SAMPLES=OFF -DCMAKE_BUILD_TYPE="$1" -B build/
+    cmake --build build/ -- -j6
+}
+
+run_tests() {
+    cmake --build build/ --target unit_test
+}
+
+echo -e "\nRunning the UndefinedBehaviorSanitizer...\n"
+clean_and_build ubsan
+run_tests
+
+echo -e "\nRunning the LeakSanitizer...\n"
+clean_and_build lsan
+run_tests
+
+echo -e "\nRunning the AddressSanitizer...\n"
+clean_and_build asan
+run_tests
+
+echo -e "\nRunning the ThreadSanitizer...\n"
+clean_and_build tsan
+run_tests
+
+popd

.github/workflows/pr.yml

@@ -0,0 +1,24 @@
+name: Validate Pull Request
+
+on: [pull_request]
+
+jobs:
+  build_package:
+    name: Build job
+    runs-on: [self-hosted, runner1]
+    steps:
+      - id: cleanup_workspace
+        name: Cleanup workspace for the job (self hosted only)
+        run: |
+          rm -fr *
+      - id: checkout_self
+        name: Check out PR
+        uses: actions/checkout@v2
+        with:
+          path: src 
+      - id: build_and_test
+        name: Build and test
+        uses: ./src/.github/builder
+        with:
+          path: src
+          coverage_threshold: 95

.gitignore

@@ -0,0 +1,69 @@
+## https://github.com/github/gitignore/blob/master/CMake.gitignore
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
+build
+
+## https://github.com/github/gitignore/blob/master/C.gitignore
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+.cache/
+.clangd

AUTHORS

@@ -0,0 +1,17 @@
+Current Maintainers
+-------------------
+
+The **USB I3C\* Library for Linux\* OS** is looking for maintainers.
+
+
+Past Maintainers
+----------------
+
+Josue David Hernandez <[email protected]> (until 12/2022)  
+Castulo Martinez <[email protected]> (until 12/2022)
+
+
+Contributors
+------------
+
+Brett T Warden <[email protected]>