Skip to content

Commit 1ce7ca9

Browse files
fanghuaqifanghuaqi
committed
doc: Add NMSIS Core SMPCC/ECC/CCache and DSP transform buffer documentation
Signed-off-by: Huaqi Fang <578567190@qq.com>
1 parent 697b67a commit 1ce7ca9

13 files changed

Lines changed: 124 additions & 3 deletions

File tree

‎NMSIS/doc/source/core/api/core_cache.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,13 @@ D-Cache Functions
3636
.. doxygengroup:: NMSIS_Core_DCache
3737
:project: nmsis_core
3838

39+
Cluster-Cache Functions
40+
-----------------------
41+
42+
.. doxygengroup:: NMSIS_Core_CCache
43+
:project: nmsis_core
44+
:outline:
45+
:content-only:
46+
47+
.. doxygengroup:: NMSIS_Core_CCache
48+
:project: nmsis_core

‎NMSIS/doc/source/core/api/core_ecc.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _core_api_ecc:
2+
3+
ECC Functions
4+
=============
5+
6+
.. doxygengroup:: NMSIS_Core_ECC_Functions
7+
:project: nmsis_core
8+
:outline:
9+
:content-only:
10+
11+
.. doxygengroup:: NMSIS_Core_ECC_Functions
12+
:project: nmsis_core
13+

‎NMSIS/doc/source/core/api/core_register_type.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,14 @@ PLIC
2424
.. doxygengroup:: NMSIS_Core_PLIC_Registers
2525
:project: nmsis_core
2626

27+
SMPCC
28+
-----
29+
30+
.. doxygengroup:: NMSIS_Core_SMPCC_Registers
31+
:project: nmsis_core
32+
2733
SysTimer
2834
--------
2935

3036
.. doxygengroup:: NMSIS_Core_SysTimer_Registers
3137
:project: nmsis_core
32-

‎NMSIS/doc/source/core/api/core_smpcc.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _core_api_smpcc:
2+
3+
SMPCC Functions
4+
===============
5+
6+
.. doxygengroup:: NMSIS_Core_SMPCC_Functions
7+
:project: nmsis_core
8+
:outline:
9+
:content-only:
10+
11+
.. doxygengroup:: NMSIS_Core_SMPCC_Functions
12+
:project: nmsis_core
13+

‎NMSIS/doc/source/core/api/index.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ please click `NMSIS Core Doxygen API Documentation`_.
2828
core_spmp.rst
2929
core_pma.rst
3030
core_cache.rst
31+
core_smpcc.rst
32+
core_ecc.rst
3133
core_system_device.rst
3234
core_arm_compatiable.rst
3335
nmsis_bench.rst

‎NMSIS/doc/source/doxygen/nmsis_core.dxy‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -807,9 +807,12 @@ INPUT = nmsis_core.txt \
807807
../../../Core/Include/core_feature_vector.h \
808808
../../../Core/Include/core_feature_bitmanip.h \
809809
../../../Core/Include/core_feature_dsp.h \
810+
../../../Core/Include/core_feature_ecc.h \
810811
../../../Core/Include/core_feature_pmp.h \
811812
../../../Core/Include/core_feature_spmp.h \
812813
../../../Core/Include/core_feature_pma.h \
814+
../../../Core/Include/core_feature_iinfo.h \
815+
../../../Core/Include/core_feature_smpcc.h \
813816
../../../Core/Include/core_feature_cache.h \
814817
../../../Core/Include/core_compatiable.h \
815818
../../../../Device/_Template_Vendor/Vendor/Device/Source/system_Device.c
@@ -2080,12 +2083,12 @@ INCLUDE_FILE_PATTERNS =
20802083

20812084
PREDEFINED = __riscv_flen=64 __riscv_vector=1 __riscv_dsp=1 __riscv_bitmanip=1 \
20822085
__ECLIC_PRESENT=1 __ECLIC_BASEADDR=0x0C000000 __ECLIC_INTNUM=64 __ECLIC_INTCTLBITS=2 \
2083-
__PLIC_PRESENT=1 __SMODE_PRESENT=1 __CCM_PRESENT=1 __SMPCC_PRESENT=1 \
2086+
__PLIC_PRESENT=1 __SMODE_PRESENT=1 __CCM_PRESENT=1 __SMPCC_PRESENT=1 __SMPCC_BASEADDR=0x18040000 \
20842087
__PMA_PRESENT=1 __PMA_MACRO_PRESENT=1 __PMA_CSR_NUM=3 __PMA_SEC_CSR_NUM=3 \
20852088
__SYSTIMER_PRESENT=1 __SYSTIMER_BASEADDR=0x02000000 __IRQC_PRESENT=1 __IRQC_INTNUM=16 \
20862089
__HPM_PRESENT=1 __CIDU_PRESENT=1 __SSTC_PRESENT=1 __SPMP_PRESENT=1 __DSP_PRESENT=1 __VECTOR_PRESENT=1 \
20872090
__PMP_PRESENT=1 __PMP_ENTRY_NUM=16 __SMPU_PRESENT=1 __SPMP_ENTRY_NUM=16 __TEE_PRESENT=1 __FPU_PRESENT=2 \
2088-
__BITMANIP_PRESENT=1 __ICACHE_PRESENT=1 __DCACHE_PRESENT=1 __CCM_PRESENT=1 __Vendor_SysTickConfig=0 \
2091+
__BITMANIP_PRESENT=1 __ICACHE_PRESENT=1 __DCACHE_PRESENT=1 __CCM_PRESENT=1 __ECC_PRESENT=1 __Vendor_SysTickConfig=0 \
20892092
__ONLY_FOR_DOXYGEN_DOCUMENT_GENERATION__
20902093

20912094
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

‎NMSIS/doc/source/dsp/api/api_generictypes.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
Generic Types
44
=============
55

6+
.. toctree::
7+
:maxdepth: 2
8+
9+
10+
generictypes/api_buffersizetypes.rst
11+
612
.. doxygengroup:: genericTypes
713
:project: nmsis_dsp
814
:outline:

‎NMSIS/doc/source/dsp/api/api_grouptransforms.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Transform Functions
1111
grouptransforms/api_dct4_idct4.rst
1212
grouptransforms/api_mfcc.rst
1313
grouptransforms/api_realfft.rst
14+
grouptransforms/api_transformbuffers.rst
1415

1516
.. doxygengroup:: groupTransforms
1617
:project: nmsis_dsp

‎NMSIS/doc/source/dsp/api/generictypes/api_buffersizetypes.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _nmsis_dsp_api_enumerations_for_transform_buffer_size_functions:
2+
3+
Enumerations for transform buffer size functions
4+
================================================
5+
6+
.. doxygengroup:: bufferSizeTypes
7+
:project: nmsis_dsp
8+
:outline:
9+
:content-only:
10+
11+
.. doxygengroup:: bufferSizeTypes
12+
:project: nmsis_dsp

‎NMSIS/doc/source/dsp/api/grouptransforms/api_transformbuffers.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _nmsis_dsp_api_transform_buffer_sizes:
2+
3+
Transform Buffer Sizes
4+
======================
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
10+
transformbuffers/api_cfftbuffers.rst
11+
transformbuffers/api_rfftbuffers.rst
12+
transformbuffers/api_mfccbuffers.rst
13+
14+
.. doxygengroup:: TransformBuffers
15+
:project: nmsis_dsp
16+
:outline:
17+
:content-only:
18+
19+
.. doxygengroup:: TransformBuffers
20+
:project: nmsis_dsp

0 commit comments

Comments
 (0)