xref: /freebsd/usr.sbin/bluetooth/bthidd/hid.c (revision 6ff6d951ade3f3379932df7f878ef3ea272cfc59)
1 /*
2  * hid.c
3  */
4 
5 /*-
6  * Copyright (c) 2006 Maksim Yevmenkin <m_evmenkin@yahoo.com>
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $Id: hid.c,v 1.5 2006/09/07 21:06:53 max Exp $
31  * $FreeBSD$
32  */
33 
34 #include <sys/consio.h>
35 #include <sys/mouse.h>
36 #include <sys/queue.h>
37 #include <assert.h>
38 #include <bluetooth.h>
39 #include <dev/usb/usb.h>
40 #include <dev/usb/usbhid.h>
41 #include <errno.h>
42 #include <stdio.h>
43 #include <string.h>
44 #include <syslog.h>
45 #include <unistd.h>
46 #include <usbhid.h>
47 #include "bthid_config.h"
48 #include "bthidd.h"
49 #include "kbd.h"
50 
51 #undef	min
52 #define	min(x, y)	(((x) < (y))? (x) : (y))
53 
54 #undef	ASIZE
55 #define	ASIZE(a)	(sizeof(a)/sizeof(a[0]))
56 
57 /*
58  * Process data from control channel
59  */
60 
61 int32_t
62 hid_control(bthid_session_p s, uint8_t *data, int32_t len)
63 {
64 	assert(s != NULL);
65 	assert(data != NULL);
66 	assert(len > 0);
67 
68 	switch (data[0] >> 4) {
69         case 0: /* Handshake (response to command) */
70 		if (data[0] & 0xf)
71 			syslog(LOG_ERR, "Got handshake message with error " \
72 				"response 0x%x from %s",
73 				data[0], bt_ntoa(&s->bdaddr, NULL));
74 		break;
75 
76 	case 1: /* HID Control */
77 		switch (data[0] & 0xf) {
78 		case 0: /* NOP */
79 			break;
80 
81 		case 1: /* Hard reset */
82 		case 2: /* Soft reset */
83 			syslog(LOG_WARNING, "Device %s requested %s reset",
84 				bt_ntoa(&s->bdaddr, NULL),
85 				((data[0] & 0xf) == 1)? "hard" : "soft");
86 			break;
87 
88 		case 3: /* Suspend */
89 			syslog(LOG_NOTICE, "Device %s requested Suspend",
90 				bt_ntoa(&s->bdaddr, NULL));
91 			break;
92 
93 		case 4: /* Exit suspend */
94 			syslog(LOG_NOTICE, "Device %s requested Exit Suspend",
95 				bt_ntoa(&s->bdaddr, NULL));
96 			break;
97 
98 		case 5: /* Virtual cable unplug */
99 			syslog(LOG_NOTICE, "Device %s unplugged virtual cable",
100 				bt_ntoa(&s->bdaddr, NULL));
101 			session_close(s);
102 			break;
103 
104 		default:
105 			syslog(LOG_WARNING, "Device %s sent unknown " \
106                                 "HID_Control message 0x%x",
107 				bt_ntoa(&s->bdaddr, NULL), data[0]);
108 			break;
109 		}
110 		break;
111 
112 	default:
113 		syslog(LOG_WARNING, "Got unexpected message 0x%x on Control " \
114 			"channel from %s", data[0], bt_ntoa(&s->bdaddr, NULL));
115 		break;
116 	}
117 
118 	return (0);
119 }
120 
121 /*
122  * Process data from the interrupt channel
123  */
124 
125 int32_t
126 hid_interrupt(bthid_session_p s, uint8_t *data, int32_t len)
127 {
128 	hid_device_p	hid_device;
129 	hid_data_t	d;
130 	hid_item_t	h;
131 	int32_t		report_id, usage, page, val,
132 			mouse_x, mouse_y, mouse_z, mouse_butt,
133 			mevents, kevents;
134 
135 	assert(s != NULL);
136 	assert(s->srv != NULL);
137 	assert(data != NULL);
138 
139 	if (len < 3) {
140 		syslog(LOG_ERR, "Got short message (%d bytes) on Interrupt " \
141 			"channel from %s", len, bt_ntoa(&s->bdaddr, NULL));
142 		return (-1);
143 	}
144 
145 	if (data[0] != 0xa1) {
146 		syslog(LOG_ERR, "Got unexpected message 0x%x on " \
147 			"Interrupt channel from %s",
148 			data[0], bt_ntoa(&s->bdaddr, NULL));
149 		return (-1);
150 	}
151 
152 	report_id = data[1];
153 	data += 2;
154 	len -= 2;
155 
156 	hid_device = get_hid_device(&s->bdaddr);
157 	assert(hid_device != NULL);
158 
159 	mouse_x = mouse_y = mouse_z = mouse_butt = mevents = kevents = 0;
160 
161 	for (d = hid_start_parse(hid_device->desc, 1 << hid_input, -1);
162 	     hid_get_item(d, &h) > 0; ) {
163 		if ((h.flags & HIO_CONST) || (h.report_ID != report_id))
164 			continue;
165 
166 		page = HID_PAGE(h.usage);
167 		usage = HID_USAGE(h.usage);
168 		val = hid_get_data(data, &h);
169 
170 		switch (page) {
171 		case HUP_GENERIC_DESKTOP:
172 			switch (usage) {
173 			case HUG_X:
174 				mouse_x = val;
175 				mevents ++;
176 				break;
177 
178 			case HUG_Y:
179 				mouse_y = val;
180 				mevents ++;
181 				break;
182 
183 			case HUG_WHEEL:
184 				mouse_z = -val;
185 				mevents ++;
186 				break;
187 
188 			case HUG_SYSTEM_SLEEP:
189 				if (val)
190 					syslog(LOG_NOTICE, "Sleep button pressed");
191 				break;
192 			}
193 			break;
194 
195 		case HUP_KEYBOARD:
196 			kevents ++;
197 
198 			if (h.flags & HIO_VARIABLE) {
199 				if (val && usage < kbd_maxkey())
200 					bit_set(s->keys1, usage);
201 			} else {
202 				if (val && val < kbd_maxkey())
203 					bit_set(s->keys1, val);
204 
205 				data ++;
206 				len --;
207 
208 				len = min(len, h.report_size);
209 				while (len > 0) {
210 					val = hid_get_data(data, &h);
211 					if (val && val < kbd_maxkey())
212 						bit_set(s->keys1, val);
213 
214 					data ++;
215 					len --;
216 				}
217 			}
218 			break;
219 
220 		case HUP_BUTTON:
221 			if (usage != 0) {
222 				if (usage == 2)
223 					usage = 3;
224 				else if (usage == 3)
225 					usage = 2;
226 
227 				mouse_butt |= (val << (usage - 1));
228 				mevents ++;
229 			}
230 			break;
231 
232 		case HUP_CONSUMER:
233 			if (!val)
234 				break;
235 
236 			switch (usage) {
237 			case 0xb5: /* Scan Next Track */
238 				val = 0x19;
239 				break;
240 
241 			case 0xb6: /* Scan Previous Track */
242 				val = 0x10;
243 				break;
244 
245 			case 0xb7: /* Stop */
246 				val = 0x24;
247 				break;
248 
249 			case 0xcd: /* Play/Pause */
250 				val = 0x22;
251 				break;
252 
253 			case 0xe2: /* Mute */
254 				val = 0x20;
255 				break;
256 
257 			case 0xe9: /* Volume Up */
258 				val = 0x30;
259 				break;
260 
261 			case 0xea: /* Volume Down */
262 				val = 0x2E;
263 				break;
264 
265 			case 0x183: /* Media Select */
266 				val = 0x6D;
267 				break;
268 
269 			case 0x018a: /* Mail */
270 				val = 0x6C;
271 				break;
272 
273 			case 0x192: /* Calculator */
274 				val = 0x21;
275 				break;
276 
277 			case 0x194: /* My Computer */
278 				val = 0x6B;
279 				break;
280 
281 			case 0x221: /* WWW Search */
282 				val = 0x65;
283 				break;
284 
285 			case 0x223: /* WWW Home */
286 				val = 0x32;
287 				break;
288 
289 			case 0x224: /* WWW Back */
290 				val = 0x6A;
291 				break;
292 
293 			case 0x225: /* WWW Forward */
294 				val = 0x69;
295 				break;
296 
297 			case 0x226: /* WWW Stop */
298 				val = 0x68;
299 				break;
300 
301 			case 0x227: /* WWW Refresh */
302 				val = 0x67;
303 				break;
304 
305 			case 0x22a: /* WWW Favorites */
306 				val = 0x66;
307 				break;
308 
309 			default:
310 				val = 0;
311 				break;
312 			}
313 
314 			/* XXX FIXME - UGLY HACK */
315 			if (val != 0) {
316 				if (hid_device->keyboard) {
317 					int32_t	buf[4] = { 0xe0, val,
318 							   0xe0, val|0x80 };
319 
320 					assert(s->vkbd != -1);
321 					write(s->vkbd, buf, sizeof(buf));
322 				} else
323 					syslog(LOG_ERR, "Keyboard events " \
324 						"received from non-keyboard " \
325 						"device %s. Please report",
326 						bt_ntoa(&s->bdaddr, NULL));
327 			}
328 			break;
329 
330 		case HUP_MICROSOFT:
331 			switch (usage) {
332 			case 0xfe01:
333 				if (!hid_device->battery_power)
334 					break;
335 
336 				switch (val) {
337 				case 1:
338 					syslog(LOG_INFO, "Battery is OK on %s",
339 						bt_ntoa(&s->bdaddr, NULL));
340 					break;
341 
342 				case 2:
343 					syslog(LOG_NOTICE, "Low battery on %s",
344 						bt_ntoa(&s->bdaddr, NULL));
345 					break;
346 
347 				case 3:
348 					syslog(LOG_WARNING, "Very low battery "\
349                                                 "on %s",
350 						bt_ntoa(&s->bdaddr, NULL));
351 					break;
352                                 }
353 				break;
354 			}
355 			break;
356 		}
357 	}
358 	hid_end_parse(d);
359 
360 	/*
361 	 * XXX FIXME Feed keyboard events into kernel.
362 	 * The code below works, bit host also needs to track
363 	 * and handle repeat.
364 	 *
365 	 * Key repeat currently works in X, but not in console.
366 	 */
367 
368 	if (kevents > 0) {
369 		if (hid_device->keyboard) {
370 			assert(s->vkbd != -1);
371 			kbd_process_keys(s);
372 		} else
373 			syslog(LOG_ERR, "Keyboard events received from " \
374 				"non-keyboard device %s. Please report",
375 				bt_ntoa(&s->bdaddr, NULL));
376 	}
377 
378 	/*
379 	 * XXX FIXME Feed mouse events into kernel.
380 	 * The code block below works, but it is not good enough.
381 	 * Need to track double-clicks etc.
382 	 *
383 	 * Double click currently works in X, but not in console.
384 	 */
385 
386 	if (mevents > 0) {
387 		struct mouse_info	mi;
388 
389 		mi.operation = MOUSE_ACTION;
390 		mi.u.data.x = mouse_x;
391 		mi.u.data.y = mouse_y;
392 		mi.u.data.z = mouse_z;
393 		mi.u.data.buttons = mouse_butt;
394 
395 		if (ioctl(s->srv->cons, CONS_MOUSECTL, &mi) < 0)
396 			syslog(LOG_ERR, "Could not process mouse events from " \
397 				"%s. %s (%d)", bt_ntoa(&s->bdaddr, NULL),
398 				strerror(errno), errno);
399 	}
400 
401 	return (0);
402 }
403