STM32 USB HID键盘例程

! {) e' U( B  l9 `( @% t& o. k最全USB HID开发资料，悉心整理一个月，亲自测试
2 C2 i$ ~/ G+ F$ r/ [& D2 h- H
通过STM32CUbeMX建立USB HID的双向通讯实验成功

' ~; u1 e' d, J2 X9 T
# m$ }6 j' V% Q; B' g发现很多人对STM32的USB通信很感兴趣。要将USB的通信协议搞懂确实是一个比较漫长的过程。但是USB的HID通信无论是上位机的设计还是STM32程序的编程都非常的简单。只是我想很多人都不知道而已。这篇文章的目的是让大家以最短的时间将USB加到你的设备中。如果想学得更深就靠大家。
5 p) E# q! W$ X' r8 d5 S) c- p
2 U+ X4 Z7 W* e# y0 iHID只是适合低速传输，其理论上可以达到64KB/S，但多由于windows系统和硬件的关系一般达不到这个传输数度。但这个速度对于一般系统的控制和数据传输都已经足够了，而且是免驱，省去了很多麻烦。如果您需要高速传输可参考我的另外一篇文章《STM32的USB例程修改步骤》文章在

一、安装完MDK后请打开C:/Keil/ARM/Examples/ST/STM32F10xUSBLib/Demos路径，将Custom_HID在同一个目录下复制一份，如果你要放到其他路径你需要在MDK Options for target的C/C++中添加USB的头文件路径（MDK下的/INC/ST/STM32F10x/USB）。
( x* q7 {0 z9 p0 s# V) B: z
$ b5 ]  E- O6 ?- I5 I  G二、打开usb_desc.c文件，该文件主要包含的端点描述符、设备描述符、配置描述符和字符描述符等。具体请大家参考其他资料了，这里主要说几个常用。

u8 DeviceDescriptor[SIZ_DEVICE_DESC]为USB设备描述符。当中的
" t' _, t0 _) j+ e$ w* M0x83, /*idVendor (0x0483)*/
0x04,
5 l* ^4 I' F7 n- M! p0x50, /*idProduct = 0x5750*/
0x57,
0 K" k. v4 c) N7 [//idVender字段。厂商ID号，我们这里取0x0483，仅供实验用。
/ D# F2 `+ B- i# Z//实际产品不能随便使用厂商ID号，必须跟USB协会申请厂商ID号。
1 y& g- D6 S+ l9 w. ^' L( f//注意小端模式，低字节在先。
//idProduct字段。产品ID号，我们这里取0x5750。
! \0 G" B- E, T& \//注意小端模式，低字节应该在前。
' s, ?5 _$ P: ]+ r

: d) R, m, e" Z* N3 Nconst u8 ConfigDescriptor[SIZ_CONFIG_DESC]是配置描述符，注意如下

1. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
2. 0x81, /* bEndpointAddress: Endpoint Address (IN) */
   
3. 0x03, /* bmAttributes: Interrupt endpoint */
   4 P/ t& S; G0 b& K  a6 C0 f
4. 0x02, /* wMaxPacketSize: 2 Bytes max */
   , k9 V/ P8 N8 g# g. V4 ~( \
5. 0x00,
   / I/ R- Z% ]) S" p3 E8 C
6. 0x20, /* bInterval: Polling Interval (32 ms) */
   / V9 J9 o% r4 b8 d- G2 t
7. /* 34 */
   
8. 0x07, /* bLength: Endpoint Descriptor size */
   
9. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   7 k/ G; }& k- a! _; ?% h
10. /* Endpoint descriptor type */
    
11. 0x01, /* bEndpointAddress: */
    % u4 a( q  e( {: U* a
12. /* Endpoint Address (OUT) */
    
13. 0x03, /* bmAttributes: Interrupt endpoint */
    5 v0 e! g' q' n1 L
14. 0x02, /* wMaxPacketSize: 2 Bytes max */
    # ?* `: J1 O. _, _
15. 0x00,
    & j! B' T# T+ e8 @
16. 0x20, /* bInterval: Polling Interval (20 ms) */

复制代码

9 d( B  N" s+ Y/ p$ z; W上面包含了“输入端点描述符”和“输出端点描述符”。
//wMaxPacketSize字段。该端点的最大包长。
//bInterval字段。端点查询的时间，

# r. `! h# d) H! z为了实现更高速的通信我们修改如下：

1. /******************** Descriptor of endpoint ********************/
   
2. /* 27 */
   2 ]/ w' E6 b2 B( q4 n9 z
3. 0x07, /*bLength: Endpoint Descriptor size*/
   8 o1 l. l" u  n. e* {
4. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
   
5. 0x81, /*bEndpointAddress: Endpoint Address (IN)*/
   
6. 0x03, /*bmAttributes: Interrupt endpoint*/
   
7. 0x40, /*wMaxPacketSize: 64 Byte max */
   1 z7 l9 C" W4 l) n0 L& o# \
8. 0x00,
   
9. 0x0A, /*bInterval: Polling Interval (10 ms)*/
   
10. /* 34 */
    
11. /******************** Descriptor of endpoint ********************/
    
12. /* 27 */
    
13. 0x07, /*bLength: Endpoint Descriptor size*/
    / i: t. w/ U1 u+ r3 B* l; n- M
14. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
    
15. 0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
    
16. 0x03, /*bmAttributes: Interrupt endpoint*/
    
17. 0x40, /*wMaxPacketSize: 64 Byte max */
    
18. 0x00,
    ; p  a: P& g7 s( Q$ F1 Z  Q) C
19. 0x0A, /*bInterval: Polling Interval (10 ms)*/
    
20. 
    
21. const u8 ReportDescriptor[SIZ_REPORT_DESC]为HID专用的报告描述符，具体的大家就参考资料了，这里可以直接复制了。
    6 Y6 ^$ b3 \+ w3 S% G2 e+ g: ^! I
22. const u8 CustomHID_ReportDescriptor[CUSTOMHID_SIZ_REPORT_DESC] =
    
23. {
    
24. 0x05, 0xFF, // USAGE_PAGE(User define)
    
25. 0x09, 0xFF, // USAGE(User define)
    
26. 0xa1, 0x01, // COLLECTION (Application)
    
27. 0x05, 0x01, // USAGE_PAGE(1)
    
28. 0x19, 0x00, // USAGE_MINIMUM(0)
    & H) j4 j9 C& P4 f, O2 d0 X
29. 0x29, 0xFF, // USAGE_MAXIMUM(255)
    ( |: \) x* y8 X+ Y
30. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    ) P) i# s$ ?. [+ F1 P; Z
31. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    & V1 q5 r+ {! T5 l- Q" j
32. 0x75, 0x08, // REPORT_SIZE (8)
    
33. 0x95, 0x40, // REPORT_COUNT (64)
    - N/ Z: X! u8 O
34. 0x81, 0x02, // INPUT (Data,Var,Abs)
    
35. 0x05, 0x02, // USAGE_PAGE(2)
    % ^& p' S& }# ]) {& F+ S1 s
36. 0x19, 0x00, // USAGE_MINIMUM (0)
    
37. 0x29, 0xFF, // USAGE_MAXIMUM (255)
    ; U$ ~: r' B) \
38. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    
39. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    
40. 0x95, 0x08, // REPORT_COUNT (8)
    
41. 0x75, 0x40, // REPORT_SIZE (64)
    
42. 0x91, 0x02, // OUTPUT (Data,Var,Abs)
    
43. 0xc0 // END_COLLECTION
    2 j! W1 n, w" K
44. }; /* ReportDescriptor */
    3 B+ p' N+ c' u1 Z0 m* G( V/ v
45. 
    
46. const u8 CustomHID_StringVendor[CUSTOMHID_SIZ_STRING_VENDOR]
    . m+ v6 ]6 o; f" _8 j7 I
47. const u8 StringProduct[SIZ_STRING_PRODUCT]
    ; F; ~, H% ^& L" F! b0 ^5 P' D
48. const u8 StringSerial[SIZ_STRING_SERIAL]

复制代码

分别是“厂商字符”、“产品字符”、“产品序列号”，这些将在USB HID设备加载的时候显示。但是这需要这些字符要求为Unicode编码，你需要将你要显示的字符先转为Unicode编码。最好大家还要根据各个数组的长度修改如下定义。
9 o. k2 k( t1 g: o
! J, V$ q+ B0 J* N9 f5 E

1. #define CUSTOMHID_SIZ_REPORT_DESC 39
   5 K8 X4 ?- Z+ K. L+ q8 e' d  r% n" e: F
2. #define CUSTOMHID_SIZ_STRING_VENDOR 64
   
3. #define CUSTOMHID_SIZ_STRING_PRODUCT 28
   
4. #define CUSTOMHID_SIZ_STRING_SERIAL 26

复制代码

$ [% \" \: O$ R/ j5 \, \/ L! y三、打开hw_config.c文件，将那些没有的函数删除，只保留如下函数
a) Set_System(void)
b) void Set_USBClock(void)
c) void USB_Interrupts_Config(void)
d) void USB_Cable_Config (FunctionalState NewState)
特别要注意最后一个函数，其主要作用是控制USB的上拉电阻，让电脑检测USB设备是否连接的。
& \, E5 ~6 X* L: w& R. e) J
/ K9 x% @( ]" R* e1 y
- [) V, l5 Y1 d8 h四、打开stm32f10x_it.c文件，把EXTI15_10_IRQHandler等中断内的代码删除。
+ D1 a5 e; O7 E' g打开usb_prop.c文件，修改如下：
4 R9 s( M: c/ }" q

1. void CustomHID_Reset(void)
   
2. {
   ) M) I5 }% q$ m" U
3. /* Set Joystick_DEVICE as not configured */
   ! v% H  E  p% W' ^4 n- k8 |
4. pInformation->Current_Configuration = 0;
   
5. pInformation->Current_Interface = 0;/*the default Interface*/
   ) E' p( X7 O3 g' P6 D5 _9 b. W
6. SetBTABLE(BTABLE_ADDRESS);
   # b) U, t! E( S5 P# K& G. v; x) w
7. 
   
8. /* Initialize Endpoint 0 */
   ( @1 K3 z; ^2 x) Y+ P# T8 N7 K
9. SetEPType(ENDP0, EP_CONTROL);
   % y" u2 x! u# n* u0 V2 A
10. SetEPTxStatus(ENDP0, EP_TX_STALL);
    
11. SetEPRxAddr(ENDP0, ENDP0_RXADDR);
    
12. SetEPTxAddr(ENDP0, ENDP0_TXADDR);
    ! w) z  I( o. a) r+ V/ D2 F2 Z
13. Clear_Status_Out(ENDP0);
    + `6 F# X$ U' Q% b
14. SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
    : i" J" B6 y. J# a: [$ u, V
15. SetEPRxValid(ENDP0);
    
16. 
    7 V* N  [+ b! H) k4 z) K
17. /* Initialize Endpoint 1 */
    
18. SetEPType(ENDP1, EP_INTERRUPT);
    
19. SetEPTxAddr(ENDP1, ENDP1_TXADDR);
    " o; z( t0 Z& k1 V
20. SetEPTxCount(ENDP1, 64);
    
21. SetEPRxStatus(ENDP1, EP_RX_DIS);
    ( E* d& n6 j; x7 z2 Z
22. SetEPTxStatus(ENDP1, EP_TX_NAK);
    ; R) Z- q, X" \5 e$ }9 V0 f
23. 
    & z! t( u! q2 l. I$ n0 u( E5 \
24. /* Initialize Endpoint 1 */
    1 n+ {* U( n5 U* l
25. // SetEPType(ENDP1, EP_INTERRUPT);
    & T/ f) X/ w, m2 Z' u! y
26. SetEPRxAddr(ENDP1, ENDP1_RXADDR);
    ' X! o; K7 t# g+ `* k% Q
27. SetEPRxCount(ENDP1, 64);
    
28. // SetEPTxStatus(ENDP1, EP_TX_DIS);
    ; Y* y& j1 y2 _) u1 ?4 |; ^
29. SetEPRxStatus(ENDP1, EP_RX_VALID);
    
30. /* Set this device to response on default address */
    3 v4 u$ Y- C' |. m! l( s  Y
31. SetDeviceAddress(0);
    
32. }

复制代码

# _5 B+ U9 Y# k5 Z+ o五、usb_endp.c文件

1. void EP1_OUT_Callback(void)
   
2. {
   
3. 这些写接收代码
   
4. }

复制代码

六、数据发送和接收，举例说明
! g: \$ c8 L- |6 I) n& h1、数据接收
1 X4 [; z, D3 G

1. u8 DataLen;
   8 e9 ]+ [* k! q' q+ I& _: C5 U
2. DataLen = GetEPRxCount(ENDP1);
   2 p; P; R$ H$ C/ V  |3 m9 A$ l
3. PMAToUserBufferCopy(TX1_buffer, ENDP1_RXADDR, DataLen);
   
4. SetEPRxValid(ENDP1);
   
5. USART1_Send(DataLen);
   
6. count_out = 1;

复制代码

2、数据发送

1. UserToPMABufferCopy(InBuffer, GetEPTxAddr(ENDP1), 64);
   
2. SetEPTxCount(ENDP1, 64);
   9 v# K# H: t" s/ W+ h6 Z
3. SetEPTxValid(ENDP1);

复制代码

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

4 e# o  l, x: x
(by xidongs)

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

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

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

谢谢分享，标记一下

谢谢分享，标记一下

谢谢分享. 学习了

谢谢，分享

支持下，标记下！

感谢分享

谢谢分享，标记一下

很不错很不错啊

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

牛逼了啊,谢谢

好东西

啊士大夫随风倒