]> sigrok.org Git - libsigrok.git/blobdiff - hardware/saleae-logic/saleae-logic.c
libsigrok: Rename open/close to opendev/closedev.
[libsigrok.git] / hardware / saleae-logic / saleae-logic.c
index 8a74332e615266ad40abba5a83b9afe4bbb82167..173e8adaa8456cd7ef226ec91f166da0f3f95c8e 100644 (file)
@@ -17,6 +17,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "config.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <sys/time.h>
@@ -25,7 +26,6 @@
 #include <libusb.h>
 #include <sigrok.h>
 #include <sigrok-internal.h>
-#include "config.h"
 
 #define USB_VENDOR                 0x0925
 #define USB_PRODUCT                    0x3881
 
 /* There is only one model Saleae Logic, and this is what it supports: */
 static int capabilities[] = {
-       HWCAP_LOGIC_ANALYZER,
-       HWCAP_SAMPLERATE,
+       SR_HWCAP_LOGIC_ANALYZER,
+       SR_HWCAP_SAMPLERATE,
 
        /* These are really implemented in the driver, not the hardware. */
-       HWCAP_LIMIT_SAMPLES,
-       HWCAP_CONTINUOUS,
+       SR_HWCAP_LIMIT_SAMPLES,
+       SR_HWCAP_CONTINUOUS,
        0,
 };
 
@@ -68,28 +68,28 @@ static GSList *device_instances = NULL;
  * upgrade -- this is like a global lock. No device will open until a proper
  * delay after the last device was upgraded.
  */
-GTimeVal firmware_updated = { 0, 0 };
+static GTimeVal firmware_updated = { 0, 0 };
 
 static libusb_context *usb_context = NULL;
 
 static uint64_t supported_samplerates[] = {
-       KHZ(200),
-       KHZ(250),
-       KHZ(500),
-       MHZ(1),
-       MHZ(2),
-       MHZ(4),
-       MHZ(8),
-       MHZ(12),
-       MHZ(16),
-       MHZ(24),
+       SR_KHZ(200),
+       SR_KHZ(250),
+       SR_KHZ(500),
+       SR_MHZ(1),
+       SR_MHZ(2),
+       SR_MHZ(4),
+       SR_MHZ(8),
+       SR_MHZ(12),
+       SR_MHZ(16),
+       SR_MHZ(24),
        0,
 };
 
-static struct samplerates samplerates = {
-       KHZ(200),
-       MHZ(24),
-       0,
+static struct sr_samplerates samplerates = {
+       SR_KHZ(200),
+       SR_MHZ(24),
+       SR_HZ(0),
        supported_samplerates,
 };
 
@@ -101,7 +101,7 @@ static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
 static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
 static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
 
-int trigger_stage = TRIGGER_FIRED;
+static int trigger_stage = TRIGGER_FIRED;
 
 static int hw_set_configuration(int device_index, int capability, void *value);
 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
@@ -112,7 +112,7 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id);
  * @return 1 if the device's configuration profile match the Logic firmware's
  *         configuration, 0 otherwise.
  */
-int check_conf_profile(libusb_device *dev)
+static int check_conf_profile(libusb_device *dev)
 {
        struct libusb_device_descriptor des;
        struct libusb_config_descriptor *conf_dsc = NULL;
@@ -166,7 +166,7 @@ int check_conf_profile(libusb_device *dev)
        return ret;
 }
 
-struct sr_device_instance *sl_open_device(int device_index)
+static struct sr_device_instance *sl_open_device(int device_index)
 {
        struct sr_device_instance *sdi;
        libusb_device **devlist;
@@ -177,7 +177,7 @@ struct sr_device_instance *sl_open_device(int device_index)
                return NULL;
 
        libusb_get_device_list(usb_context, &devlist);
-       if (sdi->status == ST_INITIALIZING) {
+       if (sdi->status == SR_ST_INITIALIZING) {
                /*
                 * This device was renumerating last time we touched it.
                 * opendev() guarantees we've waited long enough for it to
@@ -191,7 +191,7 @@ struct sr_device_instance *sl_open_device(int device_index)
                                       &skip, USB_VENDOR, USB_PRODUCT,
                                       USB_INTERFACE);
                }
-       } else if (sdi->status == ST_INACTIVE) {
+       } else if (sdi->status == SR_ST_INACTIVE) {
                /*
                 * This device is fully enumerated, so we need to find this
                 * device by vendor, product, bus and address.
@@ -203,18 +203,18 @@ struct sr_device_instance *sl_open_device(int device_index)
                                       USB_PRODUCT, USB_INTERFACE);
                }
        } else {
-               /* Status must be ST_ACTIVE, i.e. already in use... */
+               /* Status must be SR_ST_ACTIVE, i.e. already in use... */
                sdi = NULL;
        }
        libusb_free_device_list(devlist, 1);
 
-       if (sdi && sdi->status != ST_ACTIVE)
+       if (sdi && sdi->status != SR_ST_ACTIVE)
                sdi = NULL;
 
        return sdi;
 }
 
-int upload_firmware(libusb_device *dev)
+static int upload_firmware(libusb_device *dev)
 {
        int ret;
 
@@ -233,17 +233,17 @@ static void close_device(struct sr_device_instance *sdi)
        if (sdi->usb->devhdl == NULL)
                return;
 
-       g_message("saleae: closing device %d on %d.%d interface %d", sdi->index,
-                 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
+       sr_info("saleae: closing device %d on %d.%d interface %d", sdi->index,
+               sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
        libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
        libusb_close(sdi->usb->devhdl);
        sdi->usb->devhdl = NULL;
-       sdi->status = ST_INACTIVE;
+       sdi->status = SR_ST_INACTIVE;
 }
 
 static int configure_probes(GSList *probes)
 {
-       struct probe *probe;
+       struct sr_probe *probe;
        GSList *l;
        int probe_bit, stage, i;
        char *tc;
@@ -256,7 +256,7 @@ static int configure_probes(GSList *probes)
 
        stage = -1;
        for (l = probes; l; l = l->next) {
-               probe = (struct probe *)l->data;
+               probe = (struct sr_probe *)l->data;
                if (probe->enabled == FALSE)
                        continue;
                probe_bit = 1 << (probe->index - 1);
@@ -291,7 +291,7 @@ static int configure_probes(GSList *probes)
  * API callbacks
  */
 
-static int hw_init(char *deviceinfo)
+static int hw_init(const char *deviceinfo)
 {
        struct sr_device_instance *sdi;
        struct libusb_device_descriptor des;
@@ -302,7 +302,7 @@ static int hw_init(char *deviceinfo)
        deviceinfo = deviceinfo;
 
        if (libusb_init(&usb_context) != 0) {
-               g_warning("Failed to initialize USB.");
+               sr_warn("Failed to initialize USB.");
                return 0;
        }
 
@@ -312,14 +312,14 @@ static int hw_init(char *deviceinfo)
        for (i = 0; devlist[i]; i++) {
                err = libusb_get_device_descriptor(devlist[i], &des);
                if (err != 0) {
-                       g_warning("failed to get device descriptor: %d", err);
+                       sr_warn("failed to get device descriptor: %d", err);
                        continue;
                }
 
                if (des.idVendor != USB_VENDOR || des.idProduct != USB_PRODUCT)
                        continue; /* Not a Saleae Logic... */
 
-               sdi = sr_device_instance_new(devcnt, ST_INITIALIZING,
+               sdi = sr_device_instance_new(devcnt, SR_ST_INITIALIZING,
                        USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
                if (!sdi)
                        return 0;
@@ -332,8 +332,8 @@ static int hw_init(char *deviceinfo)
                         * or uploading the firmware again.
                         */
                        if (upload_firmware(devlist[i]) > 0)
-                               g_warning("firmware upload failed for "
-                                         "device %d", devcnt);
+                               sr_warn("firmware upload failed for device %d",
+                                       devcnt);
 
                        sdi->usb = sr_usb_device_instance_new
                                (libusb_get_bus_number(devlist[i]), 0, NULL);
@@ -366,27 +366,27 @@ static int hw_opendev(int device_index)
                timediff = cur - upd;
                if (timediff < FIRMWARE_RENUM_DELAY) {
                        timediff = FIRMWARE_RENUM_DELAY - timediff;
-                       g_message("saleae: waiting %d ms for device to reset",
-                                 timediff);
+                       sr_info("saleae: waiting %d ms for device to reset",
+                               timediff);
                        g_usleep(timediff * 1000);
                        firmware_updated.tv_sec = 0;
                }
        }
 
        if (!(sdi = sl_open_device(device_index))) {
-               g_warning("unable to open device");
+               sr_warn("unable to open device");
                return SR_ERR;
        }
 
        err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
        if (err != 0) {
-               g_warning("Unable to claim interface: %d", err);
+               sr_warn("Unable to claim interface: %d", err);
                return SR_ERR;
        }
 
        if (cur_samplerate == 0) {
                /* Samplerate hasn't been set; default to the slowest one. */
-               if (hw_set_configuration(device_index, HWCAP_SAMPLERATE,
+               if (hw_set_configuration(device_index, SR_HWCAP_SAMPLERATE,
                    &supported_samplerates[0]) == SR_ERR)
                        return SR_ERR;
        }
@@ -430,19 +430,19 @@ static void *hw_get_device_info(int device_index, int device_info_id)
                return NULL;
 
        switch (device_info_id) {
-       case DI_INSTANCE:
+       case SR_DI_INSTANCE:
                info = sdi;
                break;
-       case DI_NUM_PROBES:
+       case SR_DI_NUM_PROBES:
                info = GINT_TO_POINTER(NUM_PROBES);
                break;
-       case DI_SAMPLERATES:
+       case SR_DI_SAMPLERATES:
                info = &samplerates;
                break;
-       case DI_TRIGGER_TYPES:
+       case SR_DI_TRIGGER_TYPES:
                info = TRIGGER_TYPES;
                break;
-       case DI_CUR_SAMPLERATE:
+       case SR_DI_CUR_SAMPLERATE:
                info = &cur_samplerate;
                break;
        }
@@ -458,7 +458,7 @@ static int hw_get_status(int device_index)
        if (sdi)
                return sdi->status;
        else
-               return ST_NOT_FOUND;
+               return SR_ST_NOT_FOUND;
 }
 
 static int *hw_get_capabilities(void)
@@ -482,14 +482,14 @@ static int set_configuration_samplerate(struct sr_device_instance *sdi,
 
        divider = (uint8_t) (48 / (samplerate / 1000000.0)) - 1;
 
-       g_message("saleae: setting samplerate to %" PRIu64 " Hz (divider %d)",
-                 samplerate, divider);
+       sr_info("saleae: setting samplerate to %" PRIu64 " Hz (divider %d)",
+               samplerate, divider);
        buf[0] = 0x01;
        buf[1] = divider;
        ret = libusb_bulk_transfer(sdi->usb->devhdl, 1 | LIBUSB_ENDPOINT_OUT,
                                   buf, 2, &result, 500);
        if (ret != 0) {
-               g_warning("failed to set samplerate: %d", ret);
+               sr_warn("failed to set samplerate: %d", ret);
                return SR_ERR;
        }
        cur_samplerate = samplerate;
@@ -506,12 +506,12 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        if (!(sdi = sr_get_device_instance(device_instances, device_index)))
                return SR_ERR;
 
-       if (capability == HWCAP_SAMPLERATE) {
+       if (capability == SR_HWCAP_SAMPLERATE) {
                tmp_u64 = value;
                ret = set_configuration_samplerate(sdi, *tmp_u64);
-       } else if (capability == HWCAP_PROBECONFIG) {
+       } else if (capability == SR_HWCAP_PROBECONFIG) {
                ret = configure_probes((GSList *) value);
-       } else if (capability == HWCAP_LIMIT_SAMPLES) {
+       } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
                tmp_u64 = value;
                limit_samples = *tmp_u64;
                ret = SR_OK;
@@ -560,8 +560,8 @@ void receive_transfer(struct libusb_transfer *transfer)
                return;
        }
 
-       g_message("saleae: receive_transfer(): status %d received %d bytes",
-                 transfer->status, transfer->actual_length);
+       sr_info("saleae: receive_transfer(): status %d received %d bytes",
+               transfer->status, transfer->actual_length);
 
        /* Save incoming transfer before reusing the transfer struct. */
        cur_buf = transfer->buffer;
@@ -569,12 +569,17 @@ void receive_transfer(struct libusb_transfer *transfer)
        user_data = transfer->user_data;
 
        /* Fire off a new request. */
-       new_buf = g_malloc(4096);
+       if (!(new_buf = g_try_malloc(4096))) {
+               sr_err("saleae: %s: new_buf malloc failed", __func__);
+               // return SR_ERR_MALLOC;
+               return; /* FIXME */
+       }
+
        transfer->buffer = new_buf;
        transfer->length = 4096;
        if (libusb_submit_transfer(transfer) != 0) {
                /* TODO: Stop session? */
-               g_warning("eek");
+               sr_warn("eek");
        }
 
        if (cur_buflen == 0) {
@@ -607,19 +612,19 @@ void receive_transfer(struct libusb_transfer *transfer)
                                         * TODO: Send pre-trigger buffer to session bus.
                                         * Tell the frontend we hit the trigger here.
                                         */
-                                       packet.type = DF_TRIGGER;
+                                       packet.type = SR_DF_TRIGGER;
                                        packet.length = 0;
-                                       session_bus(user_data, &packet);
+                                       sr_session_bus(user_data, &packet);
 
                                        /*
                                         * Send the samples that triggered it, since we're
                                         * skipping past them.
                                         */
-                                       packet.type = DF_LOGIC;
+                                       packet.type = SR_DF_LOGIC;
                                        packet.length = trigger_stage;
                                        packet.unitsize = 1;
                                        packet.payload = trigger_buffer;
-                                       session_bus(user_data, &packet);
+                                       sr_session_bus(user_data, &packet);
 
                                        trigger_stage = TRIGGER_FIRED;
                                        break;
@@ -648,11 +653,11 @@ void receive_transfer(struct libusb_transfer *transfer)
 
        if (trigger_stage == TRIGGER_FIRED) {
                /* Send the incoming transfer to the session bus. */
-               packet.type = DF_LOGIC;
+               packet.type = SR_DF_LOGIC;
                packet.length = cur_buflen - trigger_offset;
                packet.unitsize = 1;
                packet.payload = cur_buf + trigger_offset;
-               session_bus(user_data, &packet);
+               sr_session_bus(user_data, &packet);
                g_free(cur_buf);
 
                num_samples += cur_buflen;
@@ -680,15 +685,23 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        if (!(sdi = sr_get_device_instance(device_instances, device_index)))
                return SR_ERR;
 
-       packet = g_malloc(sizeof(struct sr_datafeed_packet));
-       header = g_malloc(sizeof(struct sr_datafeed_header));
-       if (!packet || !header)
-               return SR_ERR;
+       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+               sr_err("saleae: %s: packet malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+       
+       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+               sr_err("saleae: %s: header malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
 
        /* Start with 2K transfer, subsequently increased to 4K. */
        size = 2048;
        for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
-               buf = g_malloc(size);
+               if (!(buf = g_try_malloc(size))) {
+                       sr_err("saleae: %s: buf malloc failed", __func__);
+                       return SR_ERR_MALLOC;
+               }
                transfer = libusb_alloc_transfer(0);
                libusb_fill_bulk_transfer(transfer, sdi->usb->devhdl,
                                2 | LIBUSB_ENDPOINT_IN, buf, size,
@@ -704,20 +717,20 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
 
        lupfd = libusb_get_pollfds(usb_context);
        for (i = 0; lupfd[i]; i++)
-               source_add(lupfd[i]->fd, lupfd[i]->events, 40, receive_data,
-                          NULL);
+               sr_source_add(lupfd[i]->fd, lupfd[i]->events, 40, receive_data,
+                             NULL);
        free(lupfd);
 
-       packet->type = DF_HEADER;
+       packet->type = SR_DF_HEADER;
        packet->length = sizeof(struct sr_datafeed_header);
        packet->payload = (unsigned char *)header;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
        header->samplerate = cur_samplerate;
-       header->protocol_id = PROTO_RAW;
+       header->protocol_id = SR_PROTO_RAW;
        header->num_logic_probes = NUM_PROBES;
        header->num_analog_probes = 0;
-       session_bus(session_device_id, packet);
+       sr_session_bus(session_device_id, packet);
        g_free(header);
        g_free(packet);
 
@@ -732,8 +745,8 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
        /* Avoid compiler warnings. */
        device_index = device_index;
 
-       packet.type = DF_END;
-       session_bus(session_device_id, &packet);
+       packet.type = SR_DF_END;
+       sr_session_bus(session_device_id, &packet);
 
        receive_transfer(NULL);
 
@@ -741,17 +754,17 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 }
 
 struct sr_device_plugin saleae_logic_plugin_info = {
-       "saleae-logic",
-       "Saleae Logic",
-       1,
-       hw_init,
-       hw_cleanup,
-       hw_opendev,
-       hw_closedev,
-       hw_get_device_info,
-       hw_get_status,
-       hw_get_capabilities,
-       hw_set_configuration,
-       hw_start_acquisition,
-       hw_stop_acquisition,
+       .name = "saleae-logic",
+       .longname = "Saleae Logic",
+       .api_version = 1,
+       .init = hw_init,
+       .cleanup = hw_cleanup,
+       .opendev = hw_opendev,
+       .closedev = hw_closedev,
+       .get_device_info = hw_get_device_info,
+       .get_status = hw_get_status,
+       .get_capabilities = hw_get_capabilities,
+       .set_configuration = hw_set_configuration,
+       .start_acquisition = hw_start_acquisition,
+       .stop_acquisition = hw_stop_acquisition,
 };