am7xxx: pass the context to add_new_device() and find_device()
[libam7xxx.git] / src / am7xxx.c
index cdcbf3f..1ece881 100644 (file)
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 #include <errno.h>
+#include <libusb.h>
 
 #include "am7xxx.h"
 #include "serialize.h"
 
-#define AM7XXX_VENDOR_ID  0x1de1
-#define AM7XXX_PRODUCT_ID 0xc101
+#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
+
+struct am7xxx_usb_device_descriptor {
+       const char *name;
+       uint16_t vendor_id;
+       uint16_t product_id;
+};
+
+static struct am7xxx_usb_device_descriptor supported_devices[] = {
+       {
+               .name       = "Acer C110",
+               .vendor_id  = 0x1de1,
+               .product_id = 0xc101,
+       },
+       {
+               .name       = "Philips/Sagemcom PicoPix 1020",
+               .vendor_id  = 0x21e7,
+               .product_id = 0x000e,
+       },
+};
+
+/* The header size on the wire is known to be always 24 bytes, regardless of
+ * the memory configuration enforced by different architechtures or compilers
+ * for struct am7xxx_header
+ */
+#define AM7XXX_HEADER_WIRE_SIZE 24
+
+struct _am7xxx_device {
+       libusb_device_handle *usb_device;
+       uint8_t buffer[AM7XXX_HEADER_WIRE_SIZE];
+       am7xxx_device *next;
+};
+
+struct _am7xxx_context {
+       libusb_context *usb_context;
+       am7xxx_device *devices_list;
+};
+
+typedef enum {
+       AM7XXX_PACKET_TYPE_DEVINFO = 0x01,
+       AM7XXX_PACKET_TYPE_IMAGE   = 0x02,
+       AM7XXX_PACKET_TYPE_POWER   = 0x04,
+       AM7XXX_PACKET_TYPE_UNKNOWN = 0x05,
+} am7xxx_packet_type;
+
+struct am7xxx_generic_header {
+       uint32_t field0;
+       uint32_t field1;
+       uint32_t field2;
+       uint32_t field3;
+};
+
+struct am7xxx_devinfo_header {
+       uint32_t native_width;
+       uint32_t native_height;
+       uint32_t unknown0;
+       uint32_t unknown1;
+};
+
+struct am7xxx_image_header {
+       uint32_t format;
+       uint32_t width;
+       uint32_t height;
+       uint32_t image_size;
+};
+
+struct am7xxx_power_header {
+       uint32_t bit2;
+       uint32_t bit1;
+       uint32_t bit0;
+};
+
+/*
+ * Examples of packet headers:
+ *
+ * Image header:
+ * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
+ *
+ * Power header:
+ * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+ */
+
+struct am7xxx_header {
+       uint32_t packet_type;
+       uint8_t unknown0;
+       uint8_t header_data_len;
+       uint8_t unknown2;
+       uint8_t unknown3;
+       union {
+               struct am7xxx_generic_header data;
+               struct am7xxx_devinfo_header devinfo;
+               struct am7xxx_image_header image;
+               struct am7xxx_power_header power;
+       } header_data;
+};
+
 
 static void dump_devinfo_header(struct am7xxx_devinfo_header *d)
 {
@@ -113,12 +209,12 @@ static void dump_buffer(uint8_t *buffer, unsigned int len)
        fflush(stdout);
 }
 
-static int read_data(am7xxx_device dev, uint8_t *buffer, unsigned int len)
+static int read_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
 {
        int ret;
-       int transferred;
+       int transferred = 0;
 
-       ret = libusb_bulk_transfer(dev, 0x81, buffer, len, &transferred, 0);
+       ret = libusb_bulk_transfer(dev->usb_device, 0x81, buffer, len, &transferred, 0);
        if (ret != 0 || (unsigned int)transferred != len) {
                fprintf(stderr, "Error: ret: %d\ttransferred: %d (expected %u)\n",
                        ret, transferred, len);
@@ -134,10 +230,10 @@ static int read_data(am7xxx_device dev, uint8_t *buffer, unsigned int len)
        return 0;
 }
 
-static int send_data(am7xxx_device dev, uint8_t *buffer, unsigned int len)
+static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
 {
        int ret;
-       int transferred;
+       int transferred = 0;
 
 #if DEBUG
        printf("\nsending -->\n");
@@ -145,7 +241,7 @@ static int send_data(am7xxx_device dev, uint8_t *buffer, unsigned int len)
        printf("\n");
 #endif
 
-       ret = libusb_bulk_transfer(dev, 1, buffer, len, &transferred, 0);
+       ret = libusb_bulk_transfer(dev->usb_device, 1, buffer, len, &transferred, 0);
        if (ret != 0 || (unsigned int)transferred != len) {
                fprintf(stderr, "Error: ret: %d\ttransferred: %d (expected %u)\n",
                        ret, transferred, len);
@@ -185,22 +281,15 @@ static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
        h->header_data.data.field3 = get_le32(buffer_iterator);
 }
 
-static int read_header(am7xxx_device dev, struct am7xxx_header *h)
+static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
 {
-       uint8_t *buffer;
        int ret;
 
-       buffer = calloc(AM7XXX_HEADER_WIRE_SIZE, 1);
-       if (buffer == NULL) {
-               perror("calloc buffer");
-               return -ENOMEM;
-       }
-
-       ret = read_data(dev, buffer, AM7XXX_HEADER_WIRE_SIZE);
+       ret = read_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
        if (ret < 0)
                goto out;
 
-       unserialize_header(buffer, h);
+       unserialize_header(dev->buffer, h);
 
 #if DEBUG
        printf("\n");
@@ -211,13 +300,11 @@ static int read_header(am7xxx_device dev, struct am7xxx_header *h)
        ret = 0;
 
 out:
-       free(buffer);
        return ret;
 }
 
-static int send_header(am7xxx_device dev, struct am7xxx_header *h)
+static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
 {
-       uint8_t *buffer;
        int ret;
 
 #if DEBUG
@@ -226,56 +313,272 @@ static int send_header(am7xxx_device dev, struct am7xxx_header *h)
        printf("\n");
 #endif
 
-       buffer = calloc(AM7XXX_HEADER_WIRE_SIZE, 1);
-       if (buffer == NULL) {
-               perror("calloc buffer");
-               return -ENOMEM;
+       serialize_header(h, dev->buffer);
+       ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
+       if (ret < 0)
+               fprintf(stderr, "send_header: failed to send data.\n");
+
+       return ret;
+}
+
+static am7xxx_device *add_new_device(am7xxx_context *ctx)
+{
+       am7xxx_device **devices_list;
+       am7xxx_device *new_device;
+
+       if (ctx == NULL) {
+               fprintf(stderr, "%s: context must not be NULL!\n", __func__);
+               return NULL;
+       }
+
+       devices_list = &(ctx->devices_list);
+
+       new_device = malloc(sizeof(*new_device));
+       if (new_device == NULL) {
+               perror("malloc");
+               return NULL;
+       }
+       memset(new_device, 0, sizeof(*new_device));
+
+       if (*devices_list == NULL) {
+               *devices_list = new_device;
+       } else {
+               am7xxx_device *prev = *devices_list;
+               while (prev->next)
+                       prev = prev->next;
+               prev->next = new_device;
+       }
+       return new_device;
+}
+
+static am7xxx_device *find_device(am7xxx_context *ctx,
+                                 unsigned int device_index)
+{
+       unsigned int i = 0;
+       am7xxx_device *current;
+
+       if (ctx == NULL) {
+               fprintf(stderr, "%s: context must not be NULL!\n", __func__);
+               return NULL;
+       }
+
+       current = ctx->devices_list;
+       while (current && i++ < device_index)
+               current = current->next;
+
+       return current;
+}
+
+typedef enum {
+       SCAN_OP_BUILD_DEVLIST,
+       SCAN_OP_OPEN_DEVICE,
+} scan_op;
+
+/**
+ * This is where the central logic of multi-device support is.
+ *
+ * When 'op' == SCAN_OP_BUILD_DEVLIST the parameters 'open_device_index' and
+ * 'dev' are ignored; the function returns 0 on success and a negative value
+ * on error.
+ *
+ * When 'op' == SCAN_OP_OPEN_DEVICE the function opens the supported USB
+ * device with index 'open_device_index' and returns the correspondent
+ * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
+ * 1 if the device was already open and a negative value on error.
+ * 
+ * NOTES:
+ * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
+ * the caller might want to call am7xxx_shutdown() in order to remove
+ * devices possibly added before the failure.
+ */
+static int scan_devices(am7xxx_context *ctx, scan_op op,
+                       unsigned int open_device_index, am7xxx_device **dev)
+{
+       int num_devices;
+       libusb_device** list;
+       unsigned int current_index;
+       int i;
+       int ret;
+
+       if (ctx == NULL) {
+               fprintf(stderr, "%s: context must not be NULL!\n", __func__);
+               return -EINVAL;
+       }
+       if (op == SCAN_OP_BUILD_DEVLIST && ctx->devices_list != NULL) {
+               fprintf(stderr, "%s: device scan done already? Abort!\n", __func__);
+               return -EINVAL;
+       }
+
+       num_devices = libusb_get_device_list(ctx->usb_context, &list);
+       if (num_devices < 0) {
+               ret = -ENODEV;
+               goto out;
+       }
+
+       current_index = 0;
+       for (i = 0; i < num_devices; i++) {
+               struct libusb_device_descriptor desc;
+               unsigned int j;
+
+               ret = libusb_get_device_descriptor(list[i], &desc);
+               if (ret < 0)
+                       continue;
+
+               for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
+                       if (desc.idVendor == supported_devices[j].vendor_id
+                           && desc.idProduct == supported_devices[j].product_id) {
+
+                               if (op == SCAN_OP_BUILD_DEVLIST) {
+                                       am7xxx_device *new_device;
+                                       /* debug */
+                                       printf("am7xxx device found, index: %d, name: %s\n",
+                                              current_index,
+                                              supported_devices[j].name);
+                                       new_device = add_new_device(ctx);
+                                       if (new_device == NULL) {
+                                               /* XXX, the caller may want
+                                                * to call am7xxx_shutdown() if
+                                                * we fail here, as we may have
+                                                * added some devices already
+                                                */
+                                               ret = -ENODEV;
+                                               goto out;
+                                       }
+                               } else if (op == SCAN_OP_OPEN_DEVICE &&
+                                          current_index == open_device_index) {
+
+                                       *dev = find_device(ctx, open_device_index);
+                                       if (*dev == NULL) {
+                                               ret = -ENODEV;
+                                               goto out;
+                                       }
+
+                                       /* the usb device has already been opened */
+                                       if ((*dev)->usb_device) {
+                                               ret = 1;
+                                               goto out;
+                                       }
+
+                                       ret = libusb_open(list[i], &((*dev)->usb_device));
+                                       if (ret < 0)
+                                               goto out;
+
+                                       libusb_set_configuration((*dev)->usb_device, 1);
+                                       libusb_claim_interface((*dev)->usb_device, 0);
+                                       goto out;
+                               }
+                               current_index++;
+                       }
+               }
+       }
+
+       /* if we made it up to here we didn't find any device to open */
+       if (op == SCAN_OP_OPEN_DEVICE) {
+               ret = -ENODEV;
+               goto out;
        }
 
-       serialize_header(h, buffer);
-       ret = send_data(dev, buffer, AM7XXX_HEADER_WIRE_SIZE);
+       /* everything went fine when building the device list */
+       ret = 0;
+out:
+       libusb_free_device_list(list, 1);
+       return ret;
+}
+
+int am7xxx_init(am7xxx_context **ctx)
+{
+       int ret = 0;
+
+       *ctx = malloc(sizeof(**ctx));
+       if (*ctx == NULL) {
+               perror("malloc");
+               ret = -ENOMEM;
+               goto out;
+       }
+       memset(*ctx, 0, sizeof(**ctx));
+
+       ret = libusb_init(&((*ctx)->usb_context));
        if (ret < 0)
-               fprintf(stderr, "send_header: failed to send data.\n");
+               goto out_free_context;
+
+       libusb_set_debug((*ctx)->usb_context, 3);
+
+       ret = scan_devices(*ctx, SCAN_OP_BUILD_DEVLIST , 0, NULL);
+       if (ret < 0) {
+               fprintf(stderr, "%s: scan_devices failed\n", __func__);
+               am7xxx_shutdown(*ctx);
+               goto out;
+       }
 
-       free(buffer);
+       return 0;
+
+out_free_context:
+       free(*ctx);
+       *ctx = NULL;
+out:
        return ret;
 }
 
-am7xxx_device am7xxx_init(void)
+void am7xxx_shutdown(am7xxx_context *ctx)
 {
-       am7xxx_device dev;
+       am7xxx_device *current;
 
-       libusb_init(NULL);
-       libusb_set_debug(NULL, 3);
+       if (ctx == NULL) {
+               fprintf(stderr, "%s: context must not be NULL!\n", __func__);
+               return;
+       }
 
-       dev = libusb_open_device_with_vid_pid(NULL,
-                                             AM7XXX_VENDOR_ID,
-                                             AM7XXX_PRODUCT_ID);
-       if (dev == NULL) {
-               errno = ENODEV;
-               perror("libusb_open_device_with_vid_pid");
-               goto out_libusb_exit;
+       current = ctx->devices_list;
+       while (current) {
+               am7xxx_device *next = current->next;
+               am7xxx_close_device(current);
+               free(current);
+               current = next;
        }
 
-       libusb_set_configuration(dev, 1);
-       libusb_claim_interface(dev, 0);
+       libusb_exit(ctx->usb_context);
+       free(ctx);
+       ctx = NULL;
+}
 
-       return dev;
+int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
+                      unsigned int device_index)
+{
+       int ret;
 
-out_libusb_exit:
-       libusb_exit(NULL);
-       return NULL;
+       if (ctx == NULL) {
+               fprintf(stderr, "%s: context must not be NULL!\n", __func__);
+               return -EINVAL;
+       }
+
+       ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
+       if (ret < 0) {
+               errno = ENODEV;
+       } else if (ret > 0) {
+               /* warning */
+               fprintf(stderr, "%s: device %d already open\n", __func__, device_index);
+               errno = EBUSY;
+               ret = -EBUSY;
+       }
+
+       return ret;
 }
 
-void am7xxx_shutdown(am7xxx_device dev)
+int am7xxx_close_device(am7xxx_device *dev)
 {
-       if (dev) {
-               libusb_close(dev);
-               libusb_exit(NULL);
+       if (dev == NULL) {
+               fprintf(stderr, "%s: dev must not be NULL!\n", __func__);
+               return -EINVAL;
        }
+       if (dev->usb_device) {
+               libusb_release_interface(dev->usb_device, 0);
+               libusb_close(dev->usb_device);
+               dev->usb_device = NULL;
+       }
+       return 0;
 }
 
-int am7xxx_get_device_info(am7xxx_device dev,
+int am7xxx_get_device_info(am7xxx_device *dev,
                           unsigned int *native_width,
                           unsigned int *native_height,
                           unsigned int *unknown0,
@@ -314,7 +617,7 @@ int am7xxx_get_device_info(am7xxx_device dev,
        return 0;
 }
 
-int am7xxx_send_image(am7xxx_device dev,
+int am7xxx_send_image(am7xxx_device *dev,
                      am7xxx_image_format format,
                      unsigned int width,
                      unsigned int height,
@@ -348,7 +651,7 @@ int am7xxx_send_image(am7xxx_device dev,
        return send_data(dev, image, size);
 }
 
-int am7xxx_set_power_mode(am7xxx_device dev, am7xxx_power_mode mode)
+int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode)
 {
        int ret;
        struct am7xxx_header h = {