Cumulative Development Updates

.github/workflows/build-cmake.yml

@@ -0,0 +1,90 @@
+# This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
+name: Build with CMake
+
+on:
+  push:
+    branches: [ "main", "dev*" ]
+  pull_request:
+    branches: [ "main", "dev*" ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
+      fail-fast: false
+
+      # Set up a matrix to run the following configurations:
+      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
+      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
+      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
+      # 4. <MacOS, Release, latest Clang compiler toolchain on the default runner image, default generator>
+      ##
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        build_type: [Release]
+        c_compiler: [gcc, clang, cl]
+        include:
+          - os: windows-latest
+            c_compiler: cl
+            cpp_compiler: cl
+          - os: ubuntu-latest
+            c_compiler: gcc
+            cpp_compiler: g++
+          - os: ubuntu-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+          - os: macos-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+        exclude:
+          - os: windows-latest
+            c_compiler: gcc
+          - os: windows-latest
+            c_compiler: clang
+          - os: ubuntu-latest
+            c_compiler: cl
+          - os: macos-latest
+            c_compiler: cl
+          - os: macos-latest
+            c_compiler: gcc
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-tags: true
+        fetch-depth: 0
+
+    - name: Set Vars
+      id: strings
+      shell: bash
+      run: |
+        echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
+        echo "artifact-name=libtslitex-${{ matrix.os }}-${{ matrix.c_compiler }}-artifacts" >> "$GITHUB_OUTPUT"
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: >
+        cmake -B ${{ steps.strings.outputs.build-output-dir }}
+        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
+        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
+        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+        -S ${{ github.workspace }}
+
+    - name: Build
+      # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --clean-first --config ${{ matrix.build_type }}
+
+    # - name: Test
+    #   working-directory: ${{ steps.strings.outputs.build-output-dir }}
+    #   # Execute tests defined by the CMake configuration. Note that --build-config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+    #   # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+    #   run: ctest --build-config ${{ matrix.build_type }}
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: ${{ steps.strings.outputs.artifact-name }}
+        path: ${{ steps.strings.outputs.build-output-dir }}/artifacts

.github/workflows/build-python-bindings.yml

@@ -0,0 +1,71 @@
+# This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
+name: Build Python Bindings with CMake
+
+on:
+  push:
+    branches: [ "main", "dev*" ]
+  pull_request:
+    branches: [ "main", "dev*" ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
+      fail-fast: false
+
+      # Set up a matrix to run the following configurations:
+      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
+      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
+      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
+      # 4. <MacOS, Release, latest Clang compiler toolchain on the default runner image, default generator>
+      ##
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        build_type: [Release] # Note, debug builds are not generated as they require the debug version of Python to be installed.
+        platform: [auto]
+        arch: [auto64]
+
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-tags: true
+        fetch-depth: 0
+
+    - name: Setup Python Environment
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+        cache: 'pip'
+    - run: pip install -r ${{ github.workspace }}/requirements.txt
+
+    - name: Set Vars
+      id: strings
+      shell: bash
+      run: |
+        echo "build-output-dir=${{ github.workspace }}/build/" >> "$GITHUB_OUTPUT"
+        echo "build-wheels-dir=${{ github.workspace }}/build/bindings/python/wheelhouse/" >> "$GITHUB_OUTPUT"
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory.
+      run: >
+        cmake -B ${{ steps.strings.outputs.build-output-dir }}
+        -DPY_PLATFORM=${{ matrix.platform }}
+        -DPY_ARCH=${{ matrix.arch }}
+        -S ${{ github.workspace }}
+
+    - name: Build Library
+      # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --clean-first --config ${{ matrix.build_type }} -t tslitex_static
+
+    - name: Build Python Wheels
+      # Build Wheel from Cython code.
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }} -t PyWheels
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: wheel-${{ matrix.os }}-${{ matrix.arch }}
+        path: ${{ steps.strings.outputs.build-wheels-dir }}/*.whl

.gitignore

@@ -1,4 +1,4 @@
-build*
+build/*
 artifacts/*
 .vscode
 .venv

CMakeLists.txt

@@ -1,24 +1,65 @@
-cmake_minimum_required(VERSION 3.20)
+cmake_minimum_required(VERSION 3.22...4.1)
 
 project(libtslitex)
 
+# Set Version
+include(version.cmake)
+
 enable_language(C)
 set(CMAKE_C_STANDARD 17)
 set(CMAKE_C_STANDARD_REQUIRED ON) # error if compiler doesn't support c17
 set(CMAKE_C_EXTENSIONS ON)
 
+if(MSVC)
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /std:c17 /experimental:c11atomics")
+endif(MSVC)
 
 enable_language(CXX)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON) # error if compiler doesn't support c++17
 set(CMAKE_CXX_EXTENSIONS ON)
 
+################################
+# Project Dependencies
+################################
+include(FetchContent)
+
+# json-c Library
+FetchContent_Declare(
+    json_c
+    GIT_REPOSITORY  https://github.com/json-c/json-c.git
+    GIT_TAG         2372e9518e6ba95b48d37ec162bc7d93b297b52f
+)
+set(JSON_C_BUILD_APPS OFF)
+set(JSON_C_BUILD_SHARED_LIBS OFF)
+FetchContent_MakeAvailable(json_c)
+
+# zlib Library
+FetchContent_Declare(
+    zlib
+    GIT_REPOSITORY  https://github.com/madler/zlib.git
+    GIT_TAG         v1.3.1
+)
+
+set(ZLIB_BUILD_TESTING OFF)
+set(ZLIB_BUILD_SHARED  OFF)
+set(ZLIB_INSTALL       OFF)
+FetchContent_MakeAvailable(zlib)
+
+
+
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/artifacts/libtslitex")
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/artifacts/libtslitex")
 
-add_definitions(-DUNICODE -D_UNICODE)
+option(ENABLE_FACTORY_PROVISIONING "Include Factory Provisioning Functions" OFF)
+
+if(ENABLE_FACTORY_PROVISIONING)
+    add_compile_definitions(FACTORY_PROVISIONING_API)
+endif()
 
-add_definitions(-DEN_LOGGING)
+add_compile_definitions(UNICODE _UNICODE)
+
+add_compile_definitions(EN_LOGGING)
 
 add_compile_definitions("$<$<CONFIG:Debug>:EN_LOGGING_DEBUG>")
 
@@ -33,6 +74,7 @@ set(TS_SOURCES
     src/spi.c
     src/afe.c
     src/adc.c
+    src/events.c
     src/hmcad15xx.c
     src/lmh6518.c
     src/mcp4728.c
@@ -43,6 +85,7 @@ set(TS_SOURCES
     src/samples.c
     src/spiflash.c
     src/ts_channel.c
+    src/ts_data.c
     src/ts_fw_manager.c
     src/thunderscope.c
     )
@@ -53,6 +96,7 @@ set(TS_HEADERS
     src/spi.h
     src/adc.h
     src/afe.h
+    src/events.h
     src/mcp_clkgen.h
     src/mcp_zl3026x.h
     src/platform.h
@@ -63,6 +107,7 @@ set(TS_HEADERS
     src/samples.h
     src/spiflash.h
     src/ts_channel.h
+    src/ts_data.h
     src/ts_fw_manager.h
     src/util.h
     )
@@ -80,13 +125,24 @@ add_library(tslitex SHARED ${TS_SOURCES}
             ${TS_LIB_HEADERS}
             )
 
-
+set_target_properties(tslitex PROPERTIES VERSION ${${PROJECT_NAME}_VERSION})
 set_target_properties(tslitex PROPERTIES
     RUNTIME_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/$<0:>
     LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/$<0:>
     ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/$<0:>)
 
-target_link_libraries(tslitex litepcie)
+target_link_libraries(tslitex 
+    PUBLIC 
+        "$<LINK_LIBRARY:WHOLE_ARCHIVE,litepcie>"
+    PRIVATE
+        json-c-static
+        zlibstatic
+)
+
+if(APPLE)
+    target_link_libraries(tslitex PRIVATE "$<LINK_LIBRARY:FRAMEWORK,IOKit>")
+endif()
+
 target_include_directories(tslitex PUBLIC include)
 
 ####
@@ -96,25 +152,37 @@ add_library(tslitex_static STATIC ${TS_SOURCES}
             ${TS_LIB_HEADERS}
             )
 
+set_target_properties(tslitex_static PROPERTIES VERSION ${${PROJECT_NAME}_VERSION})
 set_target_properties(tslitex_static PROPERTIES
     RUNTIME_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/$<0:>
     LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/$<0:>
     ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/$<0:>)
-
-#target_compile_definitions(tslitex_static tslitex_static_STATIC)
+
 set_target_properties(tslitex_static PROPERTIES POSITION_INDEPENDENT_CODE 1)
 
+target_link_libraries(tslitex_static 
+    PUBLIC
+        "$<LINK_LIBRARY:WHOLE_ARCHIVE,litepcie>"
+    PRIVATE
+        json-c-static
+        zlibstatic
+)
 
-target_link_libraries(tslitex_static litepcie)
 target_include_directories(tslitex_static PUBLIC include)
 
+if(APPLE)
+    target_link_libraries(tslitex_static PRIVATE "$<LINK_LIBRARY:FRAMEWORK,IOKit>")
+endif()
+
 file(COPY ${TS_LIB_HEADERS} DESTINATION ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/include)
 
+####
+# EXAMPLE APPLICATIONS
+####
 add_subdirectory(example)
 
 ####
 # BINDINGS
 ####
 add_subdirectory(bindings/python)
-add_dependencies(PyBindings tslitex_static litepcie)
 

README.md

@@ -31,10 +31,11 @@ To build the python bindings, you must first have pipx and cython installed. The
 > pip install -r requirements.txt
 ```
 
-Now you can build the `PyBindings` target with cmake
+Now you can build the `PyBindings` target with cmake.  If you get an error about some module not being installed, recreate the cmake cache with `cmake --fresh ..`
 
 ```bash
 > cd build/
+> cmake --fresh ..
 > cmake --build . -t PyBindings
 ```