am7xxx-play: add a comment to explain why a run-time warning can be ignored

[libam7xxx.git] / src / am7xxx.c

diff --git a/src/am7xxx.c b/src/am7xxx.c
index dd69fc5..8573a59 100644 (file)
--- a/src/am7xxx.c
+++ b/src/am7xxx.c
@@ -30,11 +30,22 @@
 
 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 
 
 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 

-/* If we're not using GNU C, elide __attribute__
+/*
+ * If we're not using GNU C, elide __attribute__

  * taken from: http://unixwiz.net/techtips/gnu-c-attributes.html)
  */
 #ifndef __GNUC__
  * taken from: http://unixwiz.net/techtips/gnu-c-attributes.html)
  */
 #ifndef __GNUC__

-#  define  __attribute__(x)  /* NOTHING */
+       #define  __attribute__(x)  /* NOTHING */
+#endif
+
+/*
+ * Fix printf format when compiling for Windows with MinGW, see:
+ * https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/
+ */
+#ifdef __MINGW_PRINTF_FORMAT
+       #define AM7XXX_PRINTF_FORMAT __MINGW_PRINTF_FORMAT
+#else
+       #define AM7XXX_PRINTF_FORMAT printf

 #endif
 
 /* Control shared library symbols visibility */
 #endif
 
 /* Control shared library symbols visibility */


@@ -56,7 +67,7 @@ static void log_message(am7xxx_context *ctx,
                        const char *function_name,
                        int line,
                        const char *fmt,
                        const char *function_name,
                        int line,
                        const char *fmt,

-                       ...) __attribute__ ((format (printf, 5, 6)));
+                       ...) __attribute__ ((format (AM7XXX_PRINTF_FORMAT, 5, 6)));

 
 #define fatal(...)        log_message(NULL, AM7XXX_LOG_FATAL,   __func__, __LINE__, __VA_ARGS__)
 #define error(ctx, ...)   log_message(ctx,  AM7XXX_LOG_ERROR,   __func__, __LINE__, __VA_ARGS__)
 
 #define fatal(...)        log_message(NULL, AM7XXX_LOG_FATAL,   __func__, __LINE__, __VA_ARGS__)
 #define error(ctx, ...)   log_message(ctx,  AM7XXX_LOG_ERROR,   __func__, __LINE__, __VA_ARGS__)


@@ -341,7 +352,7 @@ static inline unsigned int in_80chars(unsigned int i)
 {
        /* The 3 below is the length of "xx " where xx is the hex string
         * representation of a byte */
 {
        /* The 3 below is the length of "xx " where xx is the hex string
         * representation of a byte */

-       return ((i+1) % (80/3));
+       return ((i + 1) % (80 / 3));

 }
 
 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
 }
 
 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,


@@ -414,7 +425,7 @@ static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
        return 0;
 }
 
        return 0;
 }
 

-static void send_data_async_complete_cb(struct libusb_transfer *transfer)
+static void LIBUSB_CALL send_data_async_complete_cb(struct libusb_transfer *transfer)

 {
        am7xxx_device *dev = (am7xxx_device *)(transfer->user_data);
        int *completed = &(dev->transfer_completed);
 {
        am7xxx_device *dev = (am7xxx_device *)(transfer->user_data);
        int *completed = &(dev->transfer_completed);


@@ -720,7 +731,6 @@ static int open_device(am7xxx_context *ctx,
 
        /* the usb device has already been opened */
        if ((*dev)->usb_device) {
 
        /* the usb device has already been opened */
        if ((*dev)->usb_device) {

-               debug(ctx, "(*dev)->usb_device already set\n");

                ret = 1;
                goto out;
        }
                ret = 1;
                goto out;
        }


@@ -801,7 +811,7 @@ static int open_device(am7xxx_context *ctx,
        }
 
        if (current_configuration != (*dev)->desc->configuration) {
        }
 
        if (current_configuration != (*dev)->desc->configuration) {

-               debug(ctx, "libusb configuration changed (expected: %hhu, current: %hhu\n",
+               debug(ctx, "libusb configuration changed (expected: %hhu, current: %d)\n",

                      (*dev)->desc->configuration, current_configuration);
                ret = -EINVAL;
                goto out_libusb_release_interface;
                      (*dev)->desc->configuration, current_configuration);
                ret = -EINVAL;
                goto out_libusb_release_interface;


@@ -1094,8 +1104,7 @@ AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
        *ctx = malloc(sizeof(**ctx));
        if (*ctx == NULL) {
                fatal("cannot allocate the context (%s)\n", strerror(errno));
        *ctx = malloc(sizeof(**ctx));
        if (*ctx == NULL) {
                fatal("cannot allocate the context (%s)\n", strerror(errno));

-               ret = -ENOMEM;
-               goto out;
+               return -ENOMEM;

        }
        memset(*ctx, 0, sizeof(**ctx));
 
        }
        memset(*ctx, 0, sizeof(**ctx));
 


@@ -1181,14 +1190,14 @@ AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
         * is the first one to be sent to the device in order for it to
         * successfully return the correct device information.
         *
         * is the first one to be sent to the device in order for it to
         * successfully return the correct device information.
         *

-        * So, if there is not a cached version of it (from a previous open),
-        * we ask for device info at open time,
+        * NOTE: am7xxx_get_device_info() will fetch the actual device info
+        * from the device only the very first time it's called for a given
+        * device, otherwise, it'll return a cached version of the device info
+        * (from a previous call to am7xxx_open_device(), for instance).

         */
         */

-       if ((*dev)->device_info == NULL) {
-               ret = am7xxx_get_device_info(*dev, NULL);
-               if (ret < 0)
-                       error(ctx, "cannot get device info\n");
-       }
+       ret = am7xxx_get_device_info(*dev, NULL);
+       if (ret < 0)
+               error(ctx, "cannot get device info\n");

 
 out:
        return ret;
 
 out:
        return ret;


@@ -1215,10 +1224,9 @@ AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
        int ret;
        struct am7xxx_header h;
 
        int ret;
        struct am7xxx_header h;
 

-       if (dev->device_info) {
-               memcpy(device_info, dev->device_info, sizeof(*device_info));
-               return 0;
-       }
+       /* if there is a cached copy of the device info, just return that */
+       if (dev->device_info)
+               goto return_value;

 
        ret = send_command(dev, AM7XXX_PACKET_TYPE_DEVINFO);
        if (ret < 0)
 
        ret = send_command(dev, AM7XXX_PACKET_TYPE_DEVINFO);
        if (ret < 0)


@@ -1232,8 +1240,8 @@ AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
        if (h.packet_type != AM7XXX_PACKET_TYPE_DEVINFO) {
                error(dev->ctx, "expected packet type: %d, got %d instead!\n",
                      AM7XXX_PACKET_TYPE_DEVINFO, h.packet_type);
        if (h.packet_type != AM7XXX_PACKET_TYPE_DEVINFO) {
                error(dev->ctx, "expected packet type: %d, got %d instead!\n",
                      AM7XXX_PACKET_TYPE_DEVINFO, h.packet_type);

-               errno = ENOTSUP;
-               return -ENOTSUP;
+               errno = EINVAL;
+               return -EINVAL;

        }
 
        dev->device_info = malloc(sizeof(*dev->device_info));
        }
 
        dev->device_info = malloc(sizeof(*dev->device_info));


@@ -1252,6 +1260,9 @@ AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
        dev->device_info->unknown1 = h.header_data.devinfo.unknown1;
 #endif
 
        dev->device_info->unknown1 = h.header_data.devinfo.unknown1;
 #endif
 

+return_value:
+       if (device_info)
+               memcpy(device_info, dev->device_info, sizeof(*device_info));

        return 0;
 }
 
        return 0;
 }
 


@@ -1262,7 +1273,6 @@ AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
                                        unsigned int *scaled_width,
                                        unsigned int *scaled_height)
 {
                                        unsigned int *scaled_width,
                                        unsigned int *scaled_height)
 {

-

        am7xxx_device_info device_info;
        float width_ratio;
        float height_ratio;
        am7xxx_device_info device_info;
        float width_ratio;
        float height_ratio;