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)\n", h->direction, h->direction);
243 debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
244 debug(ctx, "unknown2: 0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
245 debug(ctx, "unknown3: 0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
247 switch(h->packet_type) {
248 case AM7XXX_PACKET_TYPE_DEVINFO:
249 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
252 case AM7XXX_PACKET_TYPE_IMAGE:
253 debug_dump_image_header(ctx, &(h->header_data.image));
256 case AM7XXX_PACKET_TYPE_POWER:
257 debug_dump_power_header(ctx, &(h->header_data.power));
260 case AM7XXX_PACKET_TYPE_ZOOM:
261 debug_dump_zoom_header(ctx, &(h->header_data.zoom));
265 debug(ctx, "Packet type not supported!\n");
268 debug(ctx, "END\n\n");
271 static inline unsigned int in_80chars(unsigned int i)
273 /* The 3 below is the length of "xx " where xx is the hex string
274 * representation of a byte */
275 return ((i+1) % (80/3));
278 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
279 uint8_t *buffer, unsigned int len)
283 if (ctx == NULL || buffer == NULL || len == 0)
288 trace(ctx, "%s\n", message);
290 for (i = 0; i < len; i++) {
291 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
296 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
302 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
303 uint8_t *buffer, unsigned int len)
312 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
317 ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
318 if (ret != 0 || (unsigned int)transferred != len) {
319 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
320 ret, transferred, len);
324 trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
329 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
334 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
336 ret = libusb_bulk_transfer(dev->usb_device, 0x1, buffer, len, &transferred, 0);
337 if (ret != 0 || (unsigned int)transferred != len) {
338 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
339 ret, transferred, len);
346 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
348 uint8_t **buffer_iterator = &buffer;
350 put_le32(h->packet_type, buffer_iterator);
351 put_8(h->direction, buffer_iterator);
352 put_8(h->header_data_len, buffer_iterator);
353 put_8(h->unknown2, buffer_iterator);
354 put_8(h->unknown3, buffer_iterator);
355 put_le32(h->header_data.data.field0, buffer_iterator);
356 put_le32(h->header_data.data.field1, buffer_iterator);
357 put_le32(h->header_data.data.field2, buffer_iterator);
358 put_le32(h->header_data.data.field3, buffer_iterator);
361 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
363 uint8_t **buffer_iterator = &buffer;
365 h->packet_type = get_le32(buffer_iterator);
366 h->direction = get_8(buffer_iterator);
367 h->header_data_len = get_8(buffer_iterator);
368 h->unknown2 = get_8(buffer_iterator);
369 h->unknown3 = get_8(buffer_iterator);
370 h->header_data.data.field0 = get_le32(buffer_iterator);
371 h->header_data.data.field1 = get_le32(buffer_iterator);
372 h->header_data.data.field2 = get_le32(buffer_iterator);
373 h->header_data.data.field3 = get_le32(buffer_iterator);
376 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
380 ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
384 unserialize_header(dev->buffer, h);
386 debug_dump_header(dev->ctx, h);
388 if (h->direction == AM7XXX_DIRECTION_IN) {
392 "Received a packet with direction AM7XXX_DIRECTION_OUT, weird!\n");
400 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
404 debug_dump_header(dev->ctx, h);
406 serialize_header(h, dev->buffer);
407 ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
409 error(dev->ctx, "failed to send data\n");
414 /* When level == AM7XXX_LOG_FATAL do not check the log_level from the context
415 * and print the message unconditionally, this makes it possible to print
416 * fatal messages even early on initialization, before the context has been
418 static void log_message(am7xxx_context *ctx,
420 const char *function,
427 if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
429 fprintf(stderr, "%s", function);
431 fprintf(stderr, "[%d]", line);
432 fprintf(stderr, ": ");
436 vfprintf(stderr, fmt, ap);
443 static am7xxx_device *add_new_device(am7xxx_context *ctx)
445 am7xxx_device **devices_list;
446 am7xxx_device *new_device;
449 fatal("context must not be NULL!\n");
453 devices_list = &(ctx->devices_list);
455 new_device = malloc(sizeof(*new_device));
456 if (new_device == NULL) {
457 fatal("cannot allocate a new device (%s)\n", strerror(errno));
460 memset(new_device, 0, sizeof(*new_device));
462 new_device->ctx = ctx;
464 if (*devices_list == NULL) {
465 *devices_list = new_device;
467 am7xxx_device *prev = *devices_list;
470 prev->next = new_device;
475 static am7xxx_device *find_device(am7xxx_context *ctx,
476 unsigned int device_index)
479 am7xxx_device *current;
482 fatal("context must not be NULL!\n");
486 current = ctx->devices_list;
487 while (current && i++ < device_index)
488 current = current->next;
494 SCAN_OP_BUILD_DEVLIST,
499 * This is where the central logic of multi-device support is.
501 * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
502 * 'dev' are ignored; the function returns 0 on success and a negative value
505 * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
506 * device with index 'open_device_index' and returns the correspondent
507 * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
508 * 1 if the device was already open and a negative value on error.
511 * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
512 * the caller might want to call am7xxx_shutdown() in order to remove
513 * devices possibly added before the failure.
515 static int scan_devices(am7xxx_context *ctx, scan_op op,
516 unsigned int open_device_index, am7xxx_device **dev)
519 libusb_device** list;
520 unsigned int current_index;
525 fatal("context must not be NULL!\n");
528 if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
529 error(ctx, "device scan done already? Abort!\n");
533 num_devices = libusb_get_device_list(ctx->usb_context, &list);
534 if (num_devices < 0) {
540 for (i = 0; i < num_devices; i++) {
541 struct libusb_device_descriptor desc;
544 ret = libusb_get_device_descriptor(list[i], &desc);
548 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
549 if (desc.idVendor == supported_devices[j].vendor_id
550 && desc.idProduct == supported_devices[j].product_id) {
552 if (op == SCAN_OP_BUILD_DEVLIST) {
553 am7xxx_device *new_device;
554 info(ctx, "am7xxx device found, index: %d, name: %s\n",
556 supported_devices[j].name);
557 new_device = add_new_device(ctx);
558 if (new_device == NULL) {
559 /* XXX, the caller may want
560 * to call am7xxx_shutdown() if
561 * we fail here, as we may have
562 * added some devices already
564 debug(ctx, "Cannot create a new device\n");
568 } else if (op == SCAN_OP_OPEN_DEVICE &&
569 current_index == open_device_index) {
571 *dev = find_device(ctx, open_device_index);
577 /* the usb device has already been opened */
578 if ((*dev)->usb_device) {
579 debug(ctx, "(*dev)->usb_device already set\n");
584 ret = libusb_open(list[i], &((*dev)->usb_device));
586 debug(ctx, "libusb_open failed\n");
590 libusb_set_configuration((*dev)->usb_device, 2);
591 libusb_claim_interface((*dev)->usb_device, 0);
599 /* if we made it up to here we didn't find any device to open */
600 if (op == SCAN_OP_OPEN_DEVICE) {
601 error(ctx, "Cannot find any device to open\n");
606 /* everything went fine when building the device list */
609 libusb_free_device_list(list, 1);
615 AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
619 *ctx = malloc(sizeof(**ctx));
621 fatal("cannot allocate the context (%s)\n", strerror(errno));
625 memset(*ctx, 0, sizeof(**ctx));
627 /* Set the highest log level during initialization */
628 (*ctx)->log_level = AM7XXX_LOG_TRACE;
630 ret = libusb_init(&((*ctx)->usb_context));
632 goto out_free_context;
634 libusb_set_debug((*ctx)->usb_context, 3);
636 ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
638 error(*ctx, "scan_devices() failed\n");
639 am7xxx_shutdown(*ctx);
643 /* Set a quieter log level as default for normal operation */
644 (*ctx)->log_level = AM7XXX_LOG_ERROR;
654 AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
656 am7xxx_device *current;
659 fatal("context must not be NULL!\n");
663 current = ctx->devices_list;
665 am7xxx_device *next = current->next;
666 am7xxx_close_device(current);
671 libusb_exit(ctx->usb_context);
676 AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
678 ctx->log_level = log_level;
681 AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
682 unsigned int device_index)
687 fatal("context must not be NULL!\n");
691 ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
694 } else if (ret > 0) {
695 warning(ctx, "device %d already open\n", device_index);
703 AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
706 fatal("dev must not be NULL!\n");
709 if (dev->usb_device) {
710 libusb_release_interface(dev->usb_device, 0);
711 libusb_close(dev->usb_device);
712 dev->usb_device = NULL;
717 AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
718 am7xxx_device_info *device_info)
721 struct am7xxx_header h = {
722 .packet_type = AM7XXX_PACKET_TYPE_DEVINFO,
723 .direction = AM7XXX_DIRECTION_OUT,
724 .header_data_len = 0x00,
737 ret = send_header(dev, &h);
741 ret = read_header(dev, &h);
745 device_info->native_width = h.header_data.devinfo.native_width;
746 device_info->native_height = h.header_data.devinfo.native_height;
748 /* No reason to expose these in the public API until we know what they mean */
749 device_info->unknown0 = h.header_data.devinfo.unknown0;
750 device_info->unknown1 = h.header_data.devinfo.unknown1;
756 AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
757 unsigned int upscale,
758 unsigned int original_width,
759 unsigned int original_height,
760 unsigned int *scaled_width,
761 unsigned int *scaled_height)
764 am7xxx_device_info device_info;
769 ret = am7xxx_get_device_info(dev, &device_info);
771 error(dev->ctx, "cannot get device info\n");
776 * Check if we need to rescale; if the input image fits the native
777 * dimensions there is no need to, unless we want to upscale.
780 original_width <= device_info.native_width &&
781 original_height <= device_info.native_height ) {
782 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
783 *scaled_width = original_width;
784 *scaled_height = original_height;
788 /* Input dimensions relative to the device native dimensions */
789 width_ratio = (float)original_width / device_info.native_width;
790 height_ratio = (float)original_height / device_info.native_height;
792 if (width_ratio > height_ratio) {
794 * The input is proportionally "wider" than the device viewport
795 * so its height needs to be adjusted
797 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
798 *scaled_width = device_info.native_width;
799 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
800 } else if (width_ratio < height_ratio) {
802 * The input is proportionally "taller" than the device viewport
803 * so its width needs to be adjusted
805 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
806 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
807 *scaled_height = device_info.native_height;
809 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
810 *scaled_width = device_info.native_width;
811 *scaled_height = device_info.native_height;
813 debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
818 AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
819 am7xxx_image_format format,
823 unsigned int image_size)
826 struct am7xxx_header h = {
827 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
828 .direction = AM7XXX_DIRECTION_OUT,
829 .header_data_len = sizeof(struct am7xxx_image_header),
837 .image_size = image_size,
842 ret = send_header(dev, &h);
846 if (image == NULL || image_size == 0) {
847 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
851 return send_data(dev, image, image_size);
854 AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
857 struct am7xxx_header h = {
858 .packet_type = AM7XXX_PACKET_TYPE_POWER,
859 .direction = AM7XXX_DIRECTION_OUT,
860 .header_data_len = sizeof(struct am7xxx_power_header),
866 case AM7XXX_POWER_OFF:
867 h.header_data.power.bit2 = 0;
868 h.header_data.power.bit1 = 0;
869 h.header_data.power.bit0 = 0;
872 case AM7XXX_POWER_LOW:
873 h.header_data.power.bit2 = 0;
874 h.header_data.power.bit1 = 0;
875 h.header_data.power.bit0 = 1;
878 case AM7XXX_POWER_MIDDLE:
879 h.header_data.power.bit2 = 0;
880 h.header_data.power.bit1 = 1;
881 h.header_data.power.bit0 = 0;
884 case AM7XXX_POWER_HIGH:
885 h.header_data.power.bit2 = 0;
886 h.header_data.power.bit1 = 1;
887 h.header_data.power.bit0 = 1;
890 case AM7XXX_POWER_TURBO:
891 h.header_data.power.bit2 = 1;
892 h.header_data.power.bit1 = 0;
893 h.header_data.power.bit0 = 0;
897 error(dev->ctx, "Unsupported power mode.\n");
901 ret = send_header(dev, &h);
908 AM7XXX_PUBLIC int am7xxx_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
911 struct am7xxx_header h = {
912 .packet_type = AM7XXX_PACKET_TYPE_ZOOM,
913 .direction = AM7XXX_DIRECTION_OUT,
914 .header_data_len = sizeof(struct am7xxx_zoom_header),
920 case AM7XXX_ZOOM_ORIGINAL:
921 h.header_data.zoom.bit1 = 0;
922 h.header_data.zoom.bit0 = 0;
926 h.header_data.zoom.bit1 = 0;
927 h.header_data.zoom.bit0 = 1;
930 case AM7XXX_ZOOM_H_V:
931 h.header_data.zoom.bit1 = 1;
932 h.header_data.zoom.bit0 = 0;
935 case AM7XXX_ZOOM_TEST:
936 h.header_data.zoom.bit1 = 1;
937 h.header_data.zoom.bit0 = 1;
941 error(dev->ctx, "Unsupported zoom mode.\n");
945 ret = send_header(dev, &h);