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",
96 /* The header size on the wire is known to be always 24 bytes, regardless of
97 * the memory configuration enforced by different architectures or compilers
98 * for struct am7xxx_header
100 #define AM7XXX_HEADER_WIRE_SIZE 24
102 struct _am7xxx_device {
103 libusb_device_handle *usb_device;
104 uint8_t buffer[AM7XXX_HEADER_WIRE_SIZE];
109 struct _am7xxx_context {
110 libusb_context *usb_context;
112 am7xxx_device *devices_list;
116 AM7XXX_PACKET_TYPE_DEVINFO = 0x01,
117 AM7XXX_PACKET_TYPE_IMAGE = 0x02,
118 AM7XXX_PACKET_TYPE_POWER = 0x04,
119 AM7XXX_PACKET_TYPE_ZOOM = 0x05,
120 } am7xxx_packet_type;
122 struct am7xxx_generic_header {
129 struct am7xxx_devinfo_header {
130 uint32_t native_width;
131 uint32_t native_height;
136 struct am7xxx_image_header {
143 struct am7xxx_power_header {
149 struct am7xxx_zoom_header {
155 * Examples of packet headers:
158 * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
161 * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
164 /* Direction of the communication from the host point of view */
165 #define AM7XXX_DIRECTION_OUT 0 /* host -> device */
166 #define AM7XXX_DIRECTION_IN 1 /* host <- device */
168 struct am7xxx_header {
169 uint32_t packet_type;
171 uint8_t header_data_len;
175 struct am7xxx_generic_header data;
176 struct am7xxx_devinfo_header devinfo;
177 struct am7xxx_image_header image;
178 struct am7xxx_power_header power;
179 struct am7xxx_zoom_header zoom;
185 static void debug_dump_devinfo_header(am7xxx_context *ctx, struct am7xxx_devinfo_header *d)
187 if (ctx == NULL || d == NULL)
190 debug(ctx, "Info header:\n");
191 debug(ctx, "\tnative_width: 0x%08x (%u)\n", d->native_width, d->native_width);
192 debug(ctx, "\tnative_height: 0x%08x (%u)\n", d->native_height, d->native_height);
193 debug(ctx, "\tunknown0: 0x%08x (%u)\n", d->unknown0, d->unknown0);
194 debug(ctx, "\tunknown1: 0x%08x (%u)\n", d->unknown1, d->unknown1);
197 static void debug_dump_image_header(am7xxx_context *ctx, struct am7xxx_image_header *i)
199 if (ctx == NULL || i == NULL)
202 debug(ctx, "Image header:\n");
203 debug(ctx, "\tformat: 0x%08x (%u)\n", i->format, i->format);
204 debug(ctx, "\twidth: 0x%08x (%u)\n", i->width, i->width);
205 debug(ctx, "\theight: 0x%08x (%u)\n", i->height, i->height);
206 debug(ctx, "\timage size: 0x%08x (%u)\n", i->image_size, i->image_size);
209 static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_header *p)
211 if (ctx == NULL || p == NULL)
214 debug(ctx, "Power header:\n");
215 debug(ctx, "\tbit2: 0x%08x (%u)\n", p->bit2, p->bit2);
216 debug(ctx, "\tbit1: 0x%08x (%u)\n", p->bit1, p->bit1);
217 debug(ctx, "\tbit0: 0x%08x (%u)\n", p->bit0, p->bit0);
220 static void debug_dump_zoom_header(am7xxx_context *ctx, struct am7xxx_zoom_header *z)
222 if (ctx == NULL || z == NULL)
225 debug(ctx, "Zoom header:\n");
226 debug(ctx, "\tbit1: 0x%08x (%u)\n", z->bit1, z->bit1);
227 debug(ctx, "\tbit0: 0x%08x (%u)\n", z->bit0, z->bit0);
230 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
232 if (ctx == NULL || h == NULL)
235 debug(ctx, "BEGIN\n");
236 debug(ctx, "packet_type: 0x%08x (%u)\n", h->packet_type, h->packet_type);
237 debug(ctx, "direction: 0x%02hhx (%hhu)\n", h->direction, h->direction);
238 debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
239 debug(ctx, "unknown2: 0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
240 debug(ctx, "unknown3: 0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
242 switch(h->packet_type) {
243 case AM7XXX_PACKET_TYPE_DEVINFO:
244 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
247 case AM7XXX_PACKET_TYPE_IMAGE:
248 debug_dump_image_header(ctx, &(h->header_data.image));
251 case AM7XXX_PACKET_TYPE_POWER:
252 debug_dump_power_header(ctx, &(h->header_data.power));
255 case AM7XXX_PACKET_TYPE_ZOOM:
256 debug_dump_zoom_header(ctx, &(h->header_data.zoom));
260 debug(ctx, "Packet type not supported!\n");
263 debug(ctx, "END\n\n");
266 static inline unsigned int in_80chars(unsigned int i)
268 /* The 3 below is the length of "xx " where xx is the hex string
269 * representation of a byte */
270 return ((i+1) % (80/3));
273 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
274 uint8_t *buffer, unsigned int len)
278 if (ctx == NULL || buffer == NULL || len == 0)
283 trace(ctx, "%s\n", message);
285 for (i = 0; i < len; i++) {
286 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
291 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
297 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
298 uint8_t *buffer, unsigned int len)
307 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
312 ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
313 if (ret != 0 || (unsigned int)transferred != len) {
314 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
315 ret, transferred, len);
319 trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
324 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
329 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
331 ret = libusb_bulk_transfer(dev->usb_device, 0x1, buffer, len, &transferred, 0);
332 if (ret != 0 || (unsigned int)transferred != len) {
333 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
334 ret, transferred, len);
341 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
343 uint8_t **buffer_iterator = &buffer;
345 put_le32(h->packet_type, buffer_iterator);
346 put_8(h->direction, buffer_iterator);
347 put_8(h->header_data_len, buffer_iterator);
348 put_8(h->unknown2, buffer_iterator);
349 put_8(h->unknown3, buffer_iterator);
350 put_le32(h->header_data.data.field0, buffer_iterator);
351 put_le32(h->header_data.data.field1, buffer_iterator);
352 put_le32(h->header_data.data.field2, buffer_iterator);
353 put_le32(h->header_data.data.field3, buffer_iterator);
356 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
358 uint8_t **buffer_iterator = &buffer;
360 h->packet_type = get_le32(buffer_iterator);
361 h->direction = get_8(buffer_iterator);
362 h->header_data_len = get_8(buffer_iterator);
363 h->unknown2 = get_8(buffer_iterator);
364 h->unknown3 = get_8(buffer_iterator);
365 h->header_data.data.field0 = get_le32(buffer_iterator);
366 h->header_data.data.field1 = get_le32(buffer_iterator);
367 h->header_data.data.field2 = get_le32(buffer_iterator);
368 h->header_data.data.field3 = get_le32(buffer_iterator);
371 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
375 ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
379 unserialize_header(dev->buffer, h);
381 debug_dump_header(dev->ctx, h);
383 if (h->direction == AM7XXX_DIRECTION_IN) {
387 "Received a packet with direction AM7XXX_DIRECTION_OUT, weird!\n");
395 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
399 debug_dump_header(dev->ctx, h);
401 serialize_header(h, dev->buffer);
402 ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
404 error(dev->ctx, "failed to send data\n");
409 /* When level == AM7XXX_LOG_FATAL do not check the log_level from the context
410 * and print the message unconditionally, this makes it possible to print
411 * fatal messages even early on initialization, before the context has been
413 static void log_message(am7xxx_context *ctx,
415 const char *function,
422 if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
424 fprintf(stderr, "%s", function);
426 fprintf(stderr, "[%d]", line);
427 fprintf(stderr, ": ");
431 vfprintf(stderr, fmt, ap);
438 static am7xxx_device *add_new_device(am7xxx_context *ctx)
440 am7xxx_device **devices_list;
441 am7xxx_device *new_device;
444 fatal("context must not be NULL!\n");
448 devices_list = &(ctx->devices_list);
450 new_device = malloc(sizeof(*new_device));
451 if (new_device == NULL) {
452 fatal("cannot allocate a new device (%s)\n", strerror(errno));
455 memset(new_device, 0, sizeof(*new_device));
457 new_device->ctx = ctx;
459 if (*devices_list == NULL) {
460 *devices_list = new_device;
462 am7xxx_device *prev = *devices_list;
465 prev->next = new_device;
470 static am7xxx_device *find_device(am7xxx_context *ctx,
471 unsigned int device_index)
474 am7xxx_device *current;
477 fatal("context must not be NULL!\n");
481 current = ctx->devices_list;
482 while (current && i++ < device_index)
483 current = current->next;
489 SCAN_OP_BUILD_DEVLIST,
494 * This is where the central logic of multi-device support is.
496 * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
497 * 'dev' are ignored; the function returns 0 on success and a negative value
500 * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
501 * device with index 'open_device_index' and returns the correspondent
502 * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
503 * 1 if the device was already open and a negative value on error.
506 * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
507 * the caller might want to call am7xxx_shutdown() in order to remove
508 * devices possibly added before the failure.
510 static int scan_devices(am7xxx_context *ctx, scan_op op,
511 unsigned int open_device_index, am7xxx_device **dev)
514 libusb_device** list;
515 unsigned int current_index;
520 fatal("context must not be NULL!\n");
523 if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
524 error(ctx, "device scan done already? Abort!\n");
528 num_devices = libusb_get_device_list(ctx->usb_context, &list);
529 if (num_devices < 0) {
535 for (i = 0; i < num_devices; i++) {
536 struct libusb_device_descriptor desc;
539 ret = libusb_get_device_descriptor(list[i], &desc);
543 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
544 if (desc.idVendor == supported_devices[j].vendor_id
545 && desc.idProduct == supported_devices[j].product_id) {
547 if (op == SCAN_OP_BUILD_DEVLIST) {
548 am7xxx_device *new_device;
549 info(ctx, "am7xxx device found, index: %d, name: %s\n",
551 supported_devices[j].name);
552 new_device = add_new_device(ctx);
553 if (new_device == NULL) {
554 /* XXX, the caller may want
555 * to call am7xxx_shutdown() if
556 * we fail here, as we may have
557 * added some devices already
559 debug(ctx, "Cannot create a new device\n");
563 } else if (op == SCAN_OP_OPEN_DEVICE &&
564 current_index == open_device_index) {
566 *dev = find_device(ctx, open_device_index);
572 /* the usb device has already been opened */
573 if ((*dev)->usb_device) {
574 debug(ctx, "(*dev)->usb_device already set\n");
579 ret = libusb_open(list[i], &((*dev)->usb_device));
581 debug(ctx, "libusb_open failed\n");
585 libusb_set_configuration((*dev)->usb_device, 2);
586 libusb_claim_interface((*dev)->usb_device, 0);
594 /* if we made it up to here we didn't find any device to open */
595 if (op == SCAN_OP_OPEN_DEVICE) {
596 error(ctx, "Cannot find any device to open\n");
601 /* everything went fine when building the device list */
604 libusb_free_device_list(list, 1);
610 AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
614 *ctx = malloc(sizeof(**ctx));
616 fatal("cannot allocate the context (%s)\n", strerror(errno));
620 memset(*ctx, 0, sizeof(**ctx));
622 /* Set the highest log level during initialization */
623 (*ctx)->log_level = AM7XXX_LOG_TRACE;
625 ret = libusb_init(&((*ctx)->usb_context));
627 goto out_free_context;
629 libusb_set_debug((*ctx)->usb_context, 3);
631 ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
633 error(*ctx, "scan_devices() failed\n");
634 am7xxx_shutdown(*ctx);
638 /* Set a quieter log level as default for normal operation */
639 (*ctx)->log_level = AM7XXX_LOG_ERROR;
649 AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
651 am7xxx_device *current;
654 fatal("context must not be NULL!\n");
658 current = ctx->devices_list;
660 am7xxx_device *next = current->next;
661 am7xxx_close_device(current);
666 libusb_exit(ctx->usb_context);
671 AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
673 ctx->log_level = log_level;
676 AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
677 unsigned int device_index)
682 fatal("context must not be NULL!\n");
686 ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
689 } else if (ret > 0) {
690 warning(ctx, "device %d already open\n", device_index);
698 AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
701 fatal("dev must not be NULL!\n");
704 if (dev->usb_device) {
705 libusb_release_interface(dev->usb_device, 0);
706 libusb_close(dev->usb_device);
707 dev->usb_device = NULL;
712 AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
713 am7xxx_device_info *device_info)
716 struct am7xxx_header h = {
717 .packet_type = AM7XXX_PACKET_TYPE_DEVINFO,
718 .direction = AM7XXX_DIRECTION_OUT,
719 .header_data_len = 0x00,
732 ret = send_header(dev, &h);
736 ret = read_header(dev, &h);
740 device_info->native_width = h.header_data.devinfo.native_width;
741 device_info->native_height = h.header_data.devinfo.native_height;
743 /* No reason to expose these in the public API until we know what they mean */
744 device_info->unknown0 = h.header_data.devinfo.unknown0;
745 device_info->unknown1 = h.header_data.devinfo.unknown1;
751 AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
752 unsigned int upscale,
753 unsigned int original_width,
754 unsigned int original_height,
755 unsigned int *scaled_width,
756 unsigned int *scaled_height)
759 am7xxx_device_info device_info;
764 ret = am7xxx_get_device_info(dev, &device_info);
766 error(dev->ctx, "cannot get device info\n");
771 * Check if we need to rescale; if the input image fits the native
772 * dimensions there is no need to, unless we want to upscale.
775 original_width <= device_info.native_width &&
776 original_height <= device_info.native_height ) {
777 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
778 *scaled_width = original_width;
779 *scaled_height = original_height;
783 /* Input dimensions relative to the device native dimensions */
784 width_ratio = (float)original_width / device_info.native_width;
785 height_ratio = (float)original_height / device_info.native_height;
787 if (width_ratio > height_ratio) {
789 * The input is proportionally "wider" than the device viewport
790 * so its height needs to be adjusted
792 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
793 *scaled_width = device_info.native_width;
794 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
795 } else if (width_ratio < height_ratio) {
797 * The input is proportionally "taller" than the device viewport
798 * so its width needs to be adjusted
800 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
801 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
802 *scaled_height = device_info.native_height;
804 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
805 *scaled_width = device_info.native_width;
806 *scaled_height = device_info.native_height;
808 debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
813 AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
814 am7xxx_image_format format,
818 unsigned int image_size)
821 struct am7xxx_header h = {
822 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
823 .direction = AM7XXX_DIRECTION_OUT,
824 .header_data_len = sizeof(struct am7xxx_image_header),
832 .image_size = image_size,
837 ret = send_header(dev, &h);
841 if (image == NULL || image_size == 0) {
842 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
846 return send_data(dev, image, image_size);
849 AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
852 struct am7xxx_header h = {
853 .packet_type = AM7XXX_PACKET_TYPE_POWER,
854 .direction = AM7XXX_DIRECTION_OUT,
855 .header_data_len = sizeof(struct am7xxx_power_header),
861 case AM7XXX_POWER_OFF:
862 h.header_data.power.bit2 = 0;
863 h.header_data.power.bit1 = 0;
864 h.header_data.power.bit0 = 0;
867 case AM7XXX_POWER_LOW:
868 h.header_data.power.bit2 = 0;
869 h.header_data.power.bit1 = 0;
870 h.header_data.power.bit0 = 1;
873 case AM7XXX_POWER_MIDDLE:
874 h.header_data.power.bit2 = 0;
875 h.header_data.power.bit1 = 1;
876 h.header_data.power.bit0 = 0;
879 case AM7XXX_POWER_HIGH:
880 h.header_data.power.bit2 = 0;
881 h.header_data.power.bit1 = 1;
882 h.header_data.power.bit0 = 1;
885 case AM7XXX_POWER_TURBO:
886 h.header_data.power.bit2 = 1;
887 h.header_data.power.bit1 = 0;
888 h.header_data.power.bit0 = 0;
892 error(dev->ctx, "Unsupported power mode.\n");
896 ret = send_header(dev, &h);
903 AM7XXX_PUBLIC int am7xxx_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
906 struct am7xxx_header h = {
907 .packet_type = AM7XXX_PACKET_TYPE_ZOOM,
908 .direction = AM7XXX_DIRECTION_OUT,
909 .header_data_len = sizeof(struct am7xxx_zoom_header),
915 case AM7XXX_ZOOM_ORIGINAL:
916 h.header_data.zoom.bit1 = 0;
917 h.header_data.zoom.bit0 = 0;
921 h.header_data.zoom.bit1 = 0;
922 h.header_data.zoom.bit0 = 1;
925 case AM7XXX_ZOOM_H_V:
926 h.header_data.zoom.bit1 = 1;
927 h.header_data.zoom.bit0 = 0;
930 case AM7XXX_ZOOM_TEST:
931 h.header_data.zoom.bit1 = 1;
932 h.header_data.zoom.bit0 = 1;
936 error(dev->ctx, "Unsupported zoom mode.\n");
940 ret = send_header(dev, &h);