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