STM32 USB HID键盘例程
. W: m" k  y1 H9 D1 N; r
最全USB HID开发资料，悉心整理一个月，亲自测试
$ ?. O/ j0 j/ u2 R& A) W
通过STM32CUbeMX建立USB HID的双向通讯实验成功

, o; B7 P  O: Q' `! g( @
发现很多人对STM32的USB通信很感兴趣。要将USB的通信协议搞懂确实是一个比较漫长的过程。但是USB的HID通信无论是上位机的设计还是STM32程序的编程都非常的简单。只是我想很多人都不知道而已。这篇文章的目的是让大家以最短的时间将USB加到你的设备中。如果想学得更深就靠大家。
+ p0 y& E9 N, L, |6 U' e# J; }1 u
HID只是适合低速传输，其理论上可以达到64KB/S，但多由于windows系统和硬件的关系一般达不到这个传输数度。但这个速度对于一般系统的控制和数据传输都已经足够了，而且是免驱，省去了很多麻烦。如果您需要高速传输可参考我的另外一篇文章《STM32的USB例程修改步骤》文章在
! t" ]* [# Z( t4 v, H( F$ P2 K
  g2 z8 E2 |/ V7 H: j一、安装完MDK后请打开C:/Keil/ARM/Examples/ST/STM32F10xUSBLib/Demos路径，将Custom_HID在同一个目录下复制一份，如果你要放到其他路径你需要在MDK Options for target的C/C++中添加USB的头文件路径（MDK下的/INC/ST/STM32F10x/USB）。
  |. F2 U: k2 D( X2 G
+ Y+ d& M/ D; D* {' H, G; y二、打开usb_desc.c文件，该文件主要包含的端点描述符、设备描述符、配置描述符和字符描述符等。具体请大家参考其他资料了，这里主要说几个常用。

u8 DeviceDescriptor[SIZ_DEVICE_DESC]为USB设备描述符。当中的
0x83, /*idVendor (0x0483)*/
0x04,
0x50, /*idProduct = 0x5750*/
/ C7 p/ c/ F9 d3 ?( m' Y- l% f, J0x57,
//idVender字段。厂商ID号，我们这里取0x0483，仅供实验用。
+ N5 }" z4 Z% ~7 B% N( n//实际产品不能随便使用厂商ID号，必须跟USB协会申请厂商ID号。
& ?/ @- O2 b0 @* v& i//注意小端模式，低字节在先。
. y9 C. \7 V* Y, S4 k7 q//idProduct字段。产品ID号，我们这里取0x5750。
: B+ V& t" G0 T( z7 }//注意小端模式，低字节应该在前。
2 ^6 D# E$ a' {, q& c, K! j" D8 b

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

1. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
2. 0x81, /* bEndpointAddress: Endpoint Address (IN) */
   # b/ c1 L) c) _% ]
3. 0x03, /* bmAttributes: Interrupt endpoint */
   / q3 H: n* I0 b
4. 0x02, /* wMaxPacketSize: 2 Bytes max */
   ! v) S& W  H- ^" F- C
5. 0x00,
   
6. 0x20, /* bInterval: Polling Interval (32 ms) */
   
7. /* 34 */
   
8. 0x07, /* bLength: Endpoint Descriptor size */
   6 l# i0 a9 q$ S6 e2 m
9. USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
   
10. /* Endpoint descriptor type */
    8 {0 o& q; j; K" P( h% X8 n
11. 0x01, /* bEndpointAddress: */
      T9 I- f. u! d- A
12. /* Endpoint Address (OUT) */
    
13. 0x03, /* bmAttributes: Interrupt endpoint */
    
14. 0x02, /* wMaxPacketSize: 2 Bytes max */
    
15. 0x00,
    
16. 0x20, /* bInterval: Polling Interval (20 ms) */

复制代码

上面包含了“输入端点描述符”和“输出端点描述符”。
//wMaxPacketSize字段。该端点的最大包长。
, ]7 }- A- n4 W$ n" H, o: r6 l6 h//bInterval字段。端点查询的时间，
6 g0 N, _' u8 L. j
% E9 R( {2 f% f' k. x为了实现更高速的通信我们修改如下：
3 v4 M" t( [* X' o+ v

1. /******************** Descriptor of endpoint ********************/
   
2. /* 27 */
   
3. 0x07, /*bLength: Endpoint Descriptor size*/
   
4. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
   
5. 0x81, /*bEndpointAddress: Endpoint Address (IN)*/
   
6. 0x03, /*bmAttributes: Interrupt endpoint*/
   
7. 0x40, /*wMaxPacketSize: 64 Byte max */
   
8. 0x00,
   " O, C2 y7 u8 H" x8 w: S
9. 0x0A, /*bInterval: Polling Interval (10 ms)*/
   
10. /* 34 */
    
11. /******************** Descriptor of endpoint ********************/
    $ A* B9 I8 |- m1 A7 z- x
12. /* 27 */
      s) O' O5 L" e4 V0 o" ~! @* s, J
13. 0x07, /*bLength: Endpoint Descriptor size*/
    
14. USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
    ( M. u. l) J8 o
15. 0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
    
16. 0x03, /*bmAttributes: Interrupt endpoint*/
    0 |; z+ K8 M# M! n. h
17. 0x40, /*wMaxPacketSize: 64 Byte max */
    
18. 0x00,
    % u* [0 p% N/ |: _
19. 0x0A, /*bInterval: Polling Interval (10 ms)*/
    $ {* r4 Q9 S3 l& q( d1 H2 X
20. 
    # `+ Z9 F7 P) F  k1 B9 m; ?) }; m
21. const u8 ReportDescriptor[SIZ_REPORT_DESC]为HID专用的报告描述符，具体的大家就参考资料了，这里可以直接复制了。
      i; D  {: L% _0 z% _
22. const u8 CustomHID_ReportDescriptor[CUSTOMHID_SIZ_REPORT_DESC] =
    
23. {
    
24. 0x05, 0xFF, // USAGE_PAGE(User define)
    3 n. x6 J- w2 ?% |  `4 }
25. 0x09, 0xFF, // USAGE(User define)
    
26. 0xa1, 0x01, // COLLECTION (Application)
    
27. 0x05, 0x01, // USAGE_PAGE(1)
    - m) Z# M( F7 @4 E* `% \
28. 0x19, 0x00, // USAGE_MINIMUM(0)
    3 r6 S, [# ?9 U. K* e; n) X, R8 b% P
29. 0x29, 0xFF, // USAGE_MAXIMUM(255)
    6 T" B( Z! ~; {# M; n$ h
30. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    & ~( {- o5 y. @( `+ I. }$ g$ |
31. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    
32. 0x75, 0x08, // REPORT_SIZE (8)
    
33. 0x95, 0x40, // REPORT_COUNT (64)
    4 l9 r2 ^& T: J& C! ^5 a- g% Z
34. 0x81, 0x02, // INPUT (Data,Var,Abs)
    
35. 0x05, 0x02, // USAGE_PAGE(2)
    
36. 0x19, 0x00, // USAGE_MINIMUM (0)
    
37. 0x29, 0xFF, // USAGE_MAXIMUM (255)
    
38. 0x15, 0x00, // LOGICAL_MINIMUM (0)
    
39. 0x25, 0xFF, // LOGICAL_MAXIMUM (255)
    
40. 0x95, 0x08, // REPORT_COUNT (8)
    7 t4 R  O( \- P2 ^0 S
41. 0x75, 0x40, // REPORT_SIZE (64)
    
42. 0x91, 0x02, // OUTPUT (Data,Var,Abs)
    
43. 0xc0 // END_COLLECTION
    ( O7 K; l2 }3 _' m8 _& I
44. }; /* ReportDescriptor */
    ; x% o7 i# ]  q7 `
45. 
    2 A% |& A) X# m! i6 D
46. const u8 CustomHID_StringVendor[CUSTOMHID_SIZ_STRING_VENDOR]
    3 ]% l9 G! O' ]5 P  I( X3 [% c
47. const u8 StringProduct[SIZ_STRING_PRODUCT]
    
48. const u8 StringSerial[SIZ_STRING_SERIAL]

复制代码

; \# N% d- W& g, T5 f+ j3 q分别是“厂商字符”、“产品字符”、“产品序列号”，这些将在USB HID设备加载的时候显示。但是这需要这些字符要求为Unicode编码，你需要将你要显示的字符先转为Unicode编码。最好大家还要根据各个数组的长度修改如下定义。
1 }) j+ L  U0 ^4 h1 y. n) Z, X
1 B/ G6 p3 ]' ^, F) g/ ]1 H

1. #define CUSTOMHID_SIZ_REPORT_DESC 39
   8 I. j/ y$ ~: D4 v, U! L
2. #define CUSTOMHID_SIZ_STRING_VENDOR 64
   ) {- Q4 g, V' s
3. #define CUSTOMHID_SIZ_STRING_PRODUCT 28
   0 V$ Z0 H! \/ [0 B
4. #define CUSTOMHID_SIZ_STRING_SERIAL 26

复制代码

三、打开hw_config.c文件，将那些没有的函数删除，只保留如下函数
+ s6 R# h6 h- g) u( T; e; W7 z; x8 da) Set_System(void)
5 b- D* y2 U8 r' M% _, u( Rb) void Set_USBClock(void)
c) void USB_Interrupts_Config(void)
* [4 b' o1 H9 bd) void USB_Cable_Config (FunctionalState NewState)
5 D* v# z* U1 w+ s6 v特别要注意最后一个函数，其主要作用是控制USB的上拉电阻，让电脑检测USB设备是否连接的。
3 f+ f. w, B; q; o; }7 m  l

7 \1 Q& u3 F7 _+ a4 ^# K四、打开stm32f10x_it.c文件，把EXTI15_10_IRQHandler等中断内的代码删除。
3 y, Q) F$ d  _9 h+ ?" V打开usb_prop.c文件，修改如下：

1. void CustomHID_Reset(void)
   
2. {
   ) [* Z  ]! `# N) S& N/ J8 n
3. /* Set Joystick_DEVICE as not configured */
   
4. pInformation->Current_Configuration = 0;
   - }- G0 Q: l" d* B2 [) ?
5. pInformation->Current_Interface = 0;/*the default Interface*/
   ( o4 s; C8 N1 F5 Y, P
6. SetBTABLE(BTABLE_ADDRESS);
   / v) L- d& T- w
7. 
   % @2 p# Q. `: V* G3 l) s% `+ P
8. /* Initialize Endpoint 0 */
   
9. SetEPType(ENDP0, EP_CONTROL);
   
10. SetEPTxStatus(ENDP0, EP_TX_STALL);
    
11. SetEPRxAddr(ENDP0, ENDP0_RXADDR);
    9 }, O% n. e2 a! o, n
12. SetEPTxAddr(ENDP0, ENDP0_TXADDR);
    9 M3 d+ v3 f: n6 A
13. Clear_Status_Out(ENDP0);
    
14. SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
    " b# }/ {  H' n4 _4 n, y
15. SetEPRxValid(ENDP0);
    ( c" f7 H" A5 [
16. 
    1 N; y( s: v  T6 b# w4 J' l
17. /* Initialize Endpoint 1 */
    ( q- Q" l4 M2 l% v) u; C. J4 K3 f
18. SetEPType(ENDP1, EP_INTERRUPT);
    
19. SetEPTxAddr(ENDP1, ENDP1_TXADDR);
    / b7 ?! o) h) M: q- N3 H9 e
20. SetEPTxCount(ENDP1, 64);
    
21. SetEPRxStatus(ENDP1, EP_RX_DIS);
    
22. SetEPTxStatus(ENDP1, EP_TX_NAK);
    
23. 
    / C+ Y: k3 ^$ C
24. /* Initialize Endpoint 1 */
    8 c- R6 K9 e! G
25. // SetEPType(ENDP1, EP_INTERRUPT);
    
26. SetEPRxAddr(ENDP1, ENDP1_RXADDR);
    
27. SetEPRxCount(ENDP1, 64);
    
28. // SetEPTxStatus(ENDP1, EP_TX_DIS);
    
29. SetEPRxStatus(ENDP1, EP_RX_VALID);
    
30. /* Set this device to response on default address */
    
31. SetDeviceAddress(0);
    
32. }

复制代码

# h; ]: v/ D" X: M1 i3 h8 _' O五、usb_endp.c文件
4 H; B7 w5 X6 t' B! m, V8 I/ n: x' d

1. void EP1_OUT_Callback(void)
   
2. {
   % b- s" S" _, H  g. ~# ^' w, h
3. 这些写接收代码
   0 x( V% r% }" I! |
4. }

复制代码

; |, S2 W. ~, C5 M; _- M六、数据发送和接收，举例说明
$ F6 C/ ^8 z- E$ M2 i4 |/ V1、数据接收

1. u8 DataLen;
   + I' a: ~1 d2 R( e
2. DataLen = GetEPRxCount(ENDP1);
   
3. PMAToUserBufferCopy(TX1_buffer, ENDP1_RXADDR, DataLen);
   / t) D- ^7 i, w, ]" |! y" x  d
4. SetEPRxValid(ENDP1);
   1 S6 E4 b: _0 O7 b, S5 R* y
5. USART1_Send(DataLen);
   
6. count_out = 1;

复制代码

2、数据发送
3 D0 N" Z* x; K, \# I

1. UserToPMABufferCopy(InBuffer, GetEPTxAddr(ENDP1), 64);
   2 r/ v+ V! D6 _8 J4 w- I: H& {
2. SetEPTxCount(ENDP1, 64);
   
3. SetEPTxValid(ENDP1);

复制代码

) T" j  m: s: h. X9 L7 [如果你发送数据较为频繁，每次发送前应使用GetEPTxStatus(ENDP1)检测上次发送是否完成。如果端点状态处于EP_TX_VALID，说明发送未结束，如果端点状态处于EP_TX_NAK，说明发送结束。


(by xidongs)

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

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

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

谢谢分享，标记一下

谢谢分享，标记一下

谢谢分享. 学习了

谢谢，分享

支持下，标记下！

感谢分享

谢谢分享，标记一下

很不错很不错啊

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

牛逼了啊,谢谢

好东西

啊士大夫随风倒