雅特力AT32 MCU USB设备库的架构和使用方法

AT32 MCU 雅特力科技 2023-02-22 1987

电子说

1.3w人已加入

描述

   

AT32 USB设备协议库

 这部分主要介绍AT32 USB设备库的结构和库的使用方法，AT32 USB是基于USB2.0全速设备，不支持USB2.0高速设备。这里库的作用是用来管理USB外设和实现USB的基本协议，使开发者能够更快的上手开发。USB Deivce库包含以下几个模块如图1：

  • 用户应用程序

    此部分为开发者根据应用具体需求开发应用程序。

  • USB Core Driver和USB设备类

    USB Core Driver：此部分实现USB设备标准协议栈，标准请求等接口。

    USB设备类：此部分实现一个具体USB设备的描述和设备请求。

  • USB硬件底层接口

    此部分实现硬件寄存器抽象接口

  • USB/OTG外设

图1. USB库结构雅特力    

AT32 USB库文件

 如下是AT32 USB应用工程结构图：图2. AT32工程结构雅特力Core Driver库路径：OTGFS-->middlewaresusb_driversUSBFS-->middlewaresusbd_driversDevice Class库路径：middlewaresusbd_class如下是USB库文件列表：表1. USB库文件列表雅特力表2. USB设备类型文件列表雅特力  

USB设备库文件说明

 USB库实现USB设备标准请求，同时实现USB规格里面的4种传输类型（control，interrupt，bulk，isochronous）的函数接口。图3. USB库文件结构雅特力  

USB设备文件函数接口

 usbd_int.c函数接口usbd_int.c主要处理底层中断，不同USB外设，此部分会根据外设不同而有所改变。AT32系列芯片USB外设存在USBFS和OTGFS两种外设，此部分函数接口基本相同。表3. usbd_int函数接口雅特力  usbd_core.c函数接口usbd_core.c此文件封装不同的usb接口用于不同的地方调用，包括一些接收，发送函数等。表4. usbd_core函数接口雅特力  usbd_sdr.c函数接口usbd_sdr.c此文件处理USB一些标准请求。表5. usbd_sdr函数接口雅特力支持的标志设备请求如下表：表6. 标准设备请求雅特力  usbd_xx_class.c函数接口usbd_xx_class.c 此文件为具体设备类型的数据处理，通过结构体函数来实现不同设备类型数据的处理。开发者根据不同的设备类型，来实现下面函数结构体中的函数，达到不同应用结果。函数结构体如下：表7. 设备class函数结构体雅特力表8. 设备class函数接口雅特力  usbd_xx_desc.c函数接口usbd_xx_desc.c此文件为设备描述文件，设备描述信息都通过此文件的函数接口返回给主机。表9. 设备描述函数结构体雅特力表10. 设备描述接口函数雅特力  其它参数函数的参数结构体如下，USB设备库中参数传递使用结构体usbd_core_type，如下图：图4. 全局结构体雅特力USB设备的连接状态如下图：连接状态包含：

  • 默认状态

  • 地址状态

  • 配置状态

  • 挂起状态

可使用usbd_connect_state_get函数查询当前USB设备的连接状态。图5. USB设备连接状态雅特力USB设备返回值，USB函数接口使用如下函数返回值。图6. 函数返回值雅特力  

端点FIFO分配

 USB要正常收发数据，在初始化时需要为每个端点分配发送/接收的FIFO，FIFO的大小可以根据端点上传输的最大包长度确认。注意，分配给所有端点FIFO大小的和不能超过系统分配给USB缓冲区的最大长度，具体USB的缓冲区大小参考RM上的描述。开发者可以参考例程usb_conf.h为每个端点自定义分配FIFO。另外使用USBFS和OTGFS两种不同的外设时，usb_conf.h中对端点FIFO分配稍有不同。  USBFS外设端点FIFO分配USBFS外设端点分配实现了两种分配方式，一种自动分配，一种是用户自定义分配。
  • 自动分配：

    1. 通过打开usb_conf.h中USB_EPT_AUTO_MALLOC_BUFFER宏开启自动分配功能

    2. 在调用打开端点函数（usbd_ept_open）时自动根据传入的最大包长度自动分配FIFO

    3. 如果使用双缓冲模式（同步端点，双缓冲Bulk）时，在打开端点前先调用（usbd_ept_dbuffer_enable）表示使用双缓冲模式，可参考audio例程。

    4. 自动分配audio例程配置如下：

    usb_conf.h

    雅特力

    audio_class.c:端点打开

    雅特力

  • 自定义分配：

    1. 关闭usb_conf.h中USB_EPT_AUTO_MALLOC_BUFFER宏开启自定义分配

    2. 在调用打开端点函数（usbd_ept_open）时调用usbd_ept_buf_custom_define函数自定义为端点分配FIFO，参考vcp_loopback例程。

    3. vcp_loopback例程自定义分配配置

    usb_conf.h:

    雅特力

    cdc_class.c端点打开：

    雅特力

 OTGFS外设端点FIFO分配OTGFS对于端点的接收缓冲是共享的，因此对于所有的OUT端点，只需要分配一个接收FIFO。对发送缓冲区则需要为每个发送端点分配一块自己专用的FIFO。支持的端点个数请参考对应型号的RM。OTGFS的端点分配都需要开发者根据端点支持的最大包长度进行分配，注意usb_conf.h中对端点分配的FIFO大小单位为word（Byte）。以vcp_loopback例程为例：雅特力  

USB设备初始化

 在使用USB时，需要对USB的寄存器做一些基本的初始化，通过调用USB的初始化函数完成这部分的操作，对于外设USBFS和OTGFS在初始化时所调用的函数一定的区别。  USBFS外设初始化USBFS初始化函数usbd_core_init包含5个参数：雅特力例程vcp_loopback的初始化如下：usbd_core_init(&usb_core_dev, USB, &class_handler, &desc_handler, 0);  OTGFS外设初始化OTGFS初始化函数usbd_init包含5个参数：雅特力例程vcp_loopback的初始化如下：雅特力  

USB设备中断处理

 USB中断入口函数usbd_irq_handler处理所有USB中断，包括Reset，端点收发数据，SOF，挂起，唤醒等中断，下面介绍一些典型的中断处理。图7. USB中断处理函数雅特力  Reset中断处理当USB设备在总线上检测到Reset信号时，将产生Reset中断。软件在收到Reset中断时，需要做基本的初始化，用于后面的枚举处理。Reset中断处理函数usbd_reset_handler：

  • 端点FIFO初始化

  • 设备地址设置为0

  • 端点0初始化

  • 调用设备类的事件函数

    udev->class_handler->event_handler(udev, USBD_RESET_EVENT);

 端点中断处理当USB端点收发数据完成时，将产生对应的端点完成中断，端点完成中断处理发送和接收的数据。中断处理函数：usbd_xeptx_handler  SOF中断处理打开SOF中断之后，USB设备在每收到一个主机发送的SOF就会产生SOF中断。中断处理函数：usbd_sof_handler

  • 中断处理函数会调用设备类的SOF处理函数

    udev->class_handler->sof_handler(udev);

 Suspend中断处理当总线满足挂起条件时，USB设备会产生一个挂起中断，开发者可根据此中断判断是否需要进入低功耗模式。中断处理函数：usbd_suspend_handler

  • 连接状态设置为挂起状态

  • 设置设备进入挂起状态

  • 调用设备类的事件处理函数

    udev->class_handler->event_handler(udev, USBD_SUSPEND_EVENT);

 Wakeup中断处理当设备在挂起状态时，如果总线上有wakeup信号，USB设备将产生wakeup中断。中断处理函数：usbd_wakeup_handler

  • 设备退出挂起状态

  • 连接状态设置为进入挂起之前的状态

  • 调用设备类事件处理函数

    udev->class_handler->event_handler(udev, USBD_WAKEUP_EVENT);

 

USB设备端点数据处理流程

 USB设备在收到主机发送的数据包之后，对应端点0的数据（IN/OUT/SETUP）会做单独处理，其它端点的数据会调用设备类的IN/OUT handler进行数据处理。如下图所示数据的处理过程：图8. 端点数据处理流程雅特力图9. Setup处理流程雅特力  USB控制端点枚举流程当设备接到主机之后，通过控制端点（端点0）进行枚举动作，典型的枚举流程图如下：图10. USB枚举流程雅特力USB控制传输过程包含SETUP-DATA-STATUS三个阶段，如下是一个主机获取设备信息的传输过程GET_DESCRIPTOR：图11 Get Descriptor雅特力如下是USB库处理上图Get Descriptor的流程：图12. USB库处理Get Descriptor调用流程雅特力USB设备请求格式（Setup请求）图13. Setup请求格式雅特力  USB应用端点处理流程应用端点指客户实际应用使用到的非0端点，包括Bulk，interrupt，ISO等端点类型，这些端点的数据通回调函数in_handler和out_handler进行处理。开发者只需要在xxx_class.c中class_in_handler和class_out_handler里面实现具体端点的数据处理即可。IN端点数据处理：图14. IN端点数据处理雅特力OUT端点数据处理:图15. OUT端点数据处理雅特力  

USB设备类型例程

 本章将说明使用AT32 USB设备库实现不同的设备类型的例程。目前实现的设备例程如下：

  • Audio

  • custom_hid

  • keyboard

  • mouse

  • msc（mass strorage）

  • printer

  • vcp_loopback

  • virtual_msc_iap

  • composite_vcp_keyboard

  • hid_iap

 

Audio例程

 Audio例程使用audio V1.0的协议实现一个Speaker和Microphone，传输Audio数据使用同步传输，Speaker使用同步OUT传输，Microphone使用同步IN传输。Audio的例程运行在AT-START评估板上，Audio Speaker和Mircophone是基于Audio Arduino Demo Board进行实现，实验过程中需要连接AT-START和Audio Arduino Board，更多开发板信息请参考《UM_Audio Arduino Daughter Board_V1.0/V2.0》,Audio协议请参数《Universal Serial Bus Device Class Define for Audio Device V1.0》。  实现功能实现一个Speaker和Microphone的Audio复合设备，可以同时进行音频播放和录音。Speaker功能：

  • 支持16K，48K采样率

  • 支持采样率切换

  • 支持16bit采样

  • 支持静音

  • 支持音量调节

  • 支持feedback功能

  • 支持双通道

Microphone功能：

  • 支持16K，48K采样率

  • 支持采样率切换

  • 支持16bit采样

  • 支持静音

  • 支持音量调节

  • 支持双通道

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举以及Audio部分控制。

  • 端点1 IN：用于Microphone录音数据

  • 端点1 OUT：用于Speaker播放数据

  • 端点2 IN：用于Feedback数据

I2C：

  • 使用I2C发送控制信息到音频Board

I2S：

  • 使用I2S1发送数据到音频board（speaker）

  • 使用I2S2从音频board接收数据（microphone）

DMA：

  • 使用DMA1通道3传输I2S1的数据

  • 使用DMA1通道4传输I2S2的数据

TIMER：

  • 使用TIMER产生Codec所需要的时钟

 Audio设备实现USB Audio设备类实现源文件在audio_class.c和audio_desc.c中，外部codec的控制以及音频数据的处理都在audio_codec.c中实现，根据主机的请求设置会调用到audio_codec.c中具体的设置函数。另外需要特别注意关于USB设备端点FIFO大小的分配在usb_conf.h中配置，此部分根据具体端点传输的最大包长度进行分配。  1. 设备描述：（audio_desc.c/h）

  • Audio设备的描述（g_usbd_descriptor）

  • Audio设备的配置描述信息（g_usbd_configuration）

    AC interface

    Mricrophone Streaming interface

    Microphone Terminal INPUT/OUTPUT

    Microphone Feature Unit

    Microphone Endpoint

    Speaker Streaming interface

    Speaker Terminal INPUT/OUTPUT

    Speaker Feature Unit

    Speaker Endpoint

    Feedback Endpoint

  • Lang id （g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（audio_desc.h）

    雅特力

  • 制造商、产品名、配置描述、接口描述（audio_desc.h）

    雅特力

 2. 数据处理部分（audio_class.c/h audio_codec.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • Audio控制请求（class_setup_handler）

    实现如下audio控制请求：

    雅特力

    雅特力

  • Audio音量、静音、采样率设置（class_ept0_rx_handler）

    此函数用于接收完主机发送的设置数据之后进行处理，包括设置音量，静音，以及采样率的设置。

    雅特力

  • Microphone和Feedback数据传输（class_in_handler）

    雅特力

  • Speaker数据接收（class_out_handler）

    雅特力

  • audio_codec.c中实现codec具体的控制以及数据处理，需要实现如下函数：

    雅特力

    以上函数可根据例程里的方式进行实现，也可以根据开发者实际使用的codec来进行修改，对于codec的初始化部分，在这里将不再讲述。

  • audio例程功能配置

    audio_conf.h中可以对当前audio例程进行配置，例如：是否需要speaker功能，支持采样率等，有如下选项配置：

    雅特力

 如何根据Audio例程进行开发本章将简单描述如何修改audio例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改audio配置（audio_conf.h）

  • 根据功能需求修改设备描述信息（audio_desc.c, audio_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    其它描述

  • 根据功能修改要使用端点(audio_class.c, audio_class.h)

    端点定义（audio_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的Audio控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • Audio数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

  • 根据具体需求实现codec函数接口（audio_codec.c）

 

custom_hid例程

 custom_hid实现一个HID（human interface device）功能，与上位机（Artery_UsbHid_Demo）通信完成一些简单的交互操作，HID使用中断传输与上位机通信，例程在AT-START开发板上运行，上位机可在官网下载，关于HID协议参考《Human Interface Devices (HID) V1.11》。  实现功能

  • 上位机显示按键状态

  • 通过上位机控制开发板LED等开关状态

  • HID数据回环功能

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

  • 端点1 OUT：用于数据接收

 custom_hid设备实现custom_hid设备类实现源代码主要在custom_hid_class.c和custom_hid_desc.c中，这两个源文件实现了对设备的描述和设备的处理。  1. 设备描述：（custom_hid_desc.c/h）

  • custom hid设备描述（g_usbd_descriptor）

  • custom hid设备配置描述（g_usbd_configuration）

    HID interface

    HID Endpoint

  • custom hid report描述（g_usbd_hid_report）

    HID_REPORT_ID_2(LED2)

    HID_REPORT_ID_3(LED3)

    HID_REPORT_ID_4(LED4)

    HID_REPORT_ID_5(BUTTON)

    HID_REPORT_ID_6(LOOPBACK DATA)

  • Lang id（g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（custom_hid_desc.h

    雅特力

  • 制造商、产品名、配置描述、接口描述（custom_hid_desc.h）

    雅特力

 2. 数据处理部分（custom_hid_class.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • HID设备类请求（class_setup_handler）

    实现如下请求：

    SET_PROTOCOL

    GET_PROTOCOL

    SET_IDLE

    GET_IDLE

    SET_REPORT

    代码如下：

    雅特力

  • Custom_HID发送数据

    雅特力

  • Custom_HID接收数据

    雅特力

  • 数据处理

    雅特力

 如何根据custom hid例程进行开发本章将简单描述如何修改custom_hid例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改设备描述信息（custom_hid_desc.c, custom_hid_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    设备报告描述符（g_usbd_hid_report）

    其它描述

  • 根据功能修改要使用端点(custom_hid_class.c, custom_hid_class.h)

    端点定义（custom_hid_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的custom_hid控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • custom_hid发送接收数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

  • 修改数据处理部分

 

keyboard例程

 keyboard实现一个键盘功能，使用中断传输与上位机通信，例程在AT-START开发板上运行，通过按键发送字符串到主机。  实现功能

  • 通过按键发送字符串（”Keyboard Demo”）到主机

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

 keyboard设备实现keyboard设备类实现源代码主要在keyboard_class.c和keyboard_desc.c中，这两个源文件实现了对设备的描述和设备的处理。  1. 设备描述：（keyboard_desc.c/h）

  • keyboard设备描述（g_usbd_descriptor）

  • keyboard设备配置描述（g_usbd_configuration）

    keyboard interface

    keyboard endpoint

  • keyboard report描述（g_usbd_hid_report）

  • Lang id（g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（keyboard_desc.h）

    雅特力

  • 制造商、产品名、配置描述、接口描述（keyboard_desc.h）

    雅特力

 2. 数据处理部分（keyboard_class.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • HID设备类请求（class_setup_handler）

    实现如下请求：

    SET_PROTOCOL

    GET_PROTOCOL

    SET_IDLE

    GET_IDLE

    SET_REPORT

  • keyboard发送数据

    雅特力

  • keyboard字符数据处理

    雅特力

 如何根据keyboard例程进行开发本章将简单描述如何修改keyboard例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改设备描述信息（keyboard_desc.c, keyboard_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    设备报告描述符（g_usbd_hid_report）

    其它描述

  • 根据功能修改要使用端点(keyboard_class.c, keyboard_class.h)

    端点定义（keyboard_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的keyboard控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • keyboard发送接收数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

  • 修改数据处理部分

 

Mouse例程

 实现功能mouse实现一个简单的鼠标功能，使用中断传输与上位机通信，例程在AT-START开发板上运行，通过开发板上的按键发送鼠标右键功能。图16. 鼠标传输格式雅特力鼠标d通常是通过设置X和Y值来控制PC鼠标移动。  外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

 mouse设备实现mouse设备实现源代码主要在mouse_class.c和mouse_desc.c中，这两个源文件实现了对设备的描述和设备的处理。  1. 设备描述：（mouse_desc.c/h）

  • mouse设备描述（g_usbd_descriptor）

  • mouse设备配置描述（g_usbd_configuration）

    mouseinterface

    mouseendpoint

  • mouse report描述（g_usbd_hid_report）

  • Lang id（g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（mouse_desc.h）

    雅特力

  • 制造商、产品名、配置描述、接口描述（keyboard_desc.h）

    雅特力

 2. 数据处理部分（mouse_class.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • HID设备类请求（class_setup_handler）

    实现如下请求：

    SET_PROTOCOL

    GET_PROTOCOL

    SET_IDLE

    GET_IDLE

    SET_REPORT

  • keyboard发送数据

    雅特力

  • mouse数据处理

    雅特力

 如何根据mouse例程进行开发本章将简单描述如何修改mouse例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改设备描述信息（mouse_desc.c, mouse_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    设备报告描述符（g_usbd_hid_report）

    其它描述

  • 根据功能修改要使用端点(mouse_class.c, mouse_class.h)

    端点定义（mouse_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的mouse控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • mouse发送接收数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

  • 修改数据处理部分

 

msc例程

 msc（mass storage）例程展示如何通过USB BULK传输，进行PC主机和AT-START通信，该例程支持BOT(Bulk only transfer)协议和SCSI（small computer system interface）指令。图17. BOT 命令/数据/状态 流程雅特力图18. BOT命令格式雅特力图19. BOT状态格式雅特力  实现功能

  • 将内部FLASH虚拟成一个磁盘

  • 实现bulk-only传输协议

  • 实现subclass SCSI传输命令

    MSC_CMD_INQUIRY

    MSC_CMD_START_STOP

    MSC_CMD_MODE_SENSE6

    MSC_CMD_MODE_SENSE10

    MSC_CMD_ALLOW_MEDIUM_REMOVAL

    MSC_CMD_READ_10

    MSC_CMD_READ_CAPACITY

    MSC_CMD_REQUEST_SENSE

    MSC_CMD_TEST_UNIT

    MSC_CMD_VERIFY

    MSC_CMD_WRITE_10

    MSC_CMD_READ_FORMAT_CAPACITY

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

  • 端点1 OUT：用于数据接收

 msc设备实现1. 设备描述：（msc_desc.c/h）

  • msc设备描述（g_usbd_descriptor）

  • msc设备配置描述（g_usbd_configuration）

    msc interface

    msc endpoint

  • Lang id（g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（custom_hid_desc.h）

    雅特力

  • 制造商、产品名、配置描述、接口描述（msc_desc.h）

    雅特力

 2. 数据处理部分（msc_class.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • MSC设备请求（class_setup_handler）

    GET_MAX_LUN    

    BO_RESET

    代码如下：

    雅特力

  • IN传输处理

    雅特力

  • OUT传输处理（接收数据）

    雅特力

 3. BOT和SCSI命令处理Bulk-only transfer和SCSI的命令处理在库文件msc_bot_scsi.c/h中。表11. msc_bot_scsi函数列表雅特力  4. diskio处理此部分主要处理与存储设备间接口，例程里面以内部flash的存储控制作为说明，msc_diskio.c/h根据开发者使用存储不同，只需要实现对应存储的读写函数即可。表12. inquiry描述雅特力表13 diskio操作函数雅特力  如何根据msc例程进行开发本章将简单描述如何修改msc例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改设备描述信息（msc_desc.c, msc_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    其它描述

  • 根据功能修改要使用端点(msc_class.c, msc_class.h)

    端点定义（msc_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的msc控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • msc发送接收数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

  • 修改diskio部分,实现表13里面的函数（msc_diskio.c/h）

 

printer例程

 Printer例程展示了使用USB Device作为打印机设备，此demo可在PC端识别到一个打印机设备并且可应答PC端发送的关于printer类的状态请求命令（例如打印机的有纸/无纸状态）  实现功能

  • 实现一个打印机设备

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

  • 端点1 OUT：用于数据接收

 printer设备实现1. 设备描述（printer_desc.c/h）

  • printer设备描述（g_usbd_descriptor）

  • printer设备配置描述（g_usbd_configuration）

    printer interface

    printer endpoint

  • Lang id（g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（custom_hid_desc.h）

    雅特力

  • 制造商、产品名、配置描述、接口描述（msc_desc.h）

    雅特力

 2. 数据处理（printer_class.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • printer设备请求（class_setup_handler）

    GET_DEVICE_ID

    PORT_STATUS

    SOFT_RESET

    代码如下：

    雅特力

  • IN传输处理

    雅特力

  • OUT传输处理（接收数据）

    雅特力

 如何根据printer例程进行开发本章将简单描述如何修改printer例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改设备描述信息（printer_desc.c, printer_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    其它描述

  • 根据功能修改要使用端点(printer_class.c, printer_class.h)

    端点定义（printer_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的printer控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • printer发送接收数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

 

vcp loopback例程

 在现代PC中，USB是和绝大部分外设通信的标准接口。尽管如此，大部分的工业软件依旧使用COM接口（UART）通信。vcp_loopback例程提供使用USB设备模拟COM接口方法，解决了该问题, vcp_loopback例程展示了如何通过CDC协议进行USB数据收发。改例程需要使用虚拟串口驱动，可在官网下载。  实现功能

  • 实现一个虚拟串口

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

  • 端点1 OUT：用于数据接收

  • 端点2 IN：监控中断传输

 vcp_loopback设备实现1. 设备描述（cdc_desc.c/h）

  • cdc设备描述（g_usbd_descriptor）

  • cdc设备配置描述（g_usbd_configuration）

    cdc interface

    cdc endpoint

  • Lang id（g_string_lang_id）

  • 序列号（g_string_serial）

  • 厂商产品ID（custom_hid_desc.h）

    雅特力

  • 制造商、产品名、配置描述、接口描述（msc_desc.h）

    雅特力

 2. 数据处理（cdc_class.c/h）

  • 端点初始化（class_init_handler）

    雅特力

  • 端点清除（class_clear_handler）

    雅特力

  • cdc设备请求（class_setup_handler）

    SET_LINE_CODING

    GET_LINE_CODING

    代码如下：

    雅特力

  • IN传输处理

    雅特力

  • OUT传输处理（接收数据）

    雅特力

 如何根据vcp_loopback例程进行开发本章将简单描述如何修改cdc例程的代码来进行开发，根据应用具体的需求来修改代码。

  • 根据功能需求修改设备描述信息（cdc_desc.c, cdc_desc.h）

    设备描述信息（g_usbd_descriptor）

    设备配置描述信息（g_usbd_configuration）

    其它描述

  • 根据功能修改要使用端点(cdc_class.c, cdc_class.h)

    端点定义（cdc_class.h）

    端点初始化（class_init_handler，class_clear_handler）

  • 修改使用的cdc控制请求

    控制请求修改（class_setup_handler）

    控制请求设置处理（class_ept0_rx_handler）

  • cdc发送接收数据处理修改

    IN数据处理（class_in_handler）

    OUT数据处理（class_out_handler）

  • 根据需求修改端点FIFO大小分配（usb_conf.h）

 

virtual_msc_iap例程

 virtual msc iap实现一个升级功能的设备，不依赖上位机，当接入PC之后，通过将固件拷贝到磁盘以达到升级目的。  实现功能

  • 将flash虚拟成磁盘进行升级

  • Iap保留使用20K byte空间

  • 升级完成之后reset usb设备返回升级状态

  • 支持下载地址设置

  • 支持升级完成之后跳转到APP运行

  • 支持bin文件升级

 外设资源使用USB外设：

  • 端点0 IN/OUT：用于USB枚举

  • 端点1 IN：用于数据发送

  • 端点1 OUT：用于数据接收

 virtual_msc_iap设备实现1. 设备描述（msc_desc.c/h）参考3.5.3.1  2. 数据处理部分（msc_class.c/h）参考3.5.3.2  3. BOT和SCSI命令处理参考3.5.3.3  4. diskio处理参考3.5.3.4  5. flash升级部分（flash_fat16.c/h）

  • 升级状态

    雅特力

    当连接Host之后，在响应磁盘上通过TXT文档显示当前状态

    准备升级状态（Ready.TXT）

    升级成功（Success.TXT）

    升级失败（Failed.TXT）

    未知文件或错误（Unkonwn.TXT）

    升级文件大于FLASH大小（Large.TXT）

  • FAT16分区表描述

    雅特力
  • 升级接口函数雅特力
 如何根据virtual_msc_iap例程进行开发本章将简单描述如何修改virtual_msc_iap例程的代码来进行开发，根据应用具体的需求来修改代码。
  • 根据功能需求修改设备描述信息（msc_desc.c, msc_desc.h）设备描述信息（g_usbd_descriptor）设备配置描述信息（g_usbd_configuration）其它描述
  • 根据功能修改要使用端点(msc_class.c, msc_class.h)端点定义（msc_class.h）端点初始化（class_init_handler，class_clear_handler）
  • 修改使用的msc控制请求控制请求修改（class_setup_handler）控制请求设置处理（class_ept0_rx_handler）
  • msc发送接收数据处理修改IN数据处理（class_in_handler）OUT数据处理（class_out_handler）
  • 根据需求修改端点FIFO大小分配（usb_conf.h）
  • 修改diskio部分,实现表13里面的函数（msc_diskio.c/h）
  • 修改flash_fat16.c/h升级参数，包括APP起始地址，IAP占用空间等，要保证IAP和APP地址不重合。
 

composive_vcp_keyboard例程

 复合设备定义如下：拥有多个相互独立接口的设备被称为复合设备。当使用该设备时，该设备上拥有多个组合的功能。例如，Composite vcp keyboard demo 提供的复合设备包含HID和CDC功能（键盘和串口通信）  实现功能
  • 实现一个USB虚拟串口（参考3.7）
  • 实现一个USB键盘设备（参考3.3）
 外设资源使用USB外设：
  • 端点0 IN/OUT：用于USB枚举
  • 端点1 IN：用于数据发送
  • 端点1 OUT：用于数据接收
  • 端点2 IN：CDC命令中断传输
  • 端点3 IN：Keyboard发送数据
 composite_vcp_keyboard设备实现1. 设备描述（cdc_keyboard_desc.c/h）
  • cdc_keyboard设备描述（g_usbd_descriptor）
  • cdc_keyboard设备配置描述（g_usbd_configuration）cdc interfacecdc endpointkeyboard interfacekeyboard endpoint
  • Lang id（g_string_lang_id）
  • 序列号（g_string_serial）
  • 厂商产品ID（custom_hid_desc.h）雅特力
  • 制造商、产品名、配置描述、接口描述（msc_desc.h）雅特力
     2. 数据处理（cdc_keyboard_class.c/h）  
  • 端点初始化（class_init_handler）雅特力
  • 端点清除（class_clear_handler）雅特力
  • 设备请求（class_setup_handler）cdc设备类请求:SET_LINE_CODINGGET_LINE_CODIN

    Keyboard hid设备类请求:

    SET_PROTOCOLGET_PROTOCOLSET_IDLEGET_IDLESET_REPORT

    代码如下：

    雅特力
  • IN传输处理雅特力
  • OUT传输处理（接收数据）雅特力
 如何根据composite_vcp_keyboard例程进行开发本章将简单描述如何修改composite_vcp_keyboard例程的代码来进行复合设备开发，根据应用具体的需求来修改代码。
  • 根据功能需求修改设备描述信息（cdc_keyboard_desc.c, cdc_keyboard_desc.h）设备描述信息（g_usbd_descriptor）设备配置描述信息（g_usbd_configuration）其它描述
  • 根据功能修改要使用端点(cdc_keyboard_class.c, cdc_keyboard_class.h)端点定义（cdc_class.h）端点初始化（class_init_handler，class_clear_handler）
  • 修改使用的cdc控制请求控制请求修改（class_setup_handler）控制请求设置处理（class_ept0_rx_handler）
  • cdc_keyboard发送接收数据处理修改IN数据处理（class_in_handler）OUT数据处理（class_out_handler）
  • 根据需求修改端点FIFO大小分配（usb_conf.h）
 

hid_iap例程

 hid_iap例程使用usb hid实现IAP升级功能，需要搭配上位机使用，上位机可在官网下载IAP_Programmer。hid iap的例程代码位于BSP固件库utilitiesat32f435_437_usb_iap_demo中，使用方法可参考《AN0007_AT32_IAP_using_the_USB_HID_ZH_V2.x.x.pdf》  1. 实现功能
  • 实现使用HID进行设备升级
 2. 外设资源使用USB 外设：
  • 端点0 IN/OUT：用于USB枚举
  • 端点1 IN：用于数据发送
  • 端点1 OUT：用于数据接收
 hid_iap设备实现1. 设备描述（hid_iap_desc.c/h）
  • hid iap设备描述（g_usbd_descriptor）
  • hid iap设备配置描述（g_usbd_configuration）HID interfaceHID Endpoint
  • hid iap report描述（g_usbd_hid_report）
  • Lang id（g_string_lang_id）
  • 序列号（g_string_serial）
  • 厂商产品ID（hid_iap_desc.h）雅特力
  • 制造商、产品名、配置描述、接口描述（hid_iap_desc.h）雅特力
 2. 数据处理（hid_iap_class.c/h）
  • 端点初始化（class_init_handler）雅特力
  • 端点清除（class_clear_handler）雅特力
  • HID设备类请求（class_setup_handler）实现如下请求：SET_PROTOCOLGET_PROTOCOLSET_IDLEGET_IDLESET_REPORT代码如下：雅特力
  • hid iap发送数据雅特力
  • hid iap接收数据雅特力
  • 升级命令数据处理  雅特力
 3. hid iap升级协议表14. hid iap升级命令雅特力

  1. 0x5AA0进入IAP模式

    作为一个特定的命令，当用户APP收到这个命令之后将进入IAP模式。实现方式为收到这个命令之后擦除flag然后reset

    上位机：[0x5A, 0xA0]

    IAP设备响应：[0x5A, 0XA0, ACK/NACK]

  2. 0x5AA1开始下载

    上位机：[0x5A,0xA1]

    IAP设备响应：[0x5A,0xA1,ACK/NACK]

  3. 0x5AA2设置下载地址

    设置下载地址需按照1KB对齐，每下载1Kbyte数据之后，都需要重新设置下载地址。

    上位机(命令+地址)：[0x5A, 0xA2, 0x08, 0x00, 0x40, 0x00]

    IAP设备响应：[0x5A,0xA2, ACK/NACK]

  4. 0x5AA3下载数据命令(1KB 对齐多个包发送)

    下载数据命令采用命令+长度+数据的格式进行发送，每包最大数据量为60Byte（64–命令–长度），当发送数据达到1KB时，上位机需要等待设备的ACK响应。此时设备需将1KB的数据写到FLASH。

    上位机（命令(2Byte)+长度(2 Byte)+数据(n byte)）:[0x5A,0xA3,LEN1,LEN0,DATA0….DATAn]

    收完1KB数据后IAP设备响应：[0x5A, 0XA3, ACK/NACK]

  5. 0x5AA4下载结束

    上位机：[0x5A, 0xA4]

    IAP设备响应：[0x5A, 0xA4, ACK/NACK]

  6. 0x5AA5固件CRC校验

    上位机传输固件起始地址和固件大小/1KB（固件大小按1KB对齐，不足补0xFF），由IAP计算CRC之后返回给上位机。

    上位机：[0x5A,0xA5, 0x08, 0x00, 0x40, 0x00, LEN1, LEN0]

    IAP设备响应: [0x5A, 0xA5, ACK/NACK, CRC3, CRC2, CRC1, CRC0]

  7. 0x5AA6跳转命令

    跳转命令将跳转到用户代码进行运行

    上位机：[0x5A,0xA6, 0x08, 0x00, 0x40, 0x00]

    IAP设备响应：[0x5A,0xA6,ACK/NACK]

  8. 0x5AA7获取IAP设置的app地址

    返回IAP设置的app地址

    上位机：[0x5A, 0xA7]

    IAP设备响应：[0x5A, 0xA7, ACK/NACK, 0x08, 0x00, 0x40, 0x00]

 如何根据hid_iap例程进行开发本章将简单描述如何修改hid_iap例程的代码来进行开发，根据应用具体的需求来修改代码。
  • 根据功能需求修改设备描述信息（hid_iap_desc.c, hid_iap_desc.h）设备描述信息（g_usbd_descriptor）设备配置描述信息（g_usbd_configuration）其它描述
  • 根据功能修改要使用端点（hid_iap_class.c, hid_iap_class.h）端点定义（hid_iap_class.h）端点初始化（class_init_handler，class_clear_handler）
  • 修改使用的hid控制请求控制请求修改（class_setup_handler）控制请求设置处理（class_ept0_rx_handler）
  • hid_iap发送接收数据处理修改IN数据处理（class_in_handler）OUT数据处理（class_out_handler）
  • 根据需求修改端点FIFO大小分配（usb_conf.h）
  • 修改hid_iap_user.h中的升级参数，包括APP起始地址等，IAP占用空间等，保证APP地址和IAP的地址不要重合。
　　审核编辑：汤梓红

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉
评论(0)
发评论
班炳炳 2023-05-22
0 回复 举报
您好  USB设备库的架构和使用方法的源码可否发我一下  收起回复

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分