专家秘笈大放送：7 系列 GTX 的复位设计

Vivado HLS中指针作为top函数参数的处理

            Harvest Guo : xilinx

    指针作为C语言精华，对于软件设计者比较好理解，但是在xilinx vivado HLS高级语言综合的设计中，由于其综合后对应的硬件元素难以用软件的概念解释，常常令程序设计者和VHLS工具使用者头痛。本文采用浅显易懂的描述方式，结合具体的c代码例子，详细描述了常用三种指针的设计类型，以及其作为顶层函数参数时，采用不同的编码风格和HLS约束策略，满足设计者对指针作为RTL接口的需求。

1. 1.       基本指针类型

基本指针类型指的是指针没有运算或者没有多次的存取（读写）。指针作为top函数的参数时，指针综合为wire型或者握手协议类型接口。如下例子1-1：

void pointer_basic (dio_t *d) {

static dio_t acc = 0;

acc += *d;

*d = acc;

}

 例子1-1 基本类型指针作为顶层函数参数

在这个例子中，只是简单的读写指针指向的变量值，并没有对指针做偏移或者指针（地址）运算，其接口综合为线型的RTL接口。

1. 2.       指针运算类型。

指针作为top层函数参数，并且函数中有对指针运算时，我们称之为指针运算类型。指针运算常常限制指针可能综合的接口类型。如下例中，指针做了偏移运算用于累加数据，从第二个值开始读出累加，并将每次累加结果写入上一个地址中。

void pointer_arith (dio_t *d) {

static int acc = 0;

int i;

for (i=0;i<4;i++) {

acc += *(d+i+1);

*(d+i) = acc;

}

}

  例子1-2 指针运算类型作为顶层函数参数

下面代码例子1-3是这个指针运算类型仿真的testbench。因为函数pointer_arith内部的for循环进行数据累加，testbench通过数组d[5]分配了地址空间并对数组赋值。

int main () {

dio_t d[5], ref[5];

int i, retval=0;

FILE *fp;

// Create input data

for (i=0;i<5;i++) {

d[i] = i;

ref[i] = i;

}

// Call the function to operate on the data

pointer_arith(d);

// Save the results to a file

fp=fopen("result.dat","w");

printf(" Din Dout\n", i, d);

for (i=0;i<4;i++) {

fprintf(fp, "%d \n", d[i]);

printf(" %d %d\n", ref[i], d[i]);

}

fclose(fp);

// Compare the results file with the golden results

retval = system("diff --brief -w result.dat result.golden.dat");

if (retval != 0) {

printf("Test failed!!!\n");

retval=1;

} else {

printf("Test passed!\n");

}

// Return 0 if the test

return retval;

}

  例子1-3 指针运算类型作为顶层函数参数的testbench

在C编译环境下仿真上面例子1-3的代码，结果如下：

Din Dout

0 1

1 3

2 6

3 10

Test passed!

指针运算带来的问题是，通常情况下，指针偏移是不规则的，不能按顺序存取指针数据。而Wire，握手类型或者Fifo接口类型没有办法乱序存取数据。

对于wire类型接口来说，当设计本身准备好接收数据时可以读入数据，或者当数据准备好ready时，可以写出数据。对握手和Fifo类型接口，当控制信号允许操作进行时，读入或写出数据。

在上面wire,握手或者FIFO类型接口的情况下，数据从0元素开始，必须按顺序到达（写入）。在指针运算的例子1-2中，第一个数据从索引1开始读入（i从0开始，0+1=1），对应于testbench中数据d[5]的第二个元素。

当这种情况在硬件应用时，需要某种格式的数据索引，这种情况对于wire类型，或者握手类型还是Fifo类型来说，都不支持。像上例1-2指针运算的代码，只能综合成ap_bus接口，因为这种接口带有地址，当数据存取（读写）时，用于对应的数据索引指示。

还有一种方法，代码必须修改成如下例子1-4的风格，用数据array作为接口替代指针。这种方法应用了array作为top层参数时综合成RAM接口（ap_memory）的原理，memory接口可以用地址作为数据的索引并且可以乱序执行，不必顺序存取操作。

void array_arith (dio_t d[5]) {

static int acc = 0;

int i;

for (i=0;i<4;i++) {

acc += d[i+1];

d[i] = acc;

}

}

例子1-4 指针运算类型作为顶层函数参数修改为array

Wire类型、握手类型或Fifo类型接口仅仅可用在数据流方式，因此不能用在与指针运算相关的地方（除非数据从索引0开始并顺序处理）。同时注意，如果想综合为FIFO接口，Fifo接口类型必须是只读或者只写，不能有读又有写操作。

1. 3.       多次读写（存取）指针类型

多次读写指针类型一般用作描述一个数据流方式的接口。

当top层函数参数使用指针，函数体对指针进行多次存取操作时，必须仔细考虑。在同一函数中对一个指针多次的读或者写，就会有多次指针存取发生，从而引起下列问题：

1. 1.       对任何函数指针参数的多次存取要使用volatile限定符。
2. 2.       对于Top层函数，如果要做RTL代码的混合仿真（co-sim），任何这种指针参数必须有这个接口存取次数的详细说明。
3. 3.       确保在综合前验证C功能，确定符合功能要求，保证C模型正确。

如果设计模型要求函数参数指针多次存取，推荐使用数据流模式模型化设计，使用数据流模型可以避免我们将会在下面讨论到的，使用多次读写指针带来的一些问题。

这个章节使用设计例子1-5 糟糕的数据流类型指针（pointer_stream_bad）解释，当多次存取指针时，为什么要使用volatile限定符。同时使用设计例子1-8 好的数据指针类型（pointer_stream_better）来说明，为什么当top层函数参数包含有这种指针接口的设计时，应该用C testbench仿真验证确保设计的行为级模型正确。

在下面的例子1-5中，指针d_i读了4次并且d_o写了2次，设计的本意是存取操作通过fifo接口，综合后的RTL以数据流的方式读入或者写出数据。

void pointer_stream_bad ( dout_t *d_o, din_t *d_i) {

din_t acc = 0;

acc += *d_i;

acc += *d_i;

*d_o = acc;

acc += *d_i;

acc += *d_i;

*d_o = acc;

}

   例子1-5 糟糕的数据流指针类型

用于验证的C testbench如下：

int main () {

din_t d_i;

dout_t d_o;

int retval=0;

FILE *fp;

// Open a file for the output results

fp=fopen("result.dat","w");

// Call the function to operate on the data

for (d_i=0;d_i<4;d_i++) {

pointer_stream_bad(&d_o,&d_i);