]> sigrok.org Git - libsigrok.git/commitdiff
chronovu-la8: use driver-private storage for instances
authorBert Vermeulen <redacted>
Thu, 2 Aug 2012 19:35:25 +0000 (21:35 +0200)
committerBert Vermeulen <redacted>
Fri, 3 Aug 2012 09:29:00 +0000 (11:29 +0200)
hardware/chronovu-la8/api.c
hardware/chronovu-la8/driver.c
hardware/chronovu-la8/driver.h

index f9320a00705e9a5177ed1ad571335f58329c9a48..aa438ff91fbc4ea9637d04b6e6be152fe83e58dc 100644 (file)
@@ -45,31 +45,39 @@ static void clear_instances(void)
 {
        GSList *l;
        struct sr_dev_inst *sdi;
-       struct context *ctx;
+       struct drv_context *drvc;
+       struct dev_context *devc;
+
+       drvc = cdi->priv;
 
        /* Properly close all devices. */
-       for (l = cdi->instances; l; l = l->next) {
+       for (l = drvc->instances; l; l = l->next) {
                if (!(sdi = l->data)) {
                        /* Log error, but continue cleaning up the rest. */
                        sr_err("la8: %s: sdi was NULL, continuing", __func__);
                        continue;
                }
                if (sdi->priv) {
-                       ctx = sdi->priv;
-                       ftdi_free(ctx->ftdic);
-                       g_free(ctx);
+                       devc = sdi->priv;
+                       ftdi_free(devc->ftdic);
+                       g_free(devc);
                }
                sr_dev_inst_free(sdi);
        }
-       g_slist_free(cdi->instances);
-       cdi->instances = NULL;
+       g_slist_free(drvc->instances);
+       drvc->instances = NULL;
 
 }
 
 static int hw_init(void)
 {
+       struct drv_context *drvc;
 
-       /* Nothing to do. */
+       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
+               sr_err("chronovu-la8: driver context malloc failed.");
+               return SR_ERR;
+       }
+       cdi->priv = drvc;
 
        return SR_OK;
 }
@@ -78,45 +86,47 @@ static GSList *hw_scan(GSList *options)
 {
        struct sr_dev_inst *sdi;
        struct sr_probe *probe;
-       struct context *ctx;
+       struct drv_context *drvc;
+       struct dev_context *devc;
        GSList *devices;
        unsigned int i;
        int ret;
 
        (void)options;
+       drvc = cdi->priv;
        devices = NULL;
 
-       /* Allocate memory for our private driver context. */
-       if (!(ctx = g_try_malloc(sizeof(struct context)))) {
+       /* Allocate memory for our private device context. */
+       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
                sr_err("la8: %s: struct context malloc failed", __func__);
                goto err_free_nothing;
        }
 
        /* Set some sane defaults. */
-       ctx->ftdic = NULL;
-       ctx->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
-       ctx->limit_msec = 0;
-       ctx->limit_samples = 0;
-       ctx->session_dev_id = NULL;
-       memset(ctx->mangled_buf, 0, BS);
-       ctx->final_buf = NULL;
-       ctx->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
-       ctx->trigger_mask = 0x00; /* All probes are "don't care". */
-       ctx->trigger_timeout = 10; /* Default to 10s trigger timeout. */
-       ctx->trigger_found = 0;
-       ctx->done = 0;
-       ctx->block_counter = 0;
-       ctx->divcount = 0; /* 10ns sample period == 100MHz samplerate */
-       ctx->usb_pid = 0;
+       devc->ftdic = NULL;
+       devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
+       devc->limit_msec = 0;
+       devc->limit_samples = 0;
+       devc->session_dev_id = NULL;
+       memset(devc->mangled_buf, 0, BS);
+       devc->final_buf = NULL;
+       devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
+       devc->trigger_mask = 0x00; /* All probes are "don't care". */
+       devc->trigger_timeout = 10; /* Default to 10s trigger timeout. */
+       devc->trigger_found = 0;
+       devc->done = 0;
+       devc->block_counter = 0;
+       devc->divcount = 0; /* 10ns sample period == 100MHz samplerate */
+       devc->usb_pid = 0;
 
        /* Allocate memory where we'll store the de-mangled data. */
-       if (!(ctx->final_buf = g_try_malloc(SDRAM_SIZE))) {
+       if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
                sr_err("la8: %s: final_buf malloc failed", __func__);
-               goto err_free_ctx;
+               goto err_free_devc;
        }
 
        /* Allocate memory for the FTDI context (ftdic) and initialize it. */
-       if (!(ctx->ftdic = ftdi_new())) {
+       if (!(devc->ftdic = ftdi_new())) {
                sr_err("la8: %s: ftdi_new failed", __func__);
                goto err_free_final_buf;
        }
@@ -125,16 +135,16 @@ static GSList *hw_scan(GSList *options)
        for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
                sr_dbg("la8: Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
                       usb_pids[i]);
-               ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
+               ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
                                         usb_pids[i], USB_DESCRIPTION, NULL);
                if (ret == 0) {
                        sr_dbg("la8: Found LA8 device (%04x:%04x).",
                               USB_VENDOR_ID, usb_pids[i]);
-                       ctx->usb_pid = usb_pids[i];
+                       devc->usb_pid = usb_pids[i];
                }
        }
 
-       if (ctx->usb_pid == 0)
+       if (devc->usb_pid == 0)
                goto err_free_ftdic;
 
        /* Register the device with libsigrok. */
@@ -145,7 +155,7 @@ static GSList *hw_scan(GSList *options)
                goto err_close_ftdic;
        }
        sdi->driver = cdi;
-       sdi->priv = ctx;
+       sdi->priv = devc;
 
        for (i = 0; probe_names[i]; i++) {
                if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
@@ -155,23 +165,23 @@ static GSList *hw_scan(GSList *options)
        }
 
        devices = g_slist_append(devices, sdi);
-       cdi->instances = g_slist_append(cdi->instances, sdi);
+       drvc->instances = g_slist_append(drvc->instances, sdi);
 
        sr_spew("la8: Device init successful.");
 
        /* Close device. We'll reopen it again when we need it. */
-       (void) la8_close(ctx); /* Log, but ignore errors. */
+       (void) la8_close(devc); /* Log, but ignore errors. */
 
        return devices;
 
 err_close_ftdic:
-       (void) la8_close(ctx); /* Log, but ignore errors. */
+       (void) la8_close(devc); /* Log, but ignore errors. */
 err_free_ftdic:
-       free(ctx->ftdic); /* NOT g_free()! */
+       free(devc->ftdic); /* NOT g_free()! */
 err_free_final_buf:
-       g_free(ctx->final_buf);
-err_free_ctx:
-       g_free(ctx);
+       g_free(devc->final_buf);
+err_free_devc:
+       g_free(devc);
 err_free_nothing:
 
        return NULL;
@@ -179,41 +189,41 @@ err_free_nothing:
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
-       struct context *ctx;
+       struct dev_context *devc;
        int ret;
 
-       if (!(ctx = sdi->priv)) {
+       if (!(devc = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
                return SR_ERR_BUG;
        }
 
        sr_dbg("la8: Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
-              ctx->usb_pid);
+              devc->usb_pid);
 
        /* Open the device. */
-       if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
-                       ctx->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
+       if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
+                       devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
                sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(ctx->ftdic));
-               (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+                      __func__, ret, ftdi_get_error_string(devc->ftdic));
+               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
                return SR_ERR;
        }
        sr_dbg("la8: Device opened successfully.");
 
        /* Purge RX/TX buffers in the FTDI chip. */
-       if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0) {
+       if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
                sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(ctx->ftdic));
-               (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+                      __func__, ret, ftdi_get_error_string(devc->ftdic));
+               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
                goto err_dev_open_close_ftdic;
        }
        sr_dbg("la8: FTDI buffers purged successfully.");
 
        /* Enable flow control in the FTDI chip. */
-       if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) {
+       if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
                sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(ctx->ftdic));
-               (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+                      __func__, ret, ftdi_get_error_string(devc->ftdic));
+               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
                goto err_dev_open_close_ftdic;
        }
        sr_dbg("la8: FTDI flow control enabled successfully.");
@@ -226,15 +236,15 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
        return SR_OK;
 
 err_dev_open_close_ftdic:
-       (void) la8_close(ctx); /* Log, but ignore errors. */
+       (void) la8_close(devc); /* Log, but ignore errors. */
        return SR_ERR;
 }
 
 static int hw_dev_close(struct sr_dev_inst *sdi)
 {
-       struct context *ctx;
+       struct dev_context *devc;
 
-       if (!(ctx = sdi->priv)) {
+       if (!(devc = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
                return SR_ERR_BUG;
        }
@@ -244,7 +254,7 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
        if (sdi->status == SR_ST_ACTIVE) {
                sr_dbg("la8: Status ACTIVE, closing device.");
                /* TODO: Really ignore errors here, or return SR_ERR? */
-               (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
        } else {
                sr_spew("la8: Status not ACTIVE, nothing to do.");
        }
@@ -252,7 +262,7 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
        sdi->status = SR_ST_INACTIVE;
 
        sr_dbg("la8: Freeing sample buffer.");
-       g_free(ctx->final_buf);
+       g_free(devc->final_buf);
 
        return SR_OK;
 }
@@ -268,7 +278,7 @@ static int hw_cleanup(void)
 static int hw_info_get(int info_id, const void **data,
        const struct sr_dev_inst *sdi)
 {
-       struct context *ctx;
+       struct dev_context *devc;
 
        switch (info_id) {
        case SR_DI_HWCAPS:
@@ -295,10 +305,10 @@ static int hw_info_get(int info_id, const void **data,
                break;
        case SR_DI_CUR_SAMPLERATE:
                if (sdi) {
-                       ctx = sdi->priv;
-                       *data = &ctx->cur_samplerate;
+                       devc = sdi->priv;
+                       *data = &devc->cur_samplerate;
                        sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.",
-                               __func__, ctx->cur_samplerate);
+                               __func__, devc->cur_samplerate);
                } else
                        return SR_ERR;
                break;
@@ -312,9 +322,9 @@ static int hw_info_get(int info_id, const void **data,
 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                const void *value)
 {
-       struct context *ctx;
+       struct dev_context *devc;
 
-       if (!(ctx = sdi->priv)) {
+       if (!(devc = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
                return SR_ERR_BUG;
        }
@@ -325,10 +335,10 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                        sr_err("la8: %s: setting samplerate failed.", __func__);
                        return SR_ERR;
                }
-               sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate);
+               sr_dbg("la8: SAMPLERATE = %" PRIu64, devc->cur_samplerate);
                break;
        case SR_HWCAP_PROBECONFIG:
-               if (configure_probes(ctx, (const GSList *)value) != SR_OK) {
+               if (configure_probes(devc, (const GSList *)value) != SR_OK) {
                        sr_err("la8: %s: probe config failed.", __func__);
                        return SR_ERR;
                }
@@ -338,16 +348,16 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                        sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__);
                        return SR_ERR;
                }
-               ctx->limit_msec = *(const uint64_t *)value;
-               sr_dbg("la8: LIMIT_MSEC = %" PRIu64, ctx->limit_msec);
+               devc->limit_msec = *(const uint64_t *)value;
+               sr_dbg("la8: LIMIT_MSEC = %" PRIu64, devc->limit_msec);
                break;
        case SR_HWCAP_LIMIT_SAMPLES:
                if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
                        sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__);
                        return SR_ERR;
                }
-               ctx->limit_samples = *(const uint64_t *)value;
-               sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, ctx->limit_samples);
+               devc->limit_samples = *(const uint64_t *)value;
+               sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
                break;
        default:
                /* Unknown capability, return SR_ERR. */
@@ -363,7 +373,7 @@ static int receive_data(int fd, int revents, void *cb_data)
 {
        int i, ret;
        struct sr_dev_inst *sdi;
-       struct context *ctx;
+       struct dev_context *devc;
 
        /* Avoid compiler errors. */
        (void)fd;
@@ -374,26 +384,26 @@ static int receive_data(int fd, int revents, void *cb_data)
                return FALSE;
        }
 
-       if (!(ctx = sdi->priv)) {
+       if (!(devc = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
                return FALSE;
        }
 
-       if (!ctx->ftdic) {
-               sr_err("la8: %s: ctx->ftdic was NULL", __func__);
+       if (!devc->ftdic) {
+               sr_err("la8: %s: devc->ftdic was NULL", __func__);
                return FALSE;
        }
 
        /* Get one block of data. */
-       if ((ret = la8_read_block(ctx)) < 0) {
+       if ((ret = la8_read_block(devc)) < 0) {
                sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
                hw_dev_acquisition_stop(sdi, sdi);
                return FALSE;
        }
 
        /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
-       if (ctx->block_counter != (NUM_BLOCKS - 1)) {
-               ctx->block_counter++;
+       if (devc->block_counter != (NUM_BLOCKS - 1)) {
+               devc->block_counter++;
                return TRUE;
        }
 
@@ -401,7 +411,7 @@ static int receive_data(int fd, int revents, void *cb_data)
 
        /* All data was received and demangled, send it to the session bus. */
        for (i = 0; i < NUM_BLOCKS; i++)
-               send_block_to_session_bus(ctx, i);
+               send_block_to_session_bus(devc, i);
 
        hw_dev_acquisition_stop(sdi, sdi);
 
@@ -412,25 +422,25 @@ static int receive_data(int fd, int revents, void *cb_data)
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
-       struct context *ctx;
+       struct dev_context *devc;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_header header;
        struct sr_datafeed_meta_logic meta;
        uint8_t buf[4];
        int bytes_written;
 
-       if (!(ctx = sdi->priv)) {
+       if (!(devc = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
                return SR_ERR_BUG;
        }
 
-       if (!ctx->ftdic) {
-               sr_err("la8: %s: ctx->ftdic was NULL", __func__);
+       if (!devc->ftdic) {
+               sr_err("la8: %s: devc->ftdic was NULL", __func__);
                return SR_ERR_BUG;
        }
 
-       ctx->divcount = samplerate_to_divcount(ctx->cur_samplerate);
-       if (ctx->divcount == 0xff) {
+       devc->divcount = samplerate_to_divcount(devc->cur_samplerate);
+       if (devc->divcount == 0xff) {
                sr_err("la8: %s: invalid divcount/samplerate", __func__);
                return SR_ERR;
        }
@@ -438,13 +448,13 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        sr_dbg("la8: Starting acquisition.");
 
        /* Fill acquisition parameters into buf[]. */
-       buf[0] = ctx->divcount;
+       buf[0] = devc->divcount;
        buf[1] = 0xff; /* This byte must always be 0xff. */
-       buf[2] = ctx->trigger_pattern;
-       buf[3] = ctx->trigger_mask;
+       buf[2] = devc->trigger_pattern;
+       buf[3] = devc->trigger_mask;
 
        /* Start acquisition. */
-       bytes_written = la8_write(ctx, buf, 4);
+       bytes_written = la8_write(devc, buf, 4);
 
        if (bytes_written < 0) {
                sr_err("la8: Acquisition failed to start.");
@@ -456,7 +466,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 
        sr_dbg("la8: Acquisition started successfully.");
 
-       ctx->session_dev_id = cb_data;
+       devc->session_dev_id = cb_data;
 
        /* Send header packet to the session bus. */
        sr_dbg("la8: Sending SR_DF_HEADER.");
@@ -464,20 +474,20 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        packet.payload = &header;
        header.feed_version = 1;
        gettimeofday(&header.starttime, NULL);
-       sr_session_send(ctx->session_dev_id, &packet);
+       sr_session_send(devc->session_dev_id, &packet);
 
        /* Send metadata about the SR_DF_LOGIC packets to come. */
        packet.type = SR_DF_META_LOGIC;
        packet.payload = &meta;
-       meta.samplerate = ctx->cur_samplerate;
+       meta.samplerate = devc->cur_samplerate;
        meta.num_probes = NUM_PROBES;
-       sr_session_send(ctx->session_dev_id, &packet);
+       sr_session_send(devc->session_dev_id, &packet);
 
        /* Time when we should be done (for detecting trigger timeouts). */
-       ctx->done = (ctx->divcount + 1) * 0.08388608 + time(NULL)
-                       + ctx->trigger_timeout;
-       ctx->block_counter = 0;
-       ctx->trigger_found = 0;
+       devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL)
+                       + devc->trigger_timeout;
+       devc->block_counter = 0;
+       devc->trigger_found = 0;
 
        /* Hook up a dummy handler to receive data from the LA8. */
        sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
@@ -488,12 +498,12 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
-       struct context *ctx;
+       struct dev_context *devc;
        struct sr_datafeed_packet packet;
 
        sr_dbg("la8: Stopping acquisition.");
 
-       if (!(ctx = sdi->priv)) {
+       if (!(devc = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
                return SR_ERR_BUG;
        }
@@ -519,5 +529,5 @@ SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
        .dev_config_set = hw_dev_config_set,
        .dev_acquisition_start = hw_dev_acquisition_start,
        .dev_acquisition_stop = hw_dev_acquisition_stop,
-       .instances = NULL,
+       .priv = NULL,
 };
index 2b697bbb27953f7fe2971413db1b1a36b5ba0f5f..47356fd088239ea4df5a90bf8c5ad1017d90b422 100644 (file)
@@ -126,17 +126,17 @@ SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate)
 /**
  * Write data of a certain length to the LA8's FTDI device.
  *
- * @param ctx The struct containing private per-device-instance data. Must not
- *            be NULL. ctx->ftdic must not be NULL either.
+ * @param devc The struct containing private per-device-instance data. Must not
+ *            be NULL. devc->ftdic must not be NULL either.
  * @param buf The buffer containing the data to write. Must not be NULL.
  * @param size The number of bytes to write. Must be >= 0.
  * @return The number of bytes written, or a negative value upon errors.
  */
-SR_PRIV int la8_write(struct context *ctx, uint8_t *buf, int size)
+SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size)
 {
        int bytes_written;
 
-       /* Note: Caller checked that ctx and ctx->ftdic != NULL. */
+       /* Note: Caller checked that devc and devc->ftdic != NULL. */
 
        if (!buf) {
                sr_err("la8: %s: buf was NULL", __func__);
@@ -148,16 +148,16 @@ SR_PRIV int la8_write(struct context *ctx, uint8_t *buf, int size)
                return SR_ERR_ARG;
        }
 
-       bytes_written = ftdi_write_data(ctx->ftdic, buf, size);
+       bytes_written = ftdi_write_data(devc->ftdic, buf, size);
 
        if (bytes_written < 0) {
                sr_err("la8: %s: ftdi_write_data: (%d) %s", __func__,
-                      bytes_written, ftdi_get_error_string(ctx->ftdic));
-               (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+                      bytes_written, ftdi_get_error_string(devc->ftdic));
+               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
        } else if (bytes_written != size) {
                sr_err("la8: %s: bytes to write: %d, bytes written: %d",
                       __func__, size, bytes_written);
-               (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
        }
 
        return bytes_written;
@@ -166,18 +166,18 @@ SR_PRIV int la8_write(struct context *ctx, uint8_t *buf, int size)
 /**
  * Read a certain amount of bytes from the LA8's FTDI device.
  *
- * @param ctx The struct containing private per-device-instance data. Must not
- *            be NULL. ctx->ftdic must not be NULL either.
+ * @param devc The struct containing private per-device-instance data. Must not
+ *            be NULL. devc->ftdic must not be NULL either.
  * @param buf The buffer where the received data will be stored. Must not
  *            be NULL.
  * @param size The number of bytes to read. Must be >= 1.
  * @return The number of bytes read, or a negative value upon errors.
  */
-SR_PRIV int la8_read(struct context *ctx, uint8_t *buf, int size)
+SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size)
 {
        int bytes_read;
 
-       /* Note: Caller checked that ctx and ctx->ftdic != NULL. */
+       /* Note: Caller checked that devc and devc->ftdic != NULL. */
 
        if (!buf) {
                sr_err("la8: %s: buf was NULL", __func__);
@@ -189,11 +189,11 @@ SR_PRIV int la8_read(struct context *ctx, uint8_t *buf, int size)
                return SR_ERR_ARG;
        }
 
-       bytes_read = ftdi_read_data(ctx->ftdic, buf, size);
+       bytes_read = ftdi_read_data(devc->ftdic, buf, size);
 
        if (bytes_read < 0) {
                sr_err("la8: %s: ftdi_read_data: (%d) %s", __func__,
-                      bytes_read, ftdi_get_error_string(ctx->ftdic));
+                      bytes_read, ftdi_get_error_string(devc->ftdic));
        } else if (bytes_read != size) {
                // sr_err("la8: %s: bytes to read: %d, bytes read: %d",
                //        __func__, size, bytes_read);
@@ -202,23 +202,23 @@ SR_PRIV int la8_read(struct context *ctx, uint8_t *buf, int size)
        return bytes_read;
 }
 
-SR_PRIV int la8_close(struct context *ctx)
+SR_PRIV int la8_close(struct dev_context *devc)
 {
        int ret;
 
-       if (!ctx) {
-               sr_err("la8: %s: ctx was NULL", __func__);
+       if (!devc) {
+               sr_err("la8: %s: devc was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       if (!ctx->ftdic) {
-               sr_err("la8: %s: ctx->ftdic was NULL", __func__);
+       if (!devc->ftdic) {
+               sr_err("la8: %s: devc->ftdic was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       if ((ret = ftdi_usb_close(ctx->ftdic)) < 0) {
+       if ((ret = ftdi_usb_close(devc->ftdic)) < 0) {
                sr_err("la8: %s: ftdi_usb_close: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(ctx->ftdic));
+                      __func__, ret, ftdi_get_error_string(devc->ftdic));
        }
 
        return ret;
@@ -227,49 +227,49 @@ SR_PRIV int la8_close(struct context *ctx)
 /**
  * Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic.
  *
- * @param ctx The struct containing private per-device-instance data.
+ * @param devc The struct containing private per-device-instance data.
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-SR_PRIV int la8_close_usb_reset_sequencer(struct context *ctx)
+SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc)
 {
        /* Magic sequence of bytes for resetting the LA8 sequencer logic. */
        uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
        int ret;
 
-       if (!ctx) {
-               sr_err("la8: %s: ctx was NULL", __func__);
+       if (!devc) {
+               sr_err("la8: %s: devc was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       if (!ctx->ftdic) {
-               sr_err("la8: %s: ctx->ftdic was NULL", __func__);
+       if (!devc->ftdic) {
+               sr_err("la8: %s: devc->ftdic was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       if (ctx->ftdic->usb_dev) {
+       if (devc->ftdic->usb_dev) {
                /* Reset the LA8 sequencer logic, then wait 100ms. */
                sr_dbg("la8: Resetting sequencer logic.");
-               (void) la8_write(ctx, buf, 8); /* Ignore errors. */
+               (void) la8_write(devc, buf, 8); /* Ignore errors. */
                g_usleep(100 * 1000);
 
                /* Purge FTDI buffers, then reset and close the FTDI device. */
                sr_dbg("la8: Purging buffers, resetting+closing FTDI device.");
 
                /* Log errors, but ignore them (i.e., don't abort). */
-               if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0)
+               if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0)
                        sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
-                           __func__, ret, ftdi_get_error_string(ctx->ftdic));
-               if ((ret = ftdi_usb_reset(ctx->ftdic)) < 0)
+                           __func__, ret, ftdi_get_error_string(devc->ftdic));
+               if ((ret = ftdi_usb_reset(devc->ftdic)) < 0)
                        sr_err("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
-                              ret, ftdi_get_error_string(ctx->ftdic));
-               if ((ret = ftdi_usb_close(ctx->ftdic)) < 0)
+                              ret, ftdi_get_error_string(devc->ftdic));
+               if ((ret = ftdi_usb_close(devc->ftdic)) < 0)
                        sr_err("la8: %s: ftdi_usb_close: (%d) %s", __func__,
-                              ret, ftdi_get_error_string(ctx->ftdic));
+                              ret, ftdi_get_error_string(devc->ftdic));
        }
 
        /* Close USB device, deinitialize and free the FTDI context. */
-       ftdi_free(ctx->ftdic); /* Returns void. */
-       ctx->ftdic = NULL;
+       ftdi_free(devc->ftdic); /* Returns void. */
+       devc->ftdic = NULL;
 
        return SR_OK;
 }
@@ -279,22 +279,22 @@ SR_PRIV int la8_close_usb_reset_sequencer(struct context *ctx)
  *
  * The LA8 must be reset after a failed read/write operation or upon timeouts.
  *
- * @param ctx The struct containing private per-device-instance data.
+ * @param devc The struct containing private per-device-instance data.
  * @return SR_OK upon success, SR_ERR upon failure.
  */
-SR_PRIV int la8_reset(struct context *ctx)
+SR_PRIV int la8_reset(struct dev_context *devc)
 {
        uint8_t buf[BS];
        time_t done, now;
        int bytes_read;
 
-       if (!ctx) {
-               sr_err("la8: %s: ctx was NULL", __func__);
+       if (!devc) {
+               sr_err("la8: %s: devc was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       if (!ctx->ftdic) {
-               sr_err("la8: %s: ctx->ftdic was NULL", __func__);
+       if (!devc->ftdic) {
+               sr_err("la8: %s: devc->ftdic was NULL", __func__);
                return SR_ERR_ARG;
        }
 
@@ -307,29 +307,29 @@ SR_PRIV int la8_reset(struct context *ctx)
        done = 20 + time(NULL);
        do {
                /* TODO: Ignore errors? Check for < 0 at least! */
-               bytes_read = la8_read(ctx, (uint8_t *)&buf, BS);
+               bytes_read = la8_read(devc, (uint8_t *)&buf, BS);
                now = time(NULL);
        } while ((done > now) && (bytes_read > 0));
 
        /* Reset the LA8 sequencer logic and close the USB port. */
-       (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
+       (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
 
        sr_dbg("la8: Device reset finished.");
 
        return SR_OK;
 }
 
-SR_PRIV int configure_probes(struct context *ctx, const GSList *probes)
+SR_PRIV int configure_probes(struct dev_context *devc, const GSList *probes)
 {
        const struct sr_probe *probe;
        const GSList *l;
        uint8_t probe_bit;
        char *tc;
 
-       /* Note: Caller checked that ctx != NULL. */
+       /* Note: Caller checked that devc != NULL. */
 
-       ctx->trigger_pattern = 0;
-       ctx->trigger_mask = 0; /* Default to "don't care" for all probes. */
+       devc->trigger_pattern = 0;
+       devc->trigger_mask = 0; /* Default to "don't care" for all probes. */
 
        for (l = probes; l; l = l->next) {
                probe = (struct sr_probe *)l->data;
@@ -358,7 +358,7 @@ SR_PRIV int configure_probes(struct context *ctx, const GSList *probes)
 
                /* Configure the probe's trigger mask and trigger pattern. */
                for (tc = probe->trigger; tc && *tc; tc++) {
-                       ctx->trigger_mask |= probe_bit;
+                       devc->trigger_mask |= probe_bit;
 
                        /* Sanity check, LA8 only supports low/high trigger. */
                        if (*tc != '0' && *tc != '1') {
@@ -368,23 +368,23 @@ SR_PRIV int configure_probes(struct context *ctx, const GSList *probes)
                        }
 
                        if (*tc == '1')
-                               ctx->trigger_pattern |= probe_bit;
+                               devc->trigger_pattern |= probe_bit;
                }
        }
 
        sr_dbg("la8: trigger_mask = 0x%x, trigger_pattern = 0x%x",
-              ctx->trigger_mask, ctx->trigger_pattern);
+              devc->trigger_mask, devc->trigger_pattern);
 
        return SR_OK;
 }
 
 SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
 {
-       struct context *ctx;
+       struct dev_context *devc;
 
        /* Note: Caller checked that sdi and sdi->priv != NULL. */
 
-       ctx = sdi->priv;
+       devc = sdi->priv;
 
        sr_spew("la8: Trying to set samplerate to %" PRIu64 "Hz.", samplerate);
 
@@ -395,9 +395,9 @@ SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
                return SR_ERR;
 
        /* Set the new samplerate. */
-       ctx->cur_samplerate = samplerate;
+       devc->cur_samplerate = samplerate;
 
-       sr_dbg("la8: Samplerate set to %" PRIu64 "Hz.", ctx->cur_samplerate);
+       sr_dbg("la8: Samplerate set to %" PRIu64 "Hz.", devc->cur_samplerate);
 
        return SR_OK;
 }
@@ -405,54 +405,54 @@ SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
 /**
  * Get a block of data from the LA8.
  *
- * @param ctx The struct containing private per-device-instance data. Must not
- *            be NULL. ctx->ftdic must not be NULL either.
+ * @param devc The struct containing private per-device-instance data. Must not
+ *            be NULL. devc->ftdic must not be NULL either.
  * @return SR_OK upon success, or SR_ERR upon errors.
  */
-SR_PRIV int la8_read_block(struct context *ctx)
+SR_PRIV int la8_read_block(struct dev_context *devc)
 {
        int i, byte_offset, m, mi, p, index, bytes_read;
        time_t now;
 
-       /* Note: Caller checked that ctx and ctx->ftdic != NULL. */
+       /* Note: Caller checked that devc and devc->ftdic != NULL. */
 
-       sr_spew("la8: Reading block %d.", ctx->block_counter);
+       sr_spew("la8: Reading block %d.", devc->block_counter);
 
-       bytes_read = la8_read(ctx, ctx->mangled_buf, BS);
+       bytes_read = la8_read(devc, devc->mangled_buf, BS);
 
        /* If first block read got 0 bytes, retry until success or timeout. */
-       if ((bytes_read == 0) && (ctx->block_counter == 0)) {
+       if ((bytes_read == 0) && (devc->block_counter == 0)) {
                do {
                        sr_spew("la8: Reading block 0 (again).");
-                       bytes_read = la8_read(ctx, ctx->mangled_buf, BS);
+                       bytes_read = la8_read(devc, devc->mangled_buf, BS);
                        /* TODO: How to handle read errors here? */
                        now = time(NULL);
-               } while ((ctx->done > now) && (bytes_read == 0));
+               } while ((devc->done > now) && (bytes_read == 0));
        }
 
        /* Check if block read was successful or a timeout occured. */
        if (bytes_read != BS) {
                sr_err("la8: Trigger timed out. Bytes read: %d.", bytes_read);
-               (void) la8_reset(ctx); /* Ignore errors. */
+               (void) la8_reset(devc); /* Ignore errors. */
                return SR_ERR;
        }
 
        /* De-mangle the data. */
-       sr_spew("la8: Demangling block %d.", ctx->block_counter);
-       byte_offset = ctx->block_counter * BS;
+       sr_spew("la8: Demangling block %d.", devc->block_counter);
+       byte_offset = devc->block_counter * BS;
        m = byte_offset / (1024 * 1024);
        mi = m * (1024 * 1024);
        for (i = 0; i < BS; i++) {
                p = i & (1 << 0);
                index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
-               index += (ctx->divcount == 0) ? p : (1 - p);
-               ctx->final_buf[index] = ctx->mangled_buf[i];
+               index += (devc->divcount == 0) ? p : (1 - p);
+               devc->final_buf[index] = devc->mangled_buf[i];
        }
 
        return SR_OK;
 }
 
-SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
+SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block)
 {
        int i;
        uint8_t sample, expected_sample;
@@ -460,14 +460,14 @@ SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
        struct sr_datafeed_logic logic;
        int trigger_point; /* Relative trigger point (in this block). */
 
-       /* Note: No sanity checks on ctx/block, caller is responsible. */
+       /* Note: No sanity checks on devc/block, caller is responsible. */
 
        /* Check if we can find the trigger condition in this block. */
        trigger_point = -1;
-       expected_sample = ctx->trigger_pattern & ctx->trigger_mask;
+       expected_sample = devc->trigger_pattern & devc->trigger_mask;
        for (i = 0; i < BS; i++) {
                /* Don't continue if the trigger was found previously. */
-               if (ctx->trigger_found)
+               if (devc->trigger_found)
                        break;
 
                /*
@@ -475,14 +475,14 @@ SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
                 * no trigger conditions were specified by the user. In that
                 * case we don't want to send an SR_DF_TRIGGER packet at all.
                 */
-               if (ctx->trigger_mask == 0x00)
+               if (devc->trigger_mask == 0x00)
                        break;
 
-               sample = *(ctx->final_buf + (block * BS) + i);
+               sample = *(devc->final_buf + (block * BS) + i);
 
-               if ((sample & ctx->trigger_mask) == expected_sample) {
+               if ((sample & devc->trigger_mask) == expected_sample) {
                        trigger_point = i;
-                       ctx->trigger_found = 1;
+                       devc->trigger_found = 1;
                        break;
                }
        }
@@ -496,8 +496,8 @@ SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
                packet.payload = &logic;
                logic.length = BS;
                logic.unitsize = 1;
-               logic.data = ctx->final_buf + (block * BS);
-               sr_session_send(ctx->session_dev_id, &packet);
+               logic.data = devc->final_buf + (block * BS);
+               sr_session_send(devc->session_dev_id, &packet);
                return;
        }
 
@@ -519,8 +519,8 @@ SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
                packet.payload = &logic;
                logic.length = trigger_point;
                logic.unitsize = 1;
-               logic.data = ctx->final_buf + (block * BS);
-               sr_session_send(ctx->session_dev_id, &packet);
+               logic.data = devc->final_buf + (block * BS);
+               sr_session_send(devc->session_dev_id, &packet);
        }
 
        /* Send the SR_DF_TRIGGER packet to the session bus. */
@@ -528,7 +528,7 @@ SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
                (block * BS) + trigger_point);
        packet.type = SR_DF_TRIGGER;
        packet.payload = NULL;
-       sr_session_send(ctx->session_dev_id, &packet);
+       sr_session_send(devc->session_dev_id, &packet);
 
        /* If at least one sample is located after the trigger... */
        if (trigger_point < (BS - 1)) {
@@ -540,7 +540,7 @@ SR_PRIV void send_block_to_session_bus(struct context *ctx, int block)
                packet.payload = &logic;
                logic.length = BS - trigger_point;
                logic.unitsize = 1;
-               logic.data = ctx->final_buf + (block * BS) + trigger_point;
-               sr_session_send(ctx->session_dev_id, &packet);
+               logic.data = devc->final_buf + (block * BS) + trigger_point;
+               sr_session_send(devc->session_dev_id, &packet);
        }
 }
index ea89645a969cd4581a65f14a37a4eebabfb55bc2..14f8b4153fcea1313d2538088129d06814a5f64f 100644 (file)
 #define BS                             4096 /* Block size */
 #define NUM_BLOCKS                     2048 /* Number of blocks */
 
+/* Private driver context. */
+struct drv_context {
+       GSList *instances;
+};
+
 /* Private, per-device-instance driver context. */
-struct context {
+struct dev_context {
        /** FTDI device context (used by libftdi). */
        struct ftdi_context *ftdic;
 
@@ -110,14 +115,14 @@ extern const struct sr_samplerates samplerates;
 SR_PRIV void fill_supported_samplerates_if_needed(void);
 SR_PRIV int is_valid_samplerate(uint64_t samplerate);
 SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate);
-SR_PRIV int la8_write(struct context *ctx, uint8_t *buf, int size);
-SR_PRIV int la8_read(struct context *ctx, uint8_t *buf, int size);
-SR_PRIV int la8_close(struct context *ctx);
-SR_PRIV int la8_close_usb_reset_sequencer(struct context *ctx);
-SR_PRIV int la8_reset(struct context *ctx);
-SR_PRIV int configure_probes(struct context *ctx, const GSList *probes);
+SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size);
+SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size);
+SR_PRIV int la8_close(struct dev_context *devc);
+SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc);
+SR_PRIV int la8_reset(struct dev_context *devc);
+SR_PRIV int configure_probes(struct dev_context *devc, const GSList *probes);
 SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
-SR_PRIV int la8_read_block(struct context *ctx);
-SR_PRIV void send_block_to_session_bus(struct context *ctx, int block);
+SR_PRIV int la8_read_block(struct dev_context *devc);
+SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block);
 
 #endif