Update documentation to 8a8b15c

.clang-format

@@ -0,0 +1,112 @@
+---
+BasedOnStyle: LLVM
+IndentWidth: 4
+---
+Language: Cpp
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        1
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: false
+IndentPPDirectives: None
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 4
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+ReflowComments:  false
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        8
+UseTab:          Never
+...

.clangformatignore

@@ -0,0 +1,11 @@
+apps/uvc-app/include
+apps/uvc-app/lib
+bindings/python/pybind11
+dependencies/third-party
+drivers/
+examples/data_collect/third_party
+examples/data_collect/adi
+examples/tof-viewer/external
+examples/tof-viewer/include/stb_image.h
+examples/tof-viewer/include/linmath.h
+sdk/src/cameras/itof-camera/tofi

.gitignore

@@ -0,0 +1,8 @@
+build/
+
+sdk/include/aditof/version.h
+
+*deps/
+*.temp/
+.vscode/
+.vs/

CMakeLists.txt

@@ -0,0 +1,163 @@
+cmake_minimum_required(VERSION 3.0)
+project(adi_tof_project)
+
+####################### Disable In-source builds ##############################
+if( ${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR} )
+    message(FATAL_ERROR "In-source builds are not allowed. \
+    Consider making a separate build folder and run cmake \
+    from there using this command:
+    cmake ${CMAKE_SOURCE_DIR}")
+endif()
+
+############################### Version #######################################
+set(ADITOF_VERSION_MAJOR 5)
+set(ADITOF_VERSION_MINOR 0)
+set(ADITOF_VERSION_PATCH 0)
+
+set(VERSION "${ADITOF_VERSION_MAJOR}.${ADITOF_VERSION_MINOR}.${ADITOF_VERSION_PATCH}")
+
+############################### Options #######################################
+option(WITH_DOC "Build documentation?" OFF)
+option(WITH_NETWORK "Build network interface?" ON)
+option(WITH_OFFLINE "Build offline interface?" OFF)
+option(WITH_GLOG_DEPENDENCY "Build with GLOG dependency to be used for logging?" ON)
+option(CI_BUILD "Build for CI" OFF)
+
+######################### Target based Options ################################
+option(NXP "Set to ON when building on NXP" OFF)
+option(NVIDIA "Set to ON when building on NVIDIA" OFF)
+option(WITH_PROTOBUF_DEPENDENCY "Build with PROTOBUF dependency?" ON)
+option(USE_DEPTH_COMPUTE_OPENSOURCE "Use an open source implementation?" OFF)
+
+################################## Git ########################################
+include(FindGit OPTIONAL)
+if (GIT_FOUND)
+	execute_process(
+		COMMAND ${GIT_EXECUTABLE} rev-parse --show-toplevel
+		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+		OUTPUT_VARIABLE ADITOFSDK_GIT_REPO
+		OUTPUT_STRIP_TRAILING_WHITESPACE
+		ERROR_QUIET
+	)
+
+	if ("${ADITOFSDK_GIT_REPO}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
+		execute_process(
+			COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
+			WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+			OUTPUT_VARIABLE ADITOFSDK_GIT_COMMIT
+			OUTPUT_STRIP_TRAILING_WHITESPACE
+		)
+		execute_process(
+			COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
+			WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+			OUTPUT_VARIABLE ADITOFSDK_GIT_BRANCH
+			OUTPUT_STRIP_TRAILING_WHITESPACE
+		)
+	endif()
+endif()
+
+add_definitions(-DADITOFSDK_GIT_COMMIT="${ADITOFSDK_GIT_COMMIT}")
+add_definitions(-DADITOFSDK_GIT_BRANCH="${ADITOFSDK_GIT_BRANCH}")
+
+############################## Rest of cmake ##################################
+
+# Check whether we configure things for remote or we're on target
+set(SELECTED_PLATFORMS 0)
+set(ALL_PLATFORMS NXP;NVIDIA)
+foreach(platform IN LISTS ALL_PLATFORMS)
+    if(${platform})
+        math(EXPR SELECTED_PLATFORMS "${SELECTED_PLATFORMS}+1")
+    endif()
+endforeach()
+
+set(ON_TARGET FALSE)
+if(${SELECTED_PLATFORMS} GREATER 1)
+        message(FATAL_ERROR "More than one platform was selected. \nPlease select a single platform. CMake will exit.")
+elseif(${SELECTED_PLATFORMS} EQUAL 1)
+    add_definitions(-DTARGET)
+    set(ON_TARGET TRUE)
+endif()
+
+if(NOT ON_TARGET AND USE_DEPTH_COMPUTE_OPENSOURCE)
+        message (STATUS "USE_DEPTH_COMPUTE_OPENSOURCE is not used on host")
+endif()
+
+if(CI_BUILD)
+    set(USE_DEPTH_COMPUTE_OPENSOURCE ON)
+endif()
+
+if (WITH_NETWORK)
+        add_definitions(-DHAS_NETWORK)
+endif()
+
+set(RESOURCES_DIR "${CMAKE_BINARY_DIR}/resources")
+make_directory(${RESOURCES_DIR})
+
+if (WITH_OFFLINE)
+        add_definitions(-DHAS_OFFLINE)
+
+        set(RESOURCES_OFFLINE_DIR "${RESOURCES_DIR}/offline")
+        make_directory(${RESOURCES_OFFLINE_DIR})
+
+        set(MODE_FILE "lr-native.bin" "sr-native.bin" "lr-qnative.bin" "sr-qnative.bin" "lr-mixed.bin" "sr-mixed.bin")
+        message("Downloading raw frames into ${RESOURCES_OFFLINE_DIR}")
+        foreach(MODE IN LISTS MODE_FILE)
+                set(MODE_URL "swdownloads.analog.com/cse/aditof/resources/itof/frames/${MODE}")
+                set(MODE_PATH "${RESOURCES_OFFLINE_DIR}/${MODE}")
+
+                if (NOT EXISTS ${MODE_PATH})
+                        file(DOWNLOAD "${MODE_URL}" "${MODE_PATH}")
+                endif()
+        endforeach()
+
+        if (ON_TARGET)
+                make_directory("${RESOURCES_OFFLINE_DIR}/adsd3500_raw")
+
+                message("Downloading raw frames into ${RESOURCES_OFFLINE_DIR}/adsd3500_raw")
+                foreach(MODE IN LISTS MODE_FILE)
+                set(MODE_URL "swdownloads.analog.com/cse/aditof/resources/itof/offline/adsd3500_raw/${MODE}")
+                set(MODE_PATH "${RESOURCES_OFFLINE_DIR}/adsd3500_raw/${MODE}")
+
+                if (NOT EXISTS ${MODE_PATH})
+                        file(DOWNLOAD "${MODE_URL}" "${MODE_PATH}")
+                endif()
+        endforeach()
+        endif()
+endif()
+
+if(WITH_GLOG_DEPENDENCY)
+        add_definitions(-DUSE_GLOG)
+endif()
+
+if(NOT WITH_PROTOBUF_DEPENDENCY)
+        if(NOT ON_TARGET)
+                message(FATAL_ERROR "SDK can be built without protobuf only on target builds!")
+        endif()
+else()
+        add_definitions(-DUSE_PROTOBUF)
+endif()
+
+if(${ON_TARGET})
+        if(USE_DEPTH_COMPUTE_OPENSOURCE)
+	        set(LIBTOFI_LIBDIR_PATH "${CMAKE_BINARY_DIR}/sdk/common/adi/depth-compute-opensource")
+        else()
+                set(LIBTOFI_LIBDIR_PATH "${CMAKE_SOURCE_DIR}/../libs")
+        endif()
+endif()
+
+set(CONFIG_DIR_NAME "config")
+add_definitions(-DCONFIG_DIR_NAME="${CONFIG_DIR_NAME}")
+add_definitions(-DRESOURCES="${RESOURCES_DIR}")
+
+add_subdirectory(dependencies)
+add_subdirectory(sdk)
+
+if (WITH_DOC)
+        add_subdirectory(doc)
+endif()
+
+############################### Installer #######################################
+configure_file(cmake/aditof-setup.iss.cmakein ${CMAKE_CURRENT_BINARY_DIR}/aditof-setup.iss @ONLY)
+
+############################### Version #######################################
+configure_file(cmake/version.h.cmakein ${CMAKE_SOURCE_DIR}/sdk/include/aditof/version.h @ONLY)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Analog Devices, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,70 @@
+# Analog Devices 3D ToF software suite 
+
+## Overview
+The **ADI ToF SDK** is a cross platform library for the Analog Devices depth cameras based on the ADSD3100 TOF Signal Processor. It provides support for data processing on the embedded processor platform as well as for USB, Ethernet, Offline or Wi-Fi to connect to a host computer. This flexibility enables evaluation across a wide range of use cases and environments.
+
+The SDK provides an API to control the ToF camera, AB stream and depth data. Windows support are built into the SDK as well as sample code and wrappers for various languages including Python and C/C++.
+
+License : [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+Platform details : [![Hardware](https://img.shields.io/badge/hardware-wiki-green.svg)]()
+
+## Supported Host Platforms
+
+For more details on building the SDK on a host platform please check the **User Guide** specified below:.
+
+| Operating System | Documentation | GitHub main status | Downloads |
+| --------- | ----------- | ----------- | ----------- |
+| Windows | [Build Instructions](scripts/windows) | [![Build status](https://dev.azure.com/AnalogDevices/3DToF-rework/_apis/build/status/analogdevicesinc.ToF?branchName=main)](https://dev.azure.com/AnalogDevices/3DToF-rework/_build?view=runs&branchFilter=3310) | [![ToF evaluation kit installer](https://img.shields.io/badge/release-ToF_evaluation_kit_installer-blue.svg)](https://github.com/analogdevicesinc/ToF/releases/latest) |
+| Linux | [Build Instructions](doc/itof/linux_build_instructions.md) | [![Build status](https://dev.azure.com/AnalogDevices/3DToF-rework/_apis/build/status/analogdevicesinc.ToF?branchName=main)](https://dev.azure.com/AnalogDevices/3DToF-rework/_build?view=runs&branchFilter=3310) | [![ToF evaluation kit installer](https://img.shields.io/badge/release-ToF_evaluation_kit_installer-blue.svg)](https://github.com/analogdevicesinc/ToF/releases/latest) |
+
+### Requirements
+
+Host Platform: 
+
+* Windows 10 or
+* Ubuntu 20.04 or
+* Ubuntu 22.04
+
+Other
+* Python 3.10
+
+## Supported Embedded Platforms
+
+For more details on building the SDK on an embedded platform please check the **User Guide** specified below:
+### ITOF camera
+| Operating system | Evaluation boards | Documentation | GitHub main status |
+| --------- | ----------- | ----------- | ----------- |
+| NXP | [EVAL-ADTF3175D-NXZ](https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175d-nxz) | [Build instructions](doc/itof/nxp_build_instructions.md) | [![Build status](https://dev.azure.com/AnalogDevices/3DToF-rework/_apis/build/status/analogdevicesinc.ToF?branchName=main)](https://dev.azure.com/AnalogDevices/3DToF-rework/_build?view=runs&branchFilter=3310) |
+
+[How to write the SD card image onto the SD card?](doc/sdcard_burn.md)
+
+## SDK Documentation
+
+From an architectural point of view, the SDK consists of two layers. One layer is the high level API that allows clients to easily grab a camera object, configure it and request frames. The other layer is the low level API which exposes the interface through which low level operations can be made to the camera hardware.
+
+For more details about the SDK check the links below:
+
+[Software stack documentation](sdk/readme.md)
+
+[API Doxygen documentation](https://analogdevicesinc.github.io/ToF/)
+
+[Building and installing the SDK](cmake)
+
+## SDK Examples
+The list of examples can be found at [this link.](https://github.com/analogdevicesinc/ToF?tab=readme-ov-file#sdk-examples)
+
+## Directory Structure
+| Directory | Description |
+| --------- | ----------- |
+| ci | Useful scripts for continuous integration |
+| cmake | Helper files for cmake |
+| dependencies | Contains third-party and owned libraries |
+| doc | Documentation |
+| sdk | SDK source code |
+
+---
+**Known issues**
+
+On a PC where Linux kernel version 5.13 is installed, a USB connected camera cannot be detected. The v4l device name that we expect is not being set properly. However it works for older and newer versions. 
+
+---