1 /* am7xxx - communication with AM7xxx based USB Pico Projectors and DPFs
3 * Copyright (C) 2012-2014 Antonio Ospite <ao2@ao2.it>
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.
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.
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/>.
28 #include "serialize.h"
31 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
33 /* If we're not using GNU C, elide __attribute__
34 * taken from: http://unixwiz.net/techtips/gnu-c-attributes.html)
37 # define __attribute__(x) /* NOTHING */
40 /* Control shared library symbols visibility */
41 #if defined _WIN32 || defined __CYGWIN__
42 #define AM7XXX_PUBLIC __declspec(dllexport)
46 #define AM7XXX_PUBLIC __attribute__ ((visibility ("default")))
47 #define AM7XXX_LOCAL __attribute__ ((visibility ("hidden")))
54 static void log_message(am7xxx_context *ctx,
59 ...) __attribute__ ((format (printf, 5, 6)));
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__)
69 int (*set_power_mode)(am7xxx_device *dev, am7xxx_power_mode power);
70 int (*set_zoom_mode)(am7xxx_device *dev, am7xxx_zoom_mode zoom);
73 struct am7xxx_usb_device_descriptor {
77 uint8_t configuration; /* The bConfigurationValue of the device */
78 uint8_t interface_number; /* The bInterfaceNumber of the device */
79 struct am7xxx_ops ops;
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);
87 #define DEFAULT_OPS { \
88 .set_power_mode = default_set_power_mode, \
89 .set_zoom_mode = default_set_zoom_mode, \
92 static const struct am7xxx_usb_device_descriptor supported_devices[] = {
98 .interface_number = 0,
104 .product_id = 0x5501,
106 .interface_number = 0,
110 .name ="Aiptek PocketCinema T25",
112 .product_id = 0x2144,
114 .interface_number = 0,
118 .name = "Philips/Sagemcom PicoPix 1020",
120 .product_id = 0x000e,
122 .interface_number = 0,
126 .name = "Philips/Sagemcom PicoPix 2055",
128 .product_id = 0x0016,
130 .interface_number = 0,
132 .set_power_mode = picopix_set_power_mode,
133 .set_zoom_mode = picopix_set_zoom_mode,
137 .name = "Philips/Sagemcom PicoPix 2330",
139 .product_id = 0x0019,
141 .interface_number = 0,
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
149 #define AM7XXX_HEADER_WIRE_SIZE 24
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;
158 const struct am7xxx_usb_device_descriptor *desc;
162 struct _am7xxx_context {
163 libusb_context *usb_context;
165 am7xxx_device *devices_list;
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;
180 struct am7xxx_generic_header {
187 struct am7xxx_devinfo_header {
188 uint32_t native_width;
189 uint32_t native_height;
194 struct am7xxx_image_header {
201 struct am7xxx_power_header {
207 struct am7xxx_zoom_header {
213 * Examples of packet headers:
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
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
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 */
226 struct am7xxx_header {
227 uint32_t packet_type;
229 uint8_t header_data_len;
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;
243 static void debug_dump_generic_header(am7xxx_context *ctx, struct am7xxx_generic_header *g)
245 if (ctx == NULL || g == NULL)
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);
255 static void debug_dump_devinfo_header(am7xxx_context *ctx, struct am7xxx_devinfo_header *d)
257 if (ctx == NULL || d == NULL)
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);
267 static void debug_dump_image_header(am7xxx_context *ctx, struct am7xxx_image_header *i)
269 if (ctx == NULL || i == NULL)
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);
279 static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_header *p)
281 if (ctx == NULL || p == NULL)
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);
290 static void debug_dump_zoom_header(am7xxx_context *ctx, struct am7xxx_zoom_header *z)
292 if (ctx == NULL || z == NULL)
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);
300 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
302 if (ctx == NULL || h == NULL)
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" :
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);
315 switch(h->packet_type) {
316 case AM7XXX_PACKET_TYPE_DEVINFO:
317 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
320 case AM7XXX_PACKET_TYPE_IMAGE:
321 debug_dump_image_header(ctx, &(h->header_data.image));
324 case AM7XXX_PACKET_TYPE_POWER:
325 debug_dump_power_header(ctx, &(h->header_data.power));
328 case AM7XXX_PACKET_TYPE_ZOOM:
329 debug_dump_zoom_header(ctx, &(h->header_data.zoom));
333 debug(ctx, "Parsing data not supported for this packet type!\n");
334 debug_dump_generic_header(ctx, &(h->header_data.data));
337 debug(ctx, "END\n\n");
340 static inline unsigned int in_80chars(unsigned int i)
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));
347 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
348 uint8_t *buffer, unsigned int len)
352 if (ctx == NULL || buffer == NULL || len == 0)
357 trace(ctx, "%s\n", message);
359 for (i = 0; i < len; i++) {
360 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
365 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
371 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
372 uint8_t *buffer, unsigned int len)
381 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
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, "%s. Transferred: %d (expected %u)\n",
389 libusb_error_name(ret), transferred, len);
393 trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
398 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
403 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
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, "%s. Transferred: %d (expected %u)\n",
408 libusb_error_name(ret), transferred, len);
415 static void send_data_async_complete_cb(struct libusb_transfer *transfer)
417 am7xxx_device *dev = (am7xxx_device *)(transfer->user_data);
418 int *completed = &(dev->transfer_completed);
419 int transferred = transfer->actual_length;
422 if (transferred != transfer->length) {
423 error(dev->ctx, "transferred: %d (expected %u)\n",
424 transferred, transfer->length);
427 switch (transfer->status) {
428 case LIBUSB_TRANSFER_COMPLETED:
431 case LIBUSB_TRANSFER_TIMED_OUT:
432 ret = LIBUSB_ERROR_TIMEOUT;
434 case LIBUSB_TRANSFER_STALL:
435 ret = LIBUSB_ERROR_PIPE;
437 case LIBUSB_TRANSFER_OVERFLOW:
438 ret = LIBUSB_ERROR_OVERFLOW;
440 case LIBUSB_TRANSFER_NO_DEVICE:
441 ret = LIBUSB_ERROR_NO_DEVICE;
443 case LIBUSB_TRANSFER_ERROR:
444 case LIBUSB_TRANSFER_CANCELLED:
445 ret = LIBUSB_ERROR_IO;
448 error(dev->ctx, "unrecognised status code %d", transfer->status);
449 ret = LIBUSB_ERROR_OTHER;
453 error(dev->ctx, "libusb transfer failed: %s",
454 libusb_error_name(ret));
456 libusb_free_transfer(transfer);
462 static inline void wait_for_trasfer_completed(am7xxx_device *dev)
464 while (!dev->transfer_completed) {
465 int ret = libusb_handle_events_completed(dev->ctx->usb_context,
466 &(dev->transfer_completed));
468 if (ret == LIBUSB_ERROR_INTERRUPTED)
470 error(dev->ctx, "libusb_handle_events failed: %s, cancelling transfer and retrying",
471 libusb_error_name(ret));
472 libusb_cancel_transfer(dev->transfer);
478 static int send_data_async(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
481 uint8_t *transfer_buffer;
483 dev->transfer = libusb_alloc_transfer(0);
484 if (dev->transfer == NULL) {
485 error(dev->ctx, "cannot allocate transfer (%s)\n",
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",
501 memcpy(transfer_buffer, buffer, len);
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);
508 /* wait for the previous transfer to complete */
509 wait_for_trasfer_completed(dev);
511 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
513 dev->transfer_completed = 0;
514 ret = libusb_submit_transfer(dev->transfer);
521 libusb_free_transfer(dev->transfer);
522 dev->transfer = NULL;
526 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
528 uint8_t **buffer_iterator = &buffer;
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);
541 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
543 uint8_t **buffer_iterator = &buffer;
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);
556 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
560 ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
564 unserialize_header(dev->buffer, h);
566 if (h->direction == AM7XXX_DIRECTION_IN) {
570 "Expected an AM7XXX_DIRECTION_IN packet, got one with direction = %d. Weird!\n",
575 debug_dump_header(dev->ctx, h);
581 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
585 debug_dump_header(dev->ctx, h);
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.
592 serialize_header(h, dev->buffer);
594 ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
596 error(dev->ctx, "failed to send data\n");
601 static int send_command(am7xxx_device *dev, am7xxx_packet_type type)
603 struct am7xxx_header h = {
605 .direction = AM7XXX_DIRECTION_OUT,
606 .header_data_len = 0x00,
619 return send_header(dev, &h);
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
627 static void log_message(am7xxx_context *ctx,
629 const char *function,
636 if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
638 fprintf(stderr, "%s", function);
640 fprintf(stderr, "[%d]", line);
641 fprintf(stderr, ": ");
645 vfprintf(stderr, fmt, ap);
652 static am7xxx_device *add_new_device(am7xxx_context *ctx,
653 const struct am7xxx_usb_device_descriptor *desc)
655 am7xxx_device **devices_list;
656 am7xxx_device *new_device;
659 fatal("context must not be NULL!\n");
663 new_device = malloc(sizeof(*new_device));
664 if (new_device == NULL) {
665 fatal("cannot allocate a new device (%s)\n", strerror(errno));
668 memset(new_device, 0, sizeof(*new_device));
670 new_device->ctx = ctx;
671 new_device->desc = desc;
672 new_device->transfer_completed = 1;
674 devices_list = &(ctx->devices_list);
676 if (*devices_list == NULL) {
677 *devices_list = new_device;
679 am7xxx_device *prev = *devices_list;
682 prev->next = new_device;
687 static am7xxx_device *find_device(am7xxx_context *ctx,
688 unsigned int device_index)
691 am7xxx_device *current;
694 fatal("context must not be NULL!\n");
698 current = ctx->devices_list;
699 while (current && i++ < device_index)
700 current = current->next;
705 static int open_device(am7xxx_context *ctx,
706 unsigned int device_index,
707 libusb_device *usb_dev,
711 int current_configuration;
713 *dev = find_device(ctx, device_index);
719 /* the usb device has already been opened */
720 if ((*dev)->usb_device) {
721 debug(ctx, "(*dev)->usb_device already set\n");
726 ret = libusb_open(usb_dev, &((*dev)->usb_device));
728 debug(ctx, "libusb_open failed: %s\n", libusb_error_name(ret));
732 /* XXX, the device is now open, if any of the calls below fail we need
733 * to close it again before bailing out.
736 current_configuration = -1;
737 libusb_get_configuration((*dev)->usb_device, ¤t_configuration);
738 if (current_configuration != (*dev)->desc->configuration) {
740 * In principle kernel drivers bound to each interface should
741 * be detached before setting the configuration, but in
742 * practice this is not necessary for most devices.
744 * For example something like the following function would be
746 * libusb_detach_all_kernel_drivers((*dev)->usb_device);
748 ret = libusb_set_configuration((*dev)->usb_device,
749 (*dev)->desc->configuration);
751 debug(ctx, "libusb_set_configuration failed: %s\n",
752 libusb_error_name(ret));
753 debug(ctx, "Cannot set configuration %hhu\n",
754 (*dev)->desc->configuration);
755 goto out_libusb_close;
759 libusb_set_auto_detach_kernel_driver((*dev)->usb_device, 1);
761 ret = libusb_claim_interface((*dev)->usb_device,
762 (*dev)->desc->interface_number);
764 debug(ctx, "libusb_claim_interface failed: %s\n",
765 libusb_error_name(ret));
766 debug(ctx, "Cannot claim interface %hhu\n",
767 (*dev)->desc->interface_number);
768 goto out_libusb_close;
771 /* Checking that the configuration has not changed, as suggested in
772 * http://libusb.sourceforge.net/api-1.0/caveats.html
774 current_configuration = -1;
775 libusb_get_configuration((*dev)->usb_device, ¤t_configuration);
776 if (current_configuration != (*dev)->desc->configuration) {
777 debug(ctx, "libusb configuration changed (expected: %hhu, current: %hhu\n",
778 (*dev)->desc->configuration, current_configuration);
780 goto out_libusb_close;
786 libusb_close((*dev)->usb_device);
787 (*dev)->usb_device = NULL;
792 SCAN_OP_BUILD_DEVLIST,
797 * This is where the central logic of multi-device support is.
799 * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
800 * 'dev' are ignored; the function returns 0 on success or a negative value
803 * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
804 * device with index 'open_device_index' and returns the correspondent
805 * am7xxx_device in the 'dev' parameter; the function returns the value from
806 * open_device(), which is 0 on success, 1 if the device was already open or
807 * a negative value on error.
810 * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
811 * the caller might want to call am7xxx_shutdown() in order to remove
812 * devices possibly added before the failure.
814 static int scan_devices(am7xxx_context *ctx, scan_op op,
815 unsigned int open_device_index, am7xxx_device **dev)
818 libusb_device **list;
819 unsigned int current_index;
824 fatal("context must not be NULL!\n");
827 if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
828 error(ctx, "device scan done already? Abort!\n");
832 num_devices = libusb_get_device_list(ctx->usb_context, &list);
833 if (num_devices < 0) {
839 for (i = 0; i < num_devices; i++) {
840 struct libusb_device_descriptor desc;
843 ret = libusb_get_device_descriptor(list[i], &desc);
847 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
848 if (desc.idVendor == supported_devices[j].vendor_id &&
849 desc.idProduct == supported_devices[j].product_id) {
851 if (op == SCAN_OP_BUILD_DEVLIST) {
852 am7xxx_device *new_device;
853 info(ctx, "am7xxx device found, index: %d, name: %s\n",
855 supported_devices[j].name);
856 new_device = add_new_device(ctx, &supported_devices[j]);
857 if (new_device == NULL) {
858 /* XXX, the caller may want
859 * to call am7xxx_shutdown() if
860 * we fail here, as we may have
861 * added some devices already
863 debug(ctx, "Cannot create a new device\n");
867 } else if (op == SCAN_OP_OPEN_DEVICE &&
868 current_index == open_device_index) {
870 ret = open_device(ctx,
875 debug(ctx, "open_device failed\n");
877 /* exit the loop unconditionally after
878 * attempting to open the device
879 * requested by the user */
887 /* if we made it up to here when op == SCAN_OP_OPEN_DEVICE,
888 * no devices to open had been found. */
889 if (op == SCAN_OP_OPEN_DEVICE) {
890 error(ctx, "Cannot find any device to open\n");
895 /* everything went fine when building the device list */
898 libusb_free_device_list(list, 1);
902 /* Device specific operations */
904 static int default_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
907 struct am7xxx_header h = {
908 .packet_type = AM7XXX_PACKET_TYPE_POWER,
909 .direction = AM7XXX_DIRECTION_OUT,
910 .header_data_len = sizeof(struct am7xxx_power_header),
916 case AM7XXX_POWER_OFF:
917 h.header_data.power.bit2 = 0;
918 h.header_data.power.bit1 = 0;
919 h.header_data.power.bit0 = 0;
922 case AM7XXX_POWER_LOW:
923 h.header_data.power.bit2 = 0;
924 h.header_data.power.bit1 = 0;
925 h.header_data.power.bit0 = 1;
928 case AM7XXX_POWER_MIDDLE:
929 h.header_data.power.bit2 = 0;
930 h.header_data.power.bit1 = 1;
931 h.header_data.power.bit0 = 0;
934 case AM7XXX_POWER_HIGH:
935 h.header_data.power.bit2 = 0;
936 h.header_data.power.bit1 = 1;
937 h.header_data.power.bit0 = 1;
940 case AM7XXX_POWER_TURBO:
941 h.header_data.power.bit2 = 1;
942 h.header_data.power.bit1 = 0;
943 h.header_data.power.bit0 = 0;
947 error(dev->ctx, "Unsupported power mode.\n");
951 ret = send_header(dev, &h);
958 static int picopix_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
961 case AM7XXX_POWER_LOW:
962 return send_command(dev, AM7XXX_PACKET_TYPE_PICOPIX_POWER_LOW);
964 case AM7XXX_POWER_MIDDLE:
965 return send_command(dev, AM7XXX_PACKET_TYPE_PICOPIX_POWER_MEDIUM);
967 case AM7XXX_POWER_HIGH:
968 return send_command(dev, AM7XXX_PACKET_TYPE_PICOPIX_POWER_HIGH);
970 case AM7XXX_POWER_OFF:
971 case AM7XXX_POWER_TURBO:
973 error(dev->ctx, "Unsupported power mode.\n");
978 static int default_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
981 struct am7xxx_header h = {
982 .packet_type = AM7XXX_PACKET_TYPE_ZOOM,
983 .direction = AM7XXX_DIRECTION_OUT,
984 .header_data_len = sizeof(struct am7xxx_zoom_header),
990 case AM7XXX_ZOOM_ORIGINAL:
991 h.header_data.zoom.bit1 = 0;
992 h.header_data.zoom.bit0 = 0;
996 h.header_data.zoom.bit1 = 0;
997 h.header_data.zoom.bit0 = 1;
1000 case AM7XXX_ZOOM_H_V:
1001 h.header_data.zoom.bit1 = 1;
1002 h.header_data.zoom.bit0 = 0;
1005 case AM7XXX_ZOOM_TEST:
1006 h.header_data.zoom.bit1 = 1;
1007 h.header_data.zoom.bit0 = 1;
1010 case AM7XXX_ZOOM_TELE:
1012 error(dev->ctx, "Unsupported zoom mode.\n");
1016 ret = send_header(dev, &h);
1023 static int picopix_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
1026 am7xxx_packet_type packet_type;
1029 case AM7XXX_ZOOM_ORIGINAL:
1030 packet_type = AM7XXX_PACKET_TYPE_PICOPIX_DISABLE_TI;
1033 case AM7XXX_ZOOM_TELE:
1034 packet_type = AM7XXX_PACKET_TYPE_PICOPIX_ENABLE_TI;
1038 case AM7XXX_ZOOM_H_V:
1039 case AM7XXX_ZOOM_TEST:
1041 error(dev->ctx, "Unsupported zoom mode.\n");
1045 ret = send_command(dev, packet_type);
1049 /* The Windows drivers wait for 100ms and send the same command again,
1050 * probably to overcome a firmware deficiency */
1055 return send_command(dev, packet_type);
1060 AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
1064 *ctx = malloc(sizeof(**ctx));
1066 fatal("cannot allocate the context (%s)\n", strerror(errno));
1070 memset(*ctx, 0, sizeof(**ctx));
1072 /* Set the highest log level during initialization */
1073 (*ctx)->log_level = AM7XXX_LOG_TRACE;
1075 ret = libusb_init(&((*ctx)->usb_context));
1077 goto out_free_context;
1079 libusb_set_debug((*ctx)->usb_context, LIBUSB_LOG_LEVEL_INFO);
1081 ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
1083 error(*ctx, "scan_devices() failed\n");
1084 am7xxx_shutdown(*ctx);
1088 /* Set a quieter log level as default for normal operation */
1089 (*ctx)->log_level = AM7XXX_LOG_ERROR;
1099 AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
1101 am7xxx_device *current;
1104 fatal("context must not be NULL!\n");
1108 current = ctx->devices_list;
1110 am7xxx_device *next = current->next;
1111 am7xxx_close_device(current);
1112 free(current->device_info);
1117 libusb_exit(ctx->usb_context);
1122 AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
1124 ctx->log_level = log_level;
1127 AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
1128 unsigned int device_index)
1133 fatal("context must not be NULL!\n");
1137 ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
1141 } else if (ret > 0) {
1142 warning(ctx, "device %d already open\n", device_index);
1148 /* Philips/Sagemcom PicoPix projectors require that the DEVINFO packet
1149 * is the first one to be sent to the device in order for it to
1150 * successfully return the correct device information.
1152 * So, if there is not a cached version of it (from a previous open),
1153 * we ask for device info at open time,
1155 if ((*dev)->device_info == NULL) {
1156 ret = am7xxx_get_device_info(*dev, NULL);
1158 error(ctx, "cannot get device info\n");
1165 AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
1168 fatal("dev must not be NULL!\n");
1171 if (dev->usb_device) {
1172 wait_for_trasfer_completed(dev);
1173 libusb_release_interface(dev->usb_device, dev->desc->interface_number);
1174 libusb_close(dev->usb_device);
1175 dev->usb_device = NULL;
1180 AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
1181 am7xxx_device_info *device_info)
1184 struct am7xxx_header h;
1186 if (dev->device_info) {
1187 memcpy(device_info, dev->device_info, sizeof(*device_info));
1191 ret = send_command(dev, AM7XXX_PACKET_TYPE_DEVINFO);
1195 memset(&h, 0, sizeof(h));
1196 ret = read_header(dev, &h);
1200 if (h.packet_type != AM7XXX_PACKET_TYPE_DEVINFO) {
1201 error(dev->ctx, "expected packet type: %d, got %d instead!\n",
1202 AM7XXX_PACKET_TYPE_DEVINFO, h.packet_type);
1207 dev->device_info = malloc(sizeof(*dev->device_info));
1208 if (dev->device_info == NULL) {
1209 error(dev->ctx, "cannot allocate a device info (%s)\n",
1213 memset(dev->device_info, 0, sizeof(*dev->device_info));
1215 dev->device_info->native_width = h.header_data.devinfo.native_width;
1216 dev->device_info->native_height = h.header_data.devinfo.native_height;
1218 /* No reason to expose these in the public API until we know what they mean */
1219 dev->device_info->unknown0 = h.header_data.devinfo.unknown0;
1220 dev->device_info->unknown1 = h.header_data.devinfo.unknown1;
1226 AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
1227 unsigned int upscale,
1228 unsigned int original_width,
1229 unsigned int original_height,
1230 unsigned int *scaled_width,
1231 unsigned int *scaled_height)
1234 am7xxx_device_info device_info;
1239 ret = am7xxx_get_device_info(dev, &device_info);
1241 error(dev->ctx, "cannot get device info\n");
1246 * Check if we need to rescale; if the input image fits the native
1247 * dimensions there is no need to, unless we want to upscale.
1250 original_width <= device_info.native_width &&
1251 original_height <= device_info.native_height ) {
1252 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
1253 *scaled_width = original_width;
1254 *scaled_height = original_height;
1258 /* Input dimensions relative to the device native dimensions */
1259 width_ratio = (float)original_width / device_info.native_width;
1260 height_ratio = (float)original_height / device_info.native_height;
1262 if (width_ratio > height_ratio) {
1264 * The input is proportionally "wider" than the device viewport
1265 * so its height needs to be adjusted
1267 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
1268 *scaled_width = device_info.native_width;
1269 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
1270 } else if (width_ratio < height_ratio) {
1272 * The input is proportionally "taller" than the device viewport
1273 * so its width needs to be adjusted
1275 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
1276 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
1277 *scaled_height = device_info.native_height;
1279 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
1280 *scaled_width = device_info.native_width;
1281 *scaled_height = device_info.native_height;
1283 debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
1288 AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
1289 am7xxx_image_format format,
1291 unsigned int height,
1293 unsigned int image_size)
1296 struct am7xxx_header h = {
1297 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
1298 .direction = AM7XXX_DIRECTION_OUT,
1299 .header_data_len = sizeof(struct am7xxx_image_header),
1307 .image_size = image_size,
1312 ret = send_header(dev, &h);
1316 if (image == NULL || image_size == 0) {
1317 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
1321 return send_data(dev, image, image_size);
1324 AM7XXX_PUBLIC int am7xxx_send_image_async(am7xxx_device *dev,
1325 am7xxx_image_format format,
1327 unsigned int height,
1329 unsigned int image_size)
1332 struct am7xxx_header h = {
1333 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
1334 .direction = AM7XXX_DIRECTION_OUT,
1335 .header_data_len = sizeof(struct am7xxx_image_header),
1343 .image_size = image_size,
1348 ret = send_header(dev, &h);
1352 if (image == NULL || image_size == 0) {
1353 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
1357 return send_data_async(dev, image, image_size);
1360 AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
1362 if (dev->desc->ops.set_power_mode == NULL) {
1364 "setting power mode is unsupported on this device\n");
1368 return dev->desc->ops.set_power_mode(dev, power);
1371 AM7XXX_PUBLIC int am7xxx_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
1373 if (dev->desc->ops.set_zoom_mode == NULL) {
1375 "setting zoom mode is unsupported on this device\n");
1379 return dev->desc->ops.set_zoom_mode(dev, zoom);