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 static void log_message(am7xxx_context *ctx,
44 ...) __attribute__ ((format (printf, 5, 6)));
46 #define fatal(...) log_message(NULL, AM7XXX_LOG_FATAL, __func__, __LINE__, __VA_ARGS__)
47 #define error(ctx, ...) log_message(ctx, AM7XXX_LOG_ERROR, __func__, __LINE__, __VA_ARGS__)
48 #define warning(ctx, ...) log_message(ctx, AM7XXX_LOG_WARNING, __func__, 0, __VA_ARGS__)
49 #define info(ctx, ...) log_message(ctx, AM7XXX_LOG_INFO, __func__, 0, __VA_ARGS__)
50 #define debug(ctx, ...) log_message(ctx, AM7XXX_LOG_DEBUG, __func__, 0, __VA_ARGS__)
51 #define trace(ctx, ...) log_message(ctx, AM7XXX_LOG_TRACE, NULL, 0, __VA_ARGS__)
53 struct am7xxx_usb_device_descriptor {
59 static struct am7xxx_usb_device_descriptor supported_devices[] = {
66 .name = "Philips/Sagemcom PicoPix 1020",
72 /* The header size on the wire is known to be always 24 bytes, regardless of
73 * the memory configuration enforced by different architectures or compilers
74 * for struct am7xxx_header
76 #define AM7XXX_HEADER_WIRE_SIZE 24
78 struct _am7xxx_device {
79 libusb_device_handle *usb_device;
80 uint8_t buffer[AM7XXX_HEADER_WIRE_SIZE];
85 struct _am7xxx_context {
86 libusb_context *usb_context;
88 am7xxx_device *devices_list;
92 AM7XXX_PACKET_TYPE_DEVINFO = 0x01,
93 AM7XXX_PACKET_TYPE_IMAGE = 0x02,
94 AM7XXX_PACKET_TYPE_POWER = 0x04,
95 AM7XXX_PACKET_TYPE_UNKNOWN = 0x05,
98 struct am7xxx_generic_header {
105 struct am7xxx_devinfo_header {
106 uint32_t native_width;
107 uint32_t native_height;
112 struct am7xxx_image_header {
119 struct am7xxx_power_header {
126 * Examples of packet headers:
129 * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
132 * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
135 struct am7xxx_header {
136 uint32_t packet_type;
138 uint8_t header_data_len;
142 struct am7xxx_generic_header data;
143 struct am7xxx_devinfo_header devinfo;
144 struct am7xxx_image_header image;
145 struct am7xxx_power_header power;
151 static void debug_dump_devinfo_header(am7xxx_context *ctx, struct am7xxx_devinfo_header *d)
153 if (ctx == NULL || d == NULL)
156 debug(ctx, "Info header:\n");
157 debug(ctx, "\tnative_width: 0x%08x (%u)\n", d->native_width, d->native_width);
158 debug(ctx, "\tnative_height: 0x%08x (%u)\n", d->native_height, d->native_height);
159 debug(ctx, "\tunknown0: 0x%08x (%u)\n", d->unknown0, d->unknown0);
160 debug(ctx, "\tunknown1: 0x%08x (%u)\n", d->unknown1, d->unknown1);
163 static void debug_dump_image_header(am7xxx_context *ctx, struct am7xxx_image_header *i)
165 if (ctx == NULL || i == NULL)
168 debug(ctx, "Image header:\n");
169 debug(ctx, "\tformat: 0x%08x (%u)\n", i->format, i->format);
170 debug(ctx, "\twidth: 0x%08x (%u)\n", i->width, i->width);
171 debug(ctx, "\theight: 0x%08x (%u)\n", i->height, i->height);
172 debug(ctx, "\timage size: 0x%08x (%u)\n", i->image_size, i->image_size);
175 static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_header *p)
177 if (ctx == NULL || p == NULL)
180 debug(ctx, "Power header:\n");
181 debug(ctx, "\tbit2: 0x%08x (%u)\n", p->bit2, p->bit2);
182 debug(ctx, "\tbit1: 0x%08x (%u)\n", p->bit1, p->bit1);
183 debug(ctx, "\tbit0: 0x%08x (%u)\n", p->bit0, p->bit0);
186 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
188 if (ctx == NULL || h == NULL)
191 debug(ctx, "BEGIN\n");
192 debug(ctx, "packet_type: 0x%08x (%u)\n", h->packet_type, h->packet_type);
193 debug(ctx, "unknown0: 0x%02hhx (%hhu)\n", h->unknown0, h->unknown0);
194 debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
195 debug(ctx, "unknown2: 0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
196 debug(ctx, "unknown3: 0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
198 switch(h->packet_type) {
199 case AM7XXX_PACKET_TYPE_DEVINFO:
200 debug_dump_devinfo_header(ctx, &(h->header_data.devinfo));
203 case AM7XXX_PACKET_TYPE_IMAGE:
204 debug_dump_image_header(ctx, &(h->header_data.image));
207 case AM7XXX_PACKET_TYPE_POWER:
208 debug_dump_power_header(ctx, &(h->header_data.power));
212 debug(ctx, "Packet type not supported!\n");
215 debug(ctx, "END\n\n");
218 static inline unsigned int in_80chars(unsigned int i)
220 /* The 3 below is the length of "xx " where xx is the hex string
221 * representation of a byte */
222 return ((i+1) % (80/3));
225 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
226 uint8_t *buffer, unsigned int len)
230 if (ctx == NULL || buffer == NULL || len == 0)
235 trace(ctx, "%s\n", message);
237 for (i = 0; i < len; i++) {
238 trace(ctx, "%02hhX%c", buffer[i], (in_80chars(i) && (i < len - 1)) ? ' ' : '\n');
243 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
249 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
250 uint8_t *buffer, unsigned int len)
259 static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
264 ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
265 if (ret != 0 || (unsigned int)transferred != len) {
266 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
267 ret, transferred, len);
271 trace_dump_buffer(dev->ctx, "<-- received", buffer, len);
276 static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
281 trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
283 ret = libusb_bulk_transfer(dev->usb_device, 1, buffer, len, &transferred, 0);
284 if (ret != 0 || (unsigned int)transferred != len) {
285 error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
286 ret, transferred, len);
293 static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
295 uint8_t **buffer_iterator = &buffer;
297 put_le32(h->packet_type, buffer_iterator);
298 put_8(h->unknown0, buffer_iterator);
299 put_8(h->header_data_len, buffer_iterator);
300 put_8(h->unknown2, buffer_iterator);
301 put_8(h->unknown3, buffer_iterator);
302 put_le32(h->header_data.data.field0, buffer_iterator);
303 put_le32(h->header_data.data.field1, buffer_iterator);
304 put_le32(h->header_data.data.field2, buffer_iterator);
305 put_le32(h->header_data.data.field3, buffer_iterator);
308 static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
310 uint8_t **buffer_iterator = &buffer;
312 h->packet_type = get_le32(buffer_iterator);
313 h->unknown0 = get_8(buffer_iterator);
314 h->header_data_len = get_8(buffer_iterator);
315 h->unknown2 = get_8(buffer_iterator);
316 h->unknown3 = get_8(buffer_iterator);
317 h->header_data.data.field0 = get_le32(buffer_iterator);
318 h->header_data.data.field1 = get_le32(buffer_iterator);
319 h->header_data.data.field2 = get_le32(buffer_iterator);
320 h->header_data.data.field3 = get_le32(buffer_iterator);
323 static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
327 ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
331 unserialize_header(dev->buffer, h);
333 debug_dump_header(dev->ctx, h);
341 static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
345 debug_dump_header(dev->ctx, h);
347 serialize_header(h, dev->buffer);
348 ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
350 error(dev->ctx, "failed to send data\n");
355 /* When level == AM7XXX_LOG_FATAL do not check the log_level from the context
356 * and print the message unconditionally, this makes it possible to print
357 * fatal messages even early on initialization, before the context has been
359 static void log_message(am7xxx_context *ctx,
361 const char *function,
368 if (level == AM7XXX_LOG_FATAL || (ctx && level <= ctx->log_level)) {
370 fprintf(stderr, "%s", function);
372 fprintf(stderr, "[%d]", line);
373 fprintf(stderr, ": ");
377 vfprintf(stderr, fmt, ap);
384 static am7xxx_device *add_new_device(am7xxx_context *ctx)
386 am7xxx_device **devices_list;
387 am7xxx_device *new_device;
390 fatal("context must not be NULL!\n");
394 devices_list = &(ctx->devices_list);
396 new_device = malloc(sizeof(*new_device));
397 if (new_device == NULL) {
398 fatal("cannot allocate a new device (%s)\n", strerror(errno));
401 memset(new_device, 0, sizeof(*new_device));
403 new_device->ctx = ctx;
405 if (*devices_list == NULL) {
406 *devices_list = new_device;
408 am7xxx_device *prev = *devices_list;
411 prev->next = new_device;
416 static am7xxx_device *find_device(am7xxx_context *ctx,
417 unsigned int device_index)
420 am7xxx_device *current;
423 fatal("context must not be NULL!\n");
427 current = ctx->devices_list;
428 while (current && i++ < device_index)
429 current = current->next;
435 SCAN_OP_BUILD_DEVLIST,
440 * This is where the central logic of multi-device support is.
442 * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
443 * 'dev' are ignored; the function returns 0 on success and a negative value
446 * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
447 * device with index 'open_device_index' and returns the correspondent
448 * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
449 * 1 if the device was already open and a negative value on error.
452 * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
453 * the caller might want to call am7xxx_shutdown() in order to remove
454 * devices possibly added before the failure.
456 static int scan_devices(am7xxx_context *ctx, scan_op op,
457 unsigned int open_device_index, am7xxx_device **dev)
460 libusb_device** list;
461 unsigned int current_index;
466 fatal("context must not be NULL!\n");
469 if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
470 error(ctx, "device scan done already? Abort!\n");
474 num_devices = libusb_get_device_list(ctx->usb_context, &list);
475 if (num_devices < 0) {
481 for (i = 0; i < num_devices; i++) {
482 struct libusb_device_descriptor desc;
485 ret = libusb_get_device_descriptor(list[i], &desc);
489 for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
490 if (desc.idVendor == supported_devices[j].vendor_id
491 && desc.idProduct == supported_devices[j].product_id) {
493 if (op == SCAN_OP_BUILD_DEVLIST) {
494 am7xxx_device *new_device;
495 info(ctx, "am7xxx device found, index: %d, name: %s\n",
497 supported_devices[j].name);
498 new_device = add_new_device(ctx);
499 if (new_device == NULL) {
500 /* XXX, the caller may want
501 * to call am7xxx_shutdown() if
502 * we fail here, as we may have
503 * added some devices already
505 debug(ctx, "Cannot create a new device\n");
509 } else if (op == SCAN_OP_OPEN_DEVICE &&
510 current_index == open_device_index) {
512 *dev = find_device(ctx, open_device_index);
518 /* the usb device has already been opened */
519 if ((*dev)->usb_device) {
520 debug(ctx, "(*dev)->usb_device already set\n");
525 ret = libusb_open(list[i], &((*dev)->usb_device));
527 debug(ctx, "libusb_open failed\n");
531 libusb_set_configuration((*dev)->usb_device, 1);
532 libusb_claim_interface((*dev)->usb_device, 0);
540 /* if we made it up to here we didn't find any device to open */
541 if (op == SCAN_OP_OPEN_DEVICE) {
542 error(ctx, "Cannot find any device to open\n");
547 /* everything went fine when building the device list */
550 libusb_free_device_list(list, 1);
554 int am7xxx_init(am7xxx_context **ctx)
558 *ctx = malloc(sizeof(**ctx));
560 fatal("cannot allocate the context (%s)\n", strerror(errno));
564 memset(*ctx, 0, sizeof(**ctx));
566 /* Set the highest log level during initialization */
567 (*ctx)->log_level = AM7XXX_LOG_TRACE;
569 ret = libusb_init(&((*ctx)->usb_context));
571 goto out_free_context;
573 libusb_set_debug((*ctx)->usb_context, 3);
575 ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
577 error(*ctx, "scan_devices() failed\n");
578 am7xxx_shutdown(*ctx);
582 /* Set a quieter log level as default for normal operation */
583 (*ctx)->log_level = AM7XXX_LOG_ERROR;
593 void am7xxx_shutdown(am7xxx_context *ctx)
595 am7xxx_device *current;
598 fatal("context must not be NULL!\n");
602 current = ctx->devices_list;
604 am7xxx_device *next = current->next;
605 am7xxx_close_device(current);
610 libusb_exit(ctx->usb_context);
615 void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
617 ctx->log_level = log_level;
620 int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
621 unsigned int device_index)
626 fatal("context must not be NULL!\n");
630 ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
633 } else if (ret > 0) {
634 warning(ctx, "device %d already open\n", device_index);
642 int am7xxx_close_device(am7xxx_device *dev)
645 fatal("dev must not be NULL!\n");
648 if (dev->usb_device) {
649 libusb_release_interface(dev->usb_device, 0);
650 libusb_close(dev->usb_device);
651 dev->usb_device = NULL;
656 int am7xxx_get_device_info(am7xxx_device *dev,
657 am7xxx_device_info *device_info)
660 struct am7xxx_header h = {
661 .packet_type = AM7XXX_PACKET_TYPE_DEVINFO,
663 .header_data_len = 0x00,
676 ret = send_header(dev, &h);
680 ret = read_header(dev, &h);
684 device_info->native_width = h.header_data.devinfo.native_width;
685 device_info->native_height = h.header_data.devinfo.native_height;
687 /* No reason to expose these in the public API until we know what they mean */
688 device_info->unknown0 = h.header_data.devinfo.unknown0;
689 device_info->unknown1 = h.header_data.devinfo.unknown1;
695 int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
696 unsigned int upscale,
697 unsigned int original_width,
698 unsigned int original_height,
699 unsigned int *scaled_width,
700 unsigned int *scaled_height)
703 am7xxx_device_info device_info;
708 ret = am7xxx_get_device_info(dev, &device_info);
710 error(dev->ctx, "cannot get device info\n");
715 * Check if we need to rescale; if the input image fits the native
716 * dimensions there is no need to, unless we want to upscale.
719 original_width <= device_info.native_width &&
720 original_height <= device_info.native_height ) {
721 debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
722 *scaled_width = original_width;
723 *scaled_height = original_height;
727 /* Input dimensions relative to the device native dimensions */
728 width_ratio = (float)original_width / device_info.native_width;
729 height_ratio = (float)original_height / device_info.native_height;
731 if (width_ratio > height_ratio) {
733 * The input is proportionally "wider" than the device viewport
734 * so its height needs to be adjusted
736 debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
737 *scaled_width = device_info.native_width;
738 *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
739 } else if (width_ratio < height_ratio) {
741 * The input is proportionally "taller" than the device viewport
742 * so its width needs to be adjusted
744 debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
745 *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
746 *scaled_height = device_info.native_height;
748 debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
749 *scaled_width = device_info.native_width;
750 *scaled_height = device_info.native_height;
752 debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
757 int am7xxx_send_image(am7xxx_device *dev,
758 am7xxx_image_format format,
762 unsigned int image_size)
765 struct am7xxx_header h = {
766 .packet_type = AM7XXX_PACKET_TYPE_IMAGE,
768 .header_data_len = sizeof(struct am7xxx_image_header),
776 .image_size = image_size,
781 ret = send_header(dev, &h);
785 if (image == NULL || image_size == 0) {
786 warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
790 return send_data(dev, image, image_size);
793 int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode)
796 struct am7xxx_header h = {
797 .packet_type = AM7XXX_PACKET_TYPE_POWER,
799 .header_data_len = sizeof(struct am7xxx_power_header),
805 case AM7XXX_POWER_OFF:
806 h.header_data.power.bit2 = 0;
807 h.header_data.power.bit1 = 0;
808 h.header_data.power.bit0 = 0;
811 case AM7XXX_POWER_LOW:
812 h.header_data.power.bit2 = 0;
813 h.header_data.power.bit1 = 0;
814 h.header_data.power.bit0 = 1;
816 case AM7XXX_POWER_MIDDLE:
817 h.header_data.power.bit2 = 0;
818 h.header_data.power.bit1 = 1;
819 h.header_data.power.bit0 = 0;
822 case AM7XXX_POWER_HIGH:
823 h.header_data.power.bit2 = 0;
824 h.header_data.power.bit1 = 1;
825 h.header_data.power.bit0 = 1;
828 case AM7XXX_POWER_TURBO:
829 h.header_data.power.bit2 = 1;
830 h.header_data.power.bit1 = 0;
831 h.header_data.power.bit0 = 0;
835 error(dev->ctx, "Power mode not supported!\n");
839 ret = send_header(dev, &h);