cmake: sdp: docs for CMake functions

Add documentation for CMake functions used in SDP.

Signed-off-by: Marcin Szymczyk <[email protected]>

Author: masz-nordic

cmake/sdp.cmake

@@ -4,6 +4,16 @@
 # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 #
 
+# This function takes as an argument target to be built and path to .c source file(s)
+# whose .s output must be verified against .s file tracked in repository. It then:
+# - adds a pre-build dependency that generates .s files in build directory
+# - adds a dependency on specified target to call sdp_asm_check.cmake with appropriate arguments
+# - adds a custom target that calls sdp_asm_install.cmake with appropriate arguments
+# - adds .s files from build directory to target sources
+#
+# Arguments:
+# target   - target to which the dependencies are to be applied
+# hrt_srcs - path to the .c source file(s) to verify
 function(sdp_assembly_install target hrt_srcs)
   sdp_assembly_generate(${CONFIG_SOC} "${hrt_srcs}")
   sdp_assembly_check(${CONFIG_SOC} "${hrt_srcs}")

cmake/sdp_asm_check.cmake

@@ -4,6 +4,11 @@
 # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 #
 
+# Function checking if .s file generated during build is identical to one tracked in repository
+#
+# Arguments:
+# hrt_srcs - path to the .c file(s) to verify
+# soc      - name of the SoC the code is being built for
 function(asm_check)
   if(NOT DEFINED soc)
     message(FATAL_ERROR "asm_check missing soc argument.")

cmake/sdp_asm_install.cmake

@@ -4,6 +4,11 @@
 # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 #
 
+# Function that replaces .s file tracked in repository with updated version from build
+#
+# Arguments:
+# hrt_srcs - path to the .c file(s) to verify
+# soc      - name of the SoC the code is being built for
 function(asm_install)
   if(NOT DEFINED soc)
     message(FATAL_ERROR "asm_install missing soc argument.")