host_cdc_msc_hid sample
Select one of the symbols to view example projects that use it.
 
Outline
#include "bsp/board_api.h"
#include "tusb.h"
#define USE_ANSI_ESCAPE
#define MAX_REPORT
keycode2ascii
hid_info
hid_app_task()
tuh_hid_mount_cb(uint8_t, uint8_t, const uint8_t *, uint16_t)
tuh_hid_umount_cb(uint8_t, uint8_t)
tuh_hid_report_received_cb(uint8_t, uint8_t, const uint8_t *, uint16_t)
find_key_in_report(const hid_keyboard_report_t *, uint8_t)
process_kbd_report(const hid_keyboard_report_t *)
cursor_movement(int8_t, int8_t, int8_t)
process_mouse_report(const hid_mouse_report_t *)
process_generic_report(uint8_t, uint8_t, const uint8_t *, uint16_t)
Files
loading...
SourceVuRaspberry Pi Pico SDK and Exampleshost_cdc_msc_hid samplehid_app.c
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * The MIT License (MIT) * * Copyright (c) 2021, Ha Thach (tinyusb.org) * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * *//* ... */ #include "bsp/board_api.h" #include "tusb.h" //--------------------------------------------------------------------+ // MACRO TYPEDEF CONSTANT ENUM DECLARATION //--------------------------------------------------------------------+ // If your host terminal support ansi escape code such as TeraTerm // it can be use to simulate mouse cursor movement within terminal #define USE_ANSI_ESCAPE 0 #define MAX_REPORT 4 static uint8_t const keycode2ascii[128][2] = { HID_KEYCODE_TO_ASCII }; // Each HID instance can has multiple reports static struct { uint8_t report_count; tuh_hid_report_info_t report_info[MAX_REPORT]; ...}hid_info[CFG_TUH_HID]; static void process_kbd_report(hid_keyboard_report_t const *report); static void process_mouse_report(hid_mouse_report_t const * report); static void process_generic_report(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len); void hid_app_task(void) { // nothing to do }{ ... } //--------------------------------------------------------------------+ // TinyUSB Callbacks //--------------------------------------------------------------------+ // Invoked when device with hid interface is mounted // Report descriptor is also available for use. tuh_hid_parse_report_descriptor() // can be used to parse common/simple enough descriptor. // Note: if report descriptor length > CFG_TUH_ENUMERATION_BUFSIZE, it will be skipped // therefore report_desc = NULL, desc_len = 0 void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_report, uint16_t desc_len) { printf("HID device address = %d, instance = %d is mounted\r\n", dev_addr, instance); // Interface protocol (hid_interface_protocol_enum_t) const char* protocol_str[] = { "None", "Keyboard", "Mouse" }; uint8_t const itf_protocol = tuh_hid_interface_protocol(dev_addr, instance); printf("HID Interface Protocol = %s\r\n", protocol_str[itf_protocol]); // By default host stack will use activate boot protocol on supported interface. // Therefore for this simple example, we only need to parse generic report descriptor (with built-in parser) if ( itf_protocol == HID_ITF_PROTOCOL_NONE ) { hid_info[instance].report_count = tuh_hid_parse_report_descriptor(hid_info[instance].report_info, MAX_REPORT, desc_report, desc_len); printf("HID has %u reports \r\n", hid_info[instance].report_count); }if (itf_protocol == HID_ITF_PROTOCOL_NONE) { ... } // request to receive report // tuh_hid_report_received_cb() will be invoked when report is available if ( !tuh_hid_receive_report(dev_addr, instance) ) { printf("Error: cannot request to receive report\r\n"); }if (!tuh_hid_receive_report(dev_addr, instance)) { ... } }{ ... } // Invoked when device with hid interface is un-mounted void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance) { printf("HID device address = %d, instance = %d is unmounted\r\n", dev_addr, instance); }{ ... } // Invoked when received report from device via interrupt endpoint void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len) { uint8_t const itf_protocol = tuh_hid_interface_protocol(dev_addr, instance); switch (itf_protocol) { case HID_ITF_PROTOCOL_KEYBOARD: TU_LOG2("HID receive boot keyboard report\r\n"); process_kbd_report( (hid_keyboard_report_t const*) report ); break; case HID_ITF_PROTOCOL_KEYBOARD: case HID_ITF_PROTOCOL_MOUSE: TU_LOG2("HID receive boot mouse report\r\n"); process_mouse_report( (hid_mouse_report_t const*) report ); break; case HID_ITF_PROTOCOL_MOUSE: default: // Generic report requires matching ReportID and contents with previous parsed report info process_generic_report(dev_addr, instance, report, len); break;default }switch (itf_protocol) { ... } // continue to request to receive report if ( !tuh_hid_receive_report(dev_addr, instance) ) { printf("Error: cannot request to receive report\r\n"); }if (!tuh_hid_receive_report(dev_addr, instance)) { ... } }{ ... } //--------------------------------------------------------------------+ // Keyboard //--------------------------------------------------------------------+ // look up new key in previous keys static inline bool find_key_in_report(hid_keyboard_report_t const *report, uint8_t keycode) { for(uint8_t i=0; i<6; i++) { if (report->keycode[i] == keycode) return true; }for (uint8_t i=0; i<6; i++) { ... } return false; }{ ... } static void process_kbd_report(hid_keyboard_report_t const *report) { static hid_keyboard_report_t prev_report = { 0, 0, {0} }; // previous report to check key released //------------- example code ignore control (non-printable) key affects -------------// for(uint8_t i=0; i<6; i++) { if ( report->keycode[i] ) { if ( find_key_in_report(&prev_report, report->keycode[i]) ) { // exist in previous report means the current key is holding }if (find_key_in_report(&prev_report, report->keycode[i])) { ... }else { // not existed in previous report means the current key is pressed bool const is_shift = report->modifier & (KEYBOARD_MODIFIER_LEFTSHIFT | KEYBOARD_MODIFIER_RIGHTSHIFT); uint8_t ch = keycode2ascii[report->keycode[i]][is_shift ? 1 : 0]; putchar(ch); if ( ch == '\r' ) putchar('\n'); // added new line for enter key #ifndef __ICCARM__ // TODO IAR doesn't support stream control ? fflush(stdout); // flush right away, else nanolib will wait for newline #endif } }if (report->keycode[i]) { ... } // TODO example skips key released }for (uint8_t i=0; i<6; i++) { ... } prev_report = *report; }{ ... } //--------------------------------------------------------------------+ // Mouse //--------------------------------------------------------------------+ void cursor_movement(int8_t x, int8_t y, int8_t wheel) { #if USE_ANSI_ESCAPE // Move X using ansi escape if ( x < 0) { printf(ANSI_CURSOR_BACKWARD(%d), (-x)); // move left }if (x < 0) { ... }else if ( x > 0) { printf(ANSI_CURSOR_FORWARD(%d), x); // move right }else if (x > 0) { ... } // Move Y using ansi escape if ( y < 0) { printf(ANSI_CURSOR_UP(%d), (-y)); // move up }if (y < 0) { ... }else if ( y > 0) { printf(ANSI_CURSOR_DOWN(%d), y); // move down }else if (y > 0) { ... } // Scroll using ansi escape if (wheel < 0) { printf(ANSI_SCROLL_UP(%d), (-wheel)); // scroll up }if (wheel < 0) { ... }else if (wheel > 0) { printf(ANSI_SCROLL_DOWN(%d), wheel); // scroll down }else if (wheel > 0) { ... } printf("\r\n");/* ... */ #else printf("(%d %d %d)\r\n", x, y, wheel); #endif }{ ... } static void process_mouse_report(hid_mouse_report_t const * report) { static hid_mouse_report_t prev_report = { 0 }; //------------- button state -------------// uint8_t button_changed_mask = report->buttons ^ prev_report.buttons; if ( button_changed_mask & report->buttons) { printf(" %c%c%c ", report->buttons & MOUSE_BUTTON_LEFT ? 'L' : '-', report->buttons & MOUSE_BUTTON_MIDDLE ? 'M' : '-', report->buttons & MOUSE_BUTTON_RIGHT ? 'R' : '-'); }if (button_changed_mask & report->buttons) { ... } button state //------------- cursor movement -------------// cursor_movement(report->x, report->y, report->wheel); }{ ... } //--------------------------------------------------------------------+ // Generic Report //--------------------------------------------------------------------+ static void process_generic_report(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len) { (void) dev_addr; uint8_t const rpt_count = hid_info[instance].report_count; tuh_hid_report_info_t* rpt_info_arr = hid_info[instance].report_info; tuh_hid_report_info_t* rpt_info = NULL; if ( rpt_count == 1 && rpt_info_arr[0].report_id == 0) { // Simple report without report ID as 1st byte rpt_info = &rpt_info_arr[0]; }if (rpt_count == 1 && rpt_info_arr[0].report_id == 0) { ... }else { // Composite report, 1st byte is report ID, data starts from 2nd byte uint8_t const rpt_id = report[0]; // Find report id in the array for(uint8_t i=0; i<rpt_count; i++) { if (rpt_id == rpt_info_arr[i].report_id ) { rpt_info = &rpt_info_arr[i]; break; }if (rpt_id == rpt_info_arr[i].report_id) { ... } }for (uint8_t i=0; i report++; len--; } if (!rpt_info) { printf("Couldn't find report info !\r\n"); return; }if (!rpt_info) { ... } // For complete list of Usage Page & Usage checkout src/class/hid/hid.h. For examples: // - Keyboard : Desktop, Keyboard // - Mouse : Desktop, Mouse // - Gamepad : Desktop, Gamepad // - Consumer Control (Media Key) : Consumer, Consumer Control // - System Control (Power key) : Desktop, System Control // - Generic (vendor) : 0xFFxx, xx if ( rpt_info->usage_page == HID_USAGE_PAGE_DESKTOP ) { switch (rpt_info->usage) { case HID_USAGE_DESKTOP_KEYBOARD: TU_LOG1("HID receive keyboard report\r\n"); // Assume keyboard follow boot report layout process_kbd_report( (hid_keyboard_report_t const*) report ); break; case HID_USAGE_DESKTOP_KEYBOARD: case HID_USAGE_DESKTOP_MOUSE: TU_LOG1("HID receive mouse report\r\n"); // Assume mouse follow boot report layout process_mouse_report( (hid_mouse_report_t const*) report ); break; case HID_USAGE_DESKTOP_MOUSE: default: break; }switch (rpt_info->usage) { ... } }if (rpt_info->usage_page == HID_USAGE_PAGE_DESKTOP) { ... } }{ ... }
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.