HiFi4 DSP Development Guidelines

Enforce development standards for Xtensa HiFi4 DSP projects, ensuring proper documentation, environment management, experiment tracking, and compilation workflows for FFT/IFFT implementations.

Instructions

When working on HiFi4 DSP projects (particularly FFT/IFFT implementations), enforce these standards:

1. Python Documentation

- Brief description

- Args section with type hints

- Returns section with type

- Raises section if applicable

- Example usage when helpful

Example format:

```python

def function_name(arg1: int, arg2: str) -> bool:

"""Brief description of function.

Args:

arg1: Description of arg1

arg2: Description of arg2

Returns:

Description of return value

Raises:

ValueError: When invalid input is provided

"""

```

2. Dependency Management

- `requirements.txt` for Python dependencies

- `Dockerfile` for containerized dependencies

3. Docker Requirements

- Base image specification

- All system dependencies

- Python package installation

- Xtensa toolchain setup if needed

- Working directory configuration

4. Automated File Naming

- Experiment number

- Date (YYYYMMDD format recommended)

- Generating function name

Example: `exp003_20260203_fft_analysis.png` or `exp003_20260203_generate_frequency_plot.csv`

Apply to:

5. Experiment Log File

- Commands executed

- Problems encountered

- Code modifications made

- Results and observations

Example format:

```

實驗 003 - 2026-02-03

==================

執行指令:

xt-clang fftifft_32_32_test_other_signal1.c -o fftifft_test_program ...

遇到問題:

- 編譯錯誤: undefined reference to 'fft_real32x32'

解決步驟:

1. 檢查 library 連結順序

2. 添加 -lNatureDSP_Signal 到編譯指令

3. 重新編譯成功

結果:

- FFT 測試通過，輸出於 exp003_20260203_fft_result.txt

```

6. Xtensa Environment Setup

**On first terminal session, export these environment variables:**

```bash

export XTENSA_SYSTEM=/home/yu-chen/xtensa/XtDevTools/install/tools/RI-2021.6-linux/XtensaTools/config

export XTENSA_BASE=/home/yu-chen/xtensa/XtDevTools/install

export XTENSA_CORE=hifi4_ss_spfpu_7

```

Consider adding to `~/.bashrc` or creating a setup script for persistence.

7. Standard Compilation Workflow

**Compile command pattern:**

```bash

xt-clang [source_file].c \

-o [output_program] \

-I/home/yu-chen/下載/HiFi4_VFPU_Library_v4_1_0/hifi4_library/include \

-L. \

-lAll_fft_NatureDSP_Signal-hifi4_ss_spfpu_7_llvm-Xtensa-release \

-lm

```

**Run command:**

```bash

xt-run [output_program]

```

**Example:**

```bash

Compile

xt-clang fftifft_32_32_test_other_signal1.c \

-o fftifft_test_program_nature_q15 \

-I/home/yu-chen/下載/HiFi4_VFPU_Library_v4_1_0/hifi4_library/include \

-L. \

-lAll_fft_NatureDSP_Signal-hifi4_ss_spfpu_7_llvm-Xtensa-release \

-lm

Execute

xt-run fftifft_test_program_nature_q15

```

Enforcement Checklist

Before committing code, verify:

Notes