代码收藏家技术教程 2024-01-19

如何在STM32中使用printf函数进行调试输出

参考代码：Embedded/stm32/STM32_printf · guorong/study – 码云 – 开源中国 (gitee.com)

在刚开始学习C语言的时候，都使用过printf函数，支持的格式比较齐全，相打印什么样的信息都比较好实现。在使用STM32的过程中，也可以使用printf函数，printf函数是C语言stdio的库里定义好的函数，或者在stm32中，推荐勾选use microlib库，printf函数调用了fputc函数，这个函数也在库里被“弱定义”了，弱定义指的是如果有在其他地方重新定义，则使用重新定义的函数，若没有找到，则使用之前“弱定义”好的函数。在startup.s文件中，就弱定义了很多函数，都可以重新被定义，如下

fputc函数被定义指向了标准输出设备，而stm32中没有该设备，所以需要做一下重映射，即将fputc重新定义一次，以方便printf打印的时候，打印到我们想让其打印去的地方

有以下两种方式

串口重映射

这种方式比较常见，直接初始化一个串口外设，然后将fputc函数定义为串口输出，如下

#include "usart.h"
int main(void)
{
    uart_init(115200);	 //串口初始化为115200
    while(1)
    {
        printf("hello world!\r\n");
    }    
 }
int fputc(int ch, FILE *f)
{      
	while((USART1->SR&0X40)==0);
    USART1->DR = (u8) ch;      
	return ch;
}

在正确初始化串口代码之后，可以在对应的串口1接入串口调试助手，即可看到串口打印出来的字符串

ITM重映射

上一种方法会占用一个串口，并且速度可能不是很快，还有一种STM32自带的调试工具ITM中也可以打印，速度快，并且不占用单片机的外设资源，配置方式如下。注意clock要配置对

然后在代码中加入如下片段

#include<stdio.h>

#define ITM_PORT8(n)         (*(volatile unsigned char *)(0xe0000000 + 4*(n)))
#define ITM_PORT16(n)        (*(volatile unsigned short *)(0xe0000000 + 4*(n)))
#define ITM_PORT32(n)        (*(volatile unsigned long *)(0xe0000000 + 4*(n)))
#define DEMCR                (*(volatile unsigned long *)(0xE000EDFC))
#define TRCENA               0X01000000
 
int fputc(int ch, FILE *f)
{
    if(DEMCR & TRCENA)
    {
        while(ITM_PORT32(0) == 0);                                                                                                                                                                                                                                                                                      
        ITM_PORT8(0) = ch;
    }
    return ch;
}
int main()
{
    while(1)
    {
        printf("hello world\r\n");
    }
}

运行在线调试，打开Debug（printf）Viewer

点击开始运行，即可看到打印出来的字符串

可以用作调试

附：关于使用标准库的时候的问题

在 STM32 或其他 ARM Cortex-M 微控制器中使用标准 C 库时，库中的一些函数默认是依赖于一个宿主系统的，这称为半主机（semihosting）操作。半主机操作使得嵌入式系统可以通过调试接口使用宿主机的I/O功能。例如，printf函数默认情况下是将字符输出到宿主机的终端上。

当你使用标准库（如printf）进行输出时，库函数实际上是调用_write函数来实现输出的。在ARM的标准库实现中，如果开启了半主机，_write函数会使用半主机操作将数据输出到宿主机。如果你的嵌入式系统中没有使用调试器或不支持半主机操作，那么这种输出就无法成功。

为了在没有半主机支持的环境里使用printf，你需要关闭半主机特性，并提供必要的重定向输出机制，让printf可以在微控制器中使用。_sys_exit是半主机标准库中调用结束程序的函数，而__FILE结构体和__stdout是用于文件操作的结构和对象。这些结构和函数在半主机环境中用于与宿主系统进行交互。

如果你不声明#pragma import(__use_no_semihosting)、struct __FILE以及重写相关函数（比如_sys_exit），在不使用半主机时，使用这些半主机特定函数会导致链接错误或运行时错误，因为它们试图调用不存在的宿主机功能。

因此，为了重映射printf至fputc，确保能够通过串口直接打印，你需要：

使用一个编译器指定语句来告诉编译器你的程序不会使用半主机特性：#pragma import(__use_no_semihosting)
提供一个struct __FILE的定义，并且定义__stdout变量，因为标准的I/O函数如fputc通常会用到这些。
提供一个_sys_exit的定义，这样程序在无法找到半主机的退出函数时不会出错。
重写fputc函数以将数据输出到你的串口（或其他所需接口），而不是试图输出到宿主机系统。

若不执行这些步骤，编译器将会试图链接到原本为半主机设计的库函数版本，而这在没有宿主机支持的情况下导致代码无法运行或失败。而microlib本身就是为了嵌入式设备写好的，处理好了这些细节。

综上，在使用标准库的时候，加入以下代码，也可以正常使用

#include "usart.h"
int main(void)
{
    uart_init(115200);	 //串口初始化为115200
    while(1)
    {
        printf("hello world!\r\n");
    }    
 }
#pragma import(__use_no_semihosting)             
struct __FILE 
{ 
    int handle; 
}; 
FILE __stdout;       
void _sys_exit(int x) 
{ 
	x = x; 
} 
int fputc(int ch, FILE *f)
{      
	while((USART1->SR&0X40)==0);
    USART1->DR = (u8) ch;      
	return ch;
}

还有一个有趣的现象，在编译的时候，如果勾选了使用microlib，如果你没有使用malloc函数，会把堆区的内存省掉，而在使用标准库的时候，则不论是否使用了malloc函数（未使用malloc函数的话，堆内存确实是没有用处的）都会保留堆内存，空间，如下两张图，分别为勾选和未勾选use microlib的内存分配情况，所以建议在开发嵌入式代码的时候，还是勾选上use microlib

勾选use microlib内存分配情况