STM32 USB HID键盘例程
% v6 ^5 h* G8 k/ }3 u
: z3 @" P! Q7 H7 {$ v% M6 u# |最全USB HID开发资料，悉心整理一个月，亲自测试
' d, M7 D; J5 U; ?
0 u/ M/ X/ E- ?6 T6 s通过STM32CUbeMX建立USB HID的双向通讯实验成功

% C$ P) B- i/ A1 ]6 ^: h1 Z; c3 h" j
发现很多人对STM32的USB通信很感兴趣。要将USB的通信协议搞懂确实是一个比较漫长的过程。但是USB的HID通信无论是上位机的设计还是STM32程序的编程都非常的简单。只是我想很多人都不知道而已。这篇文章的目的是让大家以最短的时间将USB加到你的设备中。如果想学得更深就靠大家。
" R% `( {% ]8 ]; q5 v+ L
HID只是适合低速传输，其理论上可以达到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）。
4 R' @& p/ Z, |6 [1 p9 A5 Y* R
% s' H, z1 K2 P% T/ N% o, Z* g0 g二、打开usb_desc.c文件，该文件主要包含的端点描述符、设备描述符、配置描述符和字符描述符等。具体请大家参考其他资料了，这里主要说几个常用。

/ B( e  ^$ q* q" p: Du8 DeviceDescriptor[SIZ_DEVICE_DESC]为USB设备描述符。当中的
2 u1 w7 S- S0 L8 x( ]2 b- r0x83, /*idVendor (0x0483)*/
2 c. P7 E& f1 z9 E) A, f2 e0x04,
0x50, /*idProduct = 0x5750*/
0x57,
//idVender字段。厂商ID号，我们这里取0x0483，仅供实验用。
//实际产品不能随便使用厂商ID号，必须跟USB协会申请厂商ID号。
! L6 ]$ P! i( Z9 p# d& t( D  j//注意小端模式，低字节在先。
//idProduct字段。产品ID号，我们这里取0x5750。
//注意小端模式，低字节应该在前。

- {% G4 Y! O& Q: N# x. `7 ]5 L% ]( [  s
, |3 `  i3 e' u* d7 econst u8 ConfigDescriptor[SIZ_CONFIG_DESC]是配置描述符，注意如下

1. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
2. 0x81, /* bEndpointAddress: Endpoint Address (IN) */
   2 O0 h3 I0 M7 }' h$ Q0 W
3. 0x03, /* bmAttributes: Interrupt endpoint */
   2 \9 y5 Y6 Y2 S3 V# }
4. 0x02, /* wMaxPacketSize: 2 Bytes max */
   9 ^0 {+ j$ B9 D* u
5. 0x00,
   
6. 0x20, /* bInterval: Polling Interval (32 ms) */
   
7. /* 34 */
   : D" Y, F/ `  N8 C( e
8. 0x07, /* bLength: Endpoint Descriptor size */
   
9. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
10. /* Endpoint descriptor type */
    
11. 0x01, /* bEndpointAddress: */
    . ]7 A/ }7 U! c3 e+ L
12. /* Endpoint Address (OUT) */
    
13. 0x03, /* bmAttributes: Interrupt endpoint */
    
14. 0x02, /* wMaxPacketSize: 2 Bytes max */
      E% W4 B; i- N0 K# x- r
15. 0x00,
    
16. 0x20, /* bInterval: Polling Interval (20 ms) */

复制代码

0 m; P+ |5 v' t) s上面包含了“输入端点描述符”和“输出端点描述符”。
//wMaxPacketSize字段。该端点的最大包长。
//bInterval字段。端点查询的时间，
! K- V( `% s: j* N6 J# I
( L5 F3 N! G6 J. x5 D4 r为了实现更高速的通信我们修改如下：

1. /******************** Descriptor of endpoint ********************/
   3 v& v4 y  t9 A' z8 N
2. /* 27 */
   
3. 0x07, /*bLength: Endpoint Descriptor size*/
   # H% X) F8 W8 c
4. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
   
5. 0x81, /*bEndpointAddress: Endpoint Address (IN)*/
   ( B; N8 I2 J2 q2 S2 r# s& c
6. 0x03, /*bmAttributes: Interrupt endpoint*/
   / l! E, h- S) a7 U4 q& S7 P0 H# b
7. 0x40, /*wMaxPacketSize: 64 Byte max */
   
8. 0x00,
   
9. 0x0A, /*bInterval: Polling Interval (10 ms)*/
   
10. /* 34 */
    
11. /******************** Descriptor of endpoint ********************/
    ( l$ p9 g2 @: |, ]) q* x! Y
12. /* 27 */
    
13. 0x07, /*bLength: Endpoint Descriptor size*/
    " j- z, d& n: n$ j" `
14. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
    7 j7 [! y* D- Y) c
15. 0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
    
16. 0x03, /*bmAttributes: Interrupt endpoint*/
    : G+ ]8 d9 I. k; l6 Y
17. 0x40, /*wMaxPacketSize: 64 Byte max */
    8 `" V+ q' K, o4 u
18. 0x00,
    
19. 0x0A, /*bInterval: Polling Interval (10 ms)*/
    ) a/ [" m* k) N) ?+ B8 N# a
20. 
    
21. const u8 ReportDescriptor[SIZ_REPORT_DESC]为HID专用的报告描述符，具体的大家就参考资料了，这里可以直接复制了。
    " J: v7 b: ^  P0 k  i2 P/ A& c5 I2 V
22. const u8 CustomHID_ReportDescriptor[CUSTOMHID_SIZ_REPORT_DESC] =
    $ p) ~5 I6 G9 \
23. {
      ^( ^4 N& X! R# M0 }% T, u
24. 0x05, 0xFF, // USAGE_PAGE(User define)
    % ?/ c4 Q- q9 o' J; I0 L, @. D
25. 0x09, 0xFF, // USAGE(User define)
    
26. 0xa1, 0x01, // COLLECTION (Application)
    % r( \5 S: @$ j8 e4 i$ }6 M
27. 0x05, 0x01, // USAGE_PAGE(1)
    
28. 0x19, 0x00, // USAGE_MINIMUM(0)
    ) N& L" r5 f, d
29. 0x29, 0xFF, // USAGE_MAXIMUM(255)
    ( O7 P$ R, i! |9 Z+ n( F6 H, q: _: d
30. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    # I$ V/ p6 [5 M2 m* o
31. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    
32. 0x75, 0x08, // REPORT_SIZE (8)
    
33. 0x95, 0x40, // REPORT_COUNT (64)
    " i, I0 `% z- L- C0 X
34. 0x81, 0x02, // INPUT (Data,Var,Abs)
    
35. 0x05, 0x02, // USAGE_PAGE(2)
    2 m- e& M* ]6 t8 |) D
36. 0x19, 0x00, // USAGE_MINIMUM (0)
    
37. 0x29, 0xFF, // USAGE_MAXIMUM (255)
    % y; a% Z* s0 t/ K
38. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    ( L/ z( V! h* [8 z; M4 t+ R
39. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    
40. 0x95, 0x08, // REPORT_COUNT (8)
    ( M! d: Z4 @* A) @, l) Z
41. 0x75, 0x40, // REPORT_SIZE (64)
    ( J4 P  v- A0 C) R7 n8 c
42. 0x91, 0x02, // OUTPUT (Data,Var,Abs)
    / e/ u% f: V' y7 f
43. 0xc0 // END_COLLECTION
    
44. }; /* ReportDescriptor */
    4 O! u3 d7 N- H& J; _7 j
45. 
    5 f1 z7 ?( K) Q2 O& X/ a
46. const u8 CustomHID_StringVendor[CUSTOMHID_SIZ_STRING_VENDOR]
    
47. const u8 StringProduct[SIZ_STRING_PRODUCT]
    6 A* p2 ~. k  ~( d* |
48. const u8 StringSerial[SIZ_STRING_SERIAL]

复制代码

/ j& E, K* x7 q0 ^* a6 ~+ c# L分别是“厂商字符”、“产品字符”、“产品序列号”，这些将在USB HID设备加载的时候显示。但是这需要这些字符要求为Unicode编码，你需要将你要显示的字符先转为Unicode编码。最好大家还要根据各个数组的长度修改如下定义。
' x0 j% Y; V8 h! K- S
0 \- R5 J5 ?/ c

1. #define CUSTOMHID_SIZ_REPORT_DESC 39
   , x6 Z0 r9 t9 k" t2 K  h
2. #define CUSTOMHID_SIZ_STRING_VENDOR 64
     l, a% T+ I& L4 I/ c6 I
3. #define CUSTOMHID_SIZ_STRING_PRODUCT 28
   * r( L) S$ C  b4 ?; O
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 P8 H; V2 G& B! e& ud) void USB_Cable_Config (FunctionalState NewState)
" f; R7 V. `7 n% y特别要注意最后一个函数，其主要作用是控制USB的上拉电阻，让电脑检测USB设备是否连接的。

3 y. R* p4 o2 J' ~
4 v8 f5 x9 t8 X2 J/ ?四、打开stm32f10x_it.c文件，把EXTI15_10_IRQHandler等中断内的代码删除。
9 t( X- ^  m( E" B! x& x打开usb_prop.c文件，修改如下：
  q, I9 I+ V. H' h) F2 c

1. void CustomHID_Reset(void)
   
2. {
   
3. /* Set Joystick_DEVICE as not configured */
   
4. pInformation->Current_Configuration = 0;
   
5. pInformation->Current_Interface = 0;/*the default Interface*/
   
6. SetBTABLE(BTABLE_ADDRESS);
   
7. 
   # Y& H. I* d, J) t$ u: K) z4 R
8. /* Initialize Endpoint 0 */
   6 b- i8 E; j0 j  u
9. SetEPType(ENDP0, EP_CONTROL);
   - S* @$ e/ x( W8 R" l
10. SetEPTxStatus(ENDP0, EP_TX_STALL);
    ' ~# G& D6 w, m
11. SetEPRxAddr(ENDP0, ENDP0_RXADDR);
    
12. SetEPTxAddr(ENDP0, ENDP0_TXADDR);
    : v$ j( ?: j5 a" H
13. Clear_Status_Out(ENDP0);
    # }+ q, J% V6 `
14. SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
    
15. SetEPRxValid(ENDP0);
    ' G* T- }! T' D' |# ]" T
16. 
    6 E6 W- h* s: k2 P5 k; O6 k6 H
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. 
    4 ]1 J; B% D6 t/ F1 K# u! S
24. /* Initialize Endpoint 1 */
    
25. // SetEPType(ENDP1, EP_INTERRUPT);
    * i- ]8 e8 {( r+ M
26. SetEPRxAddr(ENDP1, ENDP1_RXADDR);
    
27. SetEPRxCount(ENDP1, 64);
    
28. // SetEPTxStatus(ENDP1, EP_TX_DIS);
    1 j, n7 Y, D: z6 D3 y/ E4 N
29. SetEPRxStatus(ENDP1, EP_RX_VALID);
    3 b- P+ K& d4 ]+ h, ~' S
30. /* Set this device to response on default address */
    4 H0 @/ W" t9 [' K/ Z
31. SetDeviceAddress(0);
    1 h2 J" v/ x# {6 H& F7 I8 h
32. }

复制代码

五、usb_endp.c文件
3 j9 f" t( Y; V4 V6 [) C- \, p

1. void EP1_OUT_Callback(void)
   " T/ l. @7 U: R. |6 n/ s0 e" t* u* h
2. {
   
3. 这些写接收代码
   * P$ _, d8 I5 n: ]' U/ Q5 Z% _
4. }

复制代码

六、数据发送和接收，举例说明
1、数据接收
, W+ W" S* d. K$ k! q/ ^

1. u8 DataLen;
   # h8 q0 \% n# z( a) X* G
2. DataLen = GetEPRxCount(ENDP1);
   " I' w6 R9 m) E5 e* w
3. PMAToUserBufferCopy(TX1_buffer, ENDP1_RXADDR, DataLen);
   ! {0 E6 n1 q' R* W) q% m
4. SetEPRxValid(ENDP1);
   ' [; c! J! J. g8 t! `
5. USART1_Send(DataLen);
   $ f! i1 i: o! J0 j% k0 N
6. count_out = 1;

复制代码

2、数据发送

1. UserToPMABufferCopy(InBuffer, GetEPTxAddr(ENDP1), 64);
   ) O5 X, `# l1 c( a2 _" j4 h
2. SetEPTxCount(ENDP1, 64);
   
3. SetEPTxValid(ENDP1);

复制代码

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

$ D  X7 w" l* a1 \, K- h% [
(by xidongs)

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

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

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

谢谢分享，标记一下

谢谢分享，标记一下

谢谢分享. 学习了

谢谢，分享

支持下，标记下！

感谢分享

谢谢分享，标记一下

很不错很不错啊

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

牛逼了啊,谢谢

好东西

啊士大夫随风倒