3c7c5b4fbdc330506da2b8bc3b1c1fd1cc053459
[libam7xxx.git] / src / am7xxx.c
1 /* am7xxx - communication with AM7xxx based USB Pico Projectors and DPFs
2  *
3  * Copyright (C) 2012  Antonio Ospite <ospite@studenti.unina.it>
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #include <stdio.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include <stdarg.h>
23 #include <errno.h>
24 #include <libusb.h>
25 #include <math.h>
26
27 #include "am7xxx.h"
28 #include "serialize.h"
29
30 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
31
32 /* If we're not using GNU C, elide __attribute__
33  * taken from: http://unixwiz.net/techtips/gnu-c-attributes.html)
34  */
35 #ifndef __GNUC__
36 #  define  __attribute__(x)  /*NOTHING*/
37 #endif
38
39 /* Control shared library symbols visibility */
40 #if defined _WIN32 || defined __CYGWIN__
41         #define AM7XXX_PUBLIC __declspec(dllexport)
42         #define AM7XXX_LOCAL
43 #else
44         #if __GNUC__ >= 4
45                 #define AM7XXX_PUBLIC __attribute__ ((visibility ("default")))
46                 #define AM7XXX_LOCAL  __attribute__ ((visibility ("hidden")))
47         #else
48                 #define AM7XXX_PUBLIC
49                 #define AM7XXX_LOCAL
50         #endif
51 #endif
52
53 static void log_message(am7xxx_context *ctx,
54                         int level,
55                         const char *function,
56                         int line,
57                         const char *fmt,
58                         ...) __attribute__ ((format (printf, 5, 6)));
59
60 #define fatal(...)        log_message(NULL, AM7XXX_LOG_FATAL,   __func__, __LINE__, __VA_ARGS__)
61 #define error(ctx, ...)   log_message(ctx,  AM7XXX_LOG_ERROR,   __func__, __LINE__, __VA_ARGS__)
62 #define warning(ctx, ...) log_message(ctx,  AM7XXX_LOG_WARNING, __func__, 0,        __VA_ARGS__)
63 #define info(ctx, ...)    log_message(ctx,  AM7XXX_LOG_INFO,    __func__, 0,        __VA_ARGS__)
64 #define debug(ctx, ...)   log_message(ctx,  AM7XXX_LOG_DEBUG,   __func__, 0,        __VA_ARGS__)
65 #define trace(ctx, ...)   log_message(ctx,  AM7XXX_LOG_TRACE,   NULL,     0,        __VA_ARGS__)
66
67 struct am7xxx_ops {
68         int (*set_power_mode)(am7xxx_device *dev, am7xxx_power_mode power);
69         int (*set_zoom_mode)(am7xxx_device *dev, am7xxx_zoom_mode zoom);
70 };
71
72 struct am7xxx_usb_device_descriptor {
73         const char *name;
74         uint16_t vendor_id;
75         uint16_t product_id;
76         uint8_t configuration;    /* The bConfigurationValue of the device */
77         uint8_t interface_number; /* The bInterfaceNumber of the device */
78         struct am7xxx_ops ops;
79 };
80
81 static int default_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power);
82 static int default_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom);
83
84 #define DEFAULT_OPS { \
85         .set_power_mode = default_set_power_mode, \
86         .set_zoom_mode = default_set_zoom_mode, \
87 }
88
89 static const struct am7xxx_usb_device_descriptor supported_devices[] = {
90         {
91                 .name       = "Acer C110",
92                 .vendor_id  = 0x1de1,
93                 .product_id = 0xc101,
94                 .configuration    = 2,
95                 .interface_number = 0,
96                 .ops = DEFAULT_OPS,
97         },
98         {
99                 .name       = "Acer C112",
100                 .vendor_id  = 0x1de1,
101                 .product_id = 0x5501,
102                 .configuration    = 2,
103                 .interface_number = 0,
104                 .ops = DEFAULT_OPS,
105         },
106         {
107                 .name       ="Aiptek PocketCinema T25",
108                 .vendor_id  = 0x08ca,
109                 .product_id = 0x2144,
110                 .configuration    = 2,
111                 .interface_number = 0,
112                 .ops = DEFAULT_OPS,
113         },
114         {
115                 .name       = "Philips/Sagemcom PicoPix 1020",
116                 .vendor_id  = 0x21e7,
117                 .product_id = 0x000e,
118                 .configuration    = 2,
119                 .interface_number = 0,
120                 .ops = DEFAULT_OPS,
121         },
122         {
123                 .name       = "Philips/Sagemcom PicoPix 2055",
124                 .vendor_id  = 0x21e7,
125                 .product_id = 0x0016,
126                 .configuration    = 2,
127                 .interface_number = 0,
128         },
129         {
130                 .name       = "Philips/Sagemcom PicoPix 2330",
131                 .vendor_id  = 0x21e7,
132                 .product_id = 0x0019,
133                 .configuration    = 1,
134                 .interface_number = 0,
135         },
136 };
137
138 /* The header size on the wire is known to be always 24 bytes, regardless of
139  * the memory configuration enforced by different architectures or compilers
140  * for struct am7xxx_header
141  */
142 #define AM7XXX_HEADER_WIRE_SIZE 24
143
144 struct _am7xxx_device {
145         libusb_device_handle *usb_device;
146         struct libusb_transfer *transfer;
147         int transfer_completed;
148         uint8_t buffer[AM7XXX_HEADER_WIRE_SIZE];
149         am7xxx_device_info *device_info;
150         am7xxx_context *ctx;
151         const struct am7xxx_usb_device_descriptor *desc;
152         am7xxx_device *next;
153 };
154
155 struct _am7xxx_context {
156         libusb_context *usb_context;
157         int log_level;
158         am7xxx_device *devices_list;
159 };
160
161 typedef enum {
162         AM7XXX_PACKET_TYPE_DEVINFO = 0x01,
163         AM7XXX_PACKET_TYPE_IMAGE   = 0x02,
164         AM7XXX_PACKET_TYPE_POWER   = 0x04,
165         AM7XXX_PACKET_TYPE_ZOOM    = 0x05,
166 } am7xxx_packet_type;
167
168 struct am7xxx_generic_header {
169         uint32_t field0;
170         uint32_t field1;
171         uint32_t field2;
172         uint32_t field3;
173 };
174
175 struct am7xxx_devinfo_header {
176         uint32_t native_width;
177         uint32_t native_height;
178         uint32_t unknown0;
179         uint32_t unknown1;
180 };
181
182 struct am7xxx_image_header {
183         uint32_t format;
184         uint32_t width;
185         uint32_t height;
186         uint32_t image_size;
187 };
188
189 struct am7xxx_power_header {
190         uint32_t bit2;
191         uint32_t bit1;
192         uint32_t bit0;
193 };
194
195 struct am7xxx_zoom_header {
196         uint32_t bit1;
197         uint32_t bit0;
198 };
199
200 /*
201  * Examples of packet headers:
202  *
203  * Image header:
204  * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
205  *
206  * Power header:
207  * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
208  */
209
210 /* Direction of the communication from the host point of view */
211 #define AM7XXX_DIRECTION_OUT 0 /* host -> device */
212 #define AM7XXX_DIRECTION_IN  1 /* host <- device */
213
214 struct am7xxx_header {
215         uint32_t packet_type;
216         uint8_t direction;
217         uint8_t header_data_len;
218         uint8_t unknown2;
219         uint8_t unknown3;
220         union {
221                 struct am7xxx_generic_header data;
222                 struct am7xxx_devinfo_header devinfo;
223                 struct am7xxx_image_header image;
224                 struct am7xxx_power_header power;
225                 struct am7xxx_zoom_header zoom;
226         } header_data;
227 };
228
229
230 #ifdef DEBUG
231 static void debug_dump_devinfo_header(am7xxx_context *ctx, struct am7xxx_devinfo_header *d)
232 {
233         if (ctx == NULL || d == NULL)
234                 return;
235
236         debug(ctx, "Info header:\n");
237         debug(ctx, "\tnative_width:  0x%08x (%u)\n", d->native_width, d->native_width);
238         debug(ctx, "\tnative_height: 0x%08x (%u)\n", d->native_height, d->native_height);
239         debug(ctx, "\tunknown0:      0x%08x (%u)\n", d->unknown0, d->unknown0);
240         debug(ctx, "\tunknown1:      0x%08x (%u)\n", d->unknown1, d->unknown1);
241 }
242
243 static void debug_dump_image_header(am7xxx_context *ctx, struct am7xxx_image_header *i)
244 {
245         if (ctx == NULL || i == NULL)
246                 return;
247
248         debug(ctx, "Image header:\n");
249         debug(ctx, "\tformat:     0x%08x (%u)\n", i->format, i->format);
250         debug(ctx, "\twidth:      0x%08x (%u)\n", i->width, i->width);
251         debug(ctx, "\theight:     0x%08x (%u)\n", i->height, i->height);
252         debug(ctx, "\timage size: 0x%08x (%u)\n", i->image_size, i->image_size);
253 }
254
255 static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_header *p)
256 {
257         if (ctx == NULL || p == NULL)
258                 return;
259
260         debug(ctx, "Power header:\n");
261         debug(ctx, "\tbit2: 0x%08x (%u)\n", p->bit2, p->bit2);
262         debug(ctx, "\tbit1: 0x%08x (%u)\n", p->bit1, p->bit1);
263         debug(ctx, "\tbit0: 0x%08x (%u)\n", p->bit0, p->bit0);
264 }
265
266 static void debug_dump_zoom_header(am7xxx_context *ctx, struct am7xxx_zoom_header *z)
267 {
268         if (ctx == NULL || z == NULL)
269                 return;
270
271         debug(ctx, "Zoom header:\n");
272         debug(ctx, "\tbit1: 0x%08x (%u)\n", z->bit1, z->bit1);
273         debug(ctx, "\tbit0: 0x%08x (%u)\n", z->bit0, z->bit0);
274 }
275
276 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
277 {
278         if (ctx == NULL || h == NULL)
279                 return;
280
281         debug(ctx, "BEGIN\n");
282         debug(ctx, "packet_type:     0x%08x (%u)\n", h->packet_type, h->packet_type);
283         debug(ctx, "direction:       0x%02hhx (%hhu) (%s)\n", h->direction, h->direction,
284               h->direction == AM7XXX_DIRECTION_IN ? "IN" :
285               h->direction == AM7XXX_DIRECTION_OUT ? "OUT" :
286               "UNKNOWN");
287         debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
288         debug(ctx, "unknown2:        0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
289         debug(ctx, "unknown3:        0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
290
291         switch(h->packet_type) {
292         case AM7XXX_PACKET_TYPE_DEVINFO:
293                 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
294                 break;
295
296         case AM7XXX_PACKET_TYPE_IMAGE:
297                 debug_dump_image_header(ctx, &(h->header_data.image));
298                 break;
299
300         case AM7XXX_PACKET_TYPE_POWER:
301                 debug_dump_power_header(ctx, &(h->header_data.power));
302                 break;
303
304         case AM7XXX_PACKET_TYPE_ZOOM:
305                 debug_dump_zoom_header(ctx, &(h->header_data.zoom));
306                 break;
307
308         default:
309                 debug(ctx, "Packet type not supported!\n");
310                 break;
311         }
312         debug(ctx, "END\n\n");
313 }
314
315 static inline unsigned int in_80chars(unsigned int i)
316 {
317         /* The 3 below is the length of "xx " where xx is the hex string
318          * representation of a byte */
319         return ((i+1) % (80/3));
320 }
321
322 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
323                               uint8_t *buffer, unsigned int len)
324 {
325         unsigned int i;
326
327         if (ctx == NULL || buffer == NULL || len == 0)
328                 return;
329
330         trace(ctx, "\n");
331         if (message)
332                 trace(ctx, "%s\n", message);
333
334         for (i = 0; i < len; i++) {
335                 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
336         }
337         trace(ctx, "\n");
338 }
339 #else
340 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
341 {
342         (void)ctx;
343         (void)h;
344 }
345
346 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
347                               uint8_t *buffer, unsigned int len)
348 {
349         (void)ctx;
350         (void)message;
351         (void)buffer;
352         (void)len;
353 }
354 #endif /* DEBUG */
355
356 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
357 {
358         int ret;
359         int transferred = 0;
360
361         ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
362         if (ret != 0 || (unsigned int)transferred != len) {
363                 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
364                       ret, transferred, len);
365                 return ret;
366         }
367
368         trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
369
370         return 0;
371 }
372
373 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
374 {
375         int ret;
376         int transferred = 0;
377
378         trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
379
380         ret = libusb_bulk_transfer(dev->usb_device, 0x1, buffer, len, &transferred, 0);
381         if (ret != 0 || (unsigned int)transferred != len) {
382                 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
383                       ret, transferred, len);
384                 return ret;
385         }
386
387         return 0;
388 }
389
390 static void send_data_async_complete_cb(struct libusb_transfer *transfer)
391 {
392         am7xxx_device *dev = (am7xxx_device *)(transfer->user_data);
393         int *completed = &(dev->transfer_completed);
394         int transferred = transfer->actual_length;
395         int ret;
396
397         if (transferred != transfer->length) {
398                 error(dev->ctx, "transferred: %d (expected %u)\n",
399                       transferred, transfer->length);
400         }
401
402         switch (transfer->status) {
403         case LIBUSB_TRANSFER_COMPLETED:
404                 ret = 0;
405                 break;
406         case LIBUSB_TRANSFER_TIMED_OUT:
407                 ret = LIBUSB_ERROR_TIMEOUT;
408                 break;
409         case LIBUSB_TRANSFER_STALL:
410                 ret = LIBUSB_ERROR_PIPE;
411                 break;
412         case LIBUSB_TRANSFER_OVERFLOW:
413                 ret = LIBUSB_ERROR_OVERFLOW;
414                 break;
415         case LIBUSB_TRANSFER_NO_DEVICE:
416                 ret = LIBUSB_ERROR_NO_DEVICE;
417                 break;
418         case LIBUSB_TRANSFER_ERROR:
419         case LIBUSB_TRANSFER_CANCELLED:
420                 ret = LIBUSB_ERROR_IO;
421                 break;
422         default:
423                 error(dev->ctx, "unrecognised status code %d", transfer->status);
424                 ret = LIBUSB_ERROR_OTHER;
425         }
426
427         if (ret < 0)
428                 error(dev->ctx, "libusb transfer failed: %s",
429                       libusb_error_name(ret));
430
431         libusb_free_transfer(transfer);
432         transfer = NULL;
433
434         *completed = 1;
435 }
436
437 static inline void wait_for_trasfer_completed(am7xxx_device *dev)
438 {
439         while (!dev->transfer_completed) {
440                 int ret = libusb_handle_events_completed(dev->ctx->usb_context,
441                                                          &(dev->transfer_completed));
442                 if (ret < 0) {
443                         if (ret == LIBUSB_ERROR_INTERRUPTED)
444                                 continue;
445                         error(dev->ctx, "libusb_handle_events failed: %s, cancelling transfer and retrying",
446                               libusb_error_name(ret));
447                         libusb_cancel_transfer(dev->transfer);
448                         continue;
449                 }
450         }
451 }
452
453 static int send_data_async(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
454 {
455         int ret;
456         uint8_t *transfer_buffer;
457
458         dev->transfer = libusb_alloc_transfer(0);
459         if (dev->transfer == NULL) {
460                 error(dev->ctx, "cannot allocate transfer (%s)\n",
461                       strerror(errno));
462                 return -ENOMEM;
463         }
464
465         /* Make a copy of the buffer so the caller can safely reuse it just
466          * after libusb_submit_transfer() has returned. This technique
467          * requires more allocations than a proper double-buffering approach
468          * but it takes a lot less code. */
469         transfer_buffer = malloc(len);
470         if (transfer_buffer == NULL) {
471                 error(dev->ctx, "cannot allocate transfer buffer (%s)\n",
472                       strerror(errno));
473                 ret = -ENOMEM;
474                 goto err;
475         }
476         memcpy(transfer_buffer, buffer, len);
477
478         dev->transfer->flags |= LIBUSB_TRANSFER_FREE_BUFFER;
479         libusb_fill_bulk_transfer(dev->transfer, dev->usb_device, 0x1,
480                                   transfer_buffer, len,
481                                   send_data_async_complete_cb, dev, 0);
482
483         /* wait for the previous transfer to complete */
484         wait_for_trasfer_completed(dev);
485
486         trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
487
488         dev->transfer_completed = 0;
489         ret = libusb_submit_transfer(dev->transfer);
490         if (ret < 0)
491                 goto err;
492
493         return 0;
494
495 err:
496         libusb_free_transfer(dev->transfer);
497         dev->transfer = NULL;
498         return ret;
499 }
500
501 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
502 {
503         uint8_t **buffer_iterator = &buffer;
504
505         put_le32(h->packet_type, buffer_iterator);
506         put_8(h->direction, buffer_iterator);
507         put_8(h->header_data_len, buffer_iterator);
508         put_8(h->unknown2, buffer_iterator);
509         put_8(h->unknown3, buffer_iterator);
510         put_le32(h->header_data.data.field0, buffer_iterator);
511         put_le32(h->header_data.data.field1, buffer_iterator);
512         put_le32(h->header_data.data.field2, buffer_iterator);
513         put_le32(h->header_data.data.field3, buffer_iterator);
514 }
515
516 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
517 {
518         uint8_t **buffer_iterator = &buffer;
519
520         h->packet_type = get_le32(buffer_iterator);
521         h->direction = get_8(buffer_iterator);
522         h->header_data_len = get_8(buffer_iterator);
523         h->unknown2 = get_8(buffer_iterator);
524         h->unknown3 = get_8(buffer_iterator);
525         h->header_data.data.field0 = get_le32(buffer_iterator);
526         h->header_data.data.field1 = get_le32(buffer_iterator);
527         h->header_data.data.field2 = get_le32(buffer_iterator);
528         h->header_data.data.field3 = get_le32(buffer_iterator);
529 }
530
531 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
532 {
533         int ret;
534
535         ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
536         if (ret < 0)
537                 goto out;
538
539         unserialize_header(dev->buffer, h);
540
541         if (h->direction == AM7XXX_DIRECTION_IN) {
542                 ret = 0;
543         } else {
544                 error(dev->ctx,
545                       "Expected an AM7XXX_DIRECTION_IN packet, got one with direction = %d. Weird!\n",
546                       h->direction);
547                 ret = -EINVAL;
548         }
549
550         debug_dump_header(dev->ctx, h);
551
552 out:
553         return ret;
554 }
555
556 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
557 {
558         int ret;
559
560         debug_dump_header(dev->ctx, h);
561
562         /* For symmetry with read_header() we should check here for
563          * h->direction == AM7XXX_DIRECTION_OUT but we just ensure that in all
564          * the callers and save some cycles here.
565          */
566
567         serialize_header(h, dev->buffer);
568
569         ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
570         if (ret < 0)
571                 error(dev->ctx, "failed to send data\n");
572
573         return ret;
574 }
575
576 static int send_command(am7xxx_device *dev, am7xxx_packet_type type)
577 {
578         struct am7xxx_header h = {
579                 .packet_type     = type,
580                 .direction       = AM7XXX_DIRECTION_OUT,
581                 .header_data_len = 0x00,
582                 .unknown2        = 0x3e,
583                 .unknown3        = 0x10,
584                 .header_data = {
585                         .data = {
586                                 .field0 = 0,
587                                 .field1 = 0,
588                                 .field2 = 0,
589                                 .field3 = 0,
590                         },
591                 },
592         };
593
594         return send_header(dev, &h);
595 }
596
597
598 /* When level == AM7XXX_LOG_FATAL do not check the log_level from the context
599  * and print the message unconditionally, this makes it possible to print
600  * fatal messages even early on initialization, before the context has been
601  * set up */
602 static void log_message(am7xxx_context *ctx,
603                         int level,
604                         const char *function,
605                         int line,
606                         const char *fmt,
607                         ...)
608 {
609         va_list ap;
610
611         if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
612                 if (function) {
613                         fprintf(stderr, "%s", function);
614                         if (line)
615                                 fprintf(stderr, "[%d]", line);
616                         fprintf(stderr, ": ");
617                 }
618
619                 va_start(ap, fmt);
620                 vfprintf(stderr, fmt, ap);
621                 va_end(ap);
622         }
623
624         return;
625 }
626
627 static am7xxx_device *add_new_device(am7xxx_context *ctx,
628                                      const struct am7xxx_usb_device_descriptor *desc)
629 {
630         am7xxx_device **devices_list;
631         am7xxx_device *new_device;
632
633         if (ctx == NULL) {
634                 fatal("context must not be NULL!\n");
635                 return NULL;
636         }
637
638         new_device = malloc(sizeof(*new_device));
639         if (new_device == NULL) {
640                 fatal("cannot allocate a new device (%s)\n", strerror(errno));
641                 return NULL;
642         }
643         memset(new_device, 0, sizeof(*new_device));
644
645         new_device->ctx = ctx;
646         new_device->desc = desc;
647         new_device->transfer_completed = 1;
648
649         devices_list = &(ctx->devices_list);
650
651         if (*devices_list == NULL) {
652                 *devices_list = new_device;
653         } else {
654                 am7xxx_device *prev = *devices_list;
655                 while (prev->next)
656                         prev = prev->next;
657                 prev->next = new_device;
658         }
659         return new_device;
660 }
661
662 static am7xxx_device *find_device(am7xxx_context *ctx,
663                                   unsigned int device_index)
664 {
665         unsigned int i = 0;
666         am7xxx_device *current;
667
668         if (ctx == NULL) {
669                 fatal("context must not be NULL!\n");
670                 return NULL;
671         }
672
673         current = ctx->devices_list;
674         while (current && i++ < device_index)
675                 current = current->next;
676
677         return current;
678 }
679
680 typedef enum {
681         SCAN_OP_BUILD_DEVLIST,
682         SCAN_OP_OPEN_DEVICE,
683 } scan_op;
684
685 /**
686  * This is where the central logic of multi-device support is.
687  *
688  * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
689  * 'dev' are ignored; the function returns 0 on success and a negative value
690  * on error.
691  *
692  * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
693  * device with index 'open_device_index' and returns the correspondent
694  * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
695  * 1 if the device was already open and a negative value on error.
696  *
697  * NOTES:
698  * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
699  * the caller might want to call am7xxx_shutdown() in order to remove
700  * devices possibly added before the failure.
701  */
702 static int scan_devices(am7xxx_context *ctx, scan_op op,
703                         unsigned int open_device_index, am7xxx_device **dev)
704 {
705         ssize_t num_devices;
706         libusb_device** list;
707         unsigned int current_index;
708         int i;
709         int ret;
710
711         if (ctx == NULL) {
712                 fatal("context must not be NULL!\n");
713                 return -EINVAL;
714         }
715         if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
716                 error(ctx, "device scan done already? Abort!\n");
717                 return -EINVAL;
718         }
719
720         num_devices = libusb_get_device_list(ctx->usb_context, &list);
721         if (num_devices < 0) {
722                 ret = -ENODEV;
723                 goto out;
724         }
725
726         current_index = 0;
727         for (i = 0; i < num_devices; i++) {
728                 struct libusb_device_descriptor desc;
729                 unsigned int j;
730
731                 ret = libusb_get_device_descriptor(list[i], &desc);
732                 if (ret < 0)
733                         continue;
734
735                 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
736                         if (desc.idVendor == supported_devices[j].vendor_id &&
737                             desc.idProduct == supported_devices[j].product_id) {
738
739                                 if (op == SCAN_OP_BUILD_DEVLIST) {
740                                         am7xxx_device *new_device;
741                                         info(ctx, "am7xxx device found, index: %d, name: %s\n",
742                                              current_index,
743                                              supported_devices[j].name);
744                                         new_device = add_new_device(ctx, &supported_devices[j]);
745                                         if (new_device == NULL) {
746                                                 /* XXX, the caller may want
747                                                  * to call am7xxx_shutdown() if
748                                                  * we fail here, as we may have
749                                                  * added some devices already
750                                                  */
751                                                 debug(ctx, "Cannot create a new device\n");
752                                                 ret = -ENODEV;
753                                                 goto out;
754                                         }
755                                 } else if (op == SCAN_OP_OPEN_DEVICE &&
756                                            current_index == open_device_index) {
757
758                                         *dev = find_device(ctx, open_device_index);
759                                         if (*dev == NULL) {
760                                                 ret = -ENODEV;
761                                                 goto out;
762                                         }
763
764                                         /* the usb device has already been opened */
765                                         if ((*dev)->usb_device) {
766                                                 debug(ctx, "(*dev)->usb_device already set\n");
767                                                 ret = 1;
768                                                 goto out;
769                                         }
770
771                                         ret = libusb_open(list[i], &((*dev)->usb_device));
772                                         if (ret < 0) {
773                                                 debug(ctx, "libusb_open failed\n");
774                                                 goto out;
775                                         }
776
777                                         /* XXX, the device is now open, if any
778                                          * of the calls below fail we need to
779                                          * close it again before bailing out.
780                                          */
781
782                                         ret = libusb_set_configuration((*dev)->usb_device,
783                                                                        (*dev)->desc->configuration);
784                                         if (ret < 0) {
785                                                 debug(ctx, "libusb_set_configuration failed\n");
786                                                 debug(ctx, "Cannot set configuration %hhu\n",
787                                                       (*dev)->desc->configuration);
788                                                 goto out_libusb_close;
789                                         }
790
791                                         ret = libusb_claim_interface((*dev)->usb_device,
792                                                                      (*dev)->desc->interface_number);
793                                         if (ret < 0) {
794                                                 debug(ctx, "libusb_claim_interface failed\n");
795                                                 debug(ctx, "Cannot claim interface %hhu\n",
796                                                       (*dev)->desc->interface_number);
797 out_libusb_close:
798                                                 libusb_close((*dev)->usb_device);
799                                                 (*dev)->usb_device = NULL;
800                                                 goto out;
801                                         }
802
803                                         goto out;
804                                 }
805                                 current_index++;
806                         }
807                 }
808         }
809
810         /* if we made it up to here we didn't find any device to open */
811         if (op == SCAN_OP_OPEN_DEVICE) {
812                 error(ctx, "Cannot find any device to open\n");
813                 ret = -ENODEV;
814                 goto out;
815         }
816
817         /* everything went fine when building the device list */
818         ret = 0;
819 out:
820         libusb_free_device_list(list, 1);
821         return ret;
822 }
823
824 /* Device specific operations */
825
826 static int default_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
827 {
828         int ret;
829         struct am7xxx_header h = {
830                 .packet_type     = AM7XXX_PACKET_TYPE_POWER,
831                 .direction       = AM7XXX_DIRECTION_OUT,
832                 .header_data_len = sizeof(struct am7xxx_power_header),
833                 .unknown2        = 0x3e,
834                 .unknown3        = 0x10,
835         };
836
837         switch(power) {
838         case AM7XXX_POWER_OFF:
839                 h.header_data.power.bit2 = 0;
840                 h.header_data.power.bit1 = 0;
841                 h.header_data.power.bit0 = 0;
842                 break;
843
844         case AM7XXX_POWER_LOW:
845                 h.header_data.power.bit2 = 0;
846                 h.header_data.power.bit1 = 0;
847                 h.header_data.power.bit0 = 1;
848                 break;
849
850         case AM7XXX_POWER_MIDDLE:
851                 h.header_data.power.bit2 = 0;
852                 h.header_data.power.bit1 = 1;
853                 h.header_data.power.bit0 = 0;
854                 break;
855
856         case AM7XXX_POWER_HIGH:
857                 h.header_data.power.bit2 = 0;
858                 h.header_data.power.bit1 = 1;
859                 h.header_data.power.bit0 = 1;
860                 break;
861
862         case AM7XXX_POWER_TURBO:
863                 h.header_data.power.bit2 = 1;
864                 h.header_data.power.bit1 = 0;
865                 h.header_data.power.bit0 = 0;
866                 break;
867
868         default:
869                 error(dev->ctx, "Unsupported power mode.\n");
870                 return -EINVAL;
871         };
872
873         ret = send_header(dev, &h);
874         if (ret < 0)
875                 return ret;
876
877         return 0;
878 }
879
880 static int default_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
881 {
882         int ret;
883         struct am7xxx_header h = {
884                 .packet_type     = AM7XXX_PACKET_TYPE_ZOOM,
885                 .direction       = AM7XXX_DIRECTION_OUT,
886                 .header_data_len = sizeof(struct am7xxx_zoom_header),
887                 .unknown2        = 0x3e,
888                 .unknown3        = 0x10,
889         };
890
891         switch(zoom) {
892         case AM7XXX_ZOOM_ORIGINAL:
893                 h.header_data.zoom.bit1 = 0;
894                 h.header_data.zoom.bit0 = 0;
895                 break;
896
897         case AM7XXX_ZOOM_H:
898                 h.header_data.zoom.bit1 = 0;
899                 h.header_data.zoom.bit0 = 1;
900                 break;
901
902         case AM7XXX_ZOOM_H_V:
903                 h.header_data.zoom.bit1 = 1;
904                 h.header_data.zoom.bit0 = 0;
905                 break;
906
907         case AM7XXX_ZOOM_TEST:
908                 h.header_data.zoom.bit1 = 1;
909                 h.header_data.zoom.bit0 = 1;
910                 break;
911
912         default:
913                 error(dev->ctx, "Unsupported zoom mode.\n");
914                 return -EINVAL;
915         };
916
917         ret = send_header(dev, &h);
918         if (ret < 0)
919                 return ret;
920
921         return 0;
922 }
923
924 /* Public API */
925
926 AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
927 {
928         int ret;
929
930         *ctx = malloc(sizeof(**ctx));
931         if (*ctx == NULL) {
932                 fatal("cannot allocate the context (%s)\n", strerror(errno));
933                 ret = -ENOMEM;
934                 goto out;
935         }
936         memset(*ctx, 0, sizeof(**ctx));
937
938         /* Set the highest log level during initialization */
939         (*ctx)->log_level = AM7XXX_LOG_TRACE;
940
941         ret = libusb_init(&((*ctx)->usb_context));
942         if (ret < 0)
943                 goto out_free_context;
944
945         libusb_set_debug((*ctx)->usb_context, LIBUSB_LOG_LEVEL_INFO);
946
947         ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
948         if (ret < 0) {
949                 error(*ctx, "scan_devices() failed\n");
950                 am7xxx_shutdown(*ctx);
951                 goto out;
952         }
953
954         /* Set a quieter log level as default for normal operation */
955         (*ctx)->log_level = AM7XXX_LOG_ERROR;
956         return 0;
957
958 out_free_context:
959         free(*ctx);
960         *ctx = NULL;
961 out:
962         return ret;
963 }
964
965 AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
966 {
967         am7xxx_device *current;
968
969         if (ctx == NULL) {
970                 fatal("context must not be NULL!\n");
971                 return;
972         }
973
974         current = ctx->devices_list;
975         while (current) {
976                 am7xxx_device *next = current->next;
977                 am7xxx_close_device(current);
978                 free(current->device_info);
979                 free(current);
980                 current = next;
981         }
982
983         libusb_exit(ctx->usb_context);
984         free(ctx);
985         ctx = NULL;
986 }
987
988 AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
989 {
990         ctx->log_level = log_level;
991 }
992
993 AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
994                        unsigned int device_index)
995 {
996         int ret;
997
998         if (ctx == NULL) {
999                 fatal("context must not be NULL!\n");
1000                 return -EINVAL;
1001         }
1002
1003         ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
1004         if (ret < 0) {
1005                 errno = ENODEV;
1006                 goto out;
1007         } else if (ret > 0) {
1008                 warning(ctx, "device %d already open\n", device_index);
1009                 errno = EBUSY;
1010                 ret = -EBUSY;
1011                 goto out;
1012         }
1013
1014         /* Philips/Sagemcom PicoPix projectors require that the DEVINFO packet
1015          * is the first one to be sent to the device in order for it to
1016          * successfully return the correct device information.
1017          *
1018          * So, if there is not a cached version of it (from a previous open),
1019          * we ask for device info at open time,
1020          */
1021         if ((*dev)->device_info == NULL) {
1022                 ret = am7xxx_get_device_info(*dev, NULL);
1023                 if (ret < 0)
1024                         error(ctx, "cannot get device info\n");
1025         }
1026
1027 out:
1028         return ret;
1029 }
1030
1031 AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
1032 {
1033         if (dev == NULL) {
1034                 fatal("dev must not be NULL!\n");
1035                 return -EINVAL;
1036         }
1037         if (dev->usb_device) {
1038                 wait_for_trasfer_completed(dev);
1039                 libusb_release_interface(dev->usb_device, dev->desc->interface_number);
1040                 libusb_close(dev->usb_device);
1041                 dev->usb_device = NULL;
1042         }
1043         return 0;
1044 }
1045
1046 AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
1047                            am7xxx_device_info *device_info)
1048 {
1049         int ret;
1050         struct am7xxx_header h = { 0 };
1051
1052         if (dev->device_info) {
1053                 memcpy(device_info, dev->device_info, sizeof(*device_info));
1054                 return 0;
1055         }
1056
1057         ret = send_command(dev, AM7XXX_PACKET_TYPE_DEVINFO);
1058         if (ret < 0)
1059                 return ret;
1060
1061         ret = read_header(dev, &h);
1062         if (ret < 0)
1063                 return ret;
1064
1065         if (h.packet_type != AM7XXX_PACKET_TYPE_DEVINFO) {
1066                 error(dev->ctx, "expected packet type: %d, got %d instead!\n",
1067                       AM7XXX_PACKET_TYPE_DEVINFO, h.packet_type);
1068                 errno = ENOTSUP;
1069                 return -ENOTSUP;
1070         }
1071
1072         dev->device_info = malloc(sizeof(*dev->device_info));
1073         if (dev->device_info == NULL) {
1074                 error(dev->ctx, "cannot allocate a device info (%s)\n",
1075                        strerror(errno));
1076                 return -ENOMEM;
1077         }
1078         memset(dev->device_info, 0, sizeof(*dev->device_info));
1079
1080         dev->device_info->native_width = h.header_data.devinfo.native_width;
1081         dev->device_info->native_height = h.header_data.devinfo.native_height;
1082 #if 0
1083         /* No reason to expose these in the public API until we know what they mean */
1084         dev->device_info->unknown0 = h.header_data.devinfo.unknown0;
1085         dev->device_info->unknown1 = h.header_data.devinfo.unknown1;
1086 #endif
1087
1088         return 0;
1089 }
1090
1091 AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
1092                                         unsigned int upscale,
1093                                         unsigned int original_width,
1094                                         unsigned int original_height,
1095                                         unsigned int *scaled_width,
1096                                         unsigned int *scaled_height)
1097 {
1098
1099         am7xxx_device_info device_info;
1100         float width_ratio;
1101         float height_ratio;
1102         int ret;
1103
1104         ret = am7xxx_get_device_info(dev, &device_info);
1105         if (ret < 0) {
1106                 error(dev->ctx, "cannot get device info\n");
1107                 return ret;
1108         }
1109
1110         /*
1111          * Check if we need to rescale; if the input image fits the native
1112          * dimensions there is no need to, unless we want to upscale.
1113          */
1114         if (!upscale &&
1115             original_width <= device_info.native_width &&
1116             original_height <= device_info.native_height ) {
1117                 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
1118                 *scaled_width = original_width;
1119                 *scaled_height = original_height;
1120                 return 0;
1121         }
1122
1123         /* Input dimensions relative to the device native dimensions */
1124         width_ratio =  (float)original_width / device_info.native_width;
1125         height_ratio = (float)original_height / device_info.native_height;
1126
1127         if (width_ratio > height_ratio) {
1128                 /*
1129                  * The input is proportionally "wider" than the device viewport
1130                  * so its height needs to be adjusted
1131                  */
1132                 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
1133                 *scaled_width = device_info.native_width;
1134                 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
1135         } else if (width_ratio < height_ratio) {
1136                 /*
1137                  * The input is proportionally "taller" than the device viewport
1138                  * so its width needs to be adjusted
1139                  */
1140                 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
1141                 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
1142                 *scaled_height = device_info.native_height;
1143         } else {
1144                 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
1145                 *scaled_width = device_info.native_width;
1146                 *scaled_height = device_info.native_height;
1147         }
1148         debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
1149
1150         return 0;
1151 }
1152
1153 AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
1154                       am7xxx_image_format format,
1155                       unsigned int width,
1156                       unsigned int height,
1157                       uint8_t *image,
1158                       unsigned int image_size)
1159 {
1160         int ret;
1161         struct am7xxx_header h = {
1162                 .packet_type     = AM7XXX_PACKET_TYPE_IMAGE,
1163                 .direction       = AM7XXX_DIRECTION_OUT,
1164                 .header_data_len = sizeof(struct am7xxx_image_header),
1165                 .unknown2        = 0x3e,
1166                 .unknown3        = 0x10,
1167                 .header_data = {
1168                         .image = {
1169                                 .format     = format,
1170                                 .width      = width,
1171                                 .height     = height,
1172                                 .image_size = image_size,
1173                         },
1174                 },
1175         };
1176
1177         ret = send_header(dev, &h);
1178         if (ret < 0)
1179                 return ret;
1180
1181         if (image == NULL || image_size == 0) {
1182                 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
1183                 return 0;
1184         }
1185
1186         return send_data(dev, image, image_size);
1187 }
1188
1189 AM7XXX_PUBLIC int am7xxx_send_image_async(am7xxx_device *dev,
1190                                           am7xxx_image_format format,
1191                                           unsigned int width,
1192                                           unsigned int height,
1193                                           uint8_t *image,
1194                                           unsigned int image_size)
1195 {
1196         int ret;
1197         struct am7xxx_header h = {
1198                 .packet_type     = AM7XXX_PACKET_TYPE_IMAGE,
1199                 .direction       = AM7XXX_DIRECTION_OUT,
1200                 .header_data_len = sizeof(struct am7xxx_image_header),
1201                 .unknown2        = 0x3e,
1202                 .unknown3        = 0x10,
1203                 .header_data = {
1204                         .image = {
1205                                 .format     = format,
1206                                 .width      = width,
1207                                 .height     = height,
1208                                 .image_size = image_size,
1209                         },
1210                 },
1211         };
1212
1213         ret = send_header(dev, &h);
1214         if (ret < 0)
1215                 return ret;
1216
1217         if (image == NULL || image_size == 0) {
1218                 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
1219                 return 0;
1220         }
1221
1222         return send_data_async(dev, image, image_size);
1223 }
1224
1225 AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
1226 {
1227         if (dev->desc->ops.set_power_mode == NULL) {
1228                 warning(dev->ctx,
1229                         "setting power mode is unsupported on this device\n");
1230                 return 0;
1231         }
1232
1233         return dev->desc->ops.set_power_mode(dev, power);
1234 }
1235
1236 AM7XXX_PUBLIC int am7xxx_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
1237 {
1238         if (dev->desc->ops.set_zoom_mode == NULL) {
1239                 warning(dev->ctx,
1240                         "setting zoom mode is unsupported on this device\n");
1241                 return 0;
1242         }
1243
1244         return dev->desc->ops.set_zoom_mode(dev, zoom);
1245 }