src/am7xxx.c

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