如何修改STM32的USB例程为自己所用
如何修改STM32的USB例程为自己所用
computer00 电脑圈圈
https://www.sodocs.net/doc/3d4487547.html,/bbs/bbs_content_all.jsp?bbs_sn=1387906
在万利学习板自带的演示例程中，有几个USB的例程。如果我们想实现一个USB功能，可以拿里面的例子来改。那么具体要改哪些地方呢？首先要改各种描述符，然后是具体的数据处理。我们拿USB摇杆鼠标范例来修改，把它改成USB键盘。该范例在目录\Manley\EKBoard\EKSTM32F\USBDemo(8M osc)\USBDemo\USBLib\demos\JoyStickMouse下，将JoyStickMouse复制一份，改名为USBKeyboard，以用来修改。
描述符在文件usb_desc.c中。第一个要改的是设备描述符。设备描述符的结构都标准的，长度也是固定的。范例中的USB设备描述符如下：
/* USB Standard Device Descriptor */
const u8 Joystick_DeviceDescriptor[JOYSTICK_SIZ_DEVICE_DESC]=
{
0x12, /*bLength */
USB_DEVICE_DESCRIPTOR_TYPE, /*bDescriptorType*/
0x00, /*bcdUSB */
0x02,
0x00, /*bDeviceClass*/
0x00, /*bDeviceSubClass*/
0x00, /*bDeviceProtocol*/
0x40, /*bMaxPacketSize40*/
0x83, /*idVendor (0x0483)*/
0x04,
0x10, /*idProduct = 0x5710*/
0x57,
0x00, /*bcdDevice rel. 2.00*/
0x02,
1, /*Index of string descriptor describing
manufacturer */
2, /*Index of string descriptor describing
product*/
3, /*Index of string descriptor describing the
device serial number */
0x01 /*bNumConfigurations*/
}; /* Joystick_DeviceDescriptor */
我们只需要修改这里的idVendor（即VID）和idProduct（即PID）即可。它们是用来供电脑端识别设备以加载驱动用的，所以必须不能跟现有的设备相冲突。VID和PID都是两字节，低字节在前，高字节在后。例如这里的VID为0x0483，写在里面就是0x83,0x04。我们将VID改成0x1234，将PID改成0x4321，即: 0x34, 0x12, 0x21, 0x43。
然后再修改配置描述符集合。配置描述符集合包括配置描述符、接口描述符、类特殊描述符（这里是HID 描述符）、以及端点描述符。如果你需要增加端点，那么在最后增加就行了，注意要记得修改JOYSTICK_SIZ_CONFIG_DESC的值为配置描述符集合的长度。第一部分为配置描述符。通常这里不需要修改，除非你要改成该配置有多个接口（USB复合设备），那么应该修改bNumInterfaces，需要多少个就改成多少个，这里只有一个接口，所以值为1。第二部分为接口描述符，在接口描述符中决定该接口所实现的功
能，例如HID设备，或者是大容量存储设备等等。其中bInterfaceNumber为该接口的编号，从0开始。这里只有一个接口，所以它的值为0，如果又更多的接口，则依次编号。注意一个接口完整结束（包括该接口下的类特殊描述符和端点描述符）后，才开始一个新的接口。bNumEndpoints为该接口所使用的端点数目（不包括端点0），原来的程序是实现鼠标功能的，所以只有一个输入端点。我们这里增加一个输出端点，用来控制LED（键盘上有大写字母锁定、小键盘数字键锁定等指示灯），因此将bNumEndpoints改为2。bInterfaceClass为接口所使用的类，这里指定为HID设备，USB键盘和鼠标都是HID设备，这里不用修改，如果你要实现其它设备，请根据USB协议所规定的类来修改。bInterfaceSubClass为接口所使用的子类，在HID设备类下规定了两种子类，系统引导时能用的和不能用的，这里为1，表示系统引导时能使用。bInterfaceProtocol为接口的协议，原来为鼠标，这里改为1，键盘。第三部分为HID描述符，只有HID 设备才有，如果你要修改成其它设备，则用其它设备的类特殊描述符代替或者没有，在这里不用做修改。第四部分为输入端点1的端点描述符，原来代码中，设置的端点最大包长度（wMaxPacketSize）为4字节，我们将其改成8字节。另外，我们再增加一个输出端点1，将最后的输入端点1描述符复制一份，然后修改地址（bEndpointAddress）为0x01，这表示该端点为输出端点，地址为1。由bEndpointAddress的最高位表示方向，1为输入，0为输出，最后4位表示地址。最后，要记得在usb_desc.h文件中修改JOYSTICK_SIZ_CONFIG_DESC的长度为41，因为我们增加了7字节。实际修改好的配置描述符集合如下：
/* USB Configuration Descriptor */
/* All Descriptors (Configuration, Interface, Endpoint, Class, Vendor */
const u8 Joystick_ConfigDescriptor[JOYSTICK_SIZ_CONFIG_DESC] =
{
//以下为配置描述符
0x09, /* bLength: Configuation Descriptor size */
USB_CONFIGURATION_DESCRIPTOR_TYPE, /* bDescriptorType: Configuration */
JOYSTICK_SIZ_CONFIG_DESC,
/* wTotalLength: Bytes returned */
0x00,
0x01, /*bNumInterfaces: 1 interface*/
0x01, /*bConfigurationValue: Configuration value*/
0x00, /*iConfiguration: Index of string descriptor describing
the configuration*/
0xC0, /*bmAttributes: self powered */
0x32, /*MaxPower 100 mA: this current is used for detecting Vbus*/
//以下为接口描述符
/************** Descriptor of Joystick Mouse interface ****************/
/* 09 */
0x09, /*bLength: Interface Descriptor size*/
USB_INTERFACE_DESCRIPTOR_TYPE,/*bDescriptorType: Interface descriptor type*/
0x00, /*bInterfaceNumber: Number of Interface*/
0x00, /*bAlternateSetting: Alternate setting*/
0x02, /*bNumEndpoints*/
0x03, /*bInterfaceClass: HID*/
0x01, /*bInterfaceSubClass : 1=BOOT, 0=no boot*/
0x01, /*bInterfaceProtocol : 0=none, 1=keyboard, 2=mouse*/
0, /*iInterface: Index of string descriptor*/
//以下为HID描述符
/******************** Descriptor of Joystick Mouse HID ********************/
/* 18 */
0x09, /*bLength: HID Descriptor size*/
HID_DESCRIPTOR_TYPE, /*bDescriptorType: HID*/
0x00, /*bcdHID: HID Class Spec release number*/
0x01,
0x00, /*bCountryCode: Hardware target country*/
0x01, /*bNumDescriptors: Number of HID class descriptors to follow*/
0x22, /*bDescriptorType*/
JOYSTICK_SIZ_REPORT_DESC,/*wItemLength: Total length of Report descriptor*/
0x00,
//以下为输入端点1描述符
/******************** Descriptor of Joystick Mouse endpoint ********************/
/* 27 */
0x07, /*bLength: Endpoint Descriptor size*/
USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
0x81, /*bEndpointAddress: Endpoint Address (IN)*/
0x03, /*bmAttributes: Interrupt endpoint*/
0x08, /*wMaxPacketSize: 8 Byte max */
0x00,
0x20, /*bInterval: Polling Interval (32 ms)*/
//以下为输出端但1描述符
/* 34 */
0x07, /*bLength: Endpoint Descriptor size*/
USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
0x03, /*bmAttributes: Interrupt endpoint*/
0x08, /*wMaxPacketSize: 8 Byte max */
0x00,
0x20, /*bInterval: Polling Interval (32 ms)*/
/* 41 */
};
接下来，还需要修改报告描述符，报告描述符比较复杂，这里就不详述了，直接给出修改好的报告描述符如下：
const u8 Joystick_ReportDescriptor[JOYSTICK_SIZ_REPORT_DESC] =
{
0x05, 0x01, // USAGE_PAGE (Generic Desktop)
0x09, 0x06, // USAGE (Keyboard)
0xa1, 0x01, // COLLECTION (Application)
0x05, 0x07, // USAGE_PAGE (Keyboard/Keypad)
0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
0x15, 0x00, // LOGICAL_MINIMUM (0)
0x25, 0x01, // LOGICAL_MAXIMUM (1)
0x95, 0x08, // REPORT_COUNT (8)
0x75, 0x01, // REPORT_SIZE (1)
0x81, 0x02, // INPUT (Data,Var,Abs)
0x95, 0x01, // REPORT_COUNT (1)
0x75, 0x08, // REPORT_SIZE (8)
0x81, 0x03, // INPUT (Cnst,Var,Abs)
0x95, 0x06, // REPORT_COUNT (6)
0x75, 0x08, // REPORT_SIZE (8)
0x25, 0xFF, // LOGICAL_MAXIMUM (255)
0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
0x81, 0x00, // INPUT (Data,Ary,Abs)
0x25, 0x01, // LOGICAL_MAXIMUM (1)
0x95, 0x05, // REPORT_COUNT (5)
0x75, 0x01, // REPORT_SIZE (1)
0x05, 0x08, // USAGE_PAGE (LEDs)
0x19, 0x01, // USAGE_MINIMUM (Num Lock)
0x29, 0x02, // USAGE_MAXIMUM (Caps Lock)
0x91, 0x02, // OUTPUT (Data,Var,Abs)
0x95, 0x01, // REPORT_COUNT (1)
0x75, 0x06, // REPORT_SIZE (6)
0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
0xc0 // END_COLLECTION
};
该报告描述符说明输入报告为8字节，第一字节为特殊键，用位图表示，第二字节保留，第三至第八字节为普通按键。我们将原来的摇杆功能改成键盘上的4个方向键，中键选择键为回车键，另外KEY2和KEY3分别做大写字母锁定键和数字锁锁定键。输出报告为1字节，其中最低两位分别为Num Lock灯和Caps Lock 灯。
Joystick_StringLangID描述符不用修改，Joystick_StringVendor、Joystick_StringProduct分别为厂商字符串和设备字符串，不改也可以，但是显示出来就是原来的内容，最好还是自己修改下。这里使用的是Unicode编码，可以直接使用圈圈以前写小程序自动生成该描述符，该工具的地址为：http://computer00.***.org/user1/2198/archives/2007/42769.html。Joystick_StringSerial为产品序列号，它也是Unicode编码，这里可以不用修改，当然你修改也可以。这里我将厂商字符串改成“电脑圈圈的家当”，产品字符串改成“电脑圈圈修改的简易USB键盘”。
好了，描述符改完了，就需要去修改数据处理了。我们启用了一个新的端点，端点1输出，原来的程序中并未对它进行初始化，所以我们需要先增加对端点1输出的初始化。在usb_prop.c文件中，找到void Joystick_Reset(void)函数，该函数是负责初始化端点的。原来对端点1输入的初始化设置为4字节，我们将它改成8字节。并增加对端点输出的初始化，最终修改的代码部分如下：
/* Initialize Endpoint In 1 */
SetEPType(ENDP1, EP_INTERRUPT); //初始化为中断端点类型
SetEPTxAddr(ENDP1, ENDP1_TXADDR); //设置发送数据的地址
SetEPTxCount(ENDP1, 8); //设置发送的长度
// SetEPRxStatus(ENDP1, EP_RX_DIS);
SetEPTxStatus(ENDP1, EP_TX_NAK); //设置端点处于忙状态
/* Initialize Endpoint Out 1 */
SetEPRxAddr(ENDP1, ENDP1_RXADDR); //设置接收数据的地址
SetEPRxCount(ENDP1, 1); //设置接收长度
SetEPRxStatus(ENDP1, EP_RX_VALID); //设置端点有效，可以接收数据
需要在usb_conf.h中增加对ENDP1_RXADDR的定义：
#define ENDP1_RXADDR (0xD8)
然后，修改原来在main函数中发送数据的处理。这里我们使用圈圈前几天写的按键及摇杆驱动（见https://www.sodocs.net/doc/3d4487547.html,/computer00/142610/message.aspx）。
修改主循环中的内容如下：
while (1)
{
DelayXms(5); //延时5ms
KeyScan(); //扫描一次键盘
if (KeyUp||KeyDown)
{
Joystick_Send(KeyPress); //发送按键
KeyUp="0"; //清除事件
KeyDown="0";
}
}
然后，在hw_config.c中修改Joystick_Send函数，根据不同的按键来发送按键情况，具体怎么修改这里就不说了，最后使用函数 UserToPMABufferCopy将缓冲区中的数据复制到端点1的输出缓冲中，再使用函数SetEPTxValid(ENDP1)使端点1数据有效，从而发送出去。
对于输出，我们还需要增加一个回调函数来处理，因为原来的输出端点1的回调函数是个空函数。在usb_conf.h中找到#define EP1_OUT_Callback NOP_Process 一行，它将端点1输出回调函数定义为空处理函数。我们将它删除，换成我们自己的回调处理函数：void EP1_OUT_Callback(void);。然后回到main.c 中增加该函数的实际代码，它主要用来控制LED的状态。在使用LED之前，当然要记得初始化这些IO口为输出状态，以及使能PC口的时钟，还有前面的键盘扫描也要增加对相应的IO口初始化，这些初始化代码在void Set_System(void)函数中处理。LED连接在PC口上，在stm32f10x_conf.h文件中，将#define _GPIOC宏使能，原本该宏是被注释掉的，这样会提示GPIOC没有定义。
处理接收数据的回调函数和发送数据的函数代码分别如下：
void EP1_OUT_Callback(void)
{
u8 DataLen; //保存接收数据的长度
u8 DataBuffer[64]; //保存接收数据的缓冲区
DataLen = GetEPRxCount(ENDP1); //获取收到的长度
PMAToUserBufferCopy(DataBuffer, ENDP1_RXADDR, DataLen); //复制数据
SetEPRxValid(ENDP1); //设置端点有效，以接收下一次数据
if(DataLen==1) //收到一字节的输出报告
{
//D0位表示数字键盘灯，D1位表示大写字母锁定灯
if(DataBuffer[0]&0x01) //数字键盘灯亮
{
GPIOC->BSRR=(1<<6); //亮LED3
}
else
{
GPIOC->BRR=(1<<6); //灭LED3
}
if(DataBuffer[0]&0x02) //大写字母锁定键
{
GPIOC->BSRR=(1<<7); //亮LED2
}
else
{
GPIOC->BRR=(1<<7); //灭LED2
}
}
}
void Joystick_Send(u8 Keys)
{
u8 Buffer[8] = {0, 0, 0, 0, 0, 0, 0, 0};
u8 i;
i="2";
//对各个按键进行处理。注意，由于这里的摇杆5个按键
//不可能同时按下，所以返回的普通键数量不会超过6个。
//如果你的键盘同时按下的普通键能够超过6个的话，就需要做
//点特殊处理了，将后面6字节全部设置为0xFF，表示按键无法识别。 if(Keys&KEY_UP)
{
Buffer[i]=0x52; //Keyboard UpArrow
i++;
}
if(Keys&KEY_DOWN)
{
Buffer[i]=0x51; //Keyboard DownArrow
i++;
}
if(Keys&KEY_LEFT)
{
Buffer[i]=0x50; //Keyboard LeftArrow
i++;
}
if(Keys&KEY_RIGHT)
{
Buffer[i]=0x4F; //Keyboard RightArrow
i++;
}
if(Keys&KEY_2)
{
Buffer[i]=0x39; //Keyboard Caps Lock
i++;
}
if(Keys&KEY_3)
{
Buffer[i]=0x53; //Keypad Num Lock and Clear
i++;
}
if(Keys&KEY_SEL)
{
Buffer[i]=0x28; //Keyboard Return (ENTER)
}
/*copy mouse position info in ENDP1 Tx Packet Memory Area*/
UserToPMABufferCopy(Buffer, GetEPTxAddr(ENDP1), 8);
/* enable endpoint for transmission */
SetEPTxValid(ENDP1);
}
程序运行后，可在设备管理器中看到新增加的USB人体学输入设备和一个键盘设备。如下图：
(原文件名:KeyBoard.GIF)