From c4e40d26a9058d6af324d005d6a8ff4193e830f0 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 24 Jul 2025 02:28:24 +0000 Subject: [PATCH] Update README.md --- README.en.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..ea9673c --- /dev/null +++ b/README.en.md @@ -0,0 +1,41 @@ +# MM32F0121 C6 MDK Project + +## Project Introduction +This project is part of the CMSIS DSP library based on Cortex-M series processors, providing efficient digital signal processing capabilities. The project contains multiple modules, such as matrix operations, transform functions, controller functions, statistical functions, and support functions, suitable for signal processing tasks in embedded systems. + +## Key Features +- **Matrix Operations**: Provides matrix addition, subtraction, multiplication, inversion, and more. +- **Transform Functions**: Includes Discrete Cosine Transform (DCT), Fast Fourier Transform (FFT), etc. +- **Controller Functions**: Such as sine and cosine wave generation. +- **Statistical Functions**: Calculates maximum, minimum, average, etc. +- **Support Functions**: Provides auxiliary functionalities like data copying and filling. + +## Installation and Configuration +1. **Hardware Requirements**: A development board supporting Cortex-M series processors. +2. **Software Requirements**: Install the MDK-ARM development environment. +3. **Compiler Settings**: Define the appropriate preprocessor macros according to the target processor, such as `ARM_MATH_CM7`, `ARM_MATH_CM4`. + +## Usage Examples +### Matrix Operations +```c +arm_matrix_instance_f32 S = {nRows, nColumns, pData}; +``` +Here, `nRows` represents the number of rows in the matrix, `nColumns` represents the number of columns, and `pData` points to the matrix data array. + +### Sine and Cosine Wave Generation +```c +void arm_sin_cos_f32(float32_t theta, float32_t *pSin, float32_t *pCos); +``` +This function generates the sine and cosine values for the specified angle `theta`. + +### Data Copying +```c +void arm_copy_f32(float32_t *pSrc, float32_t *pDst, uint32_t blockSize); +``` +This function copies `blockSize` floating-point numbers from the source address `pSrc` to the destination address `pDst`. + +## Contribution Guidelines +Code and documentation contributions are welcome. Please follow the Apache-2.0 license and ensure that the code complies with the MISRA-C:2004 standard. + +## License Notice +This project is licensed under the Apache-2.0 License. For details, please refer to the [LICENSE](LICENSE) file. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..15f92ab --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# MM32F0121 C6 MDK 项目 + +## 项目简介 +本项目是基于 Cortex-M 系列处理器的 CMSIS DSP 库的一部分,提供了高效的数字信号处理功能。项目包含多个模块,如矩阵运算、变换函数、控制器函数、统计函数和支持函数等,适用于嵌入式系统中的信号处理任务。 + +## 主要特性 +- **矩阵运算**:提供矩阵加法、减法、乘法、求逆等操作。 +- **变换函数**:包括离散余弦变换(DCT)、快速傅里叶变换(FFT)等。 +- **控制器函数**:如正弦波和余弦波生成。 +- **统计函数**:计算最大值、最小值、平均值等。 +- **支持函数**:提供数据拷贝、填充等辅助功能。 + +## 安装与配置 +1. **硬件要求**:支持 Cortex-M 系列处理器的开发板。 +2. **软件要求**:安装 MDK-ARM 开发环境。 +3. **编译器设置**:根据目标处理器定义相应的预处理器宏,如 `ARM_MATH_CM7`、`ARM_MATH_CM4` ://www.apache.org/licenses/LICENSE-2.0. + +## 使用示例 +### 矩阵运算 +```c +arm_matrix_instance_f32 S = {nRows, nColumns, pData}; +``` +其中 `nRows` 表示矩阵的行数,`nColumns` 表示矩阵的列数,`pData` 指向矩阵数据数组。 + +### 正弦波生成 +```c +void arm_sin_cos_f32(float32_t theta, float32_t *pSin, float32_t *pCos); +``` +该函数用于生成指定角度 `theta` 的正弦和余弦值。 + +### 数据拷贝 +```c +void arm_copy_f32(float32_t *pSrc, float32_t *pDst, uint32_t blockSize); +``` +该函数将 `blockSize` 个浮点数从源地址 `pSrc` 拷贝到目标地址 `pDst`。 + +## 贡献指南 +欢迎贡献代码和文档。请遵循 Apache-2.0 许可证,并确保代码符合 MISRA-C:2004 规范。 + +## 版权声明 +本项目遵循 Apache-2.0 许可证。详情请参阅 [LICENSE](LICENSE) 文件。 \ No newline at end of file -- Gitee