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_UNKNOWN = 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 {
150 * Examples of packet headers:
153 * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
156 * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
159 struct am7xxx_header {
160 uint32_t packet_type;
162 uint8_t header_data_len;
166 struct am7xxx_generic_header data;
167 struct am7xxx_devinfo_header devinfo;
168 struct am7xxx_image_header image;
169 struct am7xxx_power_header power;
175 static void debug_dump_devinfo_header(am7xxx_context *ctx, struct am7xxx_devinfo_header *d)
177 if (ctx == NULL || d == NULL)
180 debug(ctx, "Info header:\n");
181 debug(ctx, "\tnative_width: 0x%08x (%u)\n", d->native_width, d->native_width);
182 debug(ctx, "\tnative_height: 0x%08x (%u)\n", d->native_height, d->native_height);
183 debug(ctx, "\tunknown0: 0x%08x (%u)\n", d->unknown0, d->unknown0);
184 debug(ctx, "\tunknown1: 0x%08x (%u)\n", d->unknown1, d->unknown1);
187 static void debug_dump_image_header(am7xxx_context *ctx, struct am7xxx_image_header *i)
189 if (ctx == NULL || i == NULL)
192 debug(ctx, "Image header:\n");
193 debug(ctx, "\tformat: 0x%08x (%u)\n", i->format, i->format);
194 debug(ctx, "\twidth: 0x%08x (%u)\n", i->width, i->width);
195 debug(ctx, "\theight: 0x%08x (%u)\n", i->height, i->height);
196 debug(ctx, "\timage size: 0x%08x (%u)\n", i->image_size, i->image_size);
199 static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_header *p)
201 if (ctx == NULL || p == NULL)
204 debug(ctx, "Power header:\n");
205 debug(ctx, "\tbit2: 0x%08x (%u)\n", p->bit2, p->bit2);
206 debug(ctx, "\tbit1: 0x%08x (%u)\n", p->bit1, p->bit1);
207 debug(ctx, "\tbit0: 0x%08x (%u)\n", p->bit0, p->bit0);
210 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
212 if (ctx == NULL || h == NULL)
215 debug(ctx, "BEGIN\n");
216 debug(ctx, "packet_type: 0x%08x (%u)\n", h->packet_type, h->packet_type);
217 debug(ctx, "unknown0: 0x%02hhx (%hhu)\n", h->unknown0, h->unknown0);
218 debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
219 debug(ctx, "unknown2: 0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
220 debug(ctx, "unknown3: 0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
222 switch(h->packet_type) {
223 case AM7XXX_PACKET_TYPE_DEVINFO:
224 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
227 case AM7XXX_PACKET_TYPE_IMAGE:
228 debug_dump_image_header(ctx, &(h->header_data.image));
231 case AM7XXX_PACKET_TYPE_POWER:
232 debug_dump_power_header(ctx, &(h->header_data.power));
236 debug(ctx, "Packet type not supported!\n");
239 debug(ctx, "END\n\n");
242 static inline unsigned int in_80chars(unsigned int i)
244 /* The 3 below is the length of "xx " where xx is the hex string
245 * representation of a byte */
246 return ((i+1) % (80/3));
249 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
250 uint8_t *buffer, unsigned int len)
254 if (ctx == NULL || buffer == NULL || len == 0)
259 trace(ctx, "%s\n", message);
261 for (i = 0; i < len; i++) {
262 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
267 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
273 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
274 uint8_t *buffer, unsigned int len)
283 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
288 ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
289 if (ret != 0 || (unsigned int)transferred != len) {
290 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
291 ret, transferred, len);
295 trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
300 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
305 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
307 ret = libusb_bulk_transfer(dev->usb_device, 0x1, buffer, len, &transferred, 0);
308 if (ret != 0 || (unsigned int)transferred != len) {
309 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
310 ret, transferred, len);
317 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
319 uint8_t **buffer_iterator = &buffer;
321 put_le32(h->packet_type, buffer_iterator);
322 put_8(h->unknown0, buffer_iterator);
323 put_8(h->header_data_len, buffer_iterator);
324 put_8(h->unknown2, buffer_iterator);
325 put_8(h->unknown3, buffer_iterator);
326 put_le32(h->header_data.data.field0, buffer_iterator);
327 put_le32(h->header_data.data.field1, buffer_iterator);
328 put_le32(h->header_data.data.field2, buffer_iterator);
329 put_le32(h->header_data.data.field3, buffer_iterator);
332 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
334 uint8_t **buffer_iterator = &buffer;
336 h->packet_type = get_le32(buffer_iterator);
337 h->unknown0 = get_8(buffer_iterator);
338 h->header_data_len = get_8(buffer_iterator);
339 h->unknown2 = get_8(buffer_iterator);
340 h->unknown3 = get_8(buffer_iterator);
341 h->header_data.data.field0 = get_le32(buffer_iterator);
342 h->header_data.data.field1 = get_le32(buffer_iterator);
343 h->header_data.data.field2 = get_le32(buffer_iterator);
344 h->header_data.data.field3 = get_le32(buffer_iterator);
347 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
351 ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
355 unserialize_header(dev->buffer, h);
357 debug_dump_header(dev->ctx, h);
365 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
369 debug_dump_header(dev->ctx, h);
371 serialize_header(h, dev->buffer);
372 ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
374 error(dev->ctx, "failed to send data\n");
379 /* When level == AM7XXX_LOG_FATAL do not check the log_level from the context
380 * and print the message unconditionally, this makes it possible to print
381 * fatal messages even early on initialization, before the context has been
383 static void log_message(am7xxx_context *ctx,
385 const char *function,
392 if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
394 fprintf(stderr, "%s", function);
396 fprintf(stderr, "[%d]", line);
397 fprintf(stderr, ": ");
401 vfprintf(stderr, fmt, ap);
408 static am7xxx_device *add_new_device(am7xxx_context *ctx)
410 am7xxx_device **devices_list;
411 am7xxx_device *new_device;
414 fatal("context must not be NULL!\n");
418 devices_list = &(ctx->devices_list);
420 new_device = malloc(sizeof(*new_device));
421 if (new_device == NULL) {
422 fatal("cannot allocate a new device (%s)\n", strerror(errno));
425 memset(new_device, 0, sizeof(*new_device));
427 new_device->ctx = ctx;
429 if (*devices_list == NULL) {
430 *devices_list = new_device;
432 am7xxx_device *prev = *devices_list;
435 prev->next = new_device;
440 static am7xxx_device *find_device(am7xxx_context *ctx,
441 unsigned int device_index)
444 am7xxx_device *current;
447 fatal("context must not be NULL!\n");
451 current = ctx->devices_list;
452 while (current && i++ < device_index)
453 current = current->next;
459 SCAN_OP_BUILD_DEVLIST,
464 * This is where the central logic of multi-device support is.
466 * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
467 * 'dev' are ignored; the function returns 0 on success and a negative value
470 * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
471 * device with index 'open_device_index' and returns the correspondent
472 * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
473 * 1 if the device was already open and a negative value on error.
476 * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
477 * the caller might want to call am7xxx_shutdown() in order to remove
478 * devices possibly added before the failure.
480 static int scan_devices(am7xxx_context *ctx, scan_op op,
481 unsigned int open_device_index, am7xxx_device **dev)
484 libusb_device** list;
485 unsigned int current_index;
490 fatal("context must not be NULL!\n");
493 if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
494 error(ctx, "device scan done already? Abort!\n");
498 num_devices = libusb_get_device_list(ctx->usb_context, &list);
499 if (num_devices < 0) {
505 for (i = 0; i < num_devices; i++) {
506 struct libusb_device_descriptor desc;
509 ret = libusb_get_device_descriptor(list[i], &desc);
513 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
514 if (desc.idVendor == supported_devices[j].vendor_id
515 && desc.idProduct == supported_devices[j].product_id) {
517 if (op == SCAN_OP_BUILD_DEVLIST) {
518 am7xxx_device *new_device;
519 info(ctx, "am7xxx device found, index: %d, name: %s\n",
521 supported_devices[j].name);
522 new_device = add_new_device(ctx);
523 if (new_device == NULL) {
524 /* XXX, the caller may want
525 * to call am7xxx_shutdown() if
526 * we fail here, as we may have
527 * added some devices already
529 debug(ctx, "Cannot create a new device\n");
533 } else if (op == SCAN_OP_OPEN_DEVICE &&
534 current_index == open_device_index) {
536 *dev = find_device(ctx, open_device_index);
542 /* the usb device has already been opened */
543 if ((*dev)->usb_device) {
544 debug(ctx, "(*dev)->usb_device already set\n");
549 ret = libusb_open(list[i], &((*dev)->usb_device));
551 debug(ctx, "libusb_open failed\n");
555 libusb_set_configuration((*dev)->usb_device, 2);
556 libusb_claim_interface((*dev)->usb_device, 0);
564 /* if we made it up to here we didn't find any device to open */
565 if (op == SCAN_OP_OPEN_DEVICE) {
566 error(ctx, "Cannot find any device to open\n");
571 /* everything went fine when building the device list */
574 libusb_free_device_list(list, 1);
580 AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
584 *ctx = malloc(sizeof(**ctx));
586 fatal("cannot allocate the context (%s)\n", strerror(errno));
590 memset(*ctx, 0, sizeof(**ctx));
592 /* Set the highest log level during initialization */
593 (*ctx)->log_level = AM7XXX_LOG_TRACE;
595 ret = libusb_init(&((*ctx)->usb_context));
597 goto out_free_context;
599 libusb_set_debug((*ctx)->usb_context, 3);
601 ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
603 error(*ctx, "scan_devices() failed\n");
604 am7xxx_shutdown(*ctx);
608 /* Set a quieter log level as default for normal operation */
609 (*ctx)->log_level = AM7XXX_LOG_ERROR;
619 AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
621 am7xxx_device *current;
624 fatal("context must not be NULL!\n");
628 current = ctx->devices_list;
630 am7xxx_device *next = current->next;
631 am7xxx_close_device(current);
636 libusb_exit(ctx->usb_context);
641 AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
643 ctx->log_level = log_level;
646 AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
647 unsigned int device_index)
652 fatal("context must not be NULL!\n");
656 ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
659 } else if (ret > 0) {
660 warning(ctx, "device %d already open\n", device_index);
668 AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
671 fatal("dev must not be NULL!\n");
674 if (dev->usb_device) {
675 libusb_release_interface(dev->usb_device, 0);
676 libusb_close(dev->usb_device);
677 dev->usb_device = NULL;
682 AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
683 am7xxx_device_info *device_info)
686 struct am7xxx_header h = {
687 .packet_type = AM7XXX_PACKET_TYPE_DEVINFO,
689 .header_data_len = 0x00,
702 ret = send_header(dev, &h);
706 ret = read_header(dev, &h);
710 device_info->native_width = h.header_data.devinfo.native_width;
711 device_info->native_height = h.header_data.devinfo.native_height;
713 /* No reason to expose these in the public API until we know what they mean */
714 device_info->unknown0 = h.header_data.devinfo.unknown0;
715 device_info->unknown1 = h.header_data.devinfo.unknown1;
721 AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
722 unsigned int upscale,
723 unsigned int original_width,
724 unsigned int original_height,
725 unsigned int *scaled_width,
726 unsigned int *scaled_height)
729 am7xxx_device_info device_info;
734 ret = am7xxx_get_device_info(dev, &device_info);
736 error(dev->ctx, "cannot get device info\n");
741 * Check if we need to rescale; if the input image fits the native
742 * dimensions there is no need to, unless we want to upscale.
745 original_width <= device_info.native_width &&
746 original_height <= device_info.native_height ) {
747 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
748 *scaled_width = original_width;
749 *scaled_height = original_height;
753 /* Input dimensions relative to the device native dimensions */
754 width_ratio = (float)original_width / device_info.native_width;
755 height_ratio = (float)original_height / device_info.native_height;
757 if (width_ratio > height_ratio) {
759 * The input is proportionally "wider" than the device viewport
760 * so its height needs to be adjusted
762 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
763 *scaled_width = device_info.native_width;
764 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
765 } else if (width_ratio < height_ratio) {
767 * The input is proportionally "taller" than the device viewport
768 * so its width needs to be adjusted
770 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
771 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
772 *scaled_height = device_info.native_height;
774 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
775 *scaled_width = device_info.native_width;
776 *scaled_height = device_info.native_height;
778 debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
783 AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
784 am7xxx_image_format format,
788 unsigned int image_size)
791 struct am7xxx_header h = {
792 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
794 .header_data_len = sizeof(struct am7xxx_image_header),
802 .image_size = image_size,
807 ret = send_header(dev, &h);
811 if (image == NULL || image_size == 0) {
812 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
816 return send_data(dev, image, image_size);
819 AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode)
822 struct am7xxx_header h = {
823 .packet_type = AM7XXX_PACKET_TYPE_POWER,
825 .header_data_len = sizeof(struct am7xxx_power_header),
831 case AM7XXX_POWER_OFF:
832 h.header_data.power.bit2 = 0;
833 h.header_data.power.bit1 = 0;
834 h.header_data.power.bit0 = 0;
837 case AM7XXX_POWER_LOW:
838 h.header_data.power.bit2 = 0;
839 h.header_data.power.bit1 = 0;
840 h.header_data.power.bit0 = 1;
842 case AM7XXX_POWER_MIDDLE:
843 h.header_data.power.bit2 = 0;
844 h.header_data.power.bit1 = 1;
845 h.header_data.power.bit0 = 0;
848 case AM7XXX_POWER_HIGH:
849 h.header_data.power.bit2 = 0;
850 h.header_data.power.bit1 = 1;
851 h.header_data.power.bit0 = 1;
854 case AM7XXX_POWER_TURBO:
855 h.header_data.power.bit2 = 1;
856 h.header_data.power.bit1 = 0;
857 h.header_data.power.bit0 = 0;
861 error(dev->ctx, "Power mode not supported!\n");
865 ret = send_header(dev, &h);