1 /* am7xxx - communication with AM7xxx based USB Pico Projectors and DPFs
3 * Copyright (C) 2012 Antonio Ospite <ospite@studenti.unina.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"
30 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
32 /* If we're not using GNU C, elide __attribute__
33 * taken from: http://unixwiz.net/techtips/gnu-c-attributes.html)
36 # define __attribute__(x) /*NOTHING*/
39 /* Control shared library symbols visibility */
40 #if defined _WIN32 || defined __CYGWIN__
41 #define AM7XXX_PUBLIC __declspec(dllexport)
45 #define AM7XXX_PUBLIC __attribute__ ((visibility ("default")))
46 #define AM7XXX_LOCAL __attribute__ ((visibility ("hidden")))
53 static void log_message(am7xxx_context *ctx,
58 ...) __attribute__ ((format (printf, 5, 6)));
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__)
67 struct am7xxx_usb_device_descriptor {
73 static struct am7xxx_usb_device_descriptor supported_devices[] = {
85 .name ="Aiptek PocketCinema T25",
90 .name = "Philips/Sagemcom PicoPix 1020",
95 .name = "Philips/Sagemcom PicoPix 2055",
101 /* The header size on the wire is known to be always 24 bytes, regardless of
102 * the memory configuration enforced by different architectures or compilers
103 * for struct am7xxx_header
105 #define AM7XXX_HEADER_WIRE_SIZE 24
107 struct _am7xxx_device {
108 libusb_device_handle *usb_device;
109 uint8_t buffer[AM7XXX_HEADER_WIRE_SIZE];
114 struct _am7xxx_context {
115 libusb_context *usb_context;
117 am7xxx_device *devices_list;
121 AM7XXX_PACKET_TYPE_DEVINFO = 0x01,
122 AM7XXX_PACKET_TYPE_IMAGE = 0x02,
123 AM7XXX_PACKET_TYPE_POWER = 0x04,
124 AM7XXX_PACKET_TYPE_ZOOM = 0x05,
125 } am7xxx_packet_type;
127 struct am7xxx_generic_header {
134 struct am7xxx_devinfo_header {
135 uint32_t native_width;
136 uint32_t native_height;
141 struct am7xxx_image_header {
148 struct am7xxx_power_header {
154 struct am7xxx_zoom_header {
160 * Examples of packet headers:
163 * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
166 * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
169 /* Direction of the communication from the host point of view */
170 #define AM7XXX_DIRECTION_OUT 0 /* host -> device */
171 #define AM7XXX_DIRECTION_IN 1 /* host <- device */
173 struct am7xxx_header {
174 uint32_t packet_type;
176 uint8_t header_data_len;
180 struct am7xxx_generic_header data;
181 struct am7xxx_devinfo_header devinfo;
182 struct am7xxx_image_header image;
183 struct am7xxx_power_header power;
184 struct am7xxx_zoom_header zoom;
190 static void debug_dump_devinfo_header(am7xxx_context *ctx, struct am7xxx_devinfo_header *d)
192 if (ctx == NULL || d == NULL)
195 debug(ctx, "Info header:\n");
196 debug(ctx, "\tnative_width: 0x%08x (%u)\n", d->native_width, d->native_width);
197 debug(ctx, "\tnative_height: 0x%08x (%u)\n", d->native_height, d->native_height);
198 debug(ctx, "\tunknown0: 0x%08x (%u)\n", d->unknown0, d->unknown0);
199 debug(ctx, "\tunknown1: 0x%08x (%u)\n", d->unknown1, d->unknown1);
202 static void debug_dump_image_header(am7xxx_context *ctx, struct am7xxx_image_header *i)
204 if (ctx == NULL || i == NULL)
207 debug(ctx, "Image header:\n");
208 debug(ctx, "\tformat: 0x%08x (%u)\n", i->format, i->format);
209 debug(ctx, "\twidth: 0x%08x (%u)\n", i->width, i->width);
210 debug(ctx, "\theight: 0x%08x (%u)\n", i->height, i->height);
211 debug(ctx, "\timage size: 0x%08x (%u)\n", i->image_size, i->image_size);
214 static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_header *p)
216 if (ctx == NULL || p == NULL)
219 debug(ctx, "Power header:\n");
220 debug(ctx, "\tbit2: 0x%08x (%u)\n", p->bit2, p->bit2);
221 debug(ctx, "\tbit1: 0x%08x (%u)\n", p->bit1, p->bit1);
222 debug(ctx, "\tbit0: 0x%08x (%u)\n", p->bit0, p->bit0);
225 static void debug_dump_zoom_header(am7xxx_context *ctx, struct am7xxx_zoom_header *z)
227 if (ctx == NULL || z == NULL)
230 debug(ctx, "Zoom header:\n");
231 debug(ctx, "\tbit1: 0x%08x (%u)\n", z->bit1, z->bit1);
232 debug(ctx, "\tbit0: 0x%08x (%u)\n", z->bit0, z->bit0);
235 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
237 if (ctx == NULL || h == NULL)
240 debug(ctx, "BEGIN\n");
241 debug(ctx, "packet_type: 0x%08x (%u)\n", h->packet_type, h->packet_type);
242 debug(ctx, "direction: 0x%02hhx (%hhu) (%s)\n", h->direction, h->direction,
243 h->direction == AM7XXX_DIRECTION_IN ? "IN" :
244 h->direction == AM7XXX_DIRECTION_OUT ? "OUT" :
246 debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
247 debug(ctx, "unknown2: 0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
248 debug(ctx, "unknown3: 0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
250 switch(h->packet_type) {
251 case AM7XXX_PACKET_TYPE_DEVINFO:
252 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
255 case AM7XXX_PACKET_TYPE_IMAGE:
256 debug_dump_image_header(ctx, &(h->header_data.image));
259 case AM7XXX_PACKET_TYPE_POWER:
260 debug_dump_power_header(ctx, &(h->header_data.power));
263 case AM7XXX_PACKET_TYPE_ZOOM:
264 debug_dump_zoom_header(ctx, &(h->header_data.zoom));
268 debug(ctx, "Packet type not supported!\n");
271 debug(ctx, "END\n\n");
274 static inline unsigned int in_80chars(unsigned int i)
276 /* The 3 below is the length of "xx " where xx is the hex string
277 * representation of a byte */
278 return ((i+1) % (80/3));
281 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
282 uint8_t *buffer, unsigned int len)
286 if (ctx == NULL || buffer == NULL || len == 0)
291 trace(ctx, "%s\n", message);
293 for (i = 0; i < len; i++) {
294 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
299 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
305 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
306 uint8_t *buffer, unsigned int len)
315 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
320 ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
321 if (ret != 0 || (unsigned int)transferred != len) {
322 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
323 ret, transferred, len);
327 trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
332 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
337 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
339 ret = libusb_bulk_transfer(dev->usb_device, 0x1, buffer, len, &transferred, 0);
340 if (ret != 0 || (unsigned int)transferred != len) {
341 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
342 ret, transferred, len);
349 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
351 uint8_t **buffer_iterator = &buffer;
353 put_le32(h->packet_type, buffer_iterator);
354 put_8(h->direction, buffer_iterator);
355 put_8(h->header_data_len, buffer_iterator);
356 put_8(h->unknown2, buffer_iterator);
357 put_8(h->unknown3, buffer_iterator);
358 put_le32(h->header_data.data.field0, buffer_iterator);
359 put_le32(h->header_data.data.field1, buffer_iterator);
360 put_le32(h->header_data.data.field2, buffer_iterator);
361 put_le32(h->header_data.data.field3, buffer_iterator);
364 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
366 uint8_t **buffer_iterator = &buffer;
368 h->packet_type = get_le32(buffer_iterator);
369 h->direction = get_8(buffer_iterator);
370 h->header_data_len = get_8(buffer_iterator);
371 h->unknown2 = get_8(buffer_iterator);
372 h->unknown3 = get_8(buffer_iterator);
373 h->header_data.data.field0 = get_le32(buffer_iterator);
374 h->header_data.data.field1 = get_le32(buffer_iterator);
375 h->header_data.data.field2 = get_le32(buffer_iterator);
376 h->header_data.data.field3 = get_le32(buffer_iterator);
379 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
383 ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
387 unserialize_header(dev->buffer, h);
389 debug_dump_header(dev->ctx, h);
391 if (h->direction == AM7XXX_DIRECTION_IN) {
395 "Received a packet with direction AM7XXX_DIRECTION_OUT, weird!\n");
403 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
407 debug_dump_header(dev->ctx, h);
409 serialize_header(h, dev->buffer);
410 ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
412 error(dev->ctx, "failed to send data\n");
417 /* When level == AM7XXX_LOG_FATAL do not check the log_level from the context
418 * and print the message unconditionally, this makes it possible to print
419 * fatal messages even early on initialization, before the context has been
421 static void log_message(am7xxx_context *ctx,
423 const char *function,
430 if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
432 fprintf(stderr, "%s", function);
434 fprintf(stderr, "[%d]", line);
435 fprintf(stderr, ": ");
439 vfprintf(stderr, fmt, ap);
446 static am7xxx_device *add_new_device(am7xxx_context *ctx)
448 am7xxx_device **devices_list;
449 am7xxx_device *new_device;
452 fatal("context must not be NULL!\n");
456 devices_list = &(ctx->devices_list);
458 new_device = malloc(sizeof(*new_device));
459 if (new_device == NULL) {
460 fatal("cannot allocate a new device (%s)\n", strerror(errno));
463 memset(new_device, 0, sizeof(*new_device));
465 new_device->ctx = ctx;
467 if (*devices_list == NULL) {
468 *devices_list = new_device;
470 am7xxx_device *prev = *devices_list;
473 prev->next = new_device;
478 static am7xxx_device *find_device(am7xxx_context *ctx,
479 unsigned int device_index)
482 am7xxx_device *current;
485 fatal("context must not be NULL!\n");
489 current = ctx->devices_list;
490 while (current && i++ < device_index)
491 current = current->next;
497 SCAN_OP_BUILD_DEVLIST,
502 * This is where the central logic of multi-device support is.
504 * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
505 * 'dev' are ignored; the function returns 0 on success and a negative value
508 * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
509 * device with index 'open_device_index' and returns the correspondent
510 * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
511 * 1 if the device was already open and a negative value on error.
514 * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
515 * the caller might want to call am7xxx_shutdown() in order to remove
516 * devices possibly added before the failure.
518 static int scan_devices(am7xxx_context *ctx, scan_op op,
519 unsigned int open_device_index, am7xxx_device **dev)
522 libusb_device** list;
523 unsigned int current_index;
528 fatal("context must not be NULL!\n");
531 if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
532 error(ctx, "device scan done already? Abort!\n");
536 num_devices = libusb_get_device_list(ctx->usb_context, &list);
537 if (num_devices < 0) {
543 for (i = 0; i < num_devices; i++) {
544 struct libusb_device_descriptor desc;
547 ret = libusb_get_device_descriptor(list[i], &desc);
551 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
552 if (desc.idVendor == supported_devices[j].vendor_id
553 && desc.idProduct == supported_devices[j].product_id) {
555 if (op == SCAN_OP_BUILD_DEVLIST) {
556 am7xxx_device *new_device;
557 info(ctx, "am7xxx device found, index: %d, name: %s\n",
559 supported_devices[j].name);
560 new_device = add_new_device(ctx);
561 if (new_device == NULL) {
562 /* XXX, the caller may want
563 * to call am7xxx_shutdown() if
564 * we fail here, as we may have
565 * added some devices already
567 debug(ctx, "Cannot create a new device\n");
571 } else if (op == SCAN_OP_OPEN_DEVICE &&
572 current_index == open_device_index) {
574 *dev = find_device(ctx, open_device_index);
580 /* the usb device has already been opened */
581 if ((*dev)->usb_device) {
582 debug(ctx, "(*dev)->usb_device already set\n");
587 ret = libusb_open(list[i], &((*dev)->usb_device));
589 debug(ctx, "libusb_open failed\n");
593 libusb_set_configuration((*dev)->usb_device, 2);
594 libusb_claim_interface((*dev)->usb_device, 0);
602 /* if we made it up to here we didn't find any device to open */
603 if (op == SCAN_OP_OPEN_DEVICE) {
604 error(ctx, "Cannot find any device to open\n");
609 /* everything went fine when building the device list */
612 libusb_free_device_list(list, 1);
618 AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
622 *ctx = malloc(sizeof(**ctx));
624 fatal("cannot allocate the context (%s)\n", strerror(errno));
628 memset(*ctx, 0, sizeof(**ctx));
630 /* Set the highest log level during initialization */
631 (*ctx)->log_level = AM7XXX_LOG_TRACE;
633 ret = libusb_init(&((*ctx)->usb_context));
635 goto out_free_context;
637 libusb_set_debug((*ctx)->usb_context, 3);
639 ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
641 error(*ctx, "scan_devices() failed\n");
642 am7xxx_shutdown(*ctx);
646 /* Set a quieter log level as default for normal operation */
647 (*ctx)->log_level = AM7XXX_LOG_ERROR;
657 AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
659 am7xxx_device *current;
662 fatal("context must not be NULL!\n");
666 current = ctx->devices_list;
668 am7xxx_device *next = current->next;
669 am7xxx_close_device(current);
674 libusb_exit(ctx->usb_context);
679 AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
681 ctx->log_level = log_level;
684 AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
685 unsigned int device_index)
690 fatal("context must not be NULL!\n");
694 ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
697 } else if (ret > 0) {
698 warning(ctx, "device %d already open\n", device_index);
706 AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
709 fatal("dev must not be NULL!\n");
712 if (dev->usb_device) {
713 libusb_release_interface(dev->usb_device, 0);
714 libusb_close(dev->usb_device);
715 dev->usb_device = NULL;
720 AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
721 am7xxx_device_info *device_info)
724 struct am7xxx_header h = {
725 .packet_type = AM7XXX_PACKET_TYPE_DEVINFO,
726 .direction = AM7XXX_DIRECTION_OUT,
727 .header_data_len = 0x00,
740 ret = send_header(dev, &h);
744 ret = read_header(dev, &h);
748 device_info->native_width = h.header_data.devinfo.native_width;
749 device_info->native_height = h.header_data.devinfo.native_height;
751 /* No reason to expose these in the public API until we know what they mean */
752 device_info->unknown0 = h.header_data.devinfo.unknown0;
753 device_info->unknown1 = h.header_data.devinfo.unknown1;
759 AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
760 unsigned int upscale,
761 unsigned int original_width,
762 unsigned int original_height,
763 unsigned int *scaled_width,
764 unsigned int *scaled_height)
767 am7xxx_device_info device_info;
772 ret = am7xxx_get_device_info(dev, &device_info);
774 error(dev->ctx, "cannot get device info\n");
779 * Check if we need to rescale; if the input image fits the native
780 * dimensions there is no need to, unless we want to upscale.
783 original_width <= device_info.native_width &&
784 original_height <= device_info.native_height ) {
785 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
786 *scaled_width = original_width;
787 *scaled_height = original_height;
791 /* Input dimensions relative to the device native dimensions */
792 width_ratio = (float)original_width / device_info.native_width;
793 height_ratio = (float)original_height / device_info.native_height;
795 if (width_ratio > height_ratio) {
797 * The input is proportionally "wider" than the device viewport
798 * so its height needs to be adjusted
800 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
801 *scaled_width = device_info.native_width;
802 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
803 } else if (width_ratio < height_ratio) {
805 * The input is proportionally "taller" than the device viewport
806 * so its width needs to be adjusted
808 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
809 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
810 *scaled_height = device_info.native_height;
812 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
813 *scaled_width = device_info.native_width;
814 *scaled_height = device_info.native_height;
816 debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
821 AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
822 am7xxx_image_format format,
826 unsigned int image_size)
829 struct am7xxx_header h = {
830 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
831 .direction = AM7XXX_DIRECTION_OUT,
832 .header_data_len = sizeof(struct am7xxx_image_header),
840 .image_size = image_size,
845 ret = send_header(dev, &h);
849 if (image == NULL || image_size == 0) {
850 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
854 return send_data(dev, image, image_size);
857 AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
860 struct am7xxx_header h = {
861 .packet_type = AM7XXX_PACKET_TYPE_POWER,
862 .direction = AM7XXX_DIRECTION_OUT,
863 .header_data_len = sizeof(struct am7xxx_power_header),
869 case AM7XXX_POWER_OFF:
870 h.header_data.power.bit2 = 0;
871 h.header_data.power.bit1 = 0;
872 h.header_data.power.bit0 = 0;
875 case AM7XXX_POWER_LOW:
876 h.header_data.power.bit2 = 0;
877 h.header_data.power.bit1 = 0;
878 h.header_data.power.bit0 = 1;
881 case AM7XXX_POWER_MIDDLE:
882 h.header_data.power.bit2 = 0;
883 h.header_data.power.bit1 = 1;
884 h.header_data.power.bit0 = 0;
887 case AM7XXX_POWER_HIGH:
888 h.header_data.power.bit2 = 0;
889 h.header_data.power.bit1 = 1;
890 h.header_data.power.bit0 = 1;
893 case AM7XXX_POWER_TURBO:
894 h.header_data.power.bit2 = 1;
895 h.header_data.power.bit1 = 0;
896 h.header_data.power.bit0 = 0;
900 error(dev->ctx, "Unsupported power mode.\n");
904 ret = send_header(dev, &h);
911 AM7XXX_PUBLIC int am7xxx_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
914 struct am7xxx_header h = {
915 .packet_type = AM7XXX_PACKET_TYPE_ZOOM,
916 .direction = AM7XXX_DIRECTION_OUT,
917 .header_data_len = sizeof(struct am7xxx_zoom_header),
923 case AM7XXX_ZOOM_ORIGINAL:
924 h.header_data.zoom.bit1 = 0;
925 h.header_data.zoom.bit0 = 0;
929 h.header_data.zoom.bit1 = 0;
930 h.header_data.zoom.bit0 = 1;
933 case AM7XXX_ZOOM_H_V:
934 h.header_data.zoom.bit1 = 1;
935 h.header_data.zoom.bit0 = 0;
938 case AM7XXX_ZOOM_TEST:
939 h.header_data.zoom.bit1 = 1;
940 h.header_data.zoom.bit0 = 1;
944 error(dev->ctx, "Unsupported zoom mode.\n");
948 ret = send_header(dev, &h);