STM32 USB HID键盘例程
. z, \) g, X5 Y8 f6 i4 x; z2 w- Y- @7 \/ P1 g. a
最全USB HID开发资料,悉心整理一个月,亲自测试
$ ?# f( }* }5 _" t3 P% P8 X' I+ @, ` X, ?5 F+ W3 S/ F
通过STM32CUbeMX建立USB HID的双向通讯实验成功
' M* T3 Y1 H: L# ?* l- {3 r
; l7 t& B& d# R# S* g5 ]' a
8 @" A( W5 V" z, {发现很多人对STM32的USB通信很感兴趣。要将USB的通信协议搞懂确实是一个比较漫长的过程。但是USB的HID通信无论是上位机的设计还是STM32程序的编程都非常的简单。只是我想很多人都不知道而已。这篇文章的目的是让大家以最短的时间将USB加到你的设备中。如果想学得更深就靠大家。* j8 b' a: U% a& i: `
5 W3 y8 t7 L/ U+ p) @
HID只是适合低速传输,其理论上可以达到64KB/S,但多由于windows系统和硬件的关系一般达不到这个传输数度。但这个速度对于一般系统的控制和数据传输都已经足够了,而且是免驱,省去了很多麻烦。如果您需要高速传输可参考我的另外一篇文章《STM32的USB例程修改步骤》文章在; Q4 J3 w Y% ^3 s% @
s6 A, v* s4 a' i$ m F
一、安装完MDK后请打开C:/Keil/ARM/Examples/ST/STM32F10xUSBLib/Demos路径,将Custom_HID在同一个目录下复制一份,如果你要放到其他路径你需要在MDK Options for target的C/C++中添加USB的头文件路径(MDK下的/INC/ST/STM32F10x/USB)。4 P1 B, s) d4 k. A! r0 L
6 I: {7 Y+ Q/ z, ~二、打开usb_desc.c文件,该文件主要包含的端点描述符、设备描述符、配置描述符和字符描述符等。具体请大家参考其他资料了,这里主要说几个常用。
9 [1 Q3 e5 {+ D1 N3 n6 m4 L
2 E& f/ m' s8 ^9 `u8 DeviceDescriptor[SIZ_DEVICE_DESC]为USB设备描述符。当中的
! f0 _# W# a6 g, q3 X, f( x0x83, /*idVendor (0x0483)*/5 T! N2 L5 W1 p
0x04,
5 p1 n8 B& Y3 r0x50, /*idProduct = 0x5750*// }6 k0 {) W8 m. V& @ X$ C( X
0x57,4 P& Q0 Z" Q2 u& z% [% Y
//idVender字段。厂商ID号,我们这里取0x0483,仅供实验用。0 X$ H% n, g- q4 d3 |
//实际产品不能随便使用厂商ID号,必须跟USB协会申请厂商ID号。( i2 A: |% F% `. S
//注意小端模式,低字节在先。
$ @0 p2 O: n' u, J! ~//idProduct字段。产品ID号,我们这里取0x5750。# D# X% w6 a0 h* }2 S
//注意小端模式,低字节应该在前。' S v6 z3 d' r! c
& Z! G3 ^1 c% A) ?/ K2 o6 Q w
* ]+ ~$ ]: L' N4 g% t( Y' ~const u8 ConfigDescriptor[SIZ_CONFIG_DESC]是配置描述符,注意如下
; W& d! F8 H& `4 N# a1 ~- USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */3 `/ r) p) t% G
- 0x81, /* bEndpointAddress: Endpoint Address (IN) */
; C' [/ ?4 `8 R - 0x03, /* bmAttributes: Interrupt endpoint */; o* {2 r8 J8 ^/ P1 i3 F: L
- 0x02, /* wMaxPacketSize: 2 Bytes max */
" {7 [3 E A" s; Y! u - 0x00,
: J( ]! I- H& n6 E3 ? - 0x20, /* bInterval: Polling Interval (32 ms) */
& [+ ~! H" _6 v. L! v0 C/ { - /* 34 */2 T/ X1 G9 W$ ?& T0 y4 w
- 0x07, /* bLength: Endpoint Descriptor size */* A% F9 A, Z) W5 K0 ]5 B
- USB_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType: */
# }- ]% J' A7 G1 |- G/ e* u3 ? B - /* Endpoint descriptor type */
. d, b2 h1 T! w7 V - 0x01, /* bEndpointAddress: */
a1 o* t; j4 F! o& u - /* Endpoint Address (OUT) */
9 t9 }1 R( I( k2 D2 ~ - 0x03, /* bmAttributes: Interrupt endpoint */; \7 O. O9 W4 I2 L; x! c; J
- 0x02, /* wMaxPacketSize: 2 Bytes max */
/ X: x9 [! r1 X) k1 i - 0x00,
- Y; T6 s# K& E) u9 T - 0x20, /* bInterval: Polling Interval (20 ms) */
复制代码
) |$ ?5 K0 u+ P c4 d6 U( y) Q上面包含了“输入端点描述符”和“输出端点描述符”。
% ~) N* _9 }2 K! X9 S6 x//wMaxPacketSize字段。该端点的最大包长。5 S/ V' U$ i( k, b% x% N m
//bInterval字段。端点查询的时间,9 E z9 i. m& P+ k8 O
: }& g$ E) L9 g9 C3 o- m s为了实现更高速的通信我们修改如下:
# X) B: x% N5 L! \8 Z9 |+ d- /******************** Descriptor of endpoint ********************/* W9 K. N, k" y# f8 O
- /* 27 */1 R* E1 M# d( e {6 }& T8 b6 c
- 0x07, /*bLength: Endpoint Descriptor size*/
! B7 I+ [7 K1 e- P% |% w/ S - USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
4 ^4 x2 F7 d* t; Q. E0 V - 0x81, /*bEndpointAddress: Endpoint Address (IN)*/ U; H; o, _1 G' {7 D, X
- 0x03, /*bmAttributes: Interrupt endpoint*/
4 K/ s; D& @1 R" {. ]' g% J - 0x40, /*wMaxPacketSize: 64 Byte max */: p v. r& C: w. J" J
- 0x00,
3 h$ w1 Q5 n' Y - 0x0A, /*bInterval: Polling Interval (10 ms)*/0 S$ O$ I" Q5 r& o+ J$ I5 Z
- /* 34 */
' z( Z5 b( @' S+ C - /******************** Descriptor of endpoint ********************/* Y _' s9 C3 n& {
- /* 27 */
* H5 ^/ w w3 i$ O" H - 0x07, /*bLength: Endpoint Descriptor size*/" Q( K# T8 P5 W1 ~3 j2 d3 c* j
- USB_ENDPOINT_DESCRIPTOR_TYPE, /*bDescriptorType:*/
( d' j' }# w* D+ g( T3 f - 0x01, /*bEndpointAddress: Endpoint Address (OUT)*/
+ \# H- I8 i9 D- T; A2 d - 0x03, /*bmAttributes: Interrupt endpoint*/
, R' X4 c6 Y: ?# L% L. J - 0x40, /*wMaxPacketSize: 64 Byte max */4 k' e+ u0 s* i" ]# ?4 }
- 0x00,
, C% B7 I e& u5 \1 k: o! T& y0 E - 0x0A, /*bInterval: Polling Interval (10 ms)*/' r8 P( h( Q+ V' r$ ~
- 2 G7 w- b: G% m* B: R# P- d
- const u8 ReportDescriptor[SIZ_REPORT_DESC]为HID专用的报告描述符,具体的大家就参考资料了,这里可以直接复制了。! K/ C' i7 ~- f" g+ b
- const u8 CustomHID_ReportDescriptor[CUSTOMHID_SIZ_REPORT_DESC] =
/ ?' K5 o# L: y+ u. Q+ P3 j2 k) O - {
) g% ^1 l/ C1 j - 0x05, 0xFF, // USAGE_PAGE(User define)
& A7 G. G3 |8 t& t' _: c - 0x09, 0xFF, // USAGE(User define)
E Y4 P% E* ?: G7 l" b) \ - 0xa1, 0x01, // COLLECTION (Application), ]* T7 g- T4 q) E
- 0x05, 0x01, // USAGE_PAGE(1)
7 S; H2 B; ?" u8 I+ O4 k9 n - 0x19, 0x00, // USAGE_MINIMUM(0)
; _% f+ w6 n% b& F6 ?" M - 0x29, 0xFF, // USAGE_MAXIMUM(255)
/ w* X& V4 S- x# f - 0x15, 0x00, // LOGICAL_MINIMUM (0)
) B3 `3 m6 H" T( Y4 Q - 0x25, 0xFF, // LOGICAL_MAXIMUM (255)$ F& n! K7 X/ p" _
- 0x75, 0x08, // REPORT_SIZE (8)3 R$ A4 `; w; w- c7 x5 t/ K+ B
- 0x95, 0x40, // REPORT_COUNT (64)0 }* X- T9 g1 z
- 0x81, 0x02, // INPUT (Data,Var,Abs)5 Q1 c: w$ h* L
- 0x05, 0x02, // USAGE_PAGE(2)
0 l" d& T3 S1 I$ h - 0x19, 0x00, // USAGE_MINIMUM (0)
! K0 m6 }5 k0 s% x - 0x29, 0xFF, // USAGE_MAXIMUM (255)" x$ J6 q1 h$ f) h' A5 L. a
- 0x15, 0x00, // LOGICAL_MINIMUM (0)
0 \ s/ u0 K9 U V( A- e - 0x25, 0xFF, // LOGICAL_MAXIMUM (255)% t6 r$ f* G' P, ?; N) A
- 0x95, 0x08, // REPORT_COUNT (8)
6 @" \& r0 I% _2 Y7 p - 0x75, 0x40, // REPORT_SIZE (64)
6 t2 V' s! R& X: g7 A. m# J A - 0x91, 0x02, // OUTPUT (Data,Var,Abs)
7 |/ r6 W/ E" l4 {4 [! B5 ^- [# } - 0xc0 // END_COLLECTION- b. `; W* d; {
- }; /* ReportDescriptor */6 G* y; ~" X2 }# y9 \2 c
9 f2 D( N4 R8 n- const u8 CustomHID_StringVendor[CUSTOMHID_SIZ_STRING_VENDOR]& k* O8 v4 W+ Z* K$ ^) {
- const u8 StringProduct[SIZ_STRING_PRODUCT]5 P3 o0 i1 @! E% w+ L% F
- const u8 StringSerial[SIZ_STRING_SERIAL]
复制代码 * F" q$ K2 j4 A% x
分别是“厂商字符”、“产品字符”、“产品序列号”,这些将在USB HID设备加载的时候显示。但是这需要这些字符要求为Unicode编码,你需要将你要显示的字符先转为Unicode编码。最好大家还要根据各个数组的长度修改如下定义。
. |2 c+ _( ^! H0 `4 s0 A+ B, H/ y
+ C, |- D; O$ ^* N5 ]) Y0 p- #define CUSTOMHID_SIZ_REPORT_DESC 39
( }6 w& ~" b$ \1 \4 l8 B6 k) s0 } - #define CUSTOMHID_SIZ_STRING_VENDOR 64
8 _5 l1 ?3 K/ D& L9 @' G$ b - #define CUSTOMHID_SIZ_STRING_PRODUCT 28
! [9 h9 z# T8 g, R - #define CUSTOMHID_SIZ_STRING_SERIAL 26
复制代码
1 K4 X; A$ R5 C- o2 L三、打开hw_config.c文件,将那些没有的函数删除,只保留如下函数$ D# B; `2 ]' Z, k. N6 E5 s0 O: n) @
a) Set_System(void)+ s9 E: N8 L' \0 T3 D
b) void Set_USBClock(void) - Z1 a7 J A4 z; ]/ w
c) void USB_Interrupts_Config(void)
9 k5 h# a; I2 fd) void USB_Cable_Config (FunctionalState NewState); c( i# Q3 l: F! l5 m5 a4 W8 e
特别要注意最后一个函数,其主要作用是控制USB的上拉电阻,让电脑检测USB设备是否连接的。; i$ L! @) w& h/ ?' ~/ }
, P/ |( x C% G1 s# y5 P; A' F, `( f# @2 Y
四、打开stm32f10x_it.c文件,把EXTI15_10_IRQHandler等中断内的代码删除。7 z, A& ^; A% y& l2 t2 ]
打开usb_prop.c文件,修改如下:9 }+ g5 p3 \5 L* E( s
- void CustomHID_Reset(void)
7 t$ s/ Y7 L) ]. Q2 V) K - {4 }' j7 {! u+ O+ Y5 d5 @6 z
- /* Set Joystick_DEVICE as not configured */
1 M, X. A4 }0 Y, J0 ~ - pInformation->Current_Configuration = 0;
+ r% T% m2 B$ }7 Y1 b2 a) b2 w - pInformation->Current_Interface = 0;/*the default Interface*/# A7 I& a0 d. u9 Y+ R& C; \
- SetBTABLE(BTABLE_ADDRESS);* L" \, ?! J- ]4 W6 O0 Q5 H
- & ~$ E. ]* d# X( k S4 i! c/ {) ~
- /* Initialize Endpoint 0 */
) ?. M* Q) P. O7 i* y( H% [ - SetEPType(ENDP0, EP_CONTROL);$ p) E# [: M) d1 e& x4 O
- SetEPTxStatus(ENDP0, EP_TX_STALL);$ t2 v2 w6 d# g7 o% X" r) n' Q% j
- SetEPRxAddr(ENDP0, ENDP0_RXADDR);
: L/ t: m. p. j: V - SetEPTxAddr(ENDP0, ENDP0_TXADDR);9 Y! E$ J7 ^$ [5 _. I; @
- Clear_Status_Out(ENDP0);: R! t# i% u: |3 L
- SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
% ~4 g" Z, i' ^/ ^ - SetEPRxValid(ENDP0);$ Q4 k- T5 A! H4 c( Y9 `9 j
- y; w- N% k" ~) w0 H9 ~0 W
- /* Initialize Endpoint 1 */
- Q3 i. y/ C) D3 }6 V, [4 V - SetEPType(ENDP1, EP_INTERRUPT);
8 Q" }2 H6 y1 Y, ~4 U - SetEPTxAddr(ENDP1, ENDP1_TXADDR);* t5 d1 d. G1 Q" x
- SetEPTxCount(ENDP1, 64);2 ]8 S6 m U; C& y# w
- SetEPRxStatus(ENDP1, EP_RX_DIS);
; C( S0 D. i9 m0 o0 r% H - SetEPTxStatus(ENDP1, EP_TX_NAK);
6 H, b8 P/ h" }* j7 V, R; y
' |- u8 P2 M$ w+ e) {- E6 n% ~' E- /* Initialize Endpoint 1 */
5 ~. ~) L( j, ]2 A( { u% p - // SetEPType(ENDP1, EP_INTERRUPT);
; v$ S. s" j4 V. O - SetEPRxAddr(ENDP1, ENDP1_RXADDR);1 ~* y' T5 t; E( E0 o
- SetEPRxCount(ENDP1, 64);- Y. y5 ~/ t& W- k
- // SetEPTxStatus(ENDP1, EP_TX_DIS);* x. w* ^& N I4 }; v! w
- SetEPRxStatus(ENDP1, EP_RX_VALID);
% G* |( f; C6 b - /* Set this device to response on default address */
V5 U% K& s% r: m - SetDeviceAddress(0);
$ }; k- g9 ` ]$ s6 B/ x& T* p - }
复制代码
% u$ j4 \. Q ?8 R五、usb_endp.c文件
9 m4 |' {) N0 C9 {( q" N- void EP1_OUT_Callback(void)! y5 g1 s$ E- v7 ]' l8 o
- {
( |6 e, a' {( S# [+ F - 这些写接收代码0 z+ v$ }" J, s: ]. R+ ?/ _
- }
复制代码 n; z. x" V6 }* T2 @+ I, w( ^
六、数据发送和接收,举例说明
+ g2 J/ a4 E3 \" ~, @1、数据接收
0 ~' C) t3 |3 s k5 B9 {- u8 DataLen;
9 W. F( V7 q3 q - DataLen = GetEPRxCount(ENDP1);
; l1 ]2 O! Z8 p" [ - PMAToUserBufferCopy(TX1_buffer, ENDP1_RXADDR, DataLen);$ Q) _' X* s1 \, B. }9 }
- SetEPRxValid(ENDP1);* k' G2 q; I4 v3 }4 A0 X
- USART1_Send(DataLen);- ~0 g/ p+ G$ D
- count_out = 1;
复制代码
. D* B+ V/ K: m% z/ h. }2、数据发送" J2 j6 w ?' W3 ~, a4 M
- UserToPMABufferCopy(InBuffer, GetEPTxAddr(ENDP1), 64);% C; ~- m, t7 {" |
- SetEPTxCount(ENDP1, 64);
7 }8 L- o3 B `! Z/ g# _7 l - SetEPTxValid(ENDP1);
复制代码
, a1 r) @+ P% Y如果你发送数据较为频繁,每次发送前应使用GetEPTxStatus(ENDP1)检测上次发送是否完成。如果端点状态处于EP_TX_VALID,说明发送未结束,如果端点状态处于EP_TX_NAK,说明发送结束。* }( v2 R G. q- Z3 {5 T% q
1 A: D7 y3 I' Q4 N% e
. i" X& |$ i* X1 v
(by xidongs)
) A# ~/ ^( m* w$ E, T) K+ w |