STM32 USB HID键盘例程
# x& A/ v. C* k7 N/ ]8 h+ Z2 I% M- g
7 u9 R3 X# D. w9 ]* s8 U1 e" G5 v最全USB HID开发资料，悉心整理一个月，亲自测试

7 H+ h, U& B: [通过STM32CUbeMX建立USB HID的双向通讯实验成功

" b" o' f1 P" h6 m  q' x  R
发现很多人对STM32的USB通信很感兴趣。要将USB的通信协议搞懂确实是一个比较漫长的过程。但是USB的HID通信无论是上位机的设计还是STM32程序的编程都非常的简单。只是我想很多人都不知道而已。这篇文章的目的是让大家以最短的时间将USB加到你的设备中。如果想学得更深就靠大家。
5 F* E) Y2 `4 P# m# l2 d
) G$ [2 `8 f; ^* L; d) hHID只是适合低速传输，其理论上可以达到64KB/S，但多由于windows系统和硬件的关系一般达不到这个传输数度。但这个速度对于一般系统的控制和数据传输都已经足够了，而且是免驱，省去了很多麻烦。如果您需要高速传输可参考我的另外一篇文章《STM32的USB例程修改步骤》文章在

2 z2 f6 }7 g0 r$ W8 k一、安装完MDK后请打开C:/Keil/ARM/Examples/ST/STM32F10xUSBLib/Demos路径，将Custom_HID在同一个目录下复制一份，如果你要放到其他路径你需要在MDK Options for target的C/C++中添加USB的头文件路径（MDK下的/INC/ST/STM32F10x/USB）。
, K: P3 S, t' Z2 R. b. a) ^
二、打开usb_desc.c文件，该文件主要包含的端点描述符、设备描述符、配置描述符和字符描述符等。具体请大家参考其他资料了，这里主要说几个常用。

- r; Z" \4 i$ M9 h% Wu8 DeviceDescriptor[SIZ_DEVICE_DESC]为USB设备描述符。当中的
" P; g7 _$ l7 o7 T+ ~' V0x83, /*idVendor (0x0483)*/
1 ^2 ~7 A7 e0 u0x04,
0x50, /*idProduct = 0x5750*/
# q! \1 a8 J5 j0x57,
* K# L# z/ |2 p5 l//idVender字段。厂商ID号，我们这里取0x0483，仅供实验用。
//实际产品不能随便使用厂商ID号，必须跟USB协会申请厂商ID号。
//注意小端模式，低字节在先。
% u) o) j+ g) G' X" B* e. h//idProduct字段。产品ID号，我们这里取0x5750。
2 f. r1 W" o3 {6 L! E. q//注意小端模式，低字节应该在前。
2 l) L6 H0 {  _9 z

/ V6 e( W" z+ Hconst u8 ConfigDescriptor[SIZ_CONFIG_DESC]是配置描述符，注意如下
6 N0 a7 q! y8 a" {

1. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
2. 0x81, /* bEndpointAddress: Endpoint Address (IN) */
   
3. 0x03, /* bmAttributes: Interrupt endpoint */
   9 h7 I7 F" q( z
4. 0x02, /* wMaxPacketSize: 2 Bytes max */
   
5. 0x00,
   & Y/ a. U9 F/ P
6. 0x20, /* bInterval: Polling Interval (32 ms) */
   . V6 H1 I# b+ x1 a1 K2 g
7. /* 34 */
   ! ^$ A2 ^, v8 K1 V* B4 ^2 L/ Z
8. 0x07, /* bLength: Endpoint Descriptor size */
   
9. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   - ]% R, w/ b9 k5 M3 m, n2 w
10. /* Endpoint descriptor type */
    
11. 0x01, /* bEndpointAddress: */
    ( v* F, @$ N$ r4 }9 r
12. /* Endpoint Address (OUT) */
    3 O: q$ Y. e( @8 ^2 ]7 M5 e
13. 0x03, /* bmAttributes: Interrupt endpoint */
    0 p3 o6 |, r% \" @3 ]1 I
14. 0x02, /* wMaxPacketSize: 2 Bytes max */
    
15. 0x00,
    , K' D5 a) \  W9 f
16. 0x20, /* bInterval: Polling Interval (20 ms) */

复制代码

上面包含了“输入端点描述符”和“输出端点描述符”。
//wMaxPacketSize字段。该端点的最大包长。
" y. `0 h, m$ x  F; i  _//bInterval字段。端点查询的时间，
9 m3 O! }& e: t1 H, L0 ~. v: E
5 g( V" P; J6 x; w+ r为了实现更高速的通信我们修改如下：
5 u. V. m! X2 P# V- N; X. y

1. /******************** Descriptor of endpoint ********************/
   6 D/ ~- `9 T- w7 G! w
2. /* 27 */
   / G: f+ U6 J. J) U
3. 0x07, /*bLength: Endpoint Descriptor size*/
   
4. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
   
5. 0x81, /*bEndpointAddress: Endpoint Address (IN)*/
   
6. 0x03, /*bmAttributes: Interrupt endpoint*/
   1 \' p; V: e6 y7 {
7. 0x40, /*wMaxPacketSize: 64 Byte max */
   % ~2 F. ]) o* k2 ?
8. 0x00,
   
9. 0x0A, /*bInterval: Polling Interval (10 ms)*/
   8 C! W  L4 v2 k) b* G
10. /* 34 */
    6 Q9 `7 U2 J/ e* j7 v1 Y
11. /******************** Descriptor of endpoint ********************/
    + ~* E- v+ j& d- r" L0 D
12. /* 27 */
    . X8 s8 i  t: A, P: f2 X
13. 0x07, /*bLength: Endpoint Descriptor size*/
    ( U/ i$ {, J+ C) s( `7 ?
14. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
    
15. 0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
    0 ?: S3 J; K1 g- b' f) G
16. 0x03, /*bmAttributes: Interrupt endpoint*/
    ( H, A3 s$ w( f, u5 s
17. 0x40, /*wMaxPacketSize: 64 Byte max */
    
18. 0x00,
    5 ?( L+ V! l; c2 |) j& s6 u- ~
19. 0x0A, /*bInterval: Polling Interval (10 ms)*/
    
20. 
    , A9 y3 I$ a+ p9 }$ B5 f- f
21. const u8 ReportDescriptor[SIZ_REPORT_DESC]为HID专用的报告描述符，具体的大家就参考资料了，这里可以直接复制了。
    
22. const u8 CustomHID_ReportDescriptor[CUSTOMHID_SIZ_REPORT_DESC] =
    0 O6 j( f5 f; P" c" A- H. O' z: c
23. {
    ; K8 `0 s1 `" K0 D0 s# F
24. 0x05, 0xFF, // USAGE_PAGE(User define)
    
25. 0x09, 0xFF, // USAGE(User define)
    
26. 0xa1, 0x01, // COLLECTION (Application)
    
27. 0x05, 0x01, // USAGE_PAGE(1)
    : _$ S# Q5 B+ u0 v! N
28. 0x19, 0x00, // USAGE_MINIMUM(0)
    
29. 0x29, 0xFF, // USAGE_MAXIMUM(255)
    
30. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    6 d$ q/ x% X; V* ^+ P4 c$ n
31. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    0 K" h- q: k! x- y0 g2 M
32. 0x75, 0x08, // REPORT_SIZE (8)
    ; K# z; U+ c5 u7 @) A, e( \
33. 0x95, 0x40, // REPORT_COUNT (64)
    ; M& U* X, |( ~% r9 D1 c7 V
34. 0x81, 0x02, // INPUT (Data,Var,Abs)
    - s0 i4 o8 Y7 Z. `; |
35. 0x05, 0x02, // USAGE_PAGE(2)
    0 k7 L, w; M0 U, z2 E6 C  ?: z0 ~
36. 0x19, 0x00, // USAGE_MINIMUM (0)
    + j6 ~9 Y0 n8 w+ \
37. 0x29, 0xFF, // USAGE_MAXIMUM (255)
    , {: [9 s+ f, U- a- G* g. |
38. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    
39. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    - {9 Z+ ?+ L: ^7 W8 M
40. 0x95, 0x08, // REPORT_COUNT (8)
    7 }+ W3 G! N  M) ^, I, b
41. 0x75, 0x40, // REPORT_SIZE (64)
    2 b9 r) V4 F2 v% A+ Z5 o2 p2 }7 A, t! y
42. 0x91, 0x02, // OUTPUT (Data,Var,Abs)
    - O% S& M/ f3 D$ r
43. 0xc0 // END_COLLECTION
    
44. }; /* ReportDescriptor */
    1 M- y  B9 ~/ B5 k
45. 
    
46. const u8 CustomHID_StringVendor[CUSTOMHID_SIZ_STRING_VENDOR]
    * }! O% M' p) L( p$ h3 V! }
47. const u8 StringProduct[SIZ_STRING_PRODUCT]
    
48. const u8 StringSerial[SIZ_STRING_SERIAL]

复制代码

  I4 T6 ~! O. l, [( h# I# e分别是“厂商字符”、“产品字符”、“产品序列号”，这些将在USB HID设备加载的时候显示。但是这需要这些字符要求为Unicode编码，你需要将你要显示的字符先转为Unicode编码。最好大家还要根据各个数组的长度修改如下定义。
) n1 [7 V9 ]8 V6 H  K

1. #define CUSTOMHID_SIZ_REPORT_DESC 39
   9 ]9 Q) `% }# x- V2 m+ m* P, }. Q, K
2. #define CUSTOMHID_SIZ_STRING_VENDOR 64
   2 \# F+ V" g( k8 ]$ L
3. #define CUSTOMHID_SIZ_STRING_PRODUCT 28
   
4. #define CUSTOMHID_SIZ_STRING_SERIAL 26

复制代码

# j3 a$ U5 _. \9 }三、打开hw_config.c文件，将那些没有的函数删除，只保留如下函数
a) Set_System(void)
b) void Set_USBClock(void)
4 g4 }: U" l0 |! I3 ^. h  Jc) void USB_Interrupts_Config(void)
d) void USB_Cable_Config (FunctionalState NewState)
& U+ o, m: a: ]. X* y3 K& o特别要注意最后一个函数，其主要作用是控制USB的上拉电阻，让电脑检测USB设备是否连接的。
; B7 s5 I6 o( g, ^+ Z4 a' o! g9 J5 J

四、打开stm32f10x_it.c文件，把EXTI15_10_IRQHandler等中断内的代码删除。
打开usb_prop.c文件，修改如下：
; F* J- R1 S! }$ \7 c  e

1. void CustomHID_Reset(void)
   
2. {
   + \! u4 Z- W* r7 Y/ b2 A
3. /* Set Joystick_DEVICE as not configured */
   , R9 @* ?" h/ h& c9 [
4. pInformation->Current_Configuration = 0;
   
5. pInformation->Current_Interface = 0;/*the default Interface*/
   % }6 t- M' N7 n4 \) ?' Q
6. SetBTABLE(BTABLE_ADDRESS);
     c; B1 u) {9 ^$ {5 g8 L' F
7. 
   8 v3 Z- J: d! Z& `8 L8 P6 l
8. /* Initialize Endpoint 0 */
   
9. SetEPType(ENDP0, EP_CONTROL);
     N, x2 B, H; P. {
10. SetEPTxStatus(ENDP0, EP_TX_STALL);
    : H/ e& o" R, t3 }2 ]- ]
11. SetEPRxAddr(ENDP0, ENDP0_RXADDR);
    ; }, \4 E3 }; X" g
12. SetEPTxAddr(ENDP0, ENDP0_TXADDR);
    
13. Clear_Status_Out(ENDP0);
    
14. SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
    
15. SetEPRxValid(ENDP0);
    
16. 
    
17. /* Initialize Endpoint 1 */
    
18. SetEPType(ENDP1, EP_INTERRUPT);
    
19. SetEPTxAddr(ENDP1, ENDP1_TXADDR);
    
20. SetEPTxCount(ENDP1, 64);
    
21. SetEPRxStatus(ENDP1, EP_RX_DIS);
    
22. SetEPTxStatus(ENDP1, EP_TX_NAK);
    
23. 
    
24. /* Initialize Endpoint 1 */
    ( y/ s: v3 t8 j5 |' e. |/ `
25. // SetEPType(ENDP1, EP_INTERRUPT);
    
26. SetEPRxAddr(ENDP1, ENDP1_RXADDR);
    
27. SetEPRxCount(ENDP1, 64);
    
28. // SetEPTxStatus(ENDP1, EP_TX_DIS);
    # C, p2 j4 {) f- o  s
29. SetEPRxStatus(ENDP1, EP_RX_VALID);
    
30. /* Set this device to response on default address */
    
31. SetDeviceAddress(0);
    
32. }

复制代码

五、usb_endp.c文件
7 i6 t: Y& f2 B. r! v5 B8 O  r+ W

1. void EP1_OUT_Callback(void)
   1 d  T$ ^8 M' C( S: k1 j
2. {
   : h, g& h0 l* O3 v1 X/ b. b
3. 这些写接收代码
   
4. }

复制代码

六、数据发送和接收，举例说明
1、数据接收
& `( ^0 [$ _. z- M+ h$ z

1. u8 DataLen;
   7 z; p6 z  s6 B& f
2. DataLen = GetEPRxCount(ENDP1);
   4 g; ]/ g) \, r1 i2 R0 _
3. PMAToUserBufferCopy(TX1_buffer, ENDP1_RXADDR, DataLen);
   : r; P6 x8 r! B7 n7 G. h; K
4. SetEPRxValid(ENDP1);
   1 w2 `6 L  x! O: x0 Y& @
5. USART1_Send(DataLen);
   
6. count_out = 1;

复制代码

8 t( s( S- M+ f" R& [- w$ c; M2、数据发送
$ N( s! @: A  s, G9 C% y

1. UserToPMABufferCopy(InBuffer, GetEPTxAddr(ENDP1), 64);
   9 Q7 p% L, Q; d: Z% a7 f# e
2. SetEPTxCount(ENDP1, 64);
   0 _8 q4 Z* {% v' I0 w
3. SetEPTxValid(ENDP1);

复制代码

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

/ j! |  X6 w+ ?6 c) ~
(by xidongs)
( v# d; c5 S3 K# ^2 L( g

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

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

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

谢谢分享，标记一下

谢谢分享，标记一下

谢谢分享. 学习了

谢谢，分享

支持下，标记下！

感谢分享

谢谢分享，标记一下

很不错很不错啊

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

牛逼了啊,谢谢

好东西

啊士大夫随风倒