STM32 USB HID键盘例程
# C( p# B2 c; t; c9 X4 a5 t; o8 Y, n, n
/ L7 y. M3 s/ h8 n, f最全USB HID开发资料，悉心整理一个月，亲自测试
: n5 W8 A- a1 C
通过STM32CUbeMX建立USB HID的双向通讯实验成功


发现很多人对STM32的USB通信很感兴趣。要将USB的通信协议搞懂确实是一个比较漫长的过程。但是USB的HID通信无论是上位机的设计还是STM32程序的编程都非常的简单。只是我想很多人都不知道而已。这篇文章的目的是让大家以最短的时间将USB加到你的设备中。如果想学得更深就靠大家。
% V9 R# I& q; f$ M; f' Z3 M) @* L
HID只是适合低速传输，其理论上可以达到64KB/S，但多由于windows系统和硬件的关系一般达不到这个传输数度。但这个速度对于一般系统的控制和数据传输都已经足够了，而且是免驱，省去了很多麻烦。如果您需要高速传输可参考我的另外一篇文章《STM32的USB例程修改步骤》文章在
! k+ }- B; I, d! w
一、安装完MDK后请打开C:/Keil/ARM/Examples/ST/STM32F10xUSBLib/Demos路径，将Custom_HID在同一个目录下复制一份，如果你要放到其他路径你需要在MDK Options for target的C/C++中添加USB的头文件路径（MDK下的/INC/ST/STM32F10x/USB）。

$ H/ h& Y( Q$ b$ e4 h$ G7 g二、打开usb_desc.c文件，该文件主要包含的端点描述符、设备描述符、配置描述符和字符描述符等。具体请大家参考其他资料了，这里主要说几个常用。

8 V+ G% J$ q! y% x& Zu8 DeviceDescriptor[SIZ_DEVICE_DESC]为USB设备描述符。当中的
9 D( t4 \4 Q- i8 ?% a5 p0x83, /*idVendor (0x0483)*/
0x04,
0x50, /*idProduct = 0x5750*/
7 \+ d& I5 N7 W1 W  W0x57,
/ b. ?: z" f6 u8 s//idVender字段。厂商ID号，我们这里取0x0483，仅供实验用。
//实际产品不能随便使用厂商ID号，必须跟USB协会申请厂商ID号。
//注意小端模式，低字节在先。
6 d1 S, w7 \* i! f8 Y  K, |4 G//idProduct字段。产品ID号，我们这里取0x5750。
8 O, B0 k1 C0 F% B6 K) ~//注意小端模式，低字节应该在前。
0 ?) C- K! M% p) S

const u8 ConfigDescriptor[SIZ_CONFIG_DESC]是配置描述符，注意如下

1. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
2. 0x81, /* bEndpointAddress: Endpoint Address (IN) */
   ( P4 z$ j8 j) J  P
3. 0x03, /* bmAttributes: Interrupt endpoint */
   
4. 0x02, /* wMaxPacketSize: 2 Bytes max */
   
5. 0x00,
   
6. 0x20, /* bInterval: Polling Interval (32 ms) */
   
7. /* 34 */
   
8. 0x07, /* bLength: Endpoint Descriptor size */
   
9. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
10. /* Endpoint descriptor type */
    ( Z( R! `8 h0 w0 ]0 q
11. 0x01, /* bEndpointAddress: */
    ; ~0 O- m) c6 h) ~7 p
12. /* Endpoint Address (OUT) */
    * n3 M! D% H0 ]0 O! \/ P8 y3 j# t
13. 0x03, /* bmAttributes: Interrupt endpoint */
    
14. 0x02, /* wMaxPacketSize: 2 Bytes max */
    , t2 p0 I, i" F" X* B
15. 0x00,
    
16. 0x20, /* bInterval: Polling Interval (20 ms) */

复制代码

上面包含了“输入端点描述符”和“输出端点描述符”。
% i5 p- ^: e7 ^7 g4 \( ^//wMaxPacketSize字段。该端点的最大包长。
& ~& f6 e: w" k* W5 f//bInterval字段。端点查询的时间，
6 ]% ~0 h8 y! y* H2 x
9 Z# B7 r4 r5 x# J& L为了实现更高速的通信我们修改如下：
; W; B# w8 r" [7 p/ L5 l

1. /******************** Descriptor of endpoint ********************/
   
2. /* 27 */
   0 S: {* n& ?8 s% \" h
3. 0x07, /*bLength: Endpoint Descriptor size*/
   
4. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
   
5. 0x81, /*bEndpointAddress: Endpoint Address (IN)*/
   - \, N% ]8 R; q8 `8 D6 ~  F3 Y6 i
6. 0x03, /*bmAttributes: Interrupt endpoint*/
   8 Z% X; a5 q! W7 g& h& o. N. ?
7. 0x40, /*wMaxPacketSize: 64 Byte max */
   
8. 0x00,
   2 _, `) d4 k5 ^8 a3 d. }  ?! h5 ]. `+ {
9. 0x0A, /*bInterval: Polling Interval (10 ms)*/
   
10. /* 34 */
    
11. /******************** Descriptor of endpoint ********************/
    . E7 x& ^& Q* E- N2 X, A0 t
12. /* 27 */
    
13. 0x07, /*bLength: Endpoint Descriptor size*/
    
14. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
    , d2 D7 T" _& b* b, J
15. 0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
    
16. 0x03, /*bmAttributes: Interrupt endpoint*/
    * e$ p& h3 W/ h+ O$ v5 I  K
17. 0x40, /*wMaxPacketSize: 64 Byte max */
    
18. 0x00,
    ( y0 b3 Y/ K  O( p% m$ |7 L
19. 0x0A, /*bInterval: Polling Interval (10 ms)*/
    / I7 J$ M# J) [2 X! M6 j
20. 
    % o2 {+ L7 O% x: Z; K/ |/ H
21. const u8 ReportDescriptor[SIZ_REPORT_DESC]为HID专用的报告描述符，具体的大家就参考资料了，这里可以直接复制了。
    ' |; ^) D5 x9 U* b$ c* P
22. const u8 CustomHID_ReportDescriptor[CUSTOMHID_SIZ_REPORT_DESC] =
    
23. {
    
24. 0x05, 0xFF, // USAGE_PAGE(User define)
    
25. 0x09, 0xFF, // USAGE(User define)
    ( T* D0 [4 c/ \( l$ w0 s% x
26. 0xa1, 0x01, // COLLECTION (Application)
    
27. 0x05, 0x01, // USAGE_PAGE(1)
    
28. 0x19, 0x00, // USAGE_MINIMUM(0)
    
29. 0x29, 0xFF, // USAGE_MAXIMUM(255)
    
30. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    
31. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    ( B  E  X; l9 G
32. 0x75, 0x08, // REPORT_SIZE (8)
    ; G& O; P( w) F8 D6 w8 N
33. 0x95, 0x40, // REPORT_COUNT (64)
    
34. 0x81, 0x02, // INPUT (Data,Var,Abs)
    + {2 z% A* U( h8 n
35. 0x05, 0x02, // USAGE_PAGE(2)
    9 t( L  M4 o# j0 d7 ?
36. 0x19, 0x00, // USAGE_MINIMUM (0)
    
37. 0x29, 0xFF, // USAGE_MAXIMUM (255)
    6 [: _# u% |5 q5 H  T+ x
38. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    ( u3 r# S) R3 K! ^/ k
39. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    1 |  |  S  a3 _' ?7 `
40. 0x95, 0x08, // REPORT_COUNT (8)
    - y# v' z& ?$ F4 D
41. 0x75, 0x40, // REPORT_SIZE (64)
    6 ~" o$ K( |7 v* d6 {1 E: ]6 A
42. 0x91, 0x02, // OUTPUT (Data,Var,Abs)
    * L8 k. f+ Q6 _6 N% {0 p
43. 0xc0 // END_COLLECTION
    * S1 X/ P6 i' _
44. }; /* ReportDescriptor */
    
45. 
    
46. const u8 CustomHID_StringVendor[CUSTOMHID_SIZ_STRING_VENDOR]
    
47. const u8 StringProduct[SIZ_STRING_PRODUCT]
    + d, i% [6 ~' Z* F
48. const u8 StringSerial[SIZ_STRING_SERIAL]

复制代码

: \5 x" _0 @3 @5 g  h分别是“厂商字符”、“产品字符”、“产品序列号”，这些将在USB HID设备加载的时候显示。但是这需要这些字符要求为Unicode编码，你需要将你要显示的字符先转为Unicode编码。最好大家还要根据各个数组的长度修改如下定义。
! u/ |# z$ H1 S- w1 c$ w+ Z

1. #define CUSTOMHID_SIZ_REPORT_DESC 39
   
2. #define CUSTOMHID_SIZ_STRING_VENDOR 64
   0 d. Y: E4 d  u' q9 D
3. #define CUSTOMHID_SIZ_STRING_PRODUCT 28
   
4. #define CUSTOMHID_SIZ_STRING_SERIAL 26

复制代码

三、打开hw_config.c文件，将那些没有的函数删除，只保留如下函数
a) Set_System(void)
b) void Set_USBClock(void)
c) void USB_Interrupts_Config(void)
6 Q  t( ?/ m/ H7 P5 }( md) void USB_Cable_Config (FunctionalState NewState)
特别要注意最后一个函数，其主要作用是控制USB的上拉电阻，让电脑检测USB设备是否连接的。

  ]+ z1 m+ x! y) _  ^; z
2 q9 c) o8 w& Q9 a( Z四、打开stm32f10x_it.c文件，把EXTI15_10_IRQHandler等中断内的代码删除。
打开usb_prop.c文件，修改如下：
0 b9 y0 G7 i; R0 D

1. void CustomHID_Reset(void)
   
2. {
   & r: U1 P& k5 k1 b: v
3. /* Set Joystick_DEVICE as not configured */
   
4. pInformation->Current_Configuration = 0;
   
5. pInformation->Current_Interface = 0;/*the default Interface*/
   
6. SetBTABLE(BTABLE_ADDRESS);
   / Q: h7 o! e+ q/ _, a2 c7 _
7. 
   
8. /* Initialize Endpoint 0 */
   
9. SetEPType(ENDP0, EP_CONTROL);
   1 v) @6 H% u- a& }& w! @5 g
10. SetEPTxStatus(ENDP0, EP_TX_STALL);
    9 Z7 Q) R" f( ?- R- h
11. SetEPRxAddr(ENDP0, ENDP0_RXADDR);
    
12. SetEPTxAddr(ENDP0, ENDP0_TXADDR);
    
13. Clear_Status_Out(ENDP0);
    
14. SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
    ' q. s- }; H* T1 L0 O
15. SetEPRxValid(ENDP0);
    
16. 
    " v' t6 |; p: l5 P4 Y  ^
17. /* Initialize Endpoint 1 */
    
18. SetEPType(ENDP1, EP_INTERRUPT);
    2 v8 d' i5 N* \3 F  S+ f
19. SetEPTxAddr(ENDP1, ENDP1_TXADDR);
    . c. `2 P/ k" u$ ]
20. SetEPTxCount(ENDP1, 64);
    - M$ I( v  d7 A% x
21. SetEPRxStatus(ENDP1, EP_RX_DIS);
    / E; x1 d0 P% ]( o
22. SetEPTxStatus(ENDP1, EP_TX_NAK);
    
23. 
    ; ]% Y% L2 T! b7 ^7 }
24. /* Initialize Endpoint 1 */
    7 Z3 a5 S- r' O: ^
25. // SetEPType(ENDP1, EP_INTERRUPT);
    - H" d! L7 |, `  O& S5 R. w$ b4 \! D
26. SetEPRxAddr(ENDP1, ENDP1_RXADDR);
    & a" }1 {( R: }4 ^; [! ~
27. SetEPRxCount(ENDP1, 64);
    
28. // SetEPTxStatus(ENDP1, EP_TX_DIS);
    
29. SetEPRxStatus(ENDP1, EP_RX_VALID);
    # z, D- j) r  L
30. /* Set this device to response on default address */
    3 u1 i' W% q5 {6 i' ^! k* K; z
31. SetDeviceAddress(0);
    
32. }

复制代码

' y& D0 U0 |, G( w- e5 `五、usb_endp.c文件
& t: R$ Z; x: l

1. void EP1_OUT_Callback(void)
   
2. {
   2 H; J' K* c* g5 I$ [* F
3. 这些写接收代码
   
4. }

复制代码

六、数据发送和接收，举例说明
- k! b& s9 U5 \2 E5 A  Q1、数据接收

1. u8 DataLen;
   2 g4 M# D; j/ M- H) H9 L" d7 I
2. DataLen = GetEPRxCount(ENDP1);
   % L- [- g! f5 @( o1 h
3. PMAToUserBufferCopy(TX1_buffer, ENDP1_RXADDR, DataLen);
   
4. SetEPRxValid(ENDP1);
   
5. USART1_Send(DataLen);
   & [* }! D* f; e& S* v8 }0 Z$ E
6. count_out = 1;

复制代码

2、数据发送

1. UserToPMABufferCopy(InBuffer, GetEPTxAddr(ENDP1), 64);
   , I6 R' o# w5 K3 l9 L
2. SetEPTxCount(ENDP1, 64);
   + D5 }9 ]8 x( _/ w" S
3. SetEPTxValid(ENDP1);

复制代码

如果你发送数据较为频繁，每次发送前应使用GetEPTxStatus(ENDP1)检测上次发送是否完成。如果端点状态处于EP_TX_VALID，说明发送未结束，如果端点状态处于EP_TX_NAK，说明发送结束。


(by xidongs)
: \: G9 \8 H7 Z

谢谢，已经移植可以识别，但是上位机软件怎么写啊

没有看到你最后写的 发送数据 写在哪个函数啊

有没有上位机软件的编写方法

谢谢分享，标记一下

谢谢分享，标记一下

谢谢分享. 学习了

谢谢，分享

支持下，标记下！

感谢分享

谢谢分享，标记一下

很不错很不错啊

正好在学习这一块，感谢分享~

牛逼了啊,谢谢

好东西

啊士大夫随风倒