Xilinx XDMA驱动代码分析及用法
先简单的介绍一下，赛灵思的XDMA的驱动是用于做什么的、他的主要功能就类似与网卡pcie接口的网卡驱动、用于控制主机与fpga设备进行pcie的通讯。通讯的主要方式是设备文件的读写，这里不清楚的同学可以看一下我上一篇文章。通过控制设备文件的读写，操作驱动与fpga设备进行数据传输。
1、目录结构
zacha@Superman:~/nfs/xdma-debug/dma_ip_drivers-master/XDMA/linux-kernel$ tree -C.
├── COPYING
├── include
│ └── libxdma_api.h
├── LICENSE
├── readme.txt
├── RELEASE
├── tests
│ ├── data
│ │ ├── datafile0_4K.bin
│ │ ├── datafile1_4K.bin
│ │ ├── datafile2_4K.bin
│ │ ├── datafile_256K.bin
│ │ ├── datafile_32M.bin
│ │ ├── datafile3_4K.bin
│ │ └── datafile_8K.bin
│ ├── dma_memory_mapped_test.sh
│ ├── dma_streaming_test.sh
│ ├── load_driver.sh
│ ├── perform_hwcount.sh
│ └── run_test.sh
├── tools
│ ├── \001
│ ├── dma_from_device.c
│ ├── dma_to_device.c
│ ├── dma_utils.c
│ ├── Makefile
│ ├── performance.c
│ ├── perform_hwcount.sh
│ └── reg_rw.c
└── xdma
├── cdev_bypass.c
├── cdev_ctrl.c
├── cdev_ctrl.h
├── cdev_events.c
├── cdev_sgdma.c
├── cdev_sgdma.h
├── cdev_xvc.c
├── cdev_xvc.h
├── libxdma.c
├── libxdma.h
├── Makefile
├── version.h
├── xdma_cdev.c
├── xdma_cdev.h
├── xdma_mod.c
├── xdma_mod.h
├── xdma_thread.c
└── xdma_thread.h
5 directories, 43 files
zacha@Superman:~/nfs/xdma-debug/dma_ip_drivers-master/XDMA/linux-kernel$
Xilinx 官方的XDMA驱动的目录结构大致如上图所示，大致就是：
xdma(驱动代码)、tools（测试工具）、tests(自动化测试脚本)、include(对外头文件)。
今天重点分析驱动的代码部分，也会简单的介绍一些测试文件代码的基本用法。
1.1 tests/tools
tools中的文件就是用于测试驱动mem读写、寄存器读写、等的工具。 tests中的文件 就是自动化运行脚本，分为两种测试方法，第一种是mem mapped 方式，第二种事streamming的方式，两种模式的区别在于DMA以及FPGA的传输方式不同。
1.2 xdma
xdma就是驱动部分的代码，我们先看一下驱动安装成功后，所生成的设备文件，然后对应设备文件去看驱动代码每部分的功能和控制逻辑。
2、驱动的文件与生成的设备
2.1
我们先看
xdma_mod.c
这个文件， 这个文件主要的功能，这部分代码的主要功能是驱动代码的整体控制入口，我们知道，整个驱动的通讯都是基于PCI协议进行通讯的，所有的总线协议在Linux下都是需要进行总线上设备注册的，所以这个代码主要的功能，就是进行pci总线初始化和注册、然后再 在总线上注册各个字符设备。
staticstructpci_driver pci_driver ={.name = DRV_MODULE_NAME,.id_table = pci_ids,.probe = probe_one,/*设备总线上的字符设备注册入口*/.remove = remove_one,.err_handler =&xdma_err_handler,};staticintxdma_mod_init(void){int rv;pr_info("%s", version);if(desc_blen_max > XDMA_DESC_BLEN_MAX)
desc_blen_max = XDMA_DESC_BLEN_MAX;pr_info("desc_blen_max: 0x%x/%u, timeout: h2c %u c2h %u sec.\n",
desc_blen_max, desc_blen_max, h2c_timeout, c2h_timeout);
rv =xdma_cdev_init();if(rv <0)return rv;returnpci_register_driver(&pci_driver);/*总线设备驱动的注册*/}
2.2
接下来我们就可以看
xdma_cdev.c
这个文件，就是用于生成下面图片所需的设备文件，看一下他的创建设备的代码，我们主要关注一下每个设备创建时进行的初始化函数，基本上就能大体的了解他的用法了。我们就按设备的顺序，一一讲解每个设备的功能和具体的用法。
enumcdev_type{
CHAR_USER,/* /dev/xdma_user */
CHAR_CTRL,/* /dev/xdma_control */
CHAR_XVC,/* /dev/xdma_xvc */
CHAR_EVENTS,/* /dev/xdma_events */
CHAR_XDMA_H2C,/* /dev/xdma_h2c */
CHAR_XDMA_C2H,/* /dev/xdma_c2h */
CHAR_BYPASS_H2C,/*fpga ip core bypass 功能 ，未配置未生成*/
CHAR_BYPASS_C2H,/*fpga ip core bypass 功能 ，未配置未生成*/
CHAR_BYPASS,/*fpga ip core bypass 功能 ，未配置未生成*/};
intxpdev_create_interfaces(structxdma_pci_dev*xpdev)；
可以看到这个函数，位于
xdma_cdev.c
，他的功能就是用于生成各个字符设备的入口，他的调用关系如下：
函数的调用关系可以与生成的dev/xdma_ 设备进行对应：
xdma_user
与
xdma_control
调用了同一个设备初始化接口，但是是两个不同的设备， 上层接口传递的参数有差异。可以从代码里查看到。他们映射的bar空间是不一样的。
control,映射的是配置寄存器的bar空间， user 映射的给用户预留的bar空间。
这里感谢@立夏的小满的指正。
2.3
接下来就是
xdma_xvc.c
与
xdma_xvc设备
了， 说实话，目前我没怎么用过这个设备，不过大体看代码逻辑，可能跟fpga的xvc协议有关。Xilinx 虚拟线缆 (XVC) 是一种基于 TCP/IP 的协议，其不仅可发挥类似于 JTAG 线缆的作用，而且还可提供一种无需使用物理线缆便可访问和调试 FPGA 或 SoC 设计的方法。 Xilinx 虚拟线缆 (XVC)。
2.4
xdma_enents.c
及
xdma_events_x 设备
: 这个文件具体的含义就是处于处理事件函数：也就是中断处理。这个设备的读操作是阻塞的， 当读到有fpga有中断过来，那么就会返回应用层，用纸用户层代码就行下一步中断来了处理的逻辑。
2.5
接下来就是驱动代码的重点文件及设备：
xdma_sgdma.c
及
xdma_c2h 、xdma_h2c两个设备
， 这两个设备分配对应用户端读和写操作，对应fpga端的读写两个通道。 这个文件是相对其他比较复杂的，它的传输方式是sgdma的传输方式， 就是所谓的scalter-gather （分散-聚集）的dma传输方式。他会生成一个scalterlist表，表的每一项是dma mem 的描述符，描述符大致的内容： src_addr、dst_addr、length、buf、next*、大致是这样。接下来我们看代码。
设备文件的读写io 调用了同一个接口，即用于读，也用于写。函数原型如下：
staticssize_tchar_sgdma_read_write(structfile*file,constchar __user *buf,size_t count,loff_t*pos, bool write)
就是说，在用户空间里，我们通过调用文件io的read，和write函数就可以完成设备数据的读和写。
该函数的主要点在：
分配-传输-释放
具体函数深入就不细讲了，之后可能会更新一篇文章来阐述，驱动在传输过程中，如何控制dma的内存传输的。下面将一下，几个设备如何使用。
3、用户层代码实现与设备使用
3.1 xdma_user
看一下官方的解释：
/* maps the PCIe BAR into user space for memory-like access using mmap() */
该设备就是用于映射PCIe设备的bar 空间
staticconststructfile_operations ctrl_fops ={.owner = THIS_MODULE,.open = char_open,.release = char_close,.read = char_ctrl_read,.write = char_ctrl_write,.mmap = bridge_mmap,.unlocked_ioctl = char_ctrl_ioctl,};
用户层代码通过mmap io 进行mem映射, 然后通过read 和write 对bar空间的内存寄存器进行读写操作，以完成用户与设备的数据交互。
用户空间代码逻辑实现如下：
staticintopen_control(char*filename){int fd;
fd =open(filename, O_RDWR | O_SYNC);if(fd ==-1){printf("open control error\n");return-1;}return fd;}staticvoid*mmap_control(int fd,long mapsize){void*vir_addr;
vir_addr =mmap(0, mapsize, PROT_READ | PROT_WRITE, MAP_SHARED, fd,0);return vir_addr;}staticvoidwrite_control(void*base_addr,int offset,uint32_t val){uint32_t writeval =htoll(val);*((uint32_t*)(base_addr+offset))= writeval;}staticuint32_tread_control(void*base_addr,int offset){uint32_t read_result =*((uint32_t*)(base_addr+offset));
read_result =ltohl(read_result);return read_result;}
int control_fd =open_control("/dev/xdma0_user");
control_base =mmap_control(control_fd,MAP_SIZE);
frame_bytes =read_control(control_base,0x0a4);write_control(control_base,0x0004,0);
打开设备， mem映射至用户空间，寄存器读和写的操作
3.2 xdma_events
事件中断设备， 用于处理设备端发送中断事件的设备，read接口是以阻塞的方式实现的。
用法其实很简单，就是去读这个设备，能读完就说明有中断来了， 卡在读这里说明没有中断过来。
看用户层代码：这里读事件中断是用一个线程一直去读的，通过信号量去通知其他线程是否有中断过来。
void*c2h_event_process(void*param){staticint flag =0;int fd =open_event("/dev/xdma0_events_0");printf("c2h event thread running, c2h_event_fd = %d\n", fd);while(1){if(read_event(fd)){sem_post(&c2h_sem);printf("c2h get %d frame event\n",flag);}else{/*timeout*/}
3.3 xdma_c2h
数据传输读设备，方向是从fpga设备中读取数据过来。对应fpga的写通道。
用户端代码的逻辑是：调用设备的读接口，将读出的数据保存在预先分配的内存中，然后写进文件。 这种方式不建议在嵌入式设备中使用， 因为写数据到文件是比较耗时的， 这样就会影响读的速度，如果fpga读的速度过慢，那么就会导致fpga端的的数据传输fifo 满，数据就会丢失或者异常。
void*c2h_data_process(void*param){int fd =open("/dev/xdma0_c2h_0",O_RDWR | O_NONBLOCK);printf("c2h data thread running, c2h_data_fd = %d\n", fd);/*读取的数据写文件*/
FILE *record_fp =fopen("/mnt/nfs/c2h_record.bin","wb");unsignedchar*buf = new unsignedchar[frame_bytes];while(1){sem_wait(&c2h_sem);read(fd, c2h_align_mem, trans_bytes);fwrite(c2h_align_mem, frame_bytes,1, record_fp);}}
3.4 xdma_h2c
数据传输写设备，方向是将数据写进fpga设备中，对应fpga的读通道。
用户端写代码的逻辑就不阐述了，无非就是将预先写好的内容写到fpga的mem, 一般是DDR或者RAM看具体的逻辑设计。
直接上用户层代码。
void*h2c_data_process(){int fd;
fd =open("/dev/xdma0_h2c_0",O_RDWR);while(1){write(fd,h2c_align_mem,frame_bytes);sem_wait(&h2c_sem);}}
4.总结
最后整体的驱动文件与设备的功能，大致就将这么多。
相关的的驱动及测试代码，以及FPGA工程，已经上传至网盘，有需要的朋友可以自行下载。
链接：https://pan.baidu.com/s/1wdPqUf8_2K6r8ZbVupizrw
提取码：i2sw
最后，声明一下： 本人的博客很多基本上都是原创， 也有参考其他博文，也基本会在本人博文中有声明地址。 如果本文对您有帮助或者你想转载，请标明文章出处。文章作者：CSDN@蕉尼基
版权归原作者 疯狂的蕉尼基 所有， 如有侵权，请联系我们删除。