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