summaryrefslogtreecommitdiff
path: root/chip/stm32/usb_hid_touchpad.c
blob: 15b7f6554c50eac6a1dabb5e268d09e04a39b41f (plain)
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
/* Copyright 2016 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#include "clock.h"
#include "common.h"
#include "config.h"
#include "console.h"
#include "gpio.h"
#include "hooks.h"
#include "link_defs.h"
#include "registers.h"
#include "task.h"
#include "timer.h"
#include "util.h"
#include "usb_descriptor.h"
#include "usb_hid.h"
#include "usb_hid_hw.h"
#include "usb_hid_touchpad.h"

/* Console output macro */
#define CPRINTF(format, args...) cprintf(CC_USB, format, ## args)

#define HID_TOUCHPAD_REPORT_SIZE  sizeof(struct usb_hid_touchpad_report)

/*
 * Touchpad EP interval: Make sure this value is smaller than the typical
 * interrupt interval from the trackpad.
 */
#define HID_TOUCHPAD_EP_INTERVAL_MS 2 /* ms */

/* HID descriptors */
const struct usb_interface_descriptor USB_IFACE_DESC(USB_IFACE_HID_TOUCHPAD) = {
	.bLength = USB_DT_INTERFACE_SIZE,
	.bDescriptorType = USB_DT_INTERFACE,
	.bInterfaceNumber = USB_IFACE_HID_TOUCHPAD,
	.bAlternateSetting = 0,
	.bNumEndpoints = 1,
	.bInterfaceClass = USB_CLASS_HID,
	.bInterfaceSubClass = 0,
	.bInterfaceProtocol = 0,
	.iInterface = 0,
};
const struct usb_endpoint_descriptor USB_EP_DESC(USB_IFACE_HID_TOUCHPAD, 81) = {
	.bLength = USB_DT_ENDPOINT_SIZE,
	.bDescriptorType = USB_DT_ENDPOINT,
	.bEndpointAddress = 0x80 | USB_EP_HID_TOUCHPAD,
	.bmAttributes = 0x03 /* Interrupt endpoint */,
	.wMaxPacketSize = HID_TOUCHPAD_REPORT_SIZE,
	.bInterval = HID_TOUCHPAD_EP_INTERVAL_MS /* polling interval */
};

/*
 * HID: Report Descriptor
 * TODO(crosbug.com/p/59083): There are ways to reduce flash usage, as the
 * Finger Usage is repeated 5 times.
 * TODO(crosbug.com/p/59083): Touchpad specific values should be probed from
 * touchpad itself.
 */
static const uint8_t report_desc[] = {
	0x05, 0x0D,        /* Usage Page (Digitizer) */
	0x09, 0x04,        /* Usage (Touch Screen) */
	0xA1, 0x01,        /* Collection (Application) */
	0x85, 0x01,        /*   Report ID (1, Touch) */
	/* Finger 0 */
	0x09, 0x22,        /*   Usage (Finger) */
	0xA1, 0x02,        /*   Collection (Logical) */
	0x09, 0x42,        /*     Usage (Tip Switch) */
	0x15, 0x00,        /*     Logical Minimum (0) */
	0x25, 0x01,        /*     Logical Maximum (1) */
	0x75, 0x01,        /*     Report Size (1) */
	0x95, 0x01,        /*     Report Count (1) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x32,        /*     Usage (In Range) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x75, 0x06,        /*     Report Size (6) */
	0x09, 0x51,        /*     Usage (0x51) Contact identifier */
	0x25, 0x1F,        /*     Logical Maximum (31) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x09, 0x48,        /*     Usage (WIDTH) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x49,        /*     Usage (HEIGHT) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x01,        /*     Usage Page (Generic Desktop Ctrls) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x55, 0x0E,        /*     Unit Exponent (-2) */
	0x65, 0x11,        /*     Unit (System: SI Linear, Length: cm) */
	0x09, 0x30,        /*     Usage (X) */
	/* FIXME: Physical/logical dimensions should come from trackpad info */
	0x35, 0x00,        /*     Physical Minimum (0) */
	0x26, 0x86, 0x0C,  /*     Logical Maximum (3206) */
	0x46, 0xF8, 0x03,  /*     Physical Maximum (10.16 cm) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x26, 0xf7, 0x06,  /*     Logical Maximum (1783) */
	0x46, 0x36, 0x02,  /*     Physical Maximum (5.66 cm) */
	0x09, 0x31,        /*     Usage (Y) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x08,        /*     Report Size (8) */
	0x09, 0x30,        /*     Usage (Tip pressure) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0xC0,              /*   End Collection */
	/* Finger 1 */
	0x09, 0x22,        /*   Usage (Finger) */
	0xA1, 0x02,        /*   Collection (Logical) */
	0x09, 0x42,        /*     Usage (Tip Switch) */
	0x15, 0x00,        /*     Logical Minimum (0) */
	0x25, 0x01,        /*     Logical Maximum (1) */
	0x75, 0x01,        /*     Report Size (1) */
	0x95, 0x01,        /*     Report Count (1) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x32,        /*     Usage (In Range) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x75, 0x06,        /*     Report Size (6) */
	0x09, 0x51,        /*     Usage (0x51) Contact identifier */
	0x25, 0x1F,        /*     Logical Maximum (31) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x09, 0x48,        /*     Usage (WIDTH) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x49,        /*     Usage (HEIGHT) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x01,        /*     Usage Page (Generic Desktop Ctrls) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x55, 0x0E,        /*     Unit Exponent (-2) */
	0x65, 0x11,        /*     Unit (System: SI Linear, Length: cm) */
	0x09, 0x30,        /*     Usage (X) */
	/* FIXME: Physical/logical dimensions should come from trackpad info */
	0x35, 0x00,        /*     Physical Minimum (0) */
	0x26, 0x86, 0x0C,  /*     Logical Maximum (3206) */
	0x46, 0xF8, 0x03,  /*     Physical Maximum (10.16 cm) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x26, 0xf7, 0x06,  /*     Logical Maximum (1783) */
	0x46, 0x36, 0x02,  /*     Physical Maximum (5.66 cm) */
	0x09, 0x31,        /*     Usage (Y) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x08,        /*     Report Size (8) */
	0x09, 0x30,        /*     Usage (Tip pressure) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0xC0,              /*   End Collection */
	/* Finger 2 */
	0x09, 0x22,        /*   Usage (Finger) */
	0xA1, 0x02,        /*   Collection (Logical) */
	0x09, 0x42,        /*     Usage (Tip Switch) */
	0x15, 0x00,        /*     Logical Minimum (0) */
	0x25, 0x01,        /*     Logical Maximum (1) */
	0x75, 0x01,        /*     Report Size (1) */
	0x95, 0x01,        /*     Report Count (1) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x32,        /*     Usage (In Range) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x75, 0x06,        /*     Report Size (6) */
	0x09, 0x51,        /*     Usage (0x51) Contact identifier */
	0x25, 0x1F,        /*     Logical Maximum (31) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x09, 0x48,        /*     Usage (WIDTH) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x49,        /*     Usage (HEIGHT) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x01,        /*     Usage Page (Generic Desktop Ctrls) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x55, 0x0E,        /*     Unit Exponent (-2) */
	0x65, 0x11,        /*     Unit (System: SI Linear, Length: cm) */
	0x09, 0x30,        /*     Usage (X) */
	/* FIXME: Physical/logical dimensions should come from trackpad info */
	0x35, 0x00,        /*     Physical Minimum (0) */
	0x26, 0x86, 0x0C,  /*     Logical Maximum (3206) */
	0x46, 0xF8, 0x03,  /*     Physical Maximum (10.16 cm) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x26, 0xf7, 0x06,  /*     Logical Maximum (1783) */
	0x46, 0x36, 0x02,  /*     Physical Maximum (5.66 cm) */
	0x09, 0x31,        /*     Usage (Y) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x08,        /*     Report Size (8) */
	0x09, 0x30,        /*     Usage (Tip pressure) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0xC0,              /*   End Collection */
	/* Finger 3 */
	0x09, 0x22,        /*   Usage (Finger) */
	0xA1, 0x02,        /*   Collection (Logical) */
	0x09, 0x42,        /*     Usage (Tip Switch) */
	0x15, 0x00,        /*     Logical Minimum (0) */
	0x25, 0x01,        /*     Logical Maximum (1) */
	0x75, 0x01,        /*     Report Size (1) */
	0x95, 0x01,        /*     Report Count (1) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x32,        /*     Usage (In Range) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x75, 0x06,        /*     Report Size (6) */
	0x09, 0x51,        /*     Usage (0x51) Contact identifier */
	0x25, 0x1F,        /*     Logical Maximum (31) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x09, 0x48,        /*     Usage (WIDTH) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x49,        /*     Usage (HEIGHT) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x01,        /*     Usage Page (Generic Desktop Ctrls) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x55, 0x0E,        /*     Unit Exponent (-2) */
	0x65, 0x11,        /*     Unit (System: SI Linear, Length: cm) */
	0x09, 0x30,        /*     Usage (X) */
	/* FIXME: Physical/logical dimensions should come from trackpad info */
	0x35, 0x00,        /*     Physical Minimum (0) */
	0x26, 0x86, 0x0C,  /*     Logical Maximum (3206) */
	0x46, 0xF8, 0x03,  /*     Physical Maximum (10.16 cm) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x26, 0xf7, 0x06,  /*     Logical Maximum (1783) */
	0x46, 0x36, 0x02,  /*     Physical Maximum (5.66 cm) */
	0x09, 0x31,        /*     Usage (Y) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x08,        /*     Report Size (8) */
	0x09, 0x30,        /*     Usage (Tip pressure) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0xC0,              /*   End Collection */
	/* Finger 4 */
	0x09, 0x22,        /*   Usage (Finger) */
	0xA1, 0x02,        /*   Collection (Logical) */
	0x09, 0x42,        /*     Usage (Tip Switch) */
	0x15, 0x00,        /*     Logical Minimum (0) */
	0x25, 0x01,        /*     Logical Maximum (1) */
	0x75, 0x01,        /*     Report Size (1) */
	0x95, 0x01,        /*     Report Count (1) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x32,        /*     Usage (In Range) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x75, 0x06,        /*     Report Size (6) */
	0x09, 0x51,        /*     Usage (0x51) Contact identifier */
	0x25, 0x1F,        /*     Logical Maximum (31) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x09, 0x48,        /*     Usage (WIDTH) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x09, 0x49,        /*     Usage (HEIGHT) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x01,        /*     Usage Page (Generic Desktop Ctrls) */
	0x75, 0x0C,        /*     Report Size (12) */
	0x55, 0x0E,        /*     Unit Exponent (-2) */
	0x65, 0x11,        /*     Unit (System: SI Linear, Length: cm) */
	0x09, 0x30,        /*     Usage (X) */
	/* FIXME: Physical/logical dimensions should come from trackpad info */
	0x35, 0x00,        /*     Physical Minimum (0) */
	0x26, 0x86, 0x0C,  /*     Logical Maximum (3206) */
	0x46, 0xF8, 0x03,  /*     Physical Maximum (10.16 cm) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x26, 0xf7, 0x06,  /*     Logical Maximum (1783) */
	0x46, 0x36, 0x02,  /*     Physical Maximum (5.66 cm) */
	0x09, 0x31,        /*     Usage (Y) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0x05, 0x0D,        /*     Usage Page (Digitizer) */
	0x26, 0xFF, 0x00,  /*     Logical Maximum (255) */
	0x75, 0x08,        /*     Report Size (8) */
	0x09, 0x30,        /*     Usage (Tip pressure) */
	0x81, 0x02,        /*     Input (Data,Var,Abs) */
	0xC0,              /*   End Collection */
	/* Contact count */
	0x05, 0x0D,        /*   Usage Page (Digitizer) */
	0x09, 0x54,        /*   Usage (Contact count) */
	0x75, 0x07,        /*   Report Size (7) */
	0x95, 0x01,        /*   Report Count (1) */
	0x81, 0x02,        /*   Input (Data,Var,Abs) */
	/* Button */
	0x05, 0x01,        /*   Usage Page (Generic Desktop Ctrls) */
	0x05, 0x09,        /*   Usage (Button) */
	0x19, 0x01,        /*   Usage Minimum (0x01) */
	0x29, 0x01,        /*   Usage Maximum (0x01) */
	0x15, 0x00,        /*   Logical Minimum (0) */
	0x25, 0x01,        /*   Logical Maximum (1) */
	0x75, 0x01,        /*   Report Size (1) */
	0x95, 0x01,        /*   Report Count (1) */
	0x81, 0x02,        /*   Input (Data,Var,Abs) */
	0xC0,              /* End Collection */
};

const struct usb_hid_descriptor USB_CUSTOM_DESC(USB_IFACE_HID_TOUCHPAD, hid) = {
	.bLength = 9,
	.bDescriptorType = USB_HID_DT_HID,
	.bcdHID = 0x0100,
	.bCountryCode = 0x00, /* Hardware target country */
	.bNumDescriptors = 1,
	.desc = {{
		.bDescriptorType = USB_HID_DT_REPORT,
		.wDescriptorLength = sizeof(report_desc)
	}}
};

static usb_uint hid_ep_buf[DIV_ROUND_UP(HID_TOUCHPAD_REPORT_SIZE, 2)] __usb_ram;

void set_touchpad_report(struct usb_hid_touchpad_report *report)
{
	/*
	 * Endpoint is busy. This should rarely happen as we make sure that
	 * the trackpad interrupt period >= USB interrupt period.
	 *
	 * TODO(crosbug.com/p/59083): Figure out how to handle USB suspend.
	 */
	int timeout = 20; /* Wait up to 5 EP intervals. */

	while ((STM32_USB_EP(USB_EP_HID_TOUCHPAD) & EP_TX_MASK)
			== EP_TX_VALID) {
		msleep(DIV_ROUND_UP(HID_TOUCHPAD_EP_INTERVAL_MS, 4));
		if (!--timeout)
			return;
	}

	memcpy_to_usbram((void *) usb_sram_addr(hid_ep_buf),
			 report, sizeof(*report));
	/* enable TX */
	STM32_TOGGLE_EP(USB_EP_HID_TOUCHPAD, EP_TX_MASK, EP_TX_VALID, 0);

#ifdef CONFIG_USB_REMOTE_WAKEUP
	/* Wake up host, if required. */
	usb_wake();
#endif
}

static void hid_touchpad_tx(void)
{
	hid_tx(USB_EP_HID_TOUCHPAD);
}

static void hid_touchpad_reset(void)
{
	hid_reset(USB_EP_HID_TOUCHPAD, hid_ep_buf, HID_TOUCHPAD_REPORT_SIZE);
}

USB_DECLARE_EP(USB_EP_HID_TOUCHPAD, hid_touchpad_tx, hid_touchpad_tx,
	       hid_touchpad_reset);

static int hid_touchpad_iface_request(usb_uint *ep0_buf_rx,
				      usb_uint *ep0_buf_tx)
{
	return hid_iface_request(ep0_buf_rx, ep0_buf_tx,
				 report_desc, sizeof(report_desc));
}
USB_DECLARE_IFACE(USB_IFACE_HID_TOUCHPAD, hid_touchpad_iface_request)