firmware-updater works now (needs hmusbif.enc)
[hmcfgusb] / hmcfgusb.c
1 /* HM-CFG-USB libusb-driver
2 *
3 * Copyright (c) 2013 Michael Gernoth <michael@gernoth.net>
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 */
23
24 #include <string.h>
25 #include <stdio.h>
26 #include <stdint.h>
27 #include <unistd.h>
28 #include <stdlib.h>
29 #include <math.h>
30 #include <poll.h>
31 #include <errno.h>
32 #include <sys/time.h>
33 #include <libusb-1.0/libusb.h>
34
35 /* Workaround for old libusb-1.0 */
36 #ifndef LIBUSB_CALL
37 #define LIBUSB_CALL
38 #define libusb_handle_events_timeout_completed(ctx, tv, x) libusb_handle_events_timeout(ctx, tv)
39 #endif
40
41 #include "hexdump.h"
42 #include "hmcfgusb.h"
43
44 #define USB_TIMEOUT 10000
45
46 #define ID_VENDOR 0x1b1f
47 #define ID_PRODUCT 0xc00f
48 #define ID_PRODUCT_BL 0xc010
49
50 /* TODO: dynamic */
51 #define ASYNC_SIZE 0x0040
52 #define ASYNC_INTERVAL 32
53
54 #define EP_OUT 0x02
55 #define EP_IN 0x83
56
57 #define INTERFACE 0
58
59 static int quit = 0;
60 static int debug = 0;
61
62 /* Not in all libusb-1.0 versions, so we have to roll our own :-( */
63 static char * usb_strerror(int e)
64 {
65 static char unknerr[256];
66
67 switch (e) {
68 case LIBUSB_SUCCESS:
69 return "Success";
70 case LIBUSB_ERROR_IO:
71 return "Input/output error";
72 case LIBUSB_ERROR_INVALID_PARAM:
73 return "Invalid parameter";
74 case LIBUSB_ERROR_ACCESS:
75 return "Access denied (insufficient permissions)";
76 case LIBUSB_ERROR_NO_DEVICE:
77 return "No such device (it may have been disconnected)";
78 case LIBUSB_ERROR_NOT_FOUND:
79 return "Entity not found";
80 case LIBUSB_ERROR_BUSY:
81 return "Resource busy";
82 case LIBUSB_ERROR_TIMEOUT:
83 return "Operation timed out";
84 case LIBUSB_ERROR_OVERFLOW:
85 return "Overflow";
86 case LIBUSB_ERROR_PIPE:
87 return "Pipe error";
88 case LIBUSB_ERROR_INTERRUPTED:
89 return "System call interrupted (perhaps due to signal)";
90 case LIBUSB_ERROR_NO_MEM:
91 return "Insufficient memory";
92 case LIBUSB_ERROR_NOT_SUPPORTED:
93 return "Operation not supported or unimplemented on this platform";
94 case LIBUSB_ERROR_OTHER:
95 return "Other error";
96 };
97 snprintf(unknerr, sizeof(unknerr), "Unknown error code %d / 0x%02x", e, e);
98 return unknerr;
99 }
100
101 static libusb_device_handle *hmcfgusb_find(int vid, int pid) {
102 libusb_device_handle *devh = NULL;
103 libusb_device **list;
104 ssize_t cnt;
105 ssize_t i;
106 int err;
107
108 cnt = libusb_get_device_list(NULL, &list);
109 if (cnt < 0) {
110 fprintf(stderr, "Can't get USB device list: %d\n", (int)cnt);
111 return NULL;
112 }
113
114 for (i = 0; i < cnt; i++){
115 struct libusb_device_descriptor desc;
116
117 err = libusb_get_device_descriptor(list[i], &desc);
118 if (err)
119 continue;
120
121 if ((desc.idVendor == vid) && (desc.idProduct == pid)) {
122 libusb_device *dev = list[i];
123
124 err = libusb_open(dev, &devh);
125 if (err) {
126 fprintf(stderr, "Can't open device: %s\n", usb_strerror(err));
127 return NULL;
128 }
129
130 err = libusb_detach_kernel_driver(devh, INTERFACE);
131 if ((err != 0) && (err != LIBUSB_ERROR_NOT_FOUND)) {
132 fprintf(stderr, "Can't detach kernel driver: %s\n", usb_strerror(err));
133 return NULL;
134 }
135
136 err = libusb_claim_interface(devh, INTERFACE);
137 if ((err != 0)) {
138 fprintf(stderr, "Can't claim interface: %s\n", usb_strerror(err));
139 return NULL;
140 }
141
142 return devh;
143 }
144
145 }
146
147 return NULL;
148 }
149
150 int hmcfgusb_send_null_frame(struct hmcfgusb_dev *usbdev, int silent)
151 {
152 int err;
153 int cnt;
154 unsigned char out[0x40];
155
156 memset(out, 0, sizeof(out));
157
158 err = libusb_interrupt_transfer(usbdev->usb_devh, EP_OUT, out, 0, &cnt, USB_TIMEOUT);
159 if (err && (!silent)) {
160 fprintf(stderr, "Can't send null frame: %s\n", usb_strerror(err));
161 return 0;
162 }
163
164 return 1;
165 }
166
167 int hmcfgusb_send(struct hmcfgusb_dev *usbdev, unsigned char* send_data, int len, int done)
168 {
169 int err;
170 int cnt;
171 struct timeval tv_start, tv_end;
172 int msec;
173
174 if (debug) {
175 hexdump(send_data, len, "USB < ");
176 }
177
178 gettimeofday(&tv_start, NULL);
179
180 err = libusb_interrupt_transfer(usbdev->usb_devh, EP_OUT, send_data, len, &cnt, USB_TIMEOUT);
181 if (err) {
182 fprintf(stderr, "Can't send data: %s\n", usb_strerror(err));
183 return 0;
184 }
185
186 if (done) {
187 if (!hmcfgusb_send_null_frame(usbdev, 0)) {
188 return 0;
189 }
190 }
191
192 gettimeofday(&tv_end, NULL);
193 msec = ((tv_end.tv_sec-tv_start.tv_sec)*1000)+((tv_end.tv_usec-tv_start.tv_usec)/1000);
194
195 if (msec > 100) {
196 fprintf(stderr, "usb-transfer took more than 100ms (%dms), this may lead to timing problems!\n", msec);
197 } else if (debug) {
198 fprintf(stderr, "usb-transfer took %dms!\n", msec);
199 }
200
201 return 1;
202 }
203
204 static struct libusb_transfer *hmcfgusb_prepare_int(libusb_device_handle *devh, libusb_transfer_cb_fn cb, void *data, int in_size)
205 {
206 unsigned char *data_buf;
207 struct libusb_transfer *transfer;
208 int err;
209
210 data_buf = malloc(in_size);
211 if (!data_buf) {
212 fprintf(stderr, "Can't allocate memory for data-buffer!\n");
213 return NULL;
214 }
215
216 transfer = libusb_alloc_transfer(0);
217 if (!transfer) {
218 fprintf(stderr, "Can't allocate memory for usb-transfer!\n");
219 free(data_buf);
220 return NULL;
221 }
222
223 libusb_fill_interrupt_transfer(transfer, devh, EP_IN,
224 data_buf, in_size, cb, data, USB_TIMEOUT);
225
226 transfer->flags = LIBUSB_TRANSFER_SHORT_NOT_OK | LIBUSB_TRANSFER_FREE_BUFFER;
227
228 err = libusb_submit_transfer(transfer);
229 if (err != 0) {
230 fprintf(stderr, "Can't submit transfer: %s\n", usb_strerror(err));
231 libusb_free_transfer(transfer);
232 return NULL;
233 }
234
235 return transfer;
236 }
237
238 struct hmcfgusb_cb_data {
239 struct hmcfgusb_dev *dev;
240 hmcfgusb_cb_fn cb;
241 void *data;
242 };
243
244 static void LIBUSB_CALL hmcfgusb_interrupt(struct libusb_transfer *transfer)
245 {
246 int err;
247 struct hmcfgusb_cb_data *cb_data;
248
249 cb_data = transfer->user_data;
250
251 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
252 if (transfer->status != LIBUSB_TRANSFER_TIMED_OUT) {
253 fprintf(stderr, "Interrupt transfer not completed: %s!\n", usb_strerror(transfer->status));
254 quit = EIO;
255
256 if (cb_data && cb_data->dev && cb_data->dev->transfer) {
257 libusb_free_transfer(cb_data->dev->transfer);
258 cb_data->dev->transfer = NULL;
259 free(cb_data);
260 }
261 return;
262 }
263 } else {
264 if (cb_data && cb_data->cb) {
265 if (debug)
266 hexdump(transfer->buffer, transfer->actual_length, "USB > ");
267
268 if (!cb_data->cb(transfer->buffer, transfer->actual_length, cb_data->data)) {
269 quit = EIO;
270
271 if (cb_data && cb_data->dev && cb_data->dev->transfer) {
272 libusb_free_transfer(cb_data->dev->transfer);
273 cb_data->dev->transfer = NULL;
274 free(cb_data);
275 }
276
277 return;
278 }
279 } else {
280 hexdump(transfer->buffer, transfer->actual_length, "> ");
281 }
282 }
283
284 err = libusb_submit_transfer(transfer);
285 if (err != 0) {
286 fprintf(stderr, "Can't re-submit transfer: %s\n", usb_strerror(err));
287 libusb_free_transfer(transfer);
288 cb_data->dev->transfer = NULL;
289 free(cb_data);
290 }
291 }
292
293 struct hmcfgusb_dev *hmcfgusb_init(hmcfgusb_cb_fn cb, void *data)
294 {
295 libusb_device_handle *devh = NULL;
296 const struct libusb_pollfd **usb_pfd = NULL;
297 struct hmcfgusb_dev *dev = NULL;
298 struct hmcfgusb_cb_data *cb_data = NULL;
299 int bootloader = 0;
300 int err;
301 int i;
302
303 err = libusb_init(NULL);
304 if (err != 0) {
305 fprintf(stderr, "Can't initialize libusb: %s\n", usb_strerror(err));
306 return NULL;
307 }
308
309 devh = hmcfgusb_find(ID_VENDOR, ID_PRODUCT);
310 if (!devh) {
311 devh = hmcfgusb_find(ID_VENDOR, ID_PRODUCT_BL);
312 if (!devh) {
313 fprintf(stderr, "Can't find/open hmcfgusb!\n");
314 libusb_exit(NULL);
315 return NULL;
316 }
317 bootloader = 1;
318 }
319
320 dev = malloc(sizeof(struct hmcfgusb_dev));
321 if (!dev) {
322 perror("Can't allocate memory for hmcfgusb_dev");
323 libusb_close(devh);
324 libusb_exit(NULL);
325 return NULL;
326 }
327
328 memset(dev, 0, sizeof(struct hmcfgusb_dev));
329 dev->usb_devh = devh;
330 dev->bootloader = bootloader;
331 dev->opened_at = time(NULL);
332
333 cb_data = malloc(sizeof(struct hmcfgusb_cb_data));
334 if (!cb_data) {
335 perror("Can't allocate memory for hmcfgusb_cb_data");
336 free(dev);
337 libusb_close(devh);
338 libusb_exit(NULL);
339 return NULL;
340 }
341
342 memset(cb_data, 0, sizeof(struct hmcfgusb_cb_data));
343
344 cb_data->dev = dev;
345 cb_data->cb = cb;
346 cb_data->data = data;
347
348 /* Bootloader can only say ack/nack/done */
349 if (dev->bootloader)
350 dev->transfer = hmcfgusb_prepare_int(devh, hmcfgusb_interrupt, cb_data, 1);
351 else
352 dev->transfer = hmcfgusb_prepare_int(devh, hmcfgusb_interrupt, cb_data, ASYNC_SIZE);
353
354 if (!dev->transfer) {
355 fprintf(stderr, "Can't prepare async device io!\n");
356 free(dev);
357 free(cb_data);
358 libusb_close(devh);
359 libusb_exit(NULL);
360 return NULL;
361 }
362
363 usb_pfd = libusb_get_pollfds(NULL);
364 if (!usb_pfd) {
365 fprintf(stderr, "Can't get FDset from libusb!\n");
366 free(dev);
367 free(cb_data);
368 libusb_close(devh);
369 libusb_exit(NULL);
370 return NULL;
371 }
372
373 dev->n_usb_pfd = 0;
374 for(i = 0; usb_pfd[i]; i++)
375 dev->n_usb_pfd++;
376
377 dev->pfd = malloc(dev->n_usb_pfd * sizeof(struct pollfd));
378 if (!dev->pfd) {
379 perror("Can't allocate memory for poll-fds");
380 free(dev);
381 free(cb_data);
382 libusb_close(devh);
383 libusb_exit(NULL);
384 return NULL;
385 }
386
387 memset(dev->pfd, 0, dev->n_usb_pfd * sizeof(struct pollfd));
388
389 for (i = 0; i < dev->n_usb_pfd; i++) {
390 dev->pfd[i].fd = usb_pfd[i]->fd;
391 dev->pfd[i].events = usb_pfd[i]->events;
392 dev->pfd[i].revents = 0;
393 }
394
395 free(usb_pfd);
396
397 dev->n_pfd = dev->n_usb_pfd;
398
399 quit = 0;
400
401 return dev;
402 }
403
404 int hmcfgusb_add_pfd(struct hmcfgusb_dev *dev, int fd, short events)
405 {
406 dev->n_pfd++;
407 dev->pfd = realloc(dev->pfd, dev->n_pfd * sizeof(struct pollfd));
408 if (!dev->pfd) {
409 perror("Can't realloc poll-fds");
410 return 0;
411 }
412
413 dev->pfd[dev->n_pfd-1].fd = fd;
414 dev->pfd[dev->n_pfd-1].events = events;
415 dev->pfd[dev->n_pfd-1].revents = 0;
416
417 return 1;
418 }
419
420 int hmcfgusb_poll(struct hmcfgusb_dev *dev, int timeout)
421 {
422 struct timeval tv;
423 int usb_event = 0;
424 int timed_out = 0;
425 int i;
426 int n;
427 int fd_n;
428 int err;
429
430 errno = 0;
431
432 memset(&tv, 0, sizeof(tv));
433 err = libusb_get_next_timeout(NULL, &tv);
434 if (err < 0) {
435 fprintf(stderr, "libusb_get_next_timeout: %s\n", usb_strerror(err));
436 errno = EIO;
437 return -1;
438 } else if (err == 0) {
439 /* No pending timeout or a sane platform */
440 tv.tv_sec = timeout;
441 } else {
442 if ((tv.tv_sec == 0) && (tv.tv_usec == 0)) {
443 usb_event = 1;
444 } else if (tv.tv_sec > timeout) {
445 tv.tv_sec = timeout;
446 tv.tv_usec = 0;
447 }
448 }
449
450 if (!usb_event) {
451 for (i = 0; i < dev->n_pfd; i++) {
452 dev->pfd[i].revents = 0;
453 }
454
455 n = poll(dev->pfd, dev->n_pfd, tv.tv_sec * 1000);
456 if (n < 0) {
457 perror("poll");
458 errno = 0;
459 return -1;
460 } else if (n == 0) {
461 usb_event = 1;
462 timed_out = 1;
463 } else {
464 for (fd_n = 0; fd_n < dev->n_pfd; fd_n++) {
465 if (dev->pfd[fd_n].revents) {
466 if (fd_n < dev->n_usb_pfd) {
467 usb_event = 1;
468 break;
469 } else {
470 errno = 0;
471 return dev->pfd[fd_n].fd;
472 }
473 }
474 }
475 }
476 }
477
478 if (usb_event) {
479 memset(&tv, 0, sizeof(tv));
480 err = libusb_handle_events_timeout_completed(NULL, &tv, NULL);
481 if (err < 0) {
482 fprintf(stderr, "libusb_handle_events_timeout_completed: %s\n", usb_strerror(err));
483 errno = EIO;
484 return -1;
485 }
486 }
487
488 errno = 0;
489 if (quit) {
490 fprintf(stderr, "closing device-connection due to error %d\n", quit);
491 errno = quit;
492 }
493
494 if (timed_out)
495 errno = ETIMEDOUT;
496
497 return -1;
498 }
499
500 void hmcfgusb_enter_bootloader(struct hmcfgusb_dev *dev)
501 {
502 uint8_t out[ASYNC_SIZE];
503
504 if (dev->bootloader) {
505 fprintf(stderr, "request for bootloader mode, but device already in bootloader!\n");
506 return;
507 }
508
509 memset(out, 0, sizeof(out));
510 out[0] = 'B';
511 hmcfgusb_send(dev, out, sizeof(out), 1);
512
513 return;
514 }
515
516 void hmcfgusb_leave_bootloader(struct hmcfgusb_dev *dev)
517 {
518 uint8_t out[ASYNC_SIZE];
519
520 if (!dev->bootloader) {
521 fprintf(stderr, "request for leaving bootloader mode, but device already in normal mode!\n");
522 return;
523 }
524
525 memset(out, 0, sizeof(out));
526 out[0] = 'K';
527 hmcfgusb_send(dev, out, sizeof(out), 1);
528
529 return;
530 }
531
532 void hmcfgusb_close(struct hmcfgusb_dev *dev)
533 {
534 int err;
535
536 if (dev->transfer) {
537 libusb_cancel_transfer(dev->transfer);
538 }
539
540 err = libusb_release_interface(dev->usb_devh, INTERFACE);
541 if ((err != 0)) {
542 fprintf(stderr, "Can't release interface: %s\n", usb_strerror(err));
543 }
544
545 libusb_close(dev->usb_devh);
546 free(dev->pfd);
547 free(dev);
548
549 libusb_exit(NULL);
550 }
551
552 void hmcfgusb_set_debug(int d)
553 {
554 debug = d;
555 }
Impressum, Datenschutz