]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/openbench-logic-sniffer/protocol.c
ols: Make use of zero-initialization.
[libsigrok.git] / src / hardware / openbench-logic-sniffer / protocol.c
index 1c94b7ff6948e9103d7caa7cb66878b0f6a76bdd..36a091c731d83ff2b7b9f4582dee87db7524e856 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include "protocol.h"
-#include <libserialport.h>
-
-extern SR_PRIV struct sr_dev_driver ols_driver_info;
-static struct sr_dev_driver *di = &ols_driver_info;
 
 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
                uint8_t command)
@@ -30,7 +27,10 @@ SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
 
        sr_dbg("Sending cmd 0x%.2x.", command);
        buf[0] = command;
-       if (serial_write_blocking(serial, buf, 1) != 1)
+       if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
+               return SR_ERR;
+
+       if (serial_drain(serial) != 0)
                return SR_ERR;
 
        return SR_OK;
@@ -48,12 +48,27 @@ SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
        buf[2] = data[1];
        buf[3] = data[2];
        buf[4] = data[3];
-       if (serial_write_blocking(serial, buf, 5) != 5)
+       if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
+               return SR_ERR;
+
+       if (serial_drain(serial) != 0)
                return SR_ERR;
 
        return SR_OK;
 }
 
+SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial)
+{
+       unsigned int i;
+
+       for (i = 0; i < 5; i++) {
+               if (send_shortcommand(serial, CMD_RESET) != SR_OK)
+                       return SR_ERR;
+       }
+
+       return SR_OK;
+}
+
 /* Configures the channel mask based on which channels are enabled. */
 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
 {
@@ -118,35 +133,58 @@ SR_PRIV struct dev_context *ols_dev_new(void)
 {
        struct dev_context *devc;
 
-       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
-               sr_err("Device context malloc failed.");
-               return NULL;
-       }
-
-       /* Device-specific settings */
-       devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
-
-       /* Acquisition settings */
-       devc->limit_samples = devc->capture_ratio = 0;
+       devc = g_malloc0(sizeof(struct dev_context));
        devc->trigger_at = -1;
-       devc->channel_mask = 0xffffffff;
-       devc->flag_reg = 0;
 
        return devc;
 }
 
+static void ols_channel_new(struct sr_dev_inst *sdi, int num_chan)
+{
+       struct dev_context *devc = sdi->priv;
+       int i;
+
+       for (i = 0; i < num_chan; i++)
+               sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
+                               ols_channel_names[i]);
+
+       devc->max_channels = num_chan;
+}
+
+static void metadata_quirks(struct sr_dev_inst *sdi)
+{
+       struct dev_context *devc;
+       gboolean is_shrimp;
+
+       if (!sdi)
+               return;
+       devc = sdi->priv;
+       if (!devc)
+               return;
+
+       is_shrimp = sdi->model && strcmp(sdi->model, "Shrimp1.0") == 0;
+       if (is_shrimp) {
+               if (!devc->max_channels)
+                       ols_channel_new(sdi, 4);
+               if (!devc->max_samples)
+                       devc->max_samples = 256 * 1024;
+               if (!devc->max_samplerate)
+                       devc->max_samplerate = SR_MHZ(20);
+       }
+}
+
 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
 {
        struct sr_dev_inst *sdi;
        struct dev_context *devc;
-       struct sr_channel *ch;
-       uint32_t tmp_int, ui;
+       uint32_t tmp_int;
        uint8_t key, type, token;
+       int delay_ms;
        GString *tmp_str, *devname, *version;
        guchar tmp_c;
 
-       sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, NULL, NULL, NULL);
-       sdi->driver = di;
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+       sdi->status = SR_ST_INACTIVE;
        devc = ols_dev_new();
        sdi->priv = devc;
 
@@ -155,7 +193,8 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
 
        key = 0xff;
        while (key) {
-               if (serial_read_blocking(serial, &key, 1) != 1)
+               delay_ms = serial_timeout(serial, 1);
+               if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
                        break;
                if (key == 0x00) {
                        sr_dbg("Got metadata key 0x00, metadata ends.");
@@ -167,7 +206,8 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
                case 0:
                        /* NULL-terminated string */
                        tmp_str = g_string_new("");
-                       while (serial_read_blocking(serial, &tmp_c, 1) == 1 && tmp_c != '\0')
+                       delay_ms = serial_timeout(serial, 1);
+                       while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
                                g_string_append_c(tmp_str, tmp_c);
                        sr_dbg("Got metadata key 0x%.2x value '%s'.",
                               key, tmp_str->str);
@@ -199,7 +239,8 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
                        break;
                case 1:
                        /* 32-bit unsigned integer */
-                       if (serial_read_blocking(serial, &tmp_int, 4) != 4)
+                       delay_ms = serial_timeout(serial, 4);
+                       if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
                                break;
                        tmp_int = RB32(&tmp_int);
                        sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
@@ -207,12 +248,7 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
                        switch (token) {
                        case 0x00:
                                /* Number of usable channels */
-                               for (ui = 0; ui < tmp_int; ui++) {
-                                       if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
-                                                       ols_channel_names[ui])))
-                                               return 0;
-                                       sdi->channels = g_slist_append(sdi->channels, ch);
-                               }
+                               ols_channel_new(sdi, tmp_int);
                                break;
                        case 0x01:
                                /* Amount of sample memory available (bytes) */
@@ -223,7 +259,7 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
                                /* what is this for? */
                                break;
                        case 0x03:
-                               /* Maximum sample rate (hz) */
+                               /* Maximum sample rate (Hz) */
                                devc->max_samplerate = tmp_int;
                                break;
                        case 0x04:
@@ -238,19 +274,15 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
                        break;
                case 2:
                        /* 8-bit unsigned integer */
-                       if (serial_read_blocking(serial, &tmp_c, 1) != 1)
+                       delay_ms = serial_timeout(serial, 1);
+                       if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
                                break;
                        sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
                               key, tmp_c);
                        switch (token) {
                        case 0x00:
                                /* Number of usable channels */
-                               for (ui = 0; ui < tmp_c; ui++) {
-                                       if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
-                                                       ols_channel_names[ui])))
-                                               return 0;
-                                       sdi->channels = g_slist_append(sdi->channels, ch);
-                               }
+                               ols_channel_new(sdi, tmp_c);
                                break;
                        case 0x01:
                                /* protocol version */
@@ -273,6 +305,9 @@ SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
        g_string_free(devname, FALSE);
        g_string_free(version, FALSE);
 
+       /* Optionally amend received metadata, model specific quirks. */
+       metadata_quirks(sdi);
+
        return sdi;
 }
 
@@ -289,13 +324,11 @@ SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
                sr_info("Enabling demux mode.");
                devc->flag_reg |= FLAG_DEMUX;
                devc->flag_reg &= ~FLAG_FILTER;
-               devc->max_channels = NUM_CHANNELS / 2;
                devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
        } else {
                sr_info("Disabling demux mode.");
                devc->flag_reg &= ~FLAG_DEMUX;
                devc->flag_reg |= FLAG_FILTER;
-               devc->max_channels = NUM_CHANNELS;
                devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
        }
 
@@ -314,15 +347,12 @@ SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
 
 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
 {
-       struct sr_datafeed_packet packet;
        struct sr_serial_dev_inst *serial;
 
        serial = sdi->conn;
        serial_source_remove(sdi->session, serial);
 
-       /* Terminate session */
-       packet.type = SR_DF_END;
-       sr_session_send(sdi, &packet);
+       std_session_send_df_end(sdi);
 }
 
 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
@@ -343,16 +373,12 @@ SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
        serial = sdi->conn;
        devc = sdi->priv;
 
+       if (devc->num_transfers == 0 && revents == 0) {
+               /* Ignore timeouts as long as we haven't received anything */
+               return TRUE;
+       }
+
        if (devc->num_transfers++ == 0) {
-               /*
-                * First time round, means the device started sending data,
-                * and will not stop until done. If it stops sending for
-                * longer than it takes to send a byte, that means it's
-                * finished. We'll double that to 30ms to be sure...
-                */
-               serial_source_remove(sdi->session, serial);
-               serial_source_add(sdi->session, serial, G_IO_IN, 30,
-                               ols_receive_data, cb_data);
                devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
                if (!devc->raw_sample_buf) {
                        sr_err("Sample buffer malloc failed.");
@@ -363,7 +389,7 @@ SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
        }
 
        num_ols_changrp = 0;
-       for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
+       for (i = 0x20; i > 0x02; i >>= 1) {
                if ((devc->flag_reg & i) == 0) {
                        num_ols_changrp++;
                }
@@ -478,12 +504,11 @@ SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
                                logic.unitsize = 4;
                                logic.data = devc->raw_sample_buf +
                                        (devc->limit_samples - devc->num_samples) * 4;
-                               sr_session_send(cb_data, &packet);
+                               sr_session_send(sdi, &packet);
                        }
 
                        /* Send the trigger. */
-                       packet.type = SR_DF_TRIGGER;
-                       sr_session_send(cb_data, &packet);
+                       std_session_send_df_trigger(sdi);
 
                        /* Send post-trigger samples. */
                        packet.type = SR_DF_LOGIC;
@@ -492,7 +517,7 @@ SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
                        logic.unitsize = 4;
                        logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
                                (devc->limit_samples - devc->num_samples) * 4;
-                       sr_session_send(cb_data, &packet);
+                       sr_session_send(sdi, &packet);
                } else {
                        /* no trigger was used */
                        packet.type = SR_DF_LOGIC;
@@ -501,7 +526,7 @@ SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
                        logic.unitsize = 4;
                        logic.data = devc->raw_sample_buf +
                                (devc->limit_samples - devc->num_samples) * 4;
-                       sr_session_send(cb_data, &packet);
+                       sr_session_send(sdi, &packet);
                }
                g_free(devc->raw_sample_buf);