X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fchronovu-la8%2Fchronovu-la8.c;h=60384a1d15affc822d6639e44ac6d581f086902d;hb=d261dbbfcc73;hp=cfca8e3dea36d467bfef1edadc7fbf5bf5a49aa7;hpb=ae32d7d759f5722f9d82a2da8ec4bbdebcfd029b;p=libsigrok.git diff --git a/hardware/chronovu-la8/chronovu-la8.c b/hardware/chronovu-la8/chronovu-la8.c index cfca8e3d..60384a1d 100644 --- a/hardware/chronovu-la8/chronovu-la8.c +++ b/hardware/chronovu-la8/chronovu-la8.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2011 Uwe Hermann + * Copyright (C) 2011-2012 Uwe Hermann * * 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 @@ -21,6 +21,7 @@ #include #include #include +#include #include "sigrok.h" #include "sigrok-internal.h" @@ -39,8 +40,9 @@ #define BS 4096 /* Block size */ #define NUM_BLOCKS 2048 /* Number of blocks */ -static GSList *device_instances = NULL; +static GSList *dev_insts = NULL; +/* Probes are numbered 0-7. */ static const char *probe_names[NUM_PROBES + 1] = { "0", "1", @@ -53,16 +55,14 @@ static const char *probe_names[NUM_PROBES + 1] = { NULL, }; -struct la8 { +/* Private, per-device-instance driver context. */ +struct context { /** FTDI device context (used by libftdi). */ struct ftdi_context *ftdic; /** The currently configured samplerate of the device. */ uint64_t cur_samplerate; - /** period in picoseconds corresponding to the samplerate */ - uint64_t period_ps; - /** The current sampling limit (in ms). */ uint64_t limit_msec; @@ -113,7 +113,7 @@ struct la8 { uint8_t divcount; }; -/* This will be initialized via hw_get_device_info()/SR_DI_SAMPLERATES. */ +/* This will be initialized via hw_dev_info_get()/SR_DI_SAMPLERATES. */ static uint64_t supported_samplerates[255 + 1] = { 0 }; /* @@ -128,7 +128,7 @@ static struct sr_samplerates samplerates = { }; /* Note: Continuous sampling is not supported by the hardware. */ -static int capabilities[] = { +static int hwcaps[] = { SR_HWCAP_LOGIC_ANALYZER, SR_HWCAP_SAMPLERATE, SR_HWCAP_LIMIT_MSEC, /* TODO: Not yet implemented. */ @@ -137,9 +137,9 @@ static int capabilities[] = { }; /* Function prototypes. */ -static int la8_close_usb_reset_sequencer(struct la8 *la8); -static void hw_stop_acquisition(int device_index, gpointer session_data); -static int la8_reset(struct la8 *la8); +static int la8_close_usb_reset_sequencer(struct context *ctx); +static int hw_dev_acquisition_stop(int dev_index, gpointer session_data); +static int la8_reset(struct context *ctx); static void fill_supported_samplerates_if_needed(void) { @@ -172,8 +172,8 @@ static int is_valid_samplerate(uint64_t samplerate) return 1; } - sr_warn("la8: %s: invalid samplerate (%" PRIu64 "Hz)", - __func__, samplerate); + sr_err("la8: %s: invalid samplerate (%" PRIu64 "Hz)", + __func__, samplerate); return 0; } @@ -207,24 +207,17 @@ static uint8_t samplerate_to_divcount(uint64_t samplerate) /** * Write data of a certain length to the LA8's FTDI device. * - * @param la8 The LA8 struct containing private per-device-instance data. - * @param buf The buffer containing the data to write. - * @param size The number of bytes to write. + * @param ctx The struct containing private per-device-instance data. Must not + * be NULL. ctx->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. */ -static int la8_write(struct la8 *la8, uint8_t *buf, int size) +static int la8_write(struct context *ctx, uint8_t *buf, int size) { int bytes_written; - if (!la8) { - sr_err("la8: %s: la8 was NULL", __func__); - return SR_ERR_ARG; - } - - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); - return SR_ERR_ARG; - } + /* Note: Caller checked that ctx and ctx->ftdic != NULL. */ if (!buf) { sr_err("la8: %s: buf was NULL", __func__); @@ -236,16 +229,16 @@ static int la8_write(struct la8 *la8, uint8_t *buf, int size) return SR_ERR_ARG; } - bytes_written = ftdi_write_data(la8->ftdic, buf, size); + bytes_written = ftdi_write_data(ctx->ftdic, buf, size); if (bytes_written < 0) { - sr_warn("la8: %s: ftdi_write_data: (%d) %s", __func__, - bytes_written, ftdi_get_error_string(la8->ftdic)); - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ + 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. */ } else if (bytes_written != size) { - sr_warn("la8: %s: bytes to write: %d, bytes written: %d", - __func__, size, bytes_written); - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ + sr_err("la8: %s: bytes to write: %d, bytes written: %d", + __func__, size, bytes_written); + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ } return bytes_written; @@ -254,24 +247,18 @@ static int la8_write(struct la8 *la8, uint8_t *buf, int size) /** * Read a certain amount of bytes from the LA8's FTDI device. * - * @param la8 The LA8 struct containing private per-device-instance data. - * @param buf The buffer where the received data will be stored. - * @param size The number of bytes to read. + * @param ctx The struct containing private per-device-instance data. Must not + * be NULL. ctx->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. */ -static int la8_read(struct la8 *la8, uint8_t *buf, int size) +static int la8_read(struct context *ctx, uint8_t *buf, int size) { int bytes_read; - if (!la8) { - sr_err("la8: %s: la8 was NULL", __func__); - return SR_ERR_ARG; - } - - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); - return SR_ERR_ARG; - } + /* Note: Caller checked that ctx and ctx->ftdic != NULL. */ if (!buf) { sr_err("la8: %s: buf was NULL", __func__); @@ -283,36 +270,36 @@ static int la8_read(struct la8 *la8, uint8_t *buf, int size) return SR_ERR_ARG; } - bytes_read = ftdi_read_data(la8->ftdic, buf, size); + bytes_read = ftdi_read_data(ctx->ftdic, buf, size); if (bytes_read < 0) { - sr_warn("la8: %s: ftdi_read_data: (%d) %s", __func__, - bytes_read, ftdi_get_error_string(la8->ftdic)); + sr_err("la8: %s: ftdi_read_data: (%d) %s", __func__, + bytes_read, ftdi_get_error_string(ctx->ftdic)); } else if (bytes_read != size) { - // sr_warn("la8: %s: bytes to read: %d, bytes read: %d", - // __func__, size, bytes_read); + // sr_err("la8: %s: bytes to read: %d, bytes read: %d", + // __func__, size, bytes_read); } return bytes_read; } -static int la8_close(struct la8 *la8) +static int la8_close(struct context *ctx) { int ret; - if (!la8) { - sr_err("la8: %s: la8 was NULL", __func__); + if (!ctx) { + sr_err("la8: %s: ctx was NULL", __func__); return SR_ERR_ARG; } - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); + if (!ctx->ftdic) { + sr_err("la8: %s: ctx->ftdic was NULL", __func__); return SR_ERR_ARG; } - if ((ret = ftdi_usb_close(la8->ftdic)) < 0) { - sr_warn("la8: %s: ftdi_usb_close: (%d) %s", - __func__, ret, ftdi_get_error_string(la8->ftdic)); + if ((ret = ftdi_usb_close(ctx->ftdic)) < 0) { + sr_err("la8: %s: ftdi_usb_close: (%d) %s", + __func__, ret, ftdi_get_error_string(ctx->ftdic)); } return ret; @@ -321,52 +308,49 @@ static int la8_close(struct la8 *la8) /** * Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic. * - * @param la8 The LA8 struct containing private per-device-instance data. - * @return SR_OK upon success, SR_ERR upon failure. + * @param ctx The struct containing private per-device-instance data. + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. */ -static int la8_close_usb_reset_sequencer(struct la8 *la8) +static int la8_close_usb_reset_sequencer(struct context *ctx) { /* Magic sequence of bytes for resetting the LA8 sequencer logic. */ uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01}; int ret; - sr_spew("la8: entering %s", __func__); - - if (!la8) { - sr_err("la8: %s: la8 was NULL", __func__); + if (!ctx) { + sr_err("la8: %s: ctx was NULL", __func__); return SR_ERR_ARG; } - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); + if (!ctx->ftdic) { + sr_err("la8: %s: ctx->ftdic was NULL", __func__); return SR_ERR_ARG; } - if (la8->ftdic->usb_dev) { + if (ctx->ftdic->usb_dev) { /* Reset the LA8 sequencer logic, then wait 100ms. */ - sr_dbg("la8: resetting sequencer logic"); - (void) la8_write(la8, buf, 8); /* Ignore errors. */ + sr_dbg("la8: Resetting sequencer logic."); + (void) la8_write(ctx, 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"); + 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(la8->ftdic)) < 0) - sr_warn("la8: %s: ftdi_usb_purge_buffers: (%d) %s", - __func__, ret, ftdi_get_error_string(la8->ftdic)); - if ((ret = ftdi_usb_reset(la8->ftdic)) < 0) - sr_warn("la8: %s: ftdi_usb_reset: (%d) %s", __func__, - ret, ftdi_get_error_string(la8->ftdic)); - if ((ret = ftdi_usb_close(la8->ftdic)) < 0) - sr_warn("la8: %s: ftdi_usb_close: (%d) %s", __func__, - ret, ftdi_get_error_string(la8->ftdic)); - } else { - sr_spew("la8: %s: usb_dev was NULL, nothing to do", __func__); + if ((ret = ftdi_usb_purge_buffers(ctx->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) + 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) + sr_err("la8: %s: ftdi_usb_close: (%d) %s", __func__, + ret, ftdi_get_error_string(ctx->ftdic)); } - ftdi_free(la8->ftdic); /* Returns void. */ - la8->ftdic = NULL; + /* Close USB device, deinitialize and free the FTDI context. */ + ftdi_free(ctx->ftdic); /* Returns void. */ + ctx->ftdic = NULL; return SR_OK; } @@ -376,26 +360,26 @@ static int la8_close_usb_reset_sequencer(struct la8 *la8) * * The LA8 must be reset after a failed read/write operation or upon timeouts. * - * @param la8 The LA8 struct containing private per-device-instance data. + * @param ctx The struct containing private per-device-instance data. * @return SR_OK upon success, SR_ERR upon failure. */ -static int la8_reset(struct la8 *la8) +static int la8_reset(struct context *ctx) { uint8_t buf[BS]; time_t done, now; int bytes_read; - if (!la8) { - sr_err("la8: %s: la8 was NULL", __func__); + if (!ctx) { + sr_err("la8: %s: ctx was NULL", __func__); return SR_ERR_ARG; } - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); + if (!ctx->ftdic) { + sr_err("la8: %s: ctx->ftdic was NULL", __func__); return SR_ERR_ARG; } - sr_dbg("la8: resetting the device"); + sr_dbg("la8: Resetting the device."); /* * Purge pending read data from the FTDI hardware FIFO until @@ -404,27 +388,29 @@ static int la8_reset(struct la8 *la8) done = 20 + time(NULL); do { /* TODO: Ignore errors? Check for < 0 at least! */ - bytes_read = la8_read(la8, (uint8_t *)&buf, BS); + bytes_read = la8_read(ctx, (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(la8); /* Ignore errors. */ + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ - sr_dbg("la8: device reset finished"); + sr_dbg("la8: Device reset finished."); return SR_OK; } -static int configure_probes(struct la8 *la8, GSList *probes) +static int configure_probes(struct context *ctx, GSList *probes) { struct sr_probe *probe; GSList *l; uint8_t probe_bit; char *tc; - la8->trigger_pattern = 0; - la8->trigger_mask = 0; /* Default to "don't care" for all probes. */ + /* Note: Caller checked that ctx != NULL. */ + + ctx->trigger_pattern = 0; + ctx->trigger_mask = 0; /* Default to "don't care" for all probes. */ for (l = probes; l; l = l->next) { probe = (struct sr_probe *)l->data; @@ -453,7 +439,7 @@ static int configure_probes(struct la8 *la8, GSList *probes) /* Configure the probe's trigger mask and trigger pattern. */ for (tc = probe->trigger; tc && *tc; tc++) { - la8->trigger_mask |= probe_bit; + ctx->trigger_mask |= probe_bit; /* Sanity check, LA8 only supports low/high trigger. */ if (*tc != '0' && *tc != '1') { @@ -463,149 +449,146 @@ static int configure_probes(struct la8 *la8, GSList *probes) } if (*tc == '1') - la8->trigger_pattern |= probe_bit; + ctx->trigger_pattern |= probe_bit; } } - sr_dbg("la8: %s: trigger_mask = 0x%x, trigger_pattern = 0x%x", - __func__, la8->trigger_mask, la8->trigger_pattern); + sr_dbg("la8: trigger_mask = 0x%x, trigger_pattern = 0x%x", + ctx->trigger_mask, ctx->trigger_pattern); return SR_OK; } -static int hw_init(const char *deviceinfo) +static int hw_init(const char *devinfo) { int ret; - struct sr_device_instance *sdi; - struct la8 *la8; - - sr_spew("la8: entering %s", __func__); + struct sr_dev_inst *sdi; + struct context *ctx; /* Avoid compiler errors. */ - (void)deviceinfo; + (void)devinfo; /* Allocate memory for our private driver context. */ - if (!(la8 = g_try_malloc(sizeof(struct la8)))) { - sr_err("la8: %s: struct la8 malloc failed", __func__); + if (!(ctx = g_try_malloc(sizeof(struct context)))) { + sr_err("la8: %s: struct context malloc failed", __func__); goto err_free_nothing; } /* Set some sane defaults. */ - la8->ftdic = NULL; - la8->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */ - la8->period_ps = 10000; - la8->limit_msec = 0; - la8->limit_samples = 0; - la8->session_id = NULL; - memset(la8->mangled_buf, 0, BS); - la8->final_buf = NULL; - la8->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */ - la8->trigger_mask = 0x00; /* All probes are "don't care". */ - la8->trigger_timeout = 10; /* Default to 10s trigger timeout. */ - la8->trigger_found = 0; - la8->done = 0; - la8->block_counter = 0; - la8->divcount = 0; /* 10ns sample period == 100MHz samplerate */ + ctx->ftdic = NULL; + ctx->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */ + ctx->limit_msec = 0; + ctx->limit_samples = 0; + ctx->session_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 */ /* Allocate memory where we'll store the de-mangled data. */ - if (!(la8->final_buf = g_try_malloc(SDRAM_SIZE))) { + if (!(ctx->final_buf = g_try_malloc(SDRAM_SIZE))) { sr_err("la8: %s: final_buf malloc failed", __func__); - goto err_free_la8; + goto err_free_ctx; } /* Allocate memory for the FTDI context (ftdic) and initialize it. */ - if (!(la8->ftdic = ftdi_new())) { + if (!(ctx->ftdic = ftdi_new())) { sr_err("la8: %s: ftdi_new failed", __func__); goto err_free_final_buf; } /* Check for the device and temporarily open it. */ - if ((ret = ftdi_usb_open_desc(la8->ftdic, USB_VENDOR_ID, + if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID, USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) { - sr_dbg("la8: %s: ftdi_usb_open_desc: (%d) %s", - __func__, ret, ftdi_get_error_string(la8->ftdic)); - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ goto err_free_ftdic; } - sr_dbg("la8: found device"); + sr_dbg("la8: Found LA8 device (%04x:%04x).", USB_VENDOR_ID, + USB_PRODUCT_ID); /* Register the device with libsigrok. */ - sdi = sr_device_instance_new(0, SR_ST_INITIALIZING, + sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING, USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION); if (!sdi) { - sr_err("la8: %s: sr_device_instance_new failed", __func__); + sr_err("la8: %s: sr_dev_inst_new failed", __func__); goto err_close_ftdic; } - sdi->priv = la8; + sdi->priv = ctx; - device_instances = g_slist_append(device_instances, sdi); + dev_insts = g_slist_append(dev_insts, sdi); - sr_spew("la8: %s finished successfully", __func__); + sr_spew("la8: Device init successful."); /* Close device. We'll reopen it again when we need it. */ - (void) la8_close(la8); /* Log, but ignore errors. */ + (void) la8_close(ctx); /* Log, but ignore errors. */ return 1; err_close_ftdic: - (void) la8_close(la8); /* Log, but ignore errors. */ + (void) la8_close(ctx); /* Log, but ignore errors. */ err_free_ftdic: - free(la8->ftdic); /* NOT g_free()! */ + free(ctx->ftdic); /* NOT g_free()! */ err_free_final_buf: - g_free(la8->final_buf); -err_free_la8: - g_free(la8); + g_free(ctx->final_buf); +err_free_ctx: + g_free(ctx); err_free_nothing: return 0; } -static int hw_opendev(int device_index) +static int hw_dev_open(int dev_index) { int ret; - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { sr_err("la8: %s: sdi was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - if (!(la8 = sdi->priv)) { + if (!(ctx = sdi->priv)) { sr_err("la8: %s: sdi->priv was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - sr_dbg("la8: opening device"); + sr_dbg("la8: Opening LA8 device (%04x:%04x).", USB_VENDOR_ID, + USB_PRODUCT_ID); /* Open the device. */ - if ((ret = ftdi_usb_open_desc(la8->ftdic, USB_VENDOR_ID, + if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID, USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) { sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s", - __func__, ret, ftdi_get_error_string(la8->ftdic)); - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ + __func__, ret, ftdi_get_error_string(ctx->ftdic)); + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ return SR_ERR; } - sr_dbg("la8: device opened successfully"); + sr_dbg("la8: Device opened successfully."); /* Purge RX/TX buffers in the FTDI chip. */ - if ((ret = ftdi_usb_purge_buffers(la8->ftdic)) < 0) { + if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0) { sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s", - __func__, ret, ftdi_get_error_string(la8->ftdic)); - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ - goto err_opendev_close_ftdic; + __func__, ret, ftdi_get_error_string(ctx->ftdic)); + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ + goto err_dev_open_close_ftdic; } - sr_dbg("la8: FTDI buffers purged successfully"); + sr_dbg("la8: FTDI buffers purged successfully."); /* Enable flow control in the FTDI chip. */ - if ((ret = ftdi_setflowctrl(la8->ftdic, SIO_RTS_CTS_HS)) < 0) { + if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) { sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s", - __func__, ret, ftdi_get_error_string(la8->ftdic)); - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ - goto err_opendev_close_ftdic; + __func__, ret, ftdi_get_error_string(ctx->ftdic)); + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ + goto err_dev_open_close_ftdic; } - sr_dbg("la8: FTDI flow control enabled successfully"); + sr_dbg("la8: FTDI flow control enabled successfully."); /* Wait 100ms. */ g_usleep(100 * 1000); @@ -614,26 +597,20 @@ static int hw_opendev(int device_index) return SR_OK; -err_opendev_close_ftdic: - (void) la8_close(la8); /* Log, but ignore errors. */ +err_dev_open_close_ftdic: + (void) la8_close(ctx); /* Log, but ignore errors. */ return SR_ERR; } -static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate) +static int set_samplerate(struct sr_dev_inst *sdi, uint64_t samplerate) { - struct la8 *la8; + struct context *ctx; - if (!sdi) { - sr_err("la8: %s: sdi was NULL", __func__); - return SR_ERR_ARG; - } + /* Note: Caller checked that sdi and sdi->priv != NULL. */ - if (!(la8 = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); - return SR_ERR_ARG; - } + ctx = sdi->priv; - sr_spew("la8: setting samplerate"); + sr_spew("la8: Trying to set samplerate to %" PRIu64 "Hz.", samplerate); fill_supported_samplerates_if_needed(); @@ -642,114 +619,115 @@ static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate) return SR_ERR; /* Set the new samplerate. */ - la8->cur_samplerate = samplerate; - la8->period_ps = 1000000000000 / samplerate; + ctx->cur_samplerate = samplerate; - sr_dbg("la8: samplerate set to %" PRIu64 "Hz", la8->cur_samplerate); + sr_dbg("la8: Samplerate set to %" PRIu64 "Hz.", ctx->cur_samplerate); return SR_OK; } -static int hw_closedev(int device_index) +static int hw_dev_close(int dev_index) { - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { sr_err("la8: %s: sdi was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - if (!(la8 = sdi->priv)) { + if (!(ctx = sdi->priv)) { sr_err("la8: %s: sdi->priv was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - sr_dbg("la8: closing device"); + sr_dbg("la8: Closing device."); if (sdi->status == SR_ST_ACTIVE) { - sr_dbg("la8: %s: status ACTIVE, closing device", __func__); + sr_dbg("la8: Status ACTIVE, closing device."); /* TODO: Really ignore errors here, or return SR_ERR? */ - (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */ + (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */ } else { - sr_spew("la8: %s: status not ACTIVE, nothing to do", __func__); + sr_spew("la8: Status not ACTIVE, nothing to do."); } sdi->status = SR_ST_INACTIVE; - sr_dbg("la8: %s: freeing sample buffers", __func__); - g_free(la8->final_buf); + sr_dbg("la8: Freeing sample buffer."); + g_free(ctx->final_buf); return SR_OK; } -static void hw_cleanup(void) +static int hw_cleanup(void) { GSList *l; - struct sr_device_instance *sdi; - - sr_spew("la8: entering %s", __func__); + struct sr_dev_inst *sdi; + int ret = SR_OK; /* Properly close all devices. */ - for (l = device_instances; l; l = l->next) { - if ((sdi = l->data) == NULL) { - sr_warn("la8: %s: sdi was NULL, continuing", __func__); + for (l = dev_insts; 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__); + ret = SR_ERR_BUG; continue; } -#if 0 - /* - * Fixes a segfault as it's free()d elsewhere already. - * TODO: Document who is supposed to free this, and when. - */ - if (sdi->priv != NULL) - free(sdi->priv); - else - sr_warn("la8: %s: sdi->priv was NULL, nothing " - "to do", __func__); -#endif - sr_device_instance_free(sdi); /* Returns void. */ + sr_dev_inst_free(sdi); /* Returns void. */ } - g_slist_free(device_instances); /* Returns void. */ - device_instances = NULL; + g_slist_free(dev_insts); /* Returns void. */ + dev_insts = NULL; + + return ret; } -static void *hw_get_device_info(int device_index, int device_info_id) +static void *hw_dev_info_get(int dev_index, int dev_info_id) { - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; void *info; - sr_spew("la8: entering %s", __func__); - - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { sr_err("la8: %s: sdi was NULL", __func__); return NULL; } - if (!(la8 = sdi->priv)) { + if (!(ctx = sdi->priv)) { sr_err("la8: %s: sdi->priv was NULL", __func__); return NULL; } - switch (device_info_id) { - case SR_DI_INSTANCE: + sr_spew("la8: %s: dev_index %d, dev_info_id %d.", __func__, + dev_index, dev_info_id); + + switch (dev_info_id) { + case SR_DI_INST: info = sdi; + sr_spew("la8: %s: Returning sdi.", __func__); break; case SR_DI_NUM_PROBES: info = GINT_TO_POINTER(NUM_PROBES); + sr_spew("la8: %s: Returning number of probes: %d.", __func__, + NUM_PROBES); break; case SR_DI_PROBE_NAMES: info = probe_names; + sr_spew("la8: %s: Returning probenames.", __func__); break; case SR_DI_SAMPLERATES: fill_supported_samplerates_if_needed(); info = &samplerates; + sr_spew("la8: %s: Returning samplerates.", __func__); break; case SR_DI_TRIGGER_TYPES: info = (char *)TRIGGER_TYPES; + sr_spew("la8: %s: Returning trigger types: %s.", __func__, + TRIGGER_TYPES); break; case SR_DI_CUR_SAMPLERATE: - info = &la8->cur_samplerate; + info = &ctx->cur_samplerate; + sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.", + __func__, ctx->cur_samplerate); break; default: /* Unknown device info ID, return NULL. */ @@ -761,75 +739,77 @@ static void *hw_get_device_info(int device_index, int device_info_id) return info; } -static int hw_get_status(int device_index) +static int hw_dev_status_get(int dev_index) { - struct sr_device_instance *sdi; + struct sr_dev_inst *sdi; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { - sr_warn("la8: %s: sdi was NULL, device not found", __func__); + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { + sr_err("la8: %s: sdi was NULL, device not found", __func__); return SR_ST_NOT_FOUND; } - sr_dbg("la8: %s: returning status %d", __func__, sdi->status); + sr_dbg("la8: Returning status: %d.", sdi->status); return sdi->status; } -static int *hw_get_capabilities(void) +static int *hw_hwcap_get_all(void) { - sr_spew("la8: entering %s", __func__); + sr_spew("la8: Returning list of device capabilities."); - return capabilities; + return hwcaps; } -static int hw_set_configuration(int device_index, int capability, void *value) +static int hw_dev_config_set(int dev_index, int hwcap, void *value) { - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; - sr_spew("la8: entering %s", __func__); - - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { sr_err("la8: %s: sdi was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - if (!(la8 = sdi->priv)) { + if (!(ctx = sdi->priv)) { sr_err("la8: %s: sdi->priv was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - switch (capability) { + sr_spew("la8: %s: dev_index %d, hwcap %d", __func__, dev_index, hwcap); + + switch (hwcap) { case SR_HWCAP_SAMPLERATE: - if (set_samplerate(sdi, *(uint64_t *)value) == SR_ERR) + if (set_samplerate(sdi, *(uint64_t *)value) == SR_ERR) { + sr_err("la8: %s: setting samplerate failed.", __func__); return SR_ERR; - sr_dbg("la8: SAMPLERATE = %" PRIu64, la8->cur_samplerate); + } + sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate); break; case SR_HWCAP_PROBECONFIG: - if (configure_probes(la8, (GSList *)value) != SR_OK) { - sr_err("la8: %s: probe config failed", __func__); + if (configure_probes(ctx, (GSList *)value) != SR_OK) { + sr_err("la8: %s: probe config failed.", __func__); return SR_ERR; } break; case SR_HWCAP_LIMIT_MSEC: if (*(uint64_t *)value == 0) { - sr_err("la8: %s: LIMIT_MSEC can't be 0", __func__); + sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__); return SR_ERR; } - la8->limit_msec = *(uint64_t *)value; - sr_dbg("la8: LIMIT_MSEC = %" PRIu64, la8->limit_msec); + ctx->limit_msec = *(uint64_t *)value; + sr_dbg("la8: LIMIT_MSEC = %" PRIu64, ctx->limit_msec); break; case SR_HWCAP_LIMIT_SAMPLES: if (*(uint64_t *)value < MIN_NUM_SAMPLES) { - sr_err("la8: %s: LIMIT_SAMPLES too small", __func__); + sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__); return SR_ERR; } - la8->limit_samples = *(uint64_t *)value; - sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, la8->limit_samples); + ctx->limit_samples = *(uint64_t *)value; + sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, ctx->limit_samples); break; default: /* Unknown capability, return SR_ERR. */ - sr_err("la8: %s: Unknown capability", __func__); + sr_err("la8: %s: Unknown capability.", __func__); return SR_ERR; break; } @@ -840,61 +820,54 @@ static int hw_set_configuration(int device_index, int capability, void *value) /** * Get a block of data from the LA8. * - * @param la8 The LA8 struct containing private per-device-instance data. + * @param ctx The struct containing private per-device-instance data. Must not + * be NULL. ctx->ftdic must not be NULL either. * @return SR_OK upon success, or SR_ERR upon errors. */ -static int la8_read_block(struct la8 *la8) +static int la8_read_block(struct context *ctx) { int i, byte_offset, m, mi, p, index, bytes_read; time_t now; - if (!la8) { - sr_err("la8: %s: la8 was NULL", __func__); - return SR_ERR_ARG; - } + /* Note: Caller checked that ctx and ctx->ftdic != NULL. */ - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); - return SR_ERR_ARG; - } - - sr_spew("la8: %s: reading block %d", __func__, la8->block_counter); + sr_spew("la8: Reading block %d.", ctx->block_counter); - bytes_read = la8_read(la8, la8->mangled_buf, BS); + bytes_read = la8_read(ctx, ctx->mangled_buf, BS); /* If first block read got 0 bytes, retry until success or timeout. */ - if ((bytes_read == 0) && (la8->block_counter == 0)) { + if ((bytes_read == 0) && (ctx->block_counter == 0)) { do { - sr_spew("la8: %s: reading block 0 again", __func__); - bytes_read = la8_read(la8, la8->mangled_buf, BS); + sr_spew("la8: Reading block 0 (again)."); + bytes_read = la8_read(ctx, ctx->mangled_buf, BS); /* TODO: How to handle read errors here? */ now = time(NULL); - } while ((la8->done > now) && (bytes_read == 0)); + } while ((ctx->done > now) && (bytes_read == 0)); } /* Check if block read was successful or a timeout occured. */ if (bytes_read != BS) { - sr_warn("la8: %s: trigger timed out", __func__); - (void) la8_reset(la8); /* Ignore errors. */ + sr_err("la8: Trigger timed out. Bytes read: %d.", bytes_read); + (void) la8_reset(ctx); /* Ignore errors. */ return SR_ERR; } /* De-mangle the data. */ - sr_spew("la8: de-mangling samples of block %d", la8->block_counter); - byte_offset = la8->block_counter * BS; + sr_spew("la8: Demangling block %d.", ctx->block_counter); + byte_offset = ctx->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 += (la8->divcount == 0) ? p : (1 - p); - la8->final_buf[index] = la8->mangled_buf[i]; + index += (ctx->divcount == 0) ? p : (1 - p); + ctx->final_buf[index] = ctx->mangled_buf[i]; } return SR_OK; } -static void send_block_to_session_bus(struct la8 *la8, int block) +static void send_block_to_session_bus(struct context *ctx, int block) { int i; uint8_t sample, expected_sample; @@ -902,14 +875,14 @@ static void send_block_to_session_bus(struct la8 *la8, int block) struct sr_datafeed_logic logic; int trigger_point; /* Relative trigger point (in this block). */ - /* Note: No sanity checks on la8/block, caller is responsible. */ + /* Note: No sanity checks on ctx/block, caller is responsible. */ /* Check if we can find the trigger condition in this block. */ trigger_point = -1; - expected_sample = la8->trigger_pattern & la8->trigger_mask; + expected_sample = ctx->trigger_pattern & ctx->trigger_mask; for (i = 0; i < BS; i++) { /* Don't continue if the trigger was found previously. */ - if (la8->trigger_found) + if (ctx->trigger_found) break; /* @@ -917,14 +890,14 @@ static void send_block_to_session_bus(struct la8 *la8, 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 (la8->trigger_mask == 0x00) + if (ctx->trigger_mask == 0x00) break; - sample = *(la8->final_buf + (block * BS) + i); + sample = *(ctx->final_buf + (block * BS) + i); - if ((sample & la8->trigger_mask) == expected_sample) { + if ((sample & ctx->trigger_mask) == expected_sample) { trigger_point = i; - la8->trigger_found = 1; + ctx->trigger_found = 1; break; } } @@ -935,13 +908,11 @@ static void send_block_to_session_bus(struct la8 *la8, int block) sr_spew("la8: sending SR_DF_LOGIC packet (%d bytes) for " "block %d", BS, block); packet.type = SR_DF_LOGIC; - packet.timeoffset = block * BS * la8->period_ps; - packet.duration = BS * la8->period_ps; packet.payload = &logic; logic.length = BS; logic.unitsize = 1; - logic.data = la8->final_buf + (block * BS); - sr_session_bus(la8->session_id, &packet); + logic.data = ctx->final_buf + (block * BS); + sr_session_bus(ctx->session_id, &packet); return; } @@ -960,23 +931,19 @@ static void send_block_to_session_bus(struct la8 *la8, int block) sr_spew("la8: sending pre-trigger SR_DF_LOGIC packet, " "start = %d, length = %d", block * BS, trigger_point); packet.type = SR_DF_LOGIC; - packet.timeoffset = block * BS * la8->period_ps; - packet.duration = trigger_point * la8->period_ps; packet.payload = &logic; logic.length = trigger_point; logic.unitsize = 1; - logic.data = la8->final_buf + (block * BS); - sr_session_bus(la8->session_id, &packet); + logic.data = ctx->final_buf + (block * BS); + sr_session_bus(ctx->session_id, &packet); } /* Send the SR_DF_TRIGGER packet to the session bus. */ sr_spew("la8: sending SR_DF_TRIGGER packet, sample = %d", (block * BS) + trigger_point); packet.type = SR_DF_TRIGGER; - packet.timeoffset = (block * BS + trigger_point) * la8->period_ps; - packet.duration = 0; packet.payload = NULL; - sr_session_bus(la8->session_id, &packet); + sr_session_bus(ctx->session_id, &packet); /* If at least one sample is located after the trigger... */ if (trigger_point < (BS - 1)) { @@ -985,21 +952,19 @@ static void send_block_to_session_bus(struct la8 *la8, int block) "start = %d, length = %d", (block * BS) + trigger_point, BS - trigger_point); packet.type = SR_DF_LOGIC; - packet.timeoffset = (block * BS + trigger_point) * la8->period_ps; - packet.duration = (BS - trigger_point) * la8->period_ps; packet.payload = &logic; logic.length = BS - trigger_point; logic.unitsize = 1; - logic.data = la8->final_buf + (block * BS) + trigger_point; - sr_session_bus(la8->session_id, &packet); + logic.data = ctx->final_buf + (block * BS) + trigger_point; + sr_session_bus(ctx->session_id, &packet); } } static int receive_data(int fd, int revents, void *session_data) { int i, ret; - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; /* Avoid compiler errors. */ (void)fd; @@ -1010,105 +975,109 @@ static int receive_data(int fd, int revents, void *session_data) return FALSE; } - if (!(la8 = sdi->priv)) { + if (!(ctx = 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__); + return FALSE; + } + /* Get one block of data. */ - if ((ret = la8_read_block(la8)) < 0) { + if ((ret = la8_read_block(ctx)) < 0) { sr_err("la8: %s: la8_read_block error: %d", __func__, ret); - hw_stop_acquisition(sdi->index, session_data); + hw_dev_acquisition_stop(sdi->index, session_data); return FALSE; } /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */ - if (la8->block_counter != (NUM_BLOCKS - 1)) { - la8->block_counter++; + if (ctx->block_counter != (NUM_BLOCKS - 1)) { + ctx->block_counter++; return TRUE; } - sr_dbg("la8: sampling finished, sending data to session bus now"); + sr_dbg("la8: Sampling finished, sending data to session bus now."); /* All data was received and demangled, send it to the session bus. */ for (i = 0; i < NUM_BLOCKS; i++) - send_block_to_session_bus(la8, i); + send_block_to_session_bus(ctx, i); - hw_stop_acquisition(sdi->index, session_data); + hw_dev_acquisition_stop(sdi->index, session_data); // return FALSE; /* FIXME? */ return TRUE; } -static int hw_start_acquisition(int device_index, gpointer session_data) +static int hw_dev_acquisition_start(int dev_index, gpointer session_data) { - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; struct sr_datafeed_packet packet; struct sr_datafeed_header header; uint8_t buf[4]; int bytes_written; - sr_spew("la8: entering %s", __func__); - - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { sr_err("la8: %s: sdi was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - if (!(la8 = sdi->priv)) { + if (!(ctx = sdi->priv)) { sr_err("la8: %s: sdi->priv was NULL", __func__); return SR_ERR; /* TODO: SR_ERR_ARG? */ } - if (!la8->ftdic) { - sr_err("la8: %s: la8->ftdic was NULL", __func__); + if (!ctx->ftdic) { + sr_err("la8: %s: ctx->ftdic was NULL", __func__); return SR_ERR_ARG; } - la8->divcount = samplerate_to_divcount(la8->cur_samplerate); - if (la8->divcount == 0xff) { + ctx->divcount = samplerate_to_divcount(ctx->cur_samplerate); + if (ctx->divcount == 0xff) { sr_err("la8: %s: invalid divcount/samplerate", __func__); return SR_ERR; } + sr_dbg("la8: Starting acquisition."); + /* Fill acquisition parameters into buf[]. */ - buf[0] = la8->divcount; + buf[0] = ctx->divcount; buf[1] = 0xff; /* This byte must always be 0xff. */ - buf[2] = la8->trigger_pattern; - buf[3] = la8->trigger_mask; + buf[2] = ctx->trigger_pattern; + buf[3] = ctx->trigger_mask; /* Start acquisition. */ - bytes_written = la8_write(la8, buf, 4); + bytes_written = la8_write(ctx, buf, 4); if (bytes_written < 0) { - sr_err("la8: acquisition failed to start"); + sr_err("la8: Acquisition failed to start."); return SR_ERR; } else if (bytes_written != 4) { - sr_err("la8: acquisition failed to start"); + sr_err("la8: Acquisition failed to start."); return SR_ERR; /* TODO: Other error and return code? */ } - sr_dbg("la8: acquisition started successfully"); + sr_dbg("la8: Acquisition started successfully."); - la8->session_id = session_data; + ctx->session_id = session_data; /* Send header packet to the session bus. */ - sr_dbg("la8: %s: sending SR_DF_HEADER", __func__); + sr_dbg("la8: Sending SR_DF_HEADER."); packet.type = SR_DF_HEADER; packet.payload = &header; header.feed_version = 1; gettimeofday(&header.starttime, NULL); - header.samplerate = la8->cur_samplerate; + header.samplerate = ctx->cur_samplerate; header.num_logic_probes = NUM_PROBES; - header.num_analog_probes = 0; sr_session_bus(session_data, &packet); /* Time when we should be done (for detecting trigger timeouts). */ - la8->done = (la8->divcount + 1) * 0.08388608 + time(NULL) - + la8->trigger_timeout; - la8->block_counter = 0; - la8->trigger_found = 0; + ctx->done = (ctx->divcount + 1) * 0.08388608 + time(NULL) + + ctx->trigger_timeout; + ctx->block_counter = 0; + ctx->trigger_found = 0; /* Hook up a dummy handler to receive data from the LA8. */ sr_source_add(-1, G_IO_IN, 0, receive_data, sdi); @@ -1116,42 +1085,44 @@ static int hw_start_acquisition(int device_index, gpointer session_data) return SR_OK; } -static void hw_stop_acquisition(int device_index, gpointer session_data) +static int hw_dev_acquisition_stop(int dev_index, gpointer session_data) { - struct sr_device_instance *sdi; - struct la8 *la8; + struct sr_dev_inst *sdi; + struct context *ctx; struct sr_datafeed_packet packet; - sr_dbg("la8: stopping acquisition"); + sr_dbg("la8: Stopping acquisition."); - if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { sr_err("la8: %s: sdi was NULL", __func__); - return; + return SR_ERR_BUG; } - if (!(la8 = sdi->priv)) { + if (!(ctx = sdi->priv)) { sr_err("la8: %s: sdi->priv was NULL", __func__); - return; + return SR_ERR_BUG; } /* Send end packet to the session bus. */ - sr_dbg("la8: %s: sending SR_DF_END", __func__); + sr_dbg("la8: Sending SR_DF_END."); packet.type = SR_DF_END; sr_session_bus(session_data, &packet); + + return SR_OK; } -struct sr_device_plugin chronovu_la8_plugin_info = { +SR_PRIV struct sr_dev_plugin chronovu_la8_plugin_info = { .name = "chronovu-la8", .longname = "ChronoVu LA8", .api_version = 1, .init = hw_init, .cleanup = hw_cleanup, - .opendev = hw_opendev, - .closedev = hw_closedev, - .get_device_info = hw_get_device_info, - .get_status = hw_get_status, - .get_capabilities = hw_get_capabilities, - .set_configuration = hw_set_configuration, - .start_acquisition = hw_start_acquisition, - .stop_acquisition = hw_stop_acquisition, + .dev_open = hw_dev_open, + .dev_close = hw_dev_close, + .dev_info_get = hw_dev_info_get, + .dev_status_get = hw_dev_status_get, + .hwcap_get_all = hw_hwcap_get_all, + .dev_config_set = hw_dev_config_set, + .dev_acquisition_start = hw_dev_acquisition_start, + .dev_acquisition_stop = hw_dev_acquisition_stop, };