Skip to content

Commit 97daa89

Browse files
committed
doc: optimize iar projects notes for this release
Signed-off-by: Huaqi Fang <[email protected]>
1 parent 2bbbf99 commit 97daa89

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

NMSIS/ideprojects/iar/README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
> This NMSIS IAR prebuilt projects maybe out of date, you may need to add NMSIS DSP and NN source code into IAR projects
55
> by yourself.
66
7+
## Introduction
8+
79
In this folder, we provided a prebuilt IAR workspace(for IAR RISC-V version 3.30.1) to build NMSIS DSP/NN libraries.
810

911
> You can refer to these demo projects to build your own iar projects.
@@ -30,6 +32,8 @@ These projects demonstrated the following features:
3032
> and these prebuilt project used NMSIS Core/DSP/NN header files provided in Nuclei SDK which is the NMSIS 1.4.0
3133
> release version, and default using library is also Nuclei SDK prebuilt NMSIS 1.4.0 DSP/NN GCC library.
3234
35+
## How to use
36+
3337
How to build the projects in **nmsis_dsp_examples.eww** and **nmsis_nn_examples.eww** workspace:
3438

3539
* Clone the ``NMSIS`` and ``nuclei-sdk`` respository
@@ -92,7 +96,15 @@ After done, the ``nuclei-sdk`` and ``NMSIS`` directory must place **in the same
9296

9397
* After example built successfully, the executable target is in `Your path\NMSIS\NMSIS\ideprojects\iar\examples\Debug\Exe` with **.out** which can be downloaded to our FPGA evaluation board.
9498

95-
**Some Notes**:
99+
You can directly try with these prebuilt IAR workspaces by clicking ``nmsis_library.eww``/``nmsis_dsp_examples.eww``/``nmsis_nn_examples.eww`` after you have installed [IAR Workbench](https://www.iar.com/riscv).
100+
101+
![IAR NMSIS Library Projects for Nuclei](assests/nmsis_iar_projects.png)
102+
103+
![IAR NMSIS Example Projects for Nuclei](assests/nmsis_iar_example_projects.png)
104+
105+
For more details about how to use IAR workbench, please refer to its user guides.
106+
107+
## FAQs
96108

97109
* **nn_cifar10_example** and **riscv_linear_interp_example** use the linker script `Your path\NMSIS\NMSIS\ideprojects\iar\linker\iar_evalsoc_ilm_512K.icf`, while by default others use the one in `Your path\nuclei-sdk\SoC\evalsoc\Board\nuclei_fpga_eval\Source\IAR`:
98110
* nn_cifar10_example takes more than 64KBytes rom/ram size, so it uses `iar_evalsoc_ilm_512K.icf` where set ROM and RAM to 512KBytes(our Evaluation SoC's best config bitstream ilm/dlm size)
@@ -109,14 +121,8 @@ After done, the ``nuclei-sdk`` and ``NMSIS`` directory must place **in the same
109121
110122
> define region RAM_region32 = mem:[from 0x90000000 to 0x9007FFFF];
111123
112-
* Stack and heap size is 0x1000(4KBytes), you can adapt it according to your application in IAR project settings: `Options->General Options->Code Generation->Stack/Heap`.
124+
* Stack and heap size in IAR is **0x1000(4KBytes)**, you can adapt it according to your application in IAR project settings: `Options->General Options->Code Generation->Stack/Heap`.
113125

114126
* The examples build with **header files** from `Your path\nuclei-sdk\NMSIS`, please check whether the version is same with `Your path\NMSIS\NMSIS`, if not, sync it according to `Your path\NMSIS\NMSIS`.
115127

116-
You can directly try with these iar workspaces by clicking nmsis_library.eww/nmsis_dsp_examples.eww/nmsis_nn_examples.eww after you have installed [IAR Workbench](https://www.iar.com/riscv).
117-
118-
![IAR Projects for Nuclei](assests/nmsis_iar_projects.png)
119-
120-
![IAR Projects for Nuclei](assests/nmsis_iar_example_projects.png)
121-
122-
For more details about how to use IAR workbench, please refer to its user guides.
128+
* [IAR IDE shows that Fatal Error\[Li001\]: could not open file ideprojects\iar\library\prebuilt\libnmsis_dsp_rv32imafdc.a](https://github.com/Nuclei-Software/NMSIS/issues/4)

0 commit comments

Comments
 (0)