]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/openbench-logic-sniffer/api.c
sr_config_set(): Factor out SR_ERR_DEV_CLOSED check.
[libsigrok.git] / src / hardware / openbench-logic-sniffer / api.c
index acbb971823846f326d72c7880765562da55ade70..93fa3bd7e57618209b19655f65aed554df708c29 100644 (file)
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include "protocol.h"
-#include <libserialport.h>
 
 #define SERIALCOMM "115200/8n1"
 
@@ -70,11 +70,10 @@ static const char *patterns[] = {
 };
 
 /* Channels are numbered 0-31 (on the PCB silkscreen). */
-SR_PRIV const char *ols_channel_names[NUM_CHANNELS + 1] = {
+SR_PRIV const char *ols_channel_names[] = {
        "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
        "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
        "24", "25", "26", "27", "28", "29", "30", "31",
-       NULL,
 };
 
 /* Default supported samplerates, can be overridden by device metadata. */
@@ -84,32 +83,19 @@ static const uint64_t samplerates[] = {
        SR_HZ(1),
 };
 
-SR_PRIV struct sr_dev_driver ols_driver_info;
-static struct sr_dev_driver *di = &ols_driver_info;
+#define RESPONSE_DELAY_US (10 * 1000)
 
-static int init(struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct sr_config *src;
        struct sr_dev_inst *sdi;
-       struct drv_context *drvc;
-       struct dev_context *devc;
-       struct sr_channel *ch;
        struct sr_serial_dev_inst *serial;
-       GPollFD probefd;
-       GSList *l, *devices;
-       int ret, i;
+       GSList *l;
+       int ret;
+       unsigned int i;
        const char *conn, *serialcomm;
        char buf[8];
 
-       drvc = di->priv;
-
-       devices = NULL;
-
        conn = serialcomm = NULL;
        for (l = options; l; l = l->next) {
                src = l->data;
@@ -125,7 +111,7 @@ static GSList *scan(GSList *options)
        if (!conn)
                return NULL;
 
-       if (serialcomm == NULL)
+       if (!serialcomm)
                serialcomm = SERIALCOMM;
 
        serial = sr_serial_dev_inst_new(conn, serialcomm);
@@ -140,42 +126,42 @@ static GSList *scan(GSList *options)
        if (serial_open(serial, SERIAL_RDWR) != SR_OK)
                return NULL;
 
-       ret = SR_OK;
-       for (i = 0; i < 5; i++) {
-               if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
-                       sr_err("Port %s is not writable.", conn);
-                       break;
-               }
-       }
-       if (ret != SR_OK) {
+       if (ols_send_reset(serial) != SR_OK) {
                serial_close(serial);
                sr_err("Could not use port %s. Quitting.", conn);
                return NULL;
        }
        send_shortcommand(serial, CMD_ID);
 
-       /* Wait 10ms for a response. */
-       g_usleep(10000);
-
-       sp_get_port_handle(serial->data, &probefd.fd);
-       probefd.events = G_IO_IN;
-       g_poll(&probefd, 1, 1);
+       g_usleep(RESPONSE_DELAY_US);
 
-       if (probefd.revents != G_IO_IN)
+       if (sp_input_waiting(serial->data) == 0) {
+               sr_dbg("Didn't get any reply.");
                return NULL;
-       if (serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4)) != 4)
+       }
+
+       ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
+       if (ret != 4) {
+               sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
                return NULL;
-       if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
+       }
+
+       if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
+               sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
+                      "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
                return NULL;
+       }
 
        /* Definitely using the OLS protocol, check if it supports
         * the metadata command.
         */
        send_shortcommand(serial, CMD_METADATA);
-       if (g_poll(&probefd, 1, 10) > 0) {
+
+       g_usleep(RESPONSE_DELAY_US);
+
+       if (sp_input_waiting(serial->data) != 0) {
                /* Got metadata. */
                sdi = get_metadata(serial);
-               devc = sdi->priv;
        } else {
                /* Not an OLS -- some other board that uses the sump protocol. */
                sr_info("Device does not support metadata.");
@@ -184,14 +170,10 @@ static GSList *scan(GSList *options)
                sdi->vendor = g_strdup("Sump");
                sdi->model = g_strdup("Logic Analyzer");
                sdi->version = g_strdup("v1.0");
-               sdi->driver = di;
-               for (i = 0; i < 32; i++) {
-                       ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
+               for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
+                       sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
                                        ols_channel_names[i]);
-                       sdi->channels = g_slist_append(sdi->channels, ch);
-               }
-               devc = ols_dev_new();
-               sdi->priv = devc;
+               sdi->priv = ols_dev_new();
        }
        /* Configure samplerate and divider. */
        if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
@@ -200,22 +182,9 @@ static GSList *scan(GSList *options)
        sdi->inst_type = SR_INST_SERIAL;
        sdi->conn = serial;
 
-       drvc->instances = g_slist_append(drvc->instances, sdi);
-       devices = g_slist_append(devices, sdi);
-
        serial_close(serial);
 
-       return devices;
-}
-
-static GSList *dev_list(void)
-{
-       return ((struct drv_context *)(di->priv))->instances;
-}
-
-static int cleanup(void)
-{
-       return std_dev_clear(di, NULL);
+       return std_scan_complete(di, g_slist_append(NULL, sdi));
 }
 
 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
@@ -268,9 +237,6 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
        switch (key) {
@@ -289,10 +255,9 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                break;
        case SR_CONF_CAPTURE_RATIO:
                devc->capture_ratio = g_variant_get_uint64(data);
-               if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
-                       devc->capture_ratio = 0;
+               if (devc->capture_ratio < 0 || devc->capture_ratio > 100)
                        ret = SR_ERR;
-               else
+               else
                        ret = SR_OK;
                break;
        case SR_CONF_EXTERNAL_CLOCK:
@@ -462,8 +427,7 @@ static int set_trigger(const struct sr_dev_inst *sdi, int stage)
        return SR_OK;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        struct sr_serial_dev_inst *serial;
@@ -472,9 +436,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        int num_ols_changrp;
        int ret, i;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
        serial = sdi->conn;
 
@@ -506,6 +467,14 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR;
        }
        if (devc->num_stages > 0) {
+               /*
+                * According to http://mygizmos.org/ols/Logic-Sniffer-FPGA-Spec.pdf
+                * reset command must be send prior each arm command
+                */
+               sr_dbg("Send reset command before trigger configure");
+               if (ols_send_reset(serial) != SR_OK)
+                       return SR_ERR;
+
                delaycount = readcount * (1 - devc->capture_ratio / 100.0);
                devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
                for (i = 0; i <= devc->num_stages; i++) {
@@ -569,32 +538,32 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
        memset(devc->sample, 0, 4);
 
-       /* Send header packet to the session bus. */
-       std_session_send_df_header(cb_data, LOG_PREFIX);
+       std_session_send_df_header(sdi);
 
-       serial_source_add(sdi->session, serial, G_IO_IN, -1,
-                       ols_receive_data, cb_data);
+       /* If the device stops sending for longer than it takes to send a byte,
+        * that means it's finished. But wait at least 100 ms to be safe.
+        */
+       serial_source_add(sdi->session, serial, G_IO_IN, 100,
+                       ols_receive_data, (struct sr_dev_inst *)sdi);
 
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
-       (void)cb_data;
-
        abort_acquisition(sdi);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver ols_driver_info = {
+static struct sr_dev_driver ols_driver_info = {
        .name = "ols",
        .longname = "Openbench Logic Sniffer",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
+       .dev_list = std_dev_list,
        .dev_clear = NULL,
        .config_get = config_get,
        .config_set = config_set,
@@ -603,5 +572,6 @@ SR_PRIV struct sr_dev_driver ols_driver_info = {
        .dev_close = std_serial_dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(ols_driver_info);