【正点原子STM32】新建寄存器版本MDK工程

一、新建工程前的准备工作
二、新建寄存器版本MDK工程步骤

• 2.1、新建工程文件夹
• 2.2、新建一个工程框架
• 2.3、添加文件
• 2.4、魔术棒设置
• 2.5、添加 main.c，并编写代码

三、下载验证
四、总结

一、新建工程前的准备工作

1、下载相关STM32Cube 官方固件包（F1/F4/F7/H7）

STM32Cube官网

路径：战舰 V4资料：资料→8，STM32 参考资料→1，STM32CubeXX固件包

2、搭建开发环境：

请参考 搭建开发环境

二、新建寄存器版本MDK工程步骤

2.1、新建工程文件夹

这是一个典型的STM32工程的目录结构，按照这样的结构可以更好地组织项目文件，使得代码清晰有序，方便团队协作和后期维护。这样的划分主要是基于不同类型的文件和功能进行分类。一般来说：

• Drivers 文件夹存放芯片厂商提供的驱动文件，这里可能包括 STM32 提供的 HAL 库、LL 库等。
• Middlewares 文件夹存放一些中间件组件，这可能包括正点原子提供的中间层组件，或者其他第三方中间件。
• Output 文件夹用于存放编译输出的文件，比如生成的可执行文件、库文件等。
• Projects 文件夹是专门用于存放MDK工程文件的，这样可以将不同类型的文件分开，方便维护。
• User 文件夹通常存放用户自定义的文件，包括 main.c 主程序文件、中断处理文件等。

这样的结构在大型嵌入式项目中是比较常见的，有助于保持项目的整洁和有序。

拷贝/新建工程相关文件

在 Drivers 文件夹中，你进一步细分了一些子文件夹，这是一个更加详细和模块化的组织结构。这种方式可以更好地根据功能和层次关系来组织代码。

• BSP（Board Support Package）文件夹存放开发板的板级支持包，其中包括各种外设的驱动代码。这个文件夹可能包含与具体硬件平台相关的代码，如GPIO、UART、SPI等外设的初始化和操作。

• CMSIS 文件夹存放 Cortex Microcontroller Software Interface Standard (CMSIS) 库的底层代码，比如启动文件（startup 文件，通常是.s文件），这是与 Cortex-M 内核相关的一些底层代码。

• SYSTEM 文件夹存放正点原子提供的系统级核心驱动代码，包括一些通用的系统级功能，比如延时（delay）函数、系统初始化等。

这种结构更具有模块化的特点，使得不同功能和层次的代码能够被更清晰地管理和维护。

2.2、新建一个工程框架

列出了一些新建工程框架的基本步骤和文件夹结构，这些步骤主要针对 Keil μVision 软件进行 STM32 工程的创建。

下面是详细的步骤来新建一个 STM32 工程。这里以 Keil μVision 为例：

1. 新建工程：

   • 打开 Keil μVision 软件。
   • 选择 “Project” 菜单，点击 “New Project”。
   • 在 “Create New Project” 对话框中，选择项目的保存路径和文件名，点击 “Save”。

2. 选择主控型号：

   • 在 “Select Device for Target” 对话框中，选择你的 STM32 主控型号。
     • 可以使用搜索框输入型号，选择对应的供应商和系列，再选择具体型号。
   • 点击 “OK”。

3. 配置目标选项：

   • 在主界面左下角的 “Project” 窗口中，右键点击 “Target 1”，选择 “Options for Target ‘Target 1’”。
   • 在 “Target” 对话框中，可以设置一些编译和调试的选项。
   • 点击 “OK”。

4. 添加源文件：

   • 在 “Project” 窗口中，右键点击 “Source Group 1”（通常是 “Source” 或 “Source Group 1”），选择 “Add New Item to Group ‘Source Group 1’”。
   • 在 “Select ‘Add New Item’ Dialog” 中，选择 “C File (.c)” 或 “C++ File (.cpp)”，输入文件名，点击 “Add”。
   • 在新创建的文件中编写你的代码。

5. 配置系统文件和驱动文件：

   • 在 “Project” 窗口中，右键点击 “Target 1”，选择 “Options for Target ‘Target 1’”。
   • 在 “C/C++” 选项卡中，添加你的头文件路径（例如，CMSIS 和 HAL 库的路径）。
   • 在 “Linker” 选项卡中，添加库文件路径和链接相关的设置。
   • 点击 “OK”。

6. 构建工程：

   • 在工具栏中点击 “Build” 按钮或者按下快捷键（一般是 F7）来构建工程。

7. 下载和调试：

   • 连接你的 STM32 开发板到电脑上。
   • 在工具栏中点击 “Flash” 按钮或者按下快捷键（一般是 F8）来下载程序到目标芯片。
   • 在 “Debug” 菜单中选择 “Start/Stop Debug Session” 来启动调试器。

这就是一个基本的 STM32 工程的创建和配置流程。具体的步骤可能会有细微差别，具体取决于你使用的工具链和硬件。

新建工程

选择主控型号

编译过程产生的链接列表、调试信息、预览、lib 等文件，统称为中间文件。为了统一管理，方便使用，我们会把输出在 Listings 和 Objects 文件夹的内容，统一改为输出到 Output 文件夹（通过魔术棒设置），我们先把 MDK 自动生成的这两个文件夹（Listings 和 Objects）删除。

2.3、添加文件

1.设置工程名和分组名

2.添加启动文件

启动文件存放在 STM32CubeF1 软件包的：Drivers→CMSIS→Device→ST→STM32F1xx→Source→Templates→arm 文件夹下。因为我们开发板使用的是 STM32F103ZET6，对应的启动文件为：startup_stm32f103xe.s，为了节省空间，在精简版 CMSIS 文件夹里面我们把其他启动文件都删了。




而且，为了更好的匹配寄存器版本代码，我们对 startup_stm32f103xe.s 做了 2 处修改：
1，我们用不到编译器的内存管理函数，为节省内存，将 Heap_Size 改成 0，源码如下：

;未用到编译器自带的内存管理(malloc,free 等)，设置 Heap_Szie 为 0
Heap_Size EQU 0x00000000

2，寄存器代码不需要调用 SystemInit 函数，因此修改 Reset_Handler 函数，去掉 SystemInit
调用，源码如下：

Reset_Handler 	PROC
     			EXPORT Reset_Handler [WEAK]
     			IMPORT __main
     			
     			; 寄存器版本代码，注释掉 SystemInit 的调用
     			; HAL 库版本代码，建议加上这里（提供 SystemInit 函数），以初始化 stm32 时钟等。
    			; IMPORT SystemInit
     			; LDR R0, =SystemInit
     			; BLX R0
     			
     			LDR R0, =__main
     			BX R0
   				ENDP

3. 添加 SYSTEM 源码

2.4、魔术棒设置

1. 设置 Target 选项卡
   
   ??我们设置芯片所使用的外部晶振频率为 8Mhz，选择 ARM Compiler 版本为：Use default compiler version 5（即 AC5 编译器）。

AC5和AC6编译器对比

2. 设置 Output 选项卡
   
   ??注意，我们勾选：Browse Information，用于输出浏览信息，这样就可以使用 go to definition查看函数/变量的定义，对我们后续调试代码比较有帮助，如果不需要调试代码，则可以去掉这个勾选，以提高编译速度。
3. 设置 Listing 选项卡
   
   ??经过 Output 和 Listing 这两步设置，原来存储在 Objects 和 Listings 文件夹的内容（中间文件）就都改为输出到 Output 文件夹了。
4. 设置 C/C++选项卡
   
   ??在②处设置了全局宏定义：STM32F103xE，用于定义所用 STM32 型号，在 stm32f1xx.h 里面会用到该宏定义。
   ??在③处设置了优化等级为-O0，可以得到最好的调试效果，当然为了提高优化效果提升性能并降低代码量，可以设置-O1~-O3，数字越大效果越明显，不过也越容易出问题。注意：当使用AC6 编译器的时候，这里推荐默认使用-O1 优化。
   ??在④处勾选 C99 模式，即使用 C99 C 语言标准。
   ??在⑤处，我们可以进行头文件包含路径设置，点击此按钮，进行下面所示设置：
   
   ??上图中我们设置了 4 个头文件包含路径，其中 3 个在 Drivers 文件夹下，一个在 User 文件夹下。为避免频繁设置头文件包含路径，最新源码的 include 全部使用相对路径，也就是我们只需要在头文件包含路径里面指定一个文件夹，那么该文件夹下的其他文件夹里面的源码，如果全部是使用相对路径，则无需再设置头文件包含路径了，直接在 include 里面就指明了头文件所在。
   ??关于相对路径，这里大家记住 3 点：
   ??1，默认路径就是指 MDK 工程所在的路径，即.uvprojx 文件所在路径（文件夹）
   ??2，“./”表示当前目录（相对当前路径，也可以写做“.\”）
   ??3，“…/”表示当前目录的上一层目录（也可以写做“…\”）
   ??举例来说，上图中：…\Drivers\CMSIS\Device\ST\STM32F1xx\Include，前面两个“…\”，表示 Drivers 文件夹在当前 MDK 工程所在文件夹（MDK-ARM）的上 2 级目录下，具体解释如下图所示：
   
   ??上图表示根据头文件包含路径：…\Drivers\CMSIS\Device\ST\STM32F1xx\Include，编译器可以找到⑥处所包含的这些头文件，即代码里面可以直接 include 这些头文件使用。
   ??再举个例子，在完成如图 6.1.4.5 所示的头文件包含路径设置以后，我们在代码里面编写：
   #include “./SYSTEM/sys/sys.h”
   ??即表示当前头文件包含路径所指示的 4 个文件夹里面，肯定有某一个文件夹包含了：
   SYSTEM/sys/sys.h 的路径，实际上就是在 Drivers 文件夹下面，两者结合起来就相当于：
   #include “…/…/Drivers/SYSTEM/sys/sys.h”
   ??这就是相对路径。它既可以减少头文件包含路径设置（即减少 MDK 配置步骤，免去频繁
   设置头文件包含路径的麻烦），同时又可以很方便的知道头文件具体在那个文件夹，因此我们推
   荐在编写代码的时候使用相对路径

最后，我们如果使用 AC6 编译器，则在图 6.1.4.4 的 Misc Controls 处需要设置：-Wnoinvalid-source-encoding，避免中文编码报错，如果使用 AC5 编译器，则不需要该设置！！

绝对路径和相对路径对比

绝对路径和相对路径是计算机领域中用于指定文件或目录位置的两种不同方式。

绝对路径：

• 定义： 绝对路径是指文件或目录从根目录开始一直到目标位置的完整路径。
• 示例： C:\Users\YourUsername\Documents\Project\file.txt （Windows 系统）
• 特点： 绝对路径是唯一确定文件或目录位置的一种方式，不受当前工作目录的影响。

相对路径：

• 定义： 相对路径是指文件或目录相对于当前工作目录或另一文件的位置。
• 示例：
  • ./folder/file.txt 表示当前目录下的 folder 目录中的 file.txt。
  • ../parentfolder/file.txt 表示当前目录的上一级目录中的 parentfolder 目录中的 file.txt。
• 特点： 相对路径是相对于当前环境而言的，可能会受到工作目录的变化而影响。

适用场景：

• 绝对路径： 适用于需要确切指定文件或目录位置的场景，路径的唯一性是必要的。
• 相对路径： 适用于在特定环境中，通过相对位置来定位文件或目录，便于移植和共享。

补充说明：

1. 在命令行或脚本中，当前工作目录的设置可能会影响相对路径的解析。
2. 在不同操作系统中，路径分隔符可能不同，例如在 Windows 使用 \，而在 Unix/Linux 使用 /。

在 MDK 工程中，相对路径通常指的是相对于工程文件（.uvprojx 文件）所在的目录。

5. 设置 Debug 选项卡
   
   ??图中，我们选择使用：CMSIS-DAP 仿真器，使用 SW 模式，并设置最大时钟频率为 10Mhz，以得到最高下载速度。当我们将仿真器和开发板连接好，并给开发板供电以后，仿真器就会找到开发板芯片，并在 SW Device 窗口显示芯片的 IDCODE、Device Name 等信息（图中⑤处），当无法找到时，请检查供电和仿真器连接状况。
6. 设置 Utilities 选项卡
   
   ??图中⑥处下载算法，是 MDK 默认添加的，针对 STM32F10x 大容量系列产品（FLASH 容量在 256KB~512KB 之间）。一般我们用这个即可。如果⑥处没有下载算法，则点击⑦处按钮，执行添加一下下载算法即可（名字和⑥处的算法名字一样）。
7. Linker 选项卡(可选)
   添加分散加载文件
   
   
   
   在 Keil MDK（Microcontroller Development Kit）中，Linker选项卡用于配置链接器的设置，其中包括添加分散加载文件（Scatter File）的步骤。分散加载文件指定了程序在存储器中的布局。

以下是添加分散加载文件的一般步骤：

1. 打开 Keil MDK 工程。

2. 在工程管理器中，找到 “Project” 菜单，然后选择 “Options for Target”。

3. 在弹出的对话框中，选择 “Linker” 选项卡。

4. 在 “Scatter File” 一栏中，可以选择 “Browse” 按钮，或者手动输入分散加载文件的路径。

   • 如果选择 “Browse”，会弹出一个文件选择对话框，你可以在其中选择分散加载文件。

   • 如果手动输入路径，确保路径是相对于工程文件的相对路径或者是绝对路径。

5. 选择完分散加载文件后，点击 “OK” 保存设置。

6. 最后，点击 “Rebuild” 或 “Build” 来重新构建工程，使得新的链接设置生效。

分散加载文件（Scatter File）通常以 .sct 或 .ld 为扩展名。在这个文件中，你可以定义存储器区域（Memory Regions）、存储器块（Memory Blocks）等，从而确定程序的存储布局。

在 Keil MDK 中使用分散加载文件可以更灵活地控制代码和数据的存放位置，适应不同的硬件平台和应用需求。

分散加载文件（Scatter File）

分散加载文件（Scatter File） 在 寄存器版本和使用 HAL 库版本的工程中可能会有一些差异。这主要是因为这两种工程的初始化和存储器布局可能不同。

在使用寄存器版本的工程中，你可能会直接定义存储器区域（Memory Regions）和存储器块（Memory Blocks），以明确指定程序在存储器中的布局。例如，在 Cortex-M系列微控制器的寄存器版本工程中，你可以使用类似如下的分散加载文件：

LR_IROM1 0x08000000 0x00100000  {    ; load region size_region
  ER_IROM1 0x08000000 0x00100000  {  ; load address = execution address
   *.o (RESET, +First)
   *(InRoot$$Sections)
   .ANY (+RO)
  }
  RW_IRAM1 0x20000000 0x00020000  {  ; RW data
   .ANY (+RW +ZI)
  }
}

上述代码定义了加载的Flash存储器区域和RAM存储器区域。

而在使用 HAL 库版本的工程中，HAL 库会提供一个包含了初始化过程的 SystemInit 函数，通常会配置系统时钟等。因此，在分散加载文件中，可能需要调用 SystemInit 函数。这样的文件可能包含以下内容：

LR_IROM1 0x08000000 0x00100000  {    ; load region size_region
  ER_IROM1 0x08000000 0x00100000  {  ; load address = execution address
   *.o (RESET, +First)
   *(InRoot$$Sections)
   .ANY (+RO)
  }
  RW_IRAM1 0x20000000 0x00020000  {  ; RW data
   .ANY (+RW +ZI)
  }
}

; Include HAL-specific sections
INCLUDE STM32F1xx_HAL_CORTEX.S
INCLUDE STM32F1xx_HAL_FLASH.S
INCLUDE STM32F1xx_HAL_RCC.S
; ... include other HAL sections as needed

在上述的例子中，STM32F1xx_HAL_CORTEX.S，STM32F1xx_HAL_FLASH.S，STM32F1xx_HAL_RCC.S 是 HAL 库提供的特定部分，用于初始化 Cortex 内核、Flash 存储器和系统时钟等。

总的来说，根据工程的具体需求和使用的库，分散加载文件的内容可能会有所不同。

2.5、添加 main.c，并编写代码

三、下载验证

四、总结