说一下基于STM32CUBE的USB键盘

[复制链接]

gaosmile 发布时间：2020-5-5 21:59

文章
文章封面:	-
文章简介:	-

前面说了USB鼠标，这次趁热打铁，说一下USB键盘。依然只说如何修改，不说背后的原理。原因你懂的，涉及的知识点太多了。

会不会写成USB三部曲？不知道

猜猜我下一步再写个啥？

生成工程

首先，STM32CubeMX的配置部分不说了，和USB鼠标部分的一样。唯一需要注意的一点是，VID和PID这两个值要改一下，否则主机（也就是电脑）会以为你还是鼠标。

修改usbd_hid.c文件

其次，生成工程后打开，修改usbd_hid.c文件。配置集合（USBD_HID_CfgFSDesc）要做一些改动，首先是长度：

这是个宏定义，之前是34，现在变成41.

然后是端点数，之前是1，现在改成2.

接着是接口协议，之前是2（鼠标），现在改成1（键盘）。

再接着是报告描述符长度：

之前是：HID_MOUSE_REPORT_DESC_SIZE，长度是74，现在改成：

HID_KEYBOARD_REPORT_DESC_SIZE，长度63.

还有就是端点每次发送的数据包长度：

之前是4，不够用了，现在改成16.

最后配置集合中增加一部分端点描述符，因为USB键盘对主机来说，不光有输入，还有输出。所以，增加的这部分端点描述符，用来描述输出。

" p2 }2 }9 b& C6 u% W% {
/******************** Descriptor of Mouse Output endpoint ********************/1 p; _% \8 T. x/ Z% U
0x07, /*bLength: Endpoint Descriptor size*/
+ `) B4 l, ]1 I- R& p( l
USB_DESC_TYPE_ENDPOINT, /*bDescriptorType:*/
9 P* P$ T6 B, b" {
0x01,- R$ R8 r2 w; o
0x03, /*bmAttributes: Interrupt endpoint*/$ P, A$ k7 u' r$ N* c, \: x) W
0x10,
1 @& X! n# a: H; h: O
0x00,
4 p5 J6 n% G" h/ y! B9 C
HID_FS_BINTERVAL, /*bInterval: Polling Interval */

复制代码

修改HID描述符

修改HID描述符中的报告描述符长度：

上面提到了，之前是鼠标描述符，长度74，现在改成键盘描述符，长度63.

生成键盘的报告描述符

把USB鼠标的报告描述符删掉，换成USB键盘的报告描述符。

不会写USB键盘的报告描述符怎么办？

USB官方提供了一个USB报告描述符自动配置的工具，打开！里面有各种例程，我们直接复制一个USB键盘的报告描述符即可。

生成.h文件如下：

1 f1 Q* A' W& j5 A1 |4 Y* a/ {
__ALIGN_BEGIN static uint8_t HID_KEYBOARD_ReportDesc[HID_KEYBOARD_REPORT_DESC_SIZE] __ALIGN_END =
+ P; ` v2 \' B% l1 y o
{6 s' z3 Z6 {2 w' r; e- p$ F
0x05, 0x01, // USAGE_PAGE (Generic Desktop)# I! ]1 N. V) P
0x09, 0x06, // USAGE (Keyboard)8 V8 M( z$ U6 ^1 r8 S
0xa1, 0x01, // COLLECTION (Application); A8 L' [$ M' @$ j! n
0x05, 0x07, // USAGE_PAGE (Keyboard)
2 S/ i+ [1 v% ]$ Y" ?
0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
$ E- m% L5 B- Y1 F* X# x
0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
9 h- F& S% J# b6 G1 I) a& v
0x15, 0x00, // LOGICAL_MINIMUM (0)) q, e8 g$ @) A
0x25, 0x01, // LOGICAL_MAXIMUM (1)1 u7 T! }+ t3 |+ T" O# J# A
0x75, 0x01, // REPORT_SIZE (1), E, B2 q; A6 e) W4 U2 C/ ?; x1 K
0x95, 0x08, // REPORT_COUNT (8)' z* j0 Y- R ?/ Y) G% Z
0x81, 0x02, // INPUT (Data,Var,Abs)" V7 H5 V5 r8 o& f8 B6 F/ f
0x95, 0x01, // REPORT_COUNT (1)
- `% ^1 s! y9 D
0x75, 0x08, // REPORT_SIZE (8)8 f6 u1 R. Q6 r( f6 m
0x81, 0x03, // INPUT (Cnst,Var,Abs)
& | z4 s1 F6 w G& ~" s& I, q
0x95, 0x05, // REPORT_COUNT (5)
& \5 b n3 R6 D F! g& _
0x75, 0x01, // REPORT_SIZE (1)
7 q4 i/ E1 b# U
0x05, 0x08, // USAGE_PAGE (LEDs)3 o( _1 [7 d }9 p
0x19, 0x01, // USAGE_MINIMUM (Num Lock)7 |9 k: X% K: d; R. @
0x29, 0x05, // USAGE_MAXIMUM (Kana)3 w A& S6 |( h+ E9 l9 n5 L1 d
0x91, 0x02, // OUTPUT (Data,Var,Abs)" M: p7 h2 }: J* Y# C( R4 }# D1 K
0x95, 0x01, // REPORT_COUNT (1)3 G0 Z6 Q4 N0 s& O( D6 Q
0x75, 0x03, // REPORT_SIZE (3)
. g1 x$ e9 `. M, f
0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
9 c$ \* ?' J( m8 q6 `
0x95, 0x06, // REPORT_COUNT (6)
- C1 T$ q3 L# ]
0x75, 0x08, // REPORT_SIZE (8)
* O( s. z4 P3 y H9 w1 b0 T
0x15, 0x00, // LOGICAL_MINIMUM (0)" f* e. Y( a% F: X
0x25, 0x65, // LOGICAL_MAXIMUM (101)
+ f3 A* Y$ c @+ r: N
0x05, 0x07, // USAGE_PAGE (Keyboard)4 |' d3 N, b l8 J
0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))9 Q s, p: I! S/ ]9 F
0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
% }% z" Z; B3 |
0x81, 0x00, // INPUT (Data,Ary,Abs)1 j+ Y+ o5 E% u2 L
0xc0 // END_COLLECTION9 T1 c; X4 E$ Z
};

复制代码

修改函数USBD_HID_Setup

第五，函数USBD_HID_Setup中，需要修改一部分代码：

获取报告描述符的部分，之前这里是鼠标的报告描述符信息，现在换成了键盘的。

修改main.c文件

main.c文件中，添加头文件，并定义相关的数组：

/ R0 e2 z; b& X) S8 k; D
/* Private includes ----------------------------------------------------------*/
: _2 K- ]4 o6 E% A
/* USER CODE BEGIN Includes */
3 F! A( b. \! O: v
#include "usbd_hid.h"8 m( H, j+ A/ \, R, p
/* USER CODE END Includes *// ], R3 S# [4 J! z }: g' N
+ X' K$ |. P6 e$ O
, {9 D6 ~5 \, v/ H- `! |4 l
/* Private typedef -----------------------------------------------------------*/
: @# i* H" b' _
/* USER CODE BEGIN PTD */6 `; T: ~' P, M$ k' C
uint8_t KeyBoard[8] = {0,0,4,0,0,0,0,0};
( p! S4 j7 z4 x F: @
uint8_t KeyBoard01[8] = {0,0,0,0,0,0,0,0};
" D$ Z' ?7 ?$ Q! M; ]: _
extern USBD_HandleTypeDef hUsbDeviceFS;
1 }: T+ i# h3 Q$ I; O) _4 m

复制代码

修改主函数

第七，主函数中循环发送英文字母A~Z。

8 ?# I3 M, l7 p% p' l. q
while (1)/ \+ S9 ~2 j& w0 L8 W
{; w! K4 \8 i9 o
/* USER CODE END WHILE */
7 r5 a5 T7 p6 ^7 G1 |
$ l v& o6 g$ ?8 a. c8 T8 z0 O
) J' ], `# ]( H
/* USER CODE BEGIN 3 */
/ z n/ o: I) \4 e0 Z7 C' b
if(KeyBoard[2] >= 29)
# ~4 }( O& C! [; e" u
{; ~1 p7 m4 h& f! T
KeyBoard[2] = 4;6 s" X5 m7 Y0 N, }2 n( z+ C, m
}7 L8 u# ~5 R6 u; y
else1 n# n3 J6 o8 G5 E/ t
{% M$ n9 O7 \! J# \( W2 g) W+ W
KeyBoard[2]++;, H/ G9 K) s1 k8 |
}
/ |; C, _. M& b8 n9 |
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&KeyBoard01,sizeof(KeyBoard));
+ |3 @7 F( a% c) z3 @
HAL_Delay(15);
/ s! j: `. |- ]2 L
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&KeyBoard,sizeof(KeyBoard01));" ~" |1 e+ w; R$ |/ ?
HAL_Delay(15);
* n+ i( X8 A6 j4 r
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&KeyBoard01,sizeof(KeyBoard));- x$ ]9 ~4 m! K5 H2 @4 V; Y
HAL_Delay(1000);: ~- k1 Z& X& X/ \3 d! H: W
}: M0 x. p5 ^6 V! L6 \

复制代码

为什么4~29对应英文字母A~Z？

USB官网的文件hut1_12v2中，对键盘的每个按键对应的值，都有一个详细的定义，看第53页，我这里截一部分图：

最后，保存、编译、下载、上电！新建一个TXT文档，看键盘自动输出字母，爽不爽？

基于STM32CUBE的USB鼠标键盘二合一

首先，在5.3.0版本的STM32CubeMX上选择STM32F103C8T6芯片。具体操作和USB鼠标的操作一样，这里就不重复了。

同理，VID和PID要和之前的设备不一样。设置完成以后，直接生成工程。

第二，修改usbd_hid.c中的配置集合（USBD_HID_CfgFSDesc）。如下图所示，框住的地方是个宏定义。配置集合的长度，由之前的34，变为41.

端点个数，由1变成2.

接口协议，由2（鼠标）变成1（键盘）。

有的小伙伴会奇怪，我们不是鼠标键盘二合一吗？怎么还是键盘？

作为一个技术人员，我们要学会透过现象看本质。虽然表明上是鼠标与键盘二合一，但实际上是以键盘功能为主，而鼠标以一个附属功能加入到了键盘里。所以，这里虽然选的是键盘，但最终的效果是键盘鼠标功能都有。

好了，继续！

跟USB键盘的部分一样，配置集合最下面，增加一个输出端点的描述符：

- U g$ v3 c# R! }5 W' C: c
/******************** Descriptor of Mouse Output endpoint ********************/
5 n& i5 }& f) S+ M
0x07, /*bLength: Endpoint Descriptor size*/
0 ? m7 {( `! M7 Y3 `) D1 |; U
USB_DESC_TYPE_ENDPOINT, /*bDescriptorType:*/0 c& @5 v: L5 `
0x01,
$ e& k1 f, \3 w( |2 H$ ~
0x03, /*bmAttributes: Interrupt endpoint*/9 H. I+ s+ B, g8 r
0x10,
9 u7 B+ g* w' U# [7 o
0x00,
" u5 @2 x. L4 Z
HID_FS_BINTERVAL, /*bInterval: Polling Interval */
4 T( `+ c$ S7 L2 ^3 c' K4 X

复制代码

第三，修改HID描述符中，报告描述符的长度：

之前这里是鼠标的报告描述符，长度有74.现在变成了117.

为什么是117？

看下文！

第四，修改报告描述符。STM32CubeMX工具自动生成的工程里，报告描述符是鼠标的。现在我们要实现的是键盘与鼠标二合一，要修改的核心位置就是报告描述符这里。

简单来说，就是把前面两个例程中的报告描述符合二为一。一个数组里面，上面放键盘的报告描述符，下面放鼠标的报告描述符。

这样的话，对USB主机（也就是电脑）来说，它收到的数据，有可能是鼠标的数据，也有可能是键盘的数据。那，怎么区分？

方法就是分别在键盘与鼠标的报告描述符中放一个报告ID，键盘的报告ID是1，鼠标的报告ID是2. 两个报告描述符，一个长65，一个长62，加起来117.

向USB主机发送数据的时候，数组的第一个元素是报告ID,后面才是键盘数据或鼠标数据。实现前面两节的例程的时候，USB键盘我们定义了一个8元素的数组，USB鼠标我们定义了一个4元素的数组。现在我们只需要一个数组，它同一时间，只发送一种数据，所以大小为8，然后，还要包含报告ID，所以变成9.

在USB协议中，报告ID默认是数组的第一个元素。明白了这一点，我们可以去修改main.c文件了。

第五，添加头文件，并定义相关的数组。

8 d% k; Y% ~* t% M4 x3 o
/* Private includes ----------------------------------------------------------*/
0 X# N$ K. S7 u% K
/* USER CODE BEGIN Includes */- N7 D5 I# S. a2 R# P/ S3 ^
#include "usbd_hid.h"
8 w( _9 x* i5 Q, U
/* USER CODE END Includes */5 E+ z" V0 M7 ^5 y
: I1 {) x0 s; [ j+ T9 L: @8 o$ M
+ _# O L7 u7 Y( h ^+ J
/* Private typedef -----------------------------------------------------------*/$ F% I/ `& _" v3 A* N
/* USER CODE BEGIN PTD */4 Z0 H) F. @- I
uint8_t KeyBoard[9] = {1,0,0,4,0,0,0,0,0};
, k# v" ^) q2 r B! \$ u: H
uint8_t KeyBoard01[9] = {1,0,0,0,0,0,0,0,0};! S& A$ w1 I- Z) E4 Z: v" c
uint8_t Mouse[9] = {2,0,0,0,0,0,0,0,0};
J, p% n; I1 s1 G; {
extern USBD_HandleTypeDef hUsbDeviceFS;) N" a& Y7 n% ?8 N

复制代码

KeyBoard 数组第一个元素是1，Mouse 数组第一个元素是2，这两个值分别对应键盘和鼠标的报告ID。KeyBoard01这个数组是为了表示键盘没有被按下的状态。

第六，修改主函数。循环输出a到z字母，同时，鼠标左键每隔1秒触发一下。

3 C: J$ B @2 ?. k0 |6 Q
/* USER CODE BEGIN 3 */8 E/ p2 O C! J2 S" t$ T
if(KeyBoard[3] >= 29)5 z9 a: _4 k, O% }, {
{ j0 {' p0 W7 U4 P/ i& l
KeyBoard[3] = 4;; W1 ?: @6 ~, t" T k. }5 X1 P
}
7 Y6 Y% J) L. d
else/ Y0 N1 u+ x( K: z% Y& R' T& m: {4 i
{
4 U0 f1 x1 u- D% q+ ~, Z- K
KeyBoard[3]++;; k a( h; P. R7 w# s5 V
}$ p5 [. g* @/ g1 z( x
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&KeyBoard01,sizeof(KeyBoard));
. T& J. I8 I9 Y* Z/ `! w
HAL_Delay(15);( e4 [: u0 O* a# ?
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&KeyBoard,sizeof(KeyBoard));7 _* ?% q! f5 F
HAL_Delay(15);
" J* A/ O5 B; U: t5 O; D9 N' [ p
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&KeyBoard01,sizeof(KeyBoard));
5 x' H2 o s- k, l) K( U
HAL_Delay(1000);
% H0 S E/ z6 V8 Q, W$ O. a
& c5 L. d6 m4 ~
Mouse[1] = 0x01;: X8 `0 {9 G0 @7 ^' c
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&Mouse,sizeof(Mouse));
8 c' W4 x, v9 @- U
HAL_Delay(1000);
`* a" C; |1 t
Mouse[1] = 0x00;
: k* X; ~3 k8 R O, B
USBD_HID_SendReport(&hUsbDeviceFS,(uint8_t*)&Mouse,sizeof(Mouse));
* q* Q8 n s6 K4 I' W6 ]1 x
HAL_Delay(1000);