C语言 | 学习使用带参宏，提高编程基础（一）

1024G 嵌入式资源大放送！包括但不限于C/C++、单片机、Linux等。关注微信公众号【嵌入式大杂烩】，回复1024，即可免费获取！

学习使用带参宏，提高编程基础（一）

公司某项目用到DSP+FPGA架构（当然不是著名的ARM+DSP+FPGA点灯项目,哈哈），我的发展方向为DSP方向。其中DSP与FPGA通过两个带参宏进行数据交互（DSP与FPGA通过一块共享内存来实现数据交互，我这边的DSP只要往共享内存中写入数据即为往FPGA中写数据，往共享内存中读取数据就是读取FPGA发送过来的数据），如下图：

也即：

#define FPGA_WRITE(data_out, base_addr, offset)  \
((((volatile uint32*)base_addr)[(offset)]) = (data_out))
#define FPGA_READ(data_in, base_addr, offset)    \
((data_in) = (((volatile uint32*)base_addr)[(offset)]))

带参宏也称做宏函数，宏函数FPGA_WRITE(data_out, base_addr, offset)用于往FPGA发送数据。其中

• 参数data_out：要写入的数据。

• 参数base_addr：基地址。

• 参数offset：相对于基地址的偏移量。

该宏函数实体为：

((((volatile uint32*)base_addr)[(offset)]) = (data_out))

我们先看等号左边，从最里层的括号开始看，(volatile uint32*)base_addr的意思是把base_addr强制转换为(volatile uint32*)类型的数据，其中加volatile关键字的作用是确保本条指令不会因编译器的优化而省略。volatile在嵌入式编程中用得很多，如在Cortex-M3内核MCU的内核文件的C函数内嵌汇编中使用了大量的volatile关键字：

关于volatile关键字更多的介绍可查看往期分享：
来看一看volatile关键字

((volatile uint32*)base_addr)[(offset)]的意思是相对于base_addr偏移offset个内存单元后所占的空间，此时已经转变为了base_addr[offset]，这就可以看做数组base_addr的第offset个元素，所以可以给它赋值。等号右边的数据data_out就是给数组元素base_addr[offset]进行赋值的。数组和指针在此处其实是可以等价的，所以

((volatile uint32*)base_addr)[(offset)]

其实可以等价为：

*(((volatile uint32*)base_addr) + offset)

宏函数FPGA_READ(data_in, base_addr, offset)用于读取FPGA发送过来的数据，其实体为：

((data_in) = (((volatile uint32*)base_addr)[(offset)]))

同写函数的分析方法类似，此处从等号右边的最里层括号开始看，分析过程省略，具体的可查看写数据函数FPGA_WRITE的分析过程。此处等号右边的

(((volatile uint32*)base_addr)[(offset)]))

可以等价于：

*(((volatile uint32*)base_addr) + offset))

为什么要在宏函数实体的参数的两边加上括号呢？为什么要在宏函数实体的两边加上括号呢？

答：虽然有时候不加括号也没什么问题，但是，更严格的做法是给参数加括号、给宏函数实体加括号，这样可以避免二义性。关于宏函数的二义性将在下一篇笔记中分享，欢迎阅读！

以上两个带参宏的测试用例

/********************************************************************************
* 宏函数FPGA_WRITE、FPGA_READ测试用例
******************************************************************************/
#include <stdio.h>

#define uint32 unsigned int

#if 1
// 调用这两个宏可往共享内存中读写数据
#define FPGA_WRITE(data_out, base_addr, offset) 
\((((volatile uint32*)base_addr)[(offset)]) = (data_out))
#define FPGA_READ(data_in, base_addr, offset) 
\((data_in) = (((volatile uint32*)base_addr)[(offset)]))

#else
// 以上宏等效的写法
#define FPGA_WRITE(data_out, base_addr, offset) 
\(*(((volatile uint32*)base_addr) + offset) = (data_out))
#define FPGA_READ(data_in, base_addr, offset) 
\((data_in) = *(((volatile uint32*)base_addr) + offset))
#endif

int main(void)
{
  // 变量定义
  uint32 arr[6] = {0, 1, 2, 3, 4, 5};
  uint32 *ptr = arr;
  uint32 data_write = 520;
  uint32 data_read = 0;

  // 验证宏函数FPGA_WRITE
  FPGA_WRITE(data_write, ptr, 3); // 此时arr[3]的值会被data_write的值覆盖
  printf("arr[3] = %d\n", arr[3]);
  if (data_write == arr[3])
  {
    printf("宏函数FPGA_WRITE验证成功！\n\n");
  }

  // 验证宏函数FPGA_READ
  FPGA_READ(data_read, ptr, 5); // 此时data_read的值会被arr[5]的值覆盖
  printf("data_read = %d\n", data_read);
  if (data_read == arr[5])
  {
    printf("宏函数FPGA_READ验证成功！\n");
  }
  return 0;
}

**以上的测试方法是：**定义一个数组arr，定义一个基地址ptr（指针变量），基地址ptr指向arr，此时ptr就可以与数组arr相关联起来了，即相对于ptr偏移offset个内存单元其实就是等价于arr[offset]。

FPGA_WRITE(data_write, ptr, 3);

这条语句的意思就是往ptr往后第3个内存单元写入数据data_write，即arr[3] = data_write;，arr[3]由原来的3变成了520。

FPGA_READ(data_read, ptr, 5);

这条语句的意思就是把ptr往后第5个内存单元中的数据赋给data_read变量，即data_read = arr[5];，data_read由原来的0变成了5。程序运行结果如下：

可见，程序输出结果与我们分析的一致！带参宏很重要，在一定程度上可以帮助我们防止出错，提高代码的可移植性和可读性等，应重点掌握。下一篇笔记我们将分享更多的带参宏的笔记，欢迎阅读。