]> sigrok.org Git - libsigrok.git/blobdiff - hardware/openbench-logic-sniffer/ols.c
sr: rename more functions to sr_thing_action format
[libsigrok.git] / hardware / openbench-logic-sniffer / ols.c
index 724aa43b613dcb89d7180ebea9cc026bcbb1d3ac..c322f789fd64f3e831fda864be0c05752782e984 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -217,7 +217,7 @@ static struct ols_device *ols_device_new(void)
        ols->trigger_at = -1;
        ols->probe_mask = 0xffffffff;
        ols->cur_samplerate = SR_KHZ(200);
-       ols->period_ps = 5000000;
+       ols->serial = NULL;
 
        return ols;
 }
@@ -231,7 +231,7 @@ static struct sr_device_instance *get_metadata(int fd)
        GString *tmp_str, *devicename, *version;
        gchar tmp_c;
 
-       sdi = sr_device_instance_new(0, SR_ST_INACTIVE, NULL, NULL, NULL);
+       sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, NULL, NULL, NULL);
        ols = ols_device_new();
        sdi->priv = ols;
 
@@ -359,7 +359,7 @@ static int hw_init(const char *deviceinfo)
        final_devcnt = 0;
 
        if (deviceinfo)
-               ports = g_slist_append(NULL, strdup(deviceinfo));
+               ports = g_slist_append(NULL, g_strdup(deviceinfo));
        else
                /* No specific device given, so scan all serial ports. */
                ports = list_serial_ports();
@@ -415,10 +415,10 @@ static int hw_init(const char *deviceinfo)
                        send_shortcommand(fd, CMD_ID);
                        fds[devcnt].fd = fd;
                        fds[devcnt].events = G_IO_IN;
-                       device_names[devcnt] = strdup(l->data);
+                       device_names[devcnt] = g_strdup(l->data);
                        devcnt++;
                }
-               free(l->data);
+               g_free(l->data);
        }
 
        /* 2ms isn't enough for reliable transfer with pl2303, let's try 10 */
@@ -446,13 +446,13 @@ static int hw_init(const char *deviceinfo)
                        sdi->index = final_devcnt;
                } else {
                        /* not an OLS -- some other board that uses the sump protocol */
-                       sdi = sr_device_instance_new(final_devcnt, SR_ST_INACTIVE,
+                       sdi = sr_dev_inst_new(final_devcnt, SR_ST_INACTIVE,
                                        "Sump", "Logic Analyzer", "v1.0");
                        ols = ols_device_new();
                        ols->num_probes = 32;
                        sdi->priv = ols;
                }
-               sdi->serial = sr_serial_device_instance_new(device_names[i], -1);
+               ols->serial = sr_serial_dev_inst_new(device_names[i], -1);
                device_instances = g_slist_append(device_instances, sdi);
                final_devcnt++;
                serial_close(fds[i].fd);
@@ -465,8 +465,8 @@ static int hw_init(const char *deviceinfo)
                        serial_restore_params(fds[i].fd, serial_params[i]);
                        serial_close(fds[i].fd);
                }
-               free(serial_params[i]);
-               free(device_names[i]);
+               g_free(serial_params[i]);
+               g_free(device_names[i]);
        }
 
        g_free(serial_params);
@@ -483,12 +483,15 @@ hw_init_free_ports:
 static int hw_opendev(int device_index)
 {
        struct sr_device_instance *sdi;
+       struct ols_device *ols;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ERR;
 
-       sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR);
-       if (sdi->serial->fd == -1)
+       ols = sdi->priv;
+
+       ols->serial->fd = serial_open(ols->serial->port, O_RDWR);
+       if (ols->serial->fd == -1)
                return SR_ERR;
 
        sdi->status = SR_ST_ACTIVE;
@@ -499,36 +502,57 @@ static int hw_opendev(int device_index)
 static int hw_closedev(int device_index)
 {
        struct sr_device_instance *sdi;
+       struct ols_device *ols;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
                sr_err("ols: %s: sdi was NULL", __func__);
                return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
 
+       ols = sdi->priv;
+
        /* TODO */
-       if (sdi->serial->fd != -1) {
-               serial_close(sdi->serial->fd);
-               sdi->serial->fd = -1;
+       if (ols->serial->fd != -1) {
+               serial_close(ols->serial->fd);
+               ols->serial->fd = -1;
                sdi->status = SR_ST_INACTIVE;
        }
 
        return SR_OK;
 }
 
-static void hw_cleanup(void)
+static int hw_cleanup(void)
 {
        GSList *l;
        struct sr_device_instance *sdi;
+       struct ols_device *ols;
+       int ret = SR_OK;
 
        /* Properly close and free all devices. */
        for (l = device_instances; l; l = l->next) {
-               sdi = l->data;
-               if (sdi->serial->fd != -1)
-                       serial_close(sdi->serial->fd);
-               sr_device_instance_free(sdi);
+               if (!(sdi = l->data)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("ols: %s: sdi was NULL, continuing", __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               if (!(ols = sdi->priv)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("ols: %s: sdi->priv was NULL, continuing",
+                              __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               /* TODO: Check for serial != NULL. */
+               if (ols->serial->fd != -1)
+                       serial_close(ols->serial->fd);
+               sr_serial_dev_inst_free(ols->serial);
+               sr_dev_inst_free(sdi);
        }
        g_slist_free(device_instances);
        device_instances = NULL;
+
+       return ret;
 }
 
 static void *hw_get_device_info(int device_index, int device_info_id)
@@ -537,7 +561,7 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        struct ols_device *ols;
        void *info;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return NULL;
        ols = sdi->priv;
 
@@ -570,7 +594,7 @@ static int hw_get_status(int device_index)
 {
        struct sr_device_instance *sdi;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ST_NOT_FOUND;
 
        return sdi->status;
@@ -605,12 +629,11 @@ static int set_configuration_samplerate(struct sr_device_instance *sdi,
         * from the requested.
         */
        ols->cur_samplerate = CLOCK_RATE / (ols->cur_samplerate_divider + 1);
-       if(ols->flag_reg & FLAG_DEMUX)
+       if (ols->flag_reg & FLAG_DEMUX)
                ols->cur_samplerate *= 2;
-       ols->period_ps = 1000000000000 / ols->cur_samplerate;
-       if(ols->cur_samplerate != samplerate)
-               sr_warn("ols: can't match samplerate %" PRIu64 ", using %" PRIu64, 
-                       samplerate, ols->cur_samplerate);
+       if (ols->cur_samplerate != samplerate)
+               sr_err("ols: can't match samplerate %" PRIu64 ", using %"
+                      PRIu64, samplerate, ols->cur_samplerate);
 
        return SR_OK;
 }
@@ -622,7 +645,7 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        int ret;
        uint64_t *tmp_u64;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ERR;
        ols = sdi->priv;
 
@@ -642,7 +665,7 @@ static int hw_set_configuration(int device_index, int capability, void *value)
                if (*tmp_u64 < MIN_NUM_SAMPLES)
                        return SR_ERR;
                if (*tmp_u64 > ols->max_samples)
-                       sr_warn("ols: sample limit exceeds hw max");
+                       sr_err("ols: sample limit exceeds hw max");
                ols->limit_samples = *tmp_u64;
                sr_info("ols: sample limit %" PRIu64, ols->limit_samples);
                ret = SR_OK;
@@ -684,7 +707,7 @@ static int receive_data(int fd, int revents, void *session_data)
        ols = NULL;
        for (l = device_instances; l; l = l->next) {
                sdi = l->data;
-               if (sdi->serial->fd == fd) {
+               if (ols->serial->fd == fd) {
                        ols = sdi->priv;
                        break;
                }
@@ -808,8 +831,6 @@ static int receive_data(int fd, int revents, void *session_data)
                        if (ols->trigger_at > 0) {
                                /* there are pre-trigger samples, send those first */
                                packet.type = SR_DF_LOGIC;
-                               packet.timeoffset = 0;
-                               packet.duration = ols->trigger_at * ols->period_ps;
                                packet.payload = &logic;
                                logic.length = ols->trigger_at * 4;
                                logic.unitsize = 4;
@@ -820,14 +841,10 @@ static int receive_data(int fd, int revents, void *session_data)
 
                        /* send the trigger */
                        packet.type = SR_DF_TRIGGER;
-                       packet.timeoffset = ols->trigger_at * ols->period_ps;
-                       packet.duration = 0;
                        sr_session_bus(session_data, &packet);
 
                        /* send post-trigger samples */
                        packet.type = SR_DF_LOGIC;
-                       packet.timeoffset = ols->trigger_at * ols->period_ps;
-                       packet.duration = (ols->num_samples - ols->trigger_at) * ols->period_ps;
                        packet.payload = &logic;
                        logic.length = (ols->num_samples * 4) - (ols->trigger_at * 4);
                        logic.unitsize = 4;
@@ -837,8 +854,6 @@ static int receive_data(int fd, int revents, void *session_data)
                } else {
                        /* no trigger was used */
                        packet.type = SR_DF_LOGIC;
-                       packet.timeoffset = 0;
-                       packet.duration = ols->num_samples * ols->period_ps;
                        packet.payload = &logic;
                        logic.length = ols->num_samples * 4;
                        logic.unitsize = 4;
@@ -851,8 +866,6 @@ static int receive_data(int fd, int revents, void *session_data)
                serial_flush(fd);
                serial_close(fd);
                packet.type = SR_DF_END;
-               packet.timeoffset = ols->num_samples * ols->period_ps;
-               packet.duration = 0;
                sr_session_bus(session_data, &packet);
        }
 
@@ -872,7 +885,7 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        int num_channels;
        int i;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ERR;
 
        ols = sdi->priv;
@@ -906,53 +919,53 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
                delaycount = readcount * (1 - ols->capture_ratio / 100.0);
                ols->trigger_at = (readcount - delaycount) * 4 - ols->num_stages;
 
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_0,
                        reverse32(ols->trigger_mask[0])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_0,
                        reverse32(ols->trigger_value[0])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
                        trigger_config[0]) != SR_OK)
                        return SR_ERR;
 
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_1,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_1,
                        reverse32(ols->trigger_mask[1])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_1,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_1,
                        reverse32(ols->trigger_value[1])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_1,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_1,
                        trigger_config[1]) != SR_OK)
                        return SR_ERR;
 
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_2,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_2,
                        reverse32(ols->trigger_mask[2])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_2,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_2,
                        reverse32(ols->trigger_value[2])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_2,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_2,
                        trigger_config[2]) != SR_OK)
                        return SR_ERR;
 
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_3,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_3,
                        reverse32(ols->trigger_mask[3])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_3,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_3,
                        reverse32(ols->trigger_value[3])) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_3,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_3,
                        trigger_config[3]) != SR_OK)
                        return SR_ERR;
        } else {
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_0,
                                ols->trigger_mask[0]) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_0,
                                ols->trigger_value[0]) != SR_OK)
                        return SR_ERR;
-               if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
+               if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
                     0x00000008) != SR_OK)
                        return SR_ERR;
                delaycount = readcount;
@@ -961,14 +974,14 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        sr_info("ols: setting samplerate to %" PRIu64 " Hz (divider %u, "
                "demux %s)", ols->cur_samplerate, ols->cur_samplerate_divider,
                ols->flag_reg & FLAG_DEMUX ? "on" : "off");
-       if (send_longcommand(sdi->serial->fd, CMD_SET_DIVIDER,
+       if (send_longcommand(ols->serial->fd, CMD_SET_DIVIDER,
                        reverse32(ols->cur_samplerate_divider)) != SR_OK)
                return SR_ERR;
 
        /* Send sample limit and pre/post-trigger capture ratio. */
        data = ((readcount - 1) & 0xffff) << 16;
        data |= (delaycount - 1) & 0xffff;
-       if (send_longcommand(sdi->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
+       if (send_longcommand(ols->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
                return SR_ERR;
 
        /* The flag register wants them here, and 1 means "disable channel". */
@@ -976,14 +989,14 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        ols->flag_reg |= FLAG_FILTER;
        ols->rle_count = 0;
        data = (ols->flag_reg << 24) | ((ols->flag_reg << 8) & 0xff0000);
-       if (send_longcommand(sdi->serial->fd, CMD_SET_FLAGS, data) != SR_OK)
+       if (send_longcommand(ols->serial->fd, CMD_SET_FLAGS, data) != SR_OK)
                return SR_ERR;
 
        /* Start acquisition on the device. */
-       if (send_shortcommand(sdi->serial->fd, CMD_RUN) != SR_OK)
+       if (send_shortcommand(ols->serial->fd, CMD_RUN) != SR_OK)
                return SR_ERR;
 
-       sr_source_add(sdi->serial->fd, G_IO_IN, -1, receive_data,
+       sr_source_add(ols->serial->fd, G_IO_IN, -1, receive_data,
                      session_data);
 
        if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
@@ -1004,7 +1017,6 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        gettimeofday(&header->starttime, NULL);
        header->samplerate = ols->cur_samplerate;
        header->num_logic_probes = NUM_PROBES;
-       header->num_analog_probes = 0;
        sr_session_bus(session_data, packet);
 
        g_free(header);
@@ -1013,7 +1025,7 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        return SR_OK;
 }
 
-static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+static int hw_stop_acquisition(int device_index, gpointer session_device_id)
 {
        struct sr_datafeed_packet packet;
 
@@ -1022,9 +1034,11 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 
        packet.type = SR_DF_END;
        sr_session_bus(session_device_id, &packet);
+
+       return SR_OK;
 }
 
-struct sr_device_plugin ols_plugin_info = {
+SR_PRIV struct sr_device_plugin ols_plugin_info = {
        .name = "ols",
        .longname = "Openbench Logic Sniffer",
        .api_version = 1,