第1页 / 共24页
第2页 / 共24页
第3页 / 共24页
第4页 / 共24页
第5页 / 共24页
第6页 / 共24页
第7页 / 共24页
第8页 / 共24页
CYPRESS USB3.0 实例代码解读.doc
CYPEESS USB3.0程序解读
--------------朱可瑀
一、 解读同步FIFO的一个例子(slaveFifoSync)。
二、再看一个简单一点的GPIO的例子（GpioApp）
三、有了这个基础后，再看一下原来syncFifo的文档。方法同样从后向前看。
五、再读一个例子关于用DMA_MANUAL_IN DMA_MANUAL_OUT的例子。
六、看一个SPI读写的例子，它是主程序命令从SPI中读写一些数据。
七、我们现在要将EP1 OUT作为命令口。EP1的IN作为数据流的口。
CYPEESS USB3.0 程序解读
--------------朱可瑀
一、 解读同步 FIFO 的一个例子(slaveFifoSync)。
*生产者，消费者。
1、首先看 DMA 的回调函数(cyu3dma.h)：
typedef void (*CyU3PDmaCallback_t) (
CyU3PDmaChannel *handle,
CyU3PDmaCbType_t type, /* The type of callback notification being generated. */
CyU3PDmaCBInput_t *input /* Union that contains data related to the notification.
The input parameter will be a pointer to a CyU3PDmaBuffer_t
variable in the cases where the callback type is
CY_U3P_DMA_CB_RECV_CPLT or CY_U3P_DMA_CB_PROD_EVENT. */
/* Handle to the DMA channel. */
);
根据其说明，解读如下：
1． 对每一个 DMA 通道，回调函数必须被注册。如果没有注册或者相应的通知事件没有被注册，则回调函
数不会被执行。
2． 回调函数不能被阻塞。即不能用 SLEEP（）之类的函数。如果数据需要处理，必须在回调函数之外。
3． 在生产者事件中，应用希望尽可能快地处理输入的数据。如果缓冲的处理不能在规定的时间内完成，
则输入的可能是陈旧的数据。在自动信号通道中，输入参量指向最新的数据。如果处理延时，生产者
socket 可能覆盖部分数据。
4． 在手动或手动 IN 通道模式时，输入参量指向第一个缓冲(用于去消费者 socket).如果在第二次调用
时，这个缓冲仍没有被处理，输入参量中将是被陈旧的数据。如果数据处理必须在通道中做，
CyU3PDmaChannelGetBuffer 函数必须被应用，而回调函数必须作为一个通知。
2、而输入指针 input 的定义如下：
typedef struct CyU3PDmaBuffer_t
{
uint8_t *buffer;
uint16_t count;
uint16_t size;
uint16_t status;
} CyU3PDmaBuffer_t;
/* Pointer to the buffer
/* Byte count of valid data in buffer
/* Buffer size
*/
/* Buffer status. This is a four bit data field…
*/
*/
CyU3PDmaChannel 这个结构中包含 20 个左右的参数，其中含回调函数。
1> .定义了一个全局变量：CyBool_t glIsApplnActive=CyFalse; 这个变量是一个 BOOL 型先设
为 FALSE.
2> .程序然后定义了一个错误处理，CyFxAppErrorHandler()我们不处理错误，故是一个死循环
语句。
1
3>. 然后，定义一个 CyFxSlFifoApplnDebugInit()用串口来显示一些信息。初始化串口，设
波特率—只允许发不允许收，另外，采用 DMA 模式来处理 UART。
*注意到这个函数：CyU3PDebugInit(CY_U3P_LPP_SOCKET_UART_CONS,8)表示只处理 8 以下的显
示，大于 8 将不显示。
3、 接下来就是两个回调处理函数
1>. DMA 回调函数 ，生产者----->消费者
CyFxSlFifoUtoPDmaCallback(
CyU3PDmaChannel *chHandle,
CyU3PDmaCbType_t type,
CyU3PDmaCBInput_t *input)
{
CyU3PReturnStatus_t status =CYU3P_SUCESS;
If(type == CY_U3P_DMA_CB_PROD_EVENT){
Status =
CyU3PDmaChannelCommitBuffer(chHandler,input->buff_p.count,0);
glDMARxCount++;}
}
其中，CommitBuffer 这个函数通常在手动 DMA 方式下被调用，它 3 个参数的含义分别为：DMA 的句
柄号，处理的字节数及当前的状态。其中地址由通道描述符隐含着。这个函数发送一个 buffer 向消费者
socket.
2>.DMA 回调函数 ，消费者----->生产者
CyFxSlFifoPtoUDmaCallback (
*chHandle,
CyU3PDmaChannel
CyU3PDmaCbType_t type,
CyU3PDmaCBInput_t *input
)
{
0);
CyU3PReturnStatus_t status = CY_U3P_SUCCESS;
if (type == CY_U3P_DMA_CB_PROD_EVENT)
{
status = CyU3PDmaChannelCommitBuffer (chHandle, input->buffer_p.count,
if (status != CY_U3P_SUCCESS)
{
CyU3PDebugPrint (4, "CyU3PDmaChannelCommitBuffer failed, Error code
= %d\n", status);
}
glDMATxCount++;
}
}
1>.这个回调跟上一个功能类似，只是这个是 PtoU（ 消费者----->生产者）。
4、 接下来，是一个比较复杂的程序
2
Void CyFxSlFifoApplnStart(void)
这个函数启动一个 slave fifo 应用。当从 USB 接口收到一个 SET_CONF 事件时，即设置配置事件时，它
被调用。在这个函数中，端点被配置，DMA 管道被建立。我们稍后将看到它就是在 USB 配置时被调用的。
首先，根据 USB 的接口速度，决定这个 DMA 缓冲区的大小为多少字节。对于 3.0 是 1024 Byte。
然后，端点配置。而得到速度是一个库函数，如何得到速度不得而知。
不过，由于配置是在设备描述符得到后，并且是设置地址后调用的。故此时估计 PC 机已经与下位机协商
好速度了。例如 PC 为 2.0 则速度只能设为 2.0
端口设为 BULK 方式，且被允许。突发长度为 1。尺寸也被设为 1024。
先配置生产者：
允许端点 1 的收，尺寸按速度设置好，其它没什么。
不过 IN 端点 1 定义成 0x81 OUT 定义成 0x01
接下来，要产生一个 DMA_MANUAL 通道 为 U TO P
看 dmaCfg 的一些参数填充：
尺寸，即 1024。
缓冲区个数，2 个。
生产者 ID 号 从 0X401 开始的。
消费者 socket 端口，从 0X103 开始的。
DMA 模式：为 0 表示按字节计数。
DMA 事件：CY_U3P_DMA_CB_PROD_EVENT 表示收到一个生产者发来的缓冲
DMA 的回调函数 UtoP
头 0
尾 0
消费 socket 的头的编移 0
最少要多少个空的缓冲才会在生产者激活前。0 表示任何时候都要激活它。
在接收 PtoU 的 DMA 通道中，修改了这些：
产生者 socketID 被定义为 0x100
消费者 socketID 被定义为 0x301
回调函数改变了。
然后是生成 DMA 通道。
再就是刷新生产者端点 EP。
再就是刷新消费者端点 EP
设置 DMA 传输尺寸。设为 0 表示无限。
最后将 glIsApplnActive = CyTrue; 将这个全局变量设为 TRUE。
下面是一个停止 FIFO 循环的程序。断开时或复位时会被调用。此处暂不管它。
再下面是一个当 USB 在 SETUP 时的回调处理
由于 SETUP 时交由 DRIVER 缺省处理，故直接返回一个 FALSE.
USB 事件处理回调函数
当设置配置时，调用 AppStart() 但是如果已激活又来这么一下，则直接调用 ApplnStop()
复位和断开时，调用 ApplnStop()
5、下面又定义一个比较重要的函数：用于初始化 GPIF 和 USB 接口。
3
///下面将这个函数写于此
//这里是设置好时钟
CyFxSlFifoApplnInit(void)
{
CyU3PPibClock_t pitClock;
CyU3PReturnStatus_t apiRetStatus =CY_U3P_SUCCESS;
//以下初始化 p-port 块
pibClock.clkDiv = 2;
pibClock.clkSrc = CY_U3P_SYS_CLK;
pibClock.isHanfDiv = CyFalse;
pibClock.isDllEnable = CyFalse;
apiRetStatus = CyU3PPibInit(CyTrue,&pibClock);
///以下装载 GPIF
apiRetStatus = CyU3PGpifLoad(&Sync_Slave_Fifo_2Bit_CyFxGpifConfig);
///接下来是启动状态机（略），启动 USB 函数：
apiRetStatus = CyU3PUsbStart(0;---开始 USB 功能
接下来
注册回调函数用于 USB 的 SETUP 过程。但它是一个返回 FALSE 的函数。
CyU3PUsbRegisterSetupCallback(CyFxSlFifoApplnUSBSetupCB,CyTrue);
CyU3PUsbRegisterEventCallback(CyFxSlFifoApplnUSBEventCB); 事务处理不是缺省的，而是我们上面定义
过的。例如 ApplnStart()就是在配置过程中启动的。
Slave_Fifo----未明白 它是如何配置的。
接下来，要开始配置设备描述符了，因为描述符中含有 PID 和 VID 的值。所以必须配置。
apiRetStatus=
CyU3PUsbSetDesc(CY_U3P_USB_SET_SS_DEVICE_DESCR,NULL,(uint8*)CyFxUSB30DeviceDscr);
接下来是二进对象存储描述符的设置。
接下来是设备量化描述符。
接下来是超速配置描述符，高速设备配置描述符，
重点看一下超速配置描述符，它含配置描述符 主要指明了接口数，配置数，配置字符串（无）
特性-自供电，远端唤醒功能
电流消耗 400mA
接口描述符有：
端口数量，2 个。
接口类 FF，子类 00 接口协议 0 接口协议字符串 0
生产者端点描述符如下：
端点地址 0x01 生产者。最大包的长度 1024，数据间隔传输类型 0 表示 BULK。
超速端点公司描述符，基本上全是 0。
消费者端点，与生产者基本类似。只是端口地址不一样，其它一样的。
接下来是高速，全速描述符。
接下来是语言描述符。
接下来是制造厂名描述符。 为 CYPRESS
接下来是产品描述符 FX3
最后连接 USB 物理层。至此枚举将开始。
}
然后定义了一个线程进入点，如下：
SlFifoAppThread_Entry(uint32 input)
4
{
CyFxSlFifoApplnDegugInit();
CyFxSlFifoApplnInit();
for(;;)
{ CyU3PThreadSleep(1000);
//sleep
///这里是 UART 串口初始化
///初始化 FIFO 应用 在这中间是 GPIF 和 USB 的初始化程序。
If(glIsApplnActive)
///如果还是激活状态
CyU3PDebugPring(6,”Data tracker:…%d,buffer send:%d\n”,glDMARxCount,glDMATxCount);
}
}
}
/////
下面是应用定义函数，估计这个函数名是不能改的。在这个函数中，我们先分配一个堆栈空间
Ptr=CyU3PMemAlloc(CY_FX_SLFIFO_THREAD_STACK);
//然后产生一个线程
retThrdCreate = CyU3PThreadCreate(*slFifoAppThread,
“ 21:Slave_FIFO_syne”,
slFifoAppThread_Entry,
0,ptr,
CY_FX_SLFIFO_THREAD_STACK,
CY_FX_SLFIFO_THREAD_PRIOITY,
CY_FX_SLFIFO_THREAD_PRIORITY,
CYU3P_NO_THIME_SLICE,
CYU3P_AUTO_START
);
6、最后是主程序 main()
首先初始化设备，设备指的是 CPU，主要是时钟和堆栈等。
然后 cachecontrol 不用 DATA CACHE。
在开发板上，由于 53：56 脚被连接到 UART，这意味着我们要么选择 DQ32 模式，要么选择 LppMode.
不然 UART 就没办法用了。Lpp 模式好象是 GPIO+UART 模式，见 datasheet 33 页。
几个参数 用 UART，不用 IIC ，不用 IIS，不用 SPI。没有 GPIO 使用到（简单复杂都没有）。
然后就是设置配置了。
最后进入到内核。不返回。结束主程序。
内核于是调用某一个函数（具体实现内核已经封装好了），也就是 CyFxApplicationDefine(void)。程序就
从此开始了。
*问：
1 程序是如何下载到 USB 中去的。要怎么做。例如将这个编译好的代码放到什么目录里还是怎么办，还是
启动时，安装 driver 时，自动下载，这个下载的东西是个什么文件格式？该放在哪里？不明白
2．难道 GPIF 口上没接任何东西， 如何将 PC 机发下来的数据发回到 PC 机上去？
生产者：USB 的 OUT 接口 1，向 GPIF 发送一批数据
消费者：GPIF 向 IN 接口 81，由它消费掉一批数据。然后通过 IN 发回 PC 机。
5
二、再看一个简单一点的 GPIO 的例子（GpioApp）
1.先是一个错误处理的函数，我们不需要它，故这是一个死循环。
2. CyFxDebugInit 这个函数，将串口作为调试口用 115200bps。
3 .void CyFxGpioIntrCb (
)
uint8_t gpioId /* Indicates the pin that triggered the interrupt */
这个函数是一个中断回调函数。必须在某个地方注册一下。
它有下列过程：apiRetStatus =CyU3PGpioGetValue(gpioID,&gpioValue);
//这个函数得到某个端口中断的
值
这个 gpioValue 是一个 BOOL 值。而 ID 则是某一个端口的端口号。这个函数只能返回一个引脚。
等会看这个 ID 是什么指定的。
4.CyU3PEventSet(&glFxGpioAppEvent,
CY_FX_GPIOAPP_GPIO_HIGH_EVENT,CYU3P_EVENT_OR);
如果为高，则设置一个事件。是一个高事件发生。注意到事件是一个全局变量，而这个事件中有许多参
数，其中比较重要的是一个回调函数。应该在某个地方将这个事件与一个回调函数联系起来。一会要补充
这里
5． void CyFxGpioInit (void)
apiRetStatus = CyU3PGpioInit(&gpioClock,CyFxGpioIntrCB);
这个函数是设定 gpio 的时钟，以及中断的回调函数。这与 4 中部分形成对照。
然后将 gpio45 定义为输入且允许中断
gpioConfig.intrMode = CY_U3P_GPIO_INTR_BOTH_EDGE;
apiRetStatus = CyU3PGpioSetSimpleConfig(45, &gpioConfig);
GPIO 的 21 脚本来作为 GPIF 的控制信号的。不能用 CyU3PDeviceConfigureIOMatrix 来将它作为 GPIF
IOs.
这个过载 API 调用必须进行必须小心当改变这个引脚的功能时。如果 IO 脚作为 GPIF 的一部分连到
外部设备上。则它不能再作为 GPIF IO 使用。在这里 CTL4 是不使用的，所以用它用 IO 脚是安全的。
apiRetStatus = CyU3PDeviceGpioOverride(21,CyTrue);
接下来 apiRetStatus = CyU3PGpioSetSimpleConfig(21,&gpioConfig);
6. 接下来有两个线程，一个是输出线程，一个是输入线程，先看输出线程：
apiRetStatus = CyFxDebugInit();
CyFxGpioInit();这个也在前面 5 定义过。后面是一个闪灯程序。
apiRetStatus = CyU3PGpioSetValue(21,true); 将输出置为高。
////初始化调试模式。这个在 2 中定义的。
延时 2 秒，将输出变为低。
延时 2 秒。
7. 下面再来看输入线程：是一个循环，等事件发生。
txApiRetStatus = CyU3PEventGet (&glFxGpioAppEvent,
(CY_FX_GPIOAPP_GPIO_HIGH_EVENT | CY_FX_GPIOAPP_GPIO_LOW_EVENT),
CYU3P_EVENT_OR_CLEAR, &eventFlag, CYU3P_WAIT_FOREVER);
这里表示永远等下去。等到后要清除事件，另返回事件的标志，这个标志我们没有用。如果等到高的
标志，就打印一个引脚为高，如果为低，就打印一个引脚为低的标志。估计这个等事件标志将被 block.
6
这样整个过程清楚了，IO 脚触发引起一个中断。这个中断回调函数中将触发一个事件。在这个线程中将等
事件发生，如果发生了，就打印出引脚的状态。
事件在什么地方初始化呢？还是不需要初始化？
8. 果然，事件是要初始化的。在应用程序中初始化了，下面就看这个应用程序
先创建一个输出线程。
再创建一个输入线程
然后 retThrdCreate = CyU3EventCreate(&glFxGpioAppEvent);
9. 最后看一下 main()
main()中主要是将 GPIO 引脚初始化一下。
io_cfg.gpioSimpleEn[0] = 0;
io_cfg.gpioSimpleEn[1] = 0x00002000; /* GPIO 45 */
io_cfg.gpioComplexEn[0] = 0;
io_cfg.gpioComplexEn[1] = 0;
45 引脚为什么对应的是 0x2000. 这是因为它是 32 位的，45 引脚=32+13 这个第 13 位正好是 0X2000
总结
从 main 开始看起：
再看一下几个定义：输出线程，输入线程及事件在文件一开始就定义了。
CyU3PThread gpioOutputThread;
CyU3PThread gpioInputThread;
CyU3PEvent glFxGpioAppEvent;
/* GPIO thread structure */
/* GPIO thread structure */
/* GPIO input event group. */
它主要是调用了一个串口设置函数，然后就进入到 cache 控制设置，再后来就是设置一个 IO 脚，45
脚使之使能。并且选用配置模式（即 LPP 模式）。允许了 UART，不允许 IIC，IIS，SPI，另外 isDQ32bit
也不允许。这个表示它不支持 GPIF 的 32 位模式。
然后我们再看应用程序启动，这是由系统自动调用的。我们可能修改它的内容，但是它是必须的。
这个函数中，它创建了两个线程。一个是输入线程，一个是输出线程。
另外，容易遗忘的一件事是它创建了一个事件。事件的创建只要这样就可以了：
retThrdCreate = Cy3U3PEventCreate(&glFxGpioAppEvent);
再往上，就是输入线程了。这个线程看输入引脚的变化，而这个变化由中断回调函数引起，中断回调函数
中，它会产生一个事件，而我们的线程就监视这个事件。如果有事件高发生，就串口打印一个引脚高，如
果低，就打印一个引脚低。看它是如何实现的：
txApiRetStatus = CyU3PEventGet(&glFxGpioAppEvent,
(CY_FX_GPIOAPPP_GPIO_HIGH_EVENT|CY_FX_GPIOAPP_GPIO_LOW_EVENT),
CYU3P_EVENT_OR_CLEAR,&eventFlag,CYU3P_WAIT_FOREVER);
这是个等事件的函数，这个函数无法找到它的定义，它是一个 API 函数。我们找 API，发现它的参数含义。
这里有一个 CYU3P_EVENT_OR_CLEAR 表示只要上面有一个位被设置就返回且清除标志。----OR。
而真正的事件就放在标志中返回了。
既然有读事件，就必有设置事件，事件的设置应该在中断回调中实现。而中断回调的注册，应该在初始化
时实现。下面应该可以很快看到这点。---事实上，在下面的输出线程中就实现了注册
7
输出线程实现，输出线程比较有意思的是其 DebugInit()居然是在它中间实现的。这有点不合常理。
而接下来，它又调用了初始化 GpioInit()这个函数。在这个函数中，先初始化 GPIO，这个 GPIO 居然还要
将时钟也设置一下，有点不合常理。在这个初始化中，它还指明了 GPIO 中断回调函数的注册。尽管这个
中断函数应该是在输入线程中注册似更合理一些。接下来，45 脚要用之为输入，所以要将配置设一下：
gpioConfig.outValue = CyTrue;
gpioConfig.inputEn = CyTrue;
gpioConfig.driveLowEn = CyFalse; //不要驱动低也不要驱动高
gpioConfig.driveHighEn = CyFalse;
gpioConfig.intrMode = CY_U3P_GPIO_INTR_BOTH_EDGE; //允许中断
apiRetStatus = CyU3PGpioSetSimpleConfig(45, &gpioConfig);
//输出为高 因为是输入，要将它设为高
//输入使能
如此这般配置了 45 脚。
接下来，要配置 21 脚，因为 21 脚比较特殊本来是用于 GPIF 的 CTRL4 的。现在要使用它就要重载一下：
这样的 IO 脚是不可以象在主程序中哪样，将它直接设为输出的，而是要先重载。
同样，看输出脚是如何定义的
///低电平
gpioConfig.outValue = CyFalse;
gpioConfig.driveLowEn = CyTrue;
//允许低输出
gpioConfig.driveHighEn = CyTrue; ///允许高输出
gpioConfig.inputEn = CyFalse;
gpioConfig.intrMode = CY_U3P_GPIO_NO_INTR; //不用中断
//方向设为输出，（假的输入就是输出）
再看一下回调函数，如何实现它的：
当引脚有跳变时，这个函数被调用。首先，它得到引脚的值。这个回调函数是带参数的。当它发生时，会
带过来一个参数。表明是哪一个引脚触发了这个事件。这在库函数中可能已经处理了，提供给用户程序就
不用麻烦再去看原因了。我想可能有一个机制，即有一个中断状态寄存器，表示是哪一个引脚变化了。
在这里调用了一个函数：CyU3PGpioGetValue(gpioId,&gpioValue); 注意到这个值是一个 BOOL 型的。
然后根据情况来设置事件：
CyU3PEventSet(&glFxGpioAppEvent,CY_FX_GPIOAPP_GPIO_HIGH_EVENT,CYU3P_EVENT_OR);
我们看，其中有要设置的事件指针，有什么事件，以什么方式设置，它是以 OR 的方式设置的。这个 OR
表示的是将这个第 2 个参数与当前的事件标志进行或。显然，如果相或的话，则事件标志将被置 1，而如
果与则完全不同，它没效果。
（在得到事件中，有一个 AND 表示全部标志都符合才生成事件，所以也是用 OR 的，不然，不可能全部符
合的，永远不会发生事件了，因为不可能既变高又变低的）
至此整个程序解读完了。在这个例子中，似乎没用到 USB 有关的部分。
8
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
