]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/openbench-logic-sniffer/api.c
Put driver pointers into special section
[libsigrok.git] / src / hardware / openbench-logic-sniffer / api.c
index ac69250cf19ecc3d36e72acdaa8bee65a01025aa..56161c5bcd7d5bbfda08e84e6ab0362881d4d426 100644 (file)
  * 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"
 
-static const uint32_t hwopts[] = {
+static const uint32_t drvopts[] = {
+       SR_CONF_LOGIC_ANALYZER,
+};
+
+static const uint32_t scanopts[] = {
        SR_CONF_CONN,
        SR_CONF_SERIALCOMM,
 };
 
-static const uint32_t hwcaps[] = {
-       SR_CONF_LOGIC_ANALYZER,
-       SR_CONF_SAMPLERATE,
-       SR_CONF_TRIGGER_MATCH,
-       SR_CONF_CAPTURE_RATIO,
-       SR_CONF_LIMIT_SAMPLES,
-       SR_CONF_EXTERNAL_CLOCK,
-       SR_CONF_PATTERN_MODE,
-       SR_CONF_SWAP,
-       SR_CONF_RLE,
+static const uint32_t devopts[] = {
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
+       SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_EXTERNAL_CLOCK | SR_CONF_SET,
+       SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_SWAP | SR_CONF_SET,
+       SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
 };
 
 static const int32_t trigger_matches[] = {
@@ -67,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. */
@@ -81,29 +83,21 @@ 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;
+       int ret;
+       unsigned int i;
        const char *conn, *serialcomm;
        char buf[8];
 
-       drvc = di->priv;
+       drvc = di->context;
 
        devices = NULL;
 
@@ -122,11 +116,10 @@ static GSList *scan(GSList *options)
        if (!conn)
                return NULL;
 
-       if (serialcomm == NULL)
+       if (!serialcomm)
                serialcomm = SERIALCOMM;
 
-       if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
-               return NULL;
+       serial = sr_serial_dev_inst_new(conn, serialcomm);
 
        /* The discovery procedure is like this: first send the Reset
         * command (0x00) 5 times, since the device could be anywhere
@@ -135,7 +128,7 @@ static GSList *scan(GSList *options)
         * have a match.
         */
        sr_info("Probing %s.", conn);
-       if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+       if (serial_open(serial, SERIAL_RDWR) != SR_OK)
                return NULL;
 
        ret = SR_OK;
@@ -152,43 +145,48 @@ static GSList *scan(GSList *options)
        }
        send_shortcommand(serial, CMD_ID);
 
-       /* Wait 10ms for a response. */
-       g_usleep(10000);
+       g_usleep(RESPONSE_DELAY_US);
 
-       sp_get_port_handle(serial->data, &probefd.fd);
-       probefd.events = G_IO_IN;
-       g_poll(&probefd, 1, 1);
-
-       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) != 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);
-               sdi->index = 0;
-               devc = sdi->priv;
        } else {
                /* Not an OLS -- some other board that uses the sump protocol. */
                sr_info("Device does not support metadata.");
-               sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
-                               "Sump", "Logic Analyzer", "v1.0");
+               sdi = g_malloc0(sizeof(struct sr_dev_inst));
+               sdi->status = SR_ST_INACTIVE;
+               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++) {
-                       if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
-                                       ols_channel_names[i])))
-                               return 0;
-                       sdi->channels = g_slist_append(sdi->channels, ch);
-               }
-               devc = ols_dev_new();
-               sdi->priv = devc;
+               for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
+                       sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
+                                       ols_channel_names[i]);
+               sdi->priv = ols_dev_new();
        }
        /* Configure samplerate and divider. */
        if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
@@ -205,16 +203,6 @@ static GSList *scan(GSList *options)
        return devices;
 }
 
-static GSList *dev_list(void)
-{
-       return ((struct drv_context *)(di->priv))->instances;
-}
-
-static int cleanup(void)
-{
-       return std_dev_clear(di, NULL);
-}
-
 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
@@ -286,10 +274,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:
@@ -364,11 +351,15 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
                *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               hwopts, ARRAY_SIZE(hwopts), sizeof(uint32_t));
+                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
                break;
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(uint32_t));
+               if (!sdi)
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
+               else
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
                break;
        case SR_CONF_SAMPLERATE:
                g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
@@ -455,8 +446,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;
@@ -562,19 +552,19 @@ 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, LOG_PREFIX);
 
-       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;
@@ -584,10 +574,10 @@ SR_PRIV 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,
@@ -596,5 +586,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);