From 54556485b3bea7bce9a26137a16843c3ebf1c56d Mon Sep 17 00:00:00 2001 From: Christophe Favergeon Date: Mon, 26 Feb 2024 11:11:09 +0100 Subject: [PATCH] Updated documentation --- Documentation/Doxygen/dsp.dxy.in | 4 +- Documentation/Doxygen/src/history.txt | 86 +++++++++++++++++++++++ Include/dsp/interpolation_functions_f16.h | 3 + Include/dsp/transform_functions.h | 8 ++- Source/TransformFunctions/arm_mfcc_q15.c | 3 +- Source/TransformFunctions/arm_mfcc_q31.c | 3 +- Testing/cmsis_build/runall.py | 1 + 7 files changed, 103 insertions(+), 5 deletions(-) diff --git a/Documentation/Doxygen/dsp.dxy.in b/Documentation/Doxygen/dsp.dxy.in index 84be2e74d..73c175731 100644 --- a/Documentation/Doxygen/dsp.dxy.in +++ b/Documentation/Doxygen/dsp.dxy.in @@ -500,7 +500,7 @@ NUM_PROC_THREADS = 1 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -564,7 +564,7 @@ RESOLVE_UNNAMED_PARAMS = YES # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. -HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set diff --git a/Documentation/Doxygen/src/history.txt b/Documentation/Doxygen/src/history.txt index e69de29bb..83e528ff0 100644 --- a/Documentation/Doxygen/src/history.txt +++ b/Documentation/Doxygen/src/history.txt @@ -0,0 +1,86 @@ +/** +\page rev_hist Revision History + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VersionDescription
v1.15.0 + v1.15.0 + + * Switched to semantic versioning + * Corrections to MFCC + * Updated support for cmsis build tools 2.0 + * Compute graph removed. It is now part of CMSIS-Stream + * Github issues: + * 95,96,105,106,108,111,112 + * New FFT initializations to allow linker to do code size optimizations + * If you know the size of the transform at build time, prefer functions like + arm_cfft_init_64_q15 to functions like arm_cfft_init_q15. + It applies for CFFT, RFFT and MFCC and other datatypes. +
v1.14.4 + Version v1.14.4 +
v1.14.3 + v1.14.3 +
v1.14.2 + Bug fixes. + + Bug fixes and improvements to compute graph. +
v1.14.1 + Some Neon acceleration for aarch64 f64 kernels +
v1.14.0 + Added support for CMSIS Event Recorder to the compute graph. + Added more customization options to the compute graph. +
v1.13.0 + Added cyclo static scheduling to the CMSIS-DSP compute graph +
v1.12.0 + New version of SDF + (Renaming and new feature to make it more developer friendly). +
v1.11.0 + Improved documentation. + + QR decomposition with Householder transform (float only). +
v1.10.1 + First release with new repository +
+*/ diff --git a/Include/dsp/interpolation_functions_f16.h b/Include/dsp/interpolation_functions_f16.h index 3df5ecdae..0a35b8c95 100755 --- a/Include/dsp/interpolation_functions_f16.h +++ b/Include/dsp/interpolation_functions_f16.h @@ -40,6 +40,9 @@ extern "C" #if defined(ARM_FLOAT16_SUPPORTED) +/** + * @brief Instance structure for the half floating-point Linear Interpolate function. + */ typedef struct { uint32_t nValues; /**< nValues */ diff --git a/Include/dsp/transform_functions.h b/Include/dsp/transform_functions.h index 3a34ce56e..a43c15740 100755 --- a/Include/dsp/transform_functions.h +++ b/Include/dsp/transform_functions.h @@ -867,6 +867,9 @@ arm_status arm_mfcc_init_f32( float32_t *pTmp ); + /** + * @brief Instance structure for the Q31 MFCC function. + */ typedef struct { const q31_t *dctCoefs; /**< Internal DCT coefficients */ @@ -993,7 +996,7 @@ arm_status arm_mfcc_init_q31( @param[in] pSrc points to the input samples @param[out] pDst points to the output MFCC values @param[inout] pTmp points to a temporary buffer of complex - @return none + @return error status */ arm_status arm_mfcc_q31( const arm_mfcc_instance_q31 * S, @@ -1002,6 +1005,9 @@ arm_status arm_mfcc_init_q31( q31_t *pTmp ); + /** + * @brief Instance structure for the Q15 MFCC function. + */ typedef struct { const q15_t *dctCoefs; /**< Internal DCT coefficients */ diff --git a/Source/TransformFunctions/arm_mfcc_q15.c b/Source/TransformFunctions/arm_mfcc_q15.c index 824fb1afe..899bfd231 100755 --- a/Source/TransformFunctions/arm_mfcc_q15.c +++ b/Source/TransformFunctions/arm_mfcc_q15.c @@ -56,7 +56,8 @@ @param[in] pSrc points to the input samples in Q15 @param[out] pDst points to the output MFCC values in q8.7 format @param[inout] pTmp points to a temporary buffer of complex - + @return error status + @par Description The number of input samples is the FFT length used when initializing the instance data structure. diff --git a/Source/TransformFunctions/arm_mfcc_q31.c b/Source/TransformFunctions/arm_mfcc_q31.c index 8b57e4d66..4be35f26e 100755 --- a/Source/TransformFunctions/arm_mfcc_q31.c +++ b/Source/TransformFunctions/arm_mfcc_q31.c @@ -56,7 +56,8 @@ @param[in] pSrc points to the input samples in Q31 @param[out] pDst points to the output MFCC values in q8.23 format @param[inout] pTmp points to a temporary buffer of complex - + @return error status + @par Description The number of input samples is the FFT length used when initializing the instance data structure. diff --git a/Testing/cmsis_build/runall.py b/Testing/cmsis_build/runall.py index c7857940c..f78b89227 100644 --- a/Testing/cmsis_build/runall.py +++ b/Testing/cmsis_build/runall.py @@ -212,6 +212,7 @@ def runAVH(build,core): 'test_ac6.csolution.yml':[ # ("VHT-Corstone-310","CS310"), ("VHT-Corstone-300","CS300"), + # ("VHT-Corstone-300-NOMVE","CS300"), ("VHT_M33","M33_DSP_FP"), ("VHT_M7","M7DP"), ("VHT_M7_UNROLLED","M7DP"),