在SDK中查阅API函数的方法

在SDK中查阅API函数的方法

大连理工大学飞翔开发团队

    当我们使用XPS搭建好硬件设计设计后就要在SDK下进行编程了。在SDK中我们可以建立c或C++工程。我在做的时候选择了C工程。一下是我找到的在SDK下查找API函数的方法。

     SDK中所有的IP的API函数查询方法都是一样的。下面以GPIO的IPCore为例来介绍如何查阅API函数，并对其常用函数进行简要说明。

（1）将SDK代码编辑区的标签页切换到system.mss页面，可以看到所有的外设都已被列出来，单击每类外设后面的"Documentation"超链接即可打开其相应的API函数说明页面。

（2）弹出库浏览页面，在PC上以网页形式给出。其中"Main Page"页面给出该IP的主要信息；"Data Structures"页面列出了软件驱动所涉及的数据结构，对于GPIO来讲，有XGpio和XGpio_Config这两个结构体；"File list"页面显示了所有相关的头文件和源文件的超链接，可点击查看其版本信息和主要函数，是设计人员需要仔细查看的页面；"Globals"页面以函数名字母为序列出了所有的函数，并给出了其所在源文件和头文件。

单击进入"Globals"页面，再单击"functions"标签即可列出GPIO外设的所有函数。单击某个函数后面的头文件超链接即可进入到详细说明页，会给出函数的功能、输入参数以及返回参数的含义。