hardware/chronovu-la8/api.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <ftdi.h>
  22 #include <glib.h>
  23 #include <string.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26 #include "driver.h"
  27
  28 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
  29 static struct sr_dev_driver *cdi = &chronovu_la8_driver_info;
  30
  31 /*
  32  * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
  33  * a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
  34  */
  35 static const uint16_t usb_pids[] = {
  36         0x6001,
  37         0x8867,
  38 };
  39
  40 /* Function prototypes. */
  41 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
  42                 void *cb_data);
  43
  44 static void clear_instances(void)
  45 {
  46         GSList *l;
  47         struct sr_dev_inst *sdi;
  48         struct context *ctx;
  49
  50         /* Properly close all devices. */
  51         for (l = cdi->instances; l; l = l->next) {
  52                 if (!(sdi = l->data)) {
  53                         /* Log error, but continue cleaning up the rest. */
  54                         sr_err("la8: %s: sdi was NULL, continuing", __func__);
  55                         continue;
  56                 }
  57                 if (sdi->priv) {
  58                         ctx = sdi->priv;
  59                         ftdi_free(ctx->ftdic);
  60                         g_free(ctx);
  61                 }
  62                 sr_dev_inst_free(sdi);
  63         }
  64         g_slist_free(cdi->instances);
  65         cdi->instances = NULL;
  66
  67 }
  68
  69 static int hw_init(void)
  70 {
  71
  72         /* Nothing to do. */
  73
  74         return SR_OK;
  75 }
  76
  77 static GSList *hw_scan(GSList *options)
  78 {
  79         struct sr_dev_inst *sdi;
  80         struct context *ctx;
  81         GSList *devices;
  82         unsigned int i;
  83         int ret;
  84
  85         (void)options;
  86         devices = NULL;
  87
  88         /* Allocate memory for our private driver context. */
  89         if (!(ctx = g_try_malloc(sizeof(struct context)))) {
  90                 sr_err("la8: %s: struct context malloc failed", __func__);
  91                 goto err_free_nothing;
  92         }
  93
  94         /* Set some sane defaults. */
  95         ctx->ftdic = NULL;
  96         ctx->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
  97         ctx->limit_msec = 0;
  98         ctx->limit_samples = 0;
  99         ctx->session_dev_id = NULL;
 100         memset(ctx->mangled_buf, 0, BS);
 101         ctx->final_buf = NULL;
 102         ctx->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
 103         ctx->trigger_mask = 0x00; /* All probes are "don't care". */
 104         ctx->trigger_timeout = 10; /* Default to 10s trigger timeout. */
 105         ctx->trigger_found = 0;
 106         ctx->done = 0;
 107         ctx->block_counter = 0;
 108         ctx->divcount = 0; /* 10ns sample period == 100MHz samplerate */
 109         ctx->usb_pid = 0;
 110
 111         /* Allocate memory where we'll store the de-mangled data. */
 112         if (!(ctx->final_buf = g_try_malloc(SDRAM_SIZE))) {
 113                 sr_err("la8: %s: final_buf malloc failed", __func__);
 114                 goto err_free_ctx;
 115         }
 116
 117         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
 118         if (!(ctx->ftdic = ftdi_new())) {
 119                 sr_err("la8: %s: ftdi_new failed", __func__);
 120                 goto err_free_final_buf;
 121         }
 122
 123         /* Check for the device and temporarily open it. */
 124         for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
 125                 sr_dbg("la8: Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
 126                        usb_pids[i]);
 127                 ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
 128                                          usb_pids[i], USB_DESCRIPTION, NULL);
 129                 if (ret == 0) {
 130                         sr_dbg("la8: Found LA8 device (%04x:%04x).",
 131                                USB_VENDOR_ID, usb_pids[i]);
 132                         ctx->usb_pid = usb_pids[i];
 133                 }
 134         }
 135
 136         if (ctx->usb_pid == 0)
 137                 goto err_free_ftdic;
 138
 139         /* Register the device with libsigrok. */
 140         sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
 141                         USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
 142         if (!sdi) {
 143                 sr_err("la8: %s: sr_dev_inst_new failed", __func__);
 144                 goto err_close_ftdic;
 145         }
 146         sdi->driver = cdi;
 147         sdi->priv = ctx;
 148
 149         devices = g_slist_append(devices, sdi);
 150         cdi->instances = g_slist_append(cdi->instances, sdi);
 151
 152         sr_spew("la8: Device init successful.");
 153
 154         /* Close device. We'll reopen it again when we need it. */
 155         (void) la8_close(ctx); /* Log, but ignore errors. */
 156
 157         return devices;
 158
 159 err_close_ftdic:
 160         (void) la8_close(ctx); /* Log, but ignore errors. */
 161 err_free_ftdic:
 162         free(ctx->ftdic); /* NOT g_free()! */
 163 err_free_final_buf:
 164         g_free(ctx->final_buf);
 165 err_free_ctx:
 166         g_free(ctx);
 167 err_free_nothing:
 168
 169         return NULL;
 170 }
 171
 172 static int hw_dev_open(struct sr_dev_inst *sdi)
 173 {
 174         struct context *ctx;
 175         int ret;
 176
 177         if (!(ctx = sdi->priv)) {
 178                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 179                 return SR_ERR_BUG;
 180         }
 181
 182         sr_dbg("la8: Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
 183                ctx->usb_pid);
 184
 185         /* Open the device. */
 186         if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
 187                         ctx->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
 188                 sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s",
 189                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 190                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 191                 return SR_ERR;
 192         }
 193         sr_dbg("la8: Device opened successfully.");
 194
 195         /* Purge RX/TX buffers in the FTDI chip. */
 196         if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0) {
 197                 sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
 198                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 199                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 200                 goto err_dev_open_close_ftdic;
 201         }
 202         sr_dbg("la8: FTDI buffers purged successfully.");
 203
 204         /* Enable flow control in the FTDI chip. */
 205         if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) {
 206                 sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s",
 207                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 208                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 209                 goto err_dev_open_close_ftdic;
 210         }
 211         sr_dbg("la8: FTDI flow control enabled successfully.");
 212
 213         /* Wait 100ms. */
 214         g_usleep(100 * 1000);
 215
 216         sdi->status = SR_ST_ACTIVE;
 217
 218         return SR_OK;
 219
 220 err_dev_open_close_ftdic:
 221         (void) la8_close(ctx); /* Log, but ignore errors. */
 222         return SR_ERR;
 223 }
 224
 225 static int hw_dev_close(struct sr_dev_inst *sdi)
 226 {
 227         struct context *ctx;
 228
 229         if (!(ctx = sdi->priv)) {
 230                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 231                 return SR_ERR_BUG;
 232         }
 233
 234         sr_dbg("la8: Closing device.");
 235
 236         if (sdi->status == SR_ST_ACTIVE) {
 237                 sr_dbg("la8: Status ACTIVE, closing device.");
 238                 /* TODO: Really ignore errors here, or return SR_ERR? */
 239                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 240         } else {
 241                 sr_spew("la8: Status not ACTIVE, nothing to do.");
 242         }
 243
 244         sdi->status = SR_ST_INACTIVE;
 245
 246         sr_dbg("la8: Freeing sample buffer.");
 247         g_free(ctx->final_buf);
 248
 249         return SR_OK;
 250 }
 251
 252 static int hw_cleanup(void)
 253 {
 254
 255         clear_instances();
 256
 257         return SR_OK;
 258 }
 259
 260 static int hw_info_get(int info_id, const void **data,
 261        const struct sr_dev_inst *sdi)
 262 {
 263         struct context *ctx;
 264
 265         switch (info_id) {
 266         case SR_DI_INST:
 267                 *data = sdi;
 268                 sr_spew("la8: %s: Returning sdi.", __func__);
 269                 break;
 270         case SR_DI_HWCAPS:
 271                 *data = hwcaps;
 272                 break;
 273         case SR_DI_NUM_PROBES:
 274                 *data = GINT_TO_POINTER(NUM_PROBES);
 275                 sr_spew("la8: %s: Returning number of probes: %d.", __func__,
 276                         NUM_PROBES);
 277                 break;
 278         case SR_DI_PROBE_NAMES:
 279                 *data = probe_names;
 280                 sr_spew("la8: %s: Returning probenames.", __func__);
 281                 break;
 282         case SR_DI_SAMPLERATES:
 283                 fill_supported_samplerates_if_needed();
 284                 *data = &samplerates;
 285                 sr_spew("la8: %s: Returning samplerates.", __func__);
 286                 break;
 287         case SR_DI_TRIGGER_TYPES:
 288                 *data = (char *)TRIGGER_TYPES;
 289                 sr_spew("la8: %s: Returning trigger types: %s.", __func__,
 290                         TRIGGER_TYPES);
 291                 break;
 292         case SR_DI_CUR_SAMPLERATE:
 293                 if (sdi) {
 294                         ctx = sdi->priv;
 295                         *data = &ctx->cur_samplerate;
 296                         sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.",
 297                                 __func__, ctx->cur_samplerate);
 298                 } else
 299                         return SR_ERR;
 300                 break;
 301         default:
 302                 return SR_ERR_ARG;
 303         }
 304
 305         return SR_OK;
 306 }
 307
 308 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 309                 const void *value)
 310 {
 311         struct context *ctx;
 312
 313         if (!(ctx = sdi->priv)) {
 314                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 315                 return SR_ERR_BUG;
 316         }
 317
 318         switch (hwcap) {
 319         case SR_HWCAP_SAMPLERATE:
 320                 if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) {
 321                         sr_err("la8: %s: setting samplerate failed.", __func__);
 322                         return SR_ERR;
 323                 }
 324                 sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate);
 325                 break;
 326         case SR_HWCAP_PROBECONFIG:
 327                 if (configure_probes(ctx, (const GSList *)value) != SR_OK) {
 328                         sr_err("la8: %s: probe config failed.", __func__);
 329                         return SR_ERR;
 330                 }
 331                 break;
 332         case SR_HWCAP_LIMIT_MSEC:
 333                 if (*(const uint64_t *)value == 0) {
 334                         sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__);
 335                         return SR_ERR;
 336                 }
 337                 ctx->limit_msec = *(const uint64_t *)value;
 338                 sr_dbg("la8: LIMIT_MSEC = %" PRIu64, ctx->limit_msec);
 339                 break;
 340         case SR_HWCAP_LIMIT_SAMPLES:
 341                 if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
 342                         sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__);
 343                         return SR_ERR;
 344                 }
 345                 ctx->limit_samples = *(const uint64_t *)value;
 346                 sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, ctx->limit_samples);
 347                 break;
 348         default:
 349                 /* Unknown capability, return SR_ERR. */
 350                 sr_err("la8: %s: Unknown capability.", __func__);
 351                 return SR_ERR;
 352                 break;
 353         }
 354
 355         return SR_OK;
 356 }
 357
 358 static int receive_data(int fd, int revents, void *cb_data)
 359 {
 360         int i, ret;
 361         struct sr_dev_inst *sdi;
 362         struct context *ctx;
 363
 364         /* Avoid compiler errors. */
 365         (void)fd;
 366         (void)revents;
 367
 368         if (!(sdi = cb_data)) {
 369                 sr_err("la8: %s: cb_data was NULL", __func__);
 370                 return FALSE;
 371         }
 372
 373         if (!(ctx = sdi->priv)) {
 374                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 375                 return FALSE;
 376         }
 377
 378         if (!ctx->ftdic) {
 379                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 380                 return FALSE;
 381         }
 382
 383         /* Get one block of data. */
 384         if ((ret = la8_read_block(ctx)) < 0) {
 385                 sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
 386                 hw_dev_acquisition_stop(sdi, sdi);
 387                 return FALSE;
 388         }
 389
 390         /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
 391         if (ctx->block_counter != (NUM_BLOCKS - 1)) {
 392                 ctx->block_counter++;
 393                 return TRUE;
 394         }
 395
 396         sr_dbg("la8: Sampling finished, sending data to session bus now.");
 397
 398         /* All data was received and demangled, send it to the session bus. */
 399         for (i = 0; i < NUM_BLOCKS; i++)
 400                 send_block_to_session_bus(ctx, i);
 401
 402         hw_dev_acquisition_stop(sdi, sdi);
 403
 404         // return FALSE; /* FIXME? */
 405         return TRUE;
 406 }
 407
 408 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 409                 void *cb_data)
 410 {
 411         struct context *ctx;
 412         struct sr_datafeed_packet packet;
 413         struct sr_datafeed_header header;
 414         struct sr_datafeed_meta_logic meta;
 415         uint8_t buf[4];
 416         int bytes_written;
 417
 418         if (!(ctx = sdi->priv)) {
 419                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 420                 return SR_ERR_BUG;
 421         }
 422
 423         if (!ctx->ftdic) {
 424                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 425                 return SR_ERR_BUG;
 426         }
 427
 428         ctx->divcount = samplerate_to_divcount(ctx->cur_samplerate);
 429         if (ctx->divcount == 0xff) {
 430                 sr_err("la8: %s: invalid divcount/samplerate", __func__);
 431                 return SR_ERR;
 432         }
 433
 434         sr_dbg("la8: Starting acquisition.");
 435
 436         /* Fill acquisition parameters into buf[]. */
 437         buf[0] = ctx->divcount;
 438         buf[1] = 0xff; /* This byte must always be 0xff. */
 439         buf[2] = ctx->trigger_pattern;
 440         buf[3] = ctx->trigger_mask;
 441
 442         /* Start acquisition. */
 443         bytes_written = la8_write(ctx, buf, 4);
 444
 445         if (bytes_written < 0) {
 446                 sr_err("la8: Acquisition failed to start.");
 447                 return SR_ERR;
 448         } else if (bytes_written != 4) {
 449                 sr_err("la8: Acquisition failed to start.");
 450                 return SR_ERR; /* TODO: Other error and return code? */
 451         }
 452
 453         sr_dbg("la8: Acquisition started successfully.");
 454
 455         ctx->session_dev_id = cb_data;
 456
 457         /* Send header packet to the session bus. */
 458         sr_dbg("la8: Sending SR_DF_HEADER.");
 459         packet.type = SR_DF_HEADER;
 460         packet.payload = &header;
 461         header.feed_version = 1;
 462         gettimeofday(&header.starttime, NULL);
 463         sr_session_send(ctx->session_dev_id, &packet);
 464
 465         /* Send metadata about the SR_DF_LOGIC packets to come. */
 466         packet.type = SR_DF_META_LOGIC;
 467         packet.payload = &meta;
 468         meta.samplerate = ctx->cur_samplerate;
 469         meta.num_probes = NUM_PROBES;
 470         sr_session_send(ctx->session_dev_id, &packet);
 471
 472         /* Time when we should be done (for detecting trigger timeouts). */
 473         ctx->done = (ctx->divcount + 1) * 0.08388608 + time(NULL)
 474                         + ctx->trigger_timeout;
 475         ctx->block_counter = 0;
 476         ctx->trigger_found = 0;
 477
 478         /* Hook up a dummy handler to receive data from the LA8. */
 479         sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
 480
 481         return SR_OK;
 482 }
 483
 484 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
 485                 void *cb_data)
 486 {
 487         struct context *ctx;
 488         struct sr_datafeed_packet packet;
 489
 490         sr_dbg("la8: Stopping acquisition.");
 491
 492         if (!(ctx = sdi->priv)) {
 493                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 494                 return SR_ERR_BUG;
 495         }
 496
 497         /* Send end packet to the session bus. */
 498         sr_dbg("la8: Sending SR_DF_END.");
 499         packet.type = SR_DF_END;
 500         sr_session_send(cb_data, &packet);
 501
 502         return SR_OK;
 503 }
 504
 505 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
 506         .name = "chronovu-la8",
 507         .longname = "ChronoVu LA8",
 508         .api_version = 1,
 509         .init = hw_init,
 510         .cleanup = hw_cleanup,
 511         .scan = hw_scan,
 512         .dev_open = hw_dev_open,
 513         .dev_close = hw_dev_close,
 514         .info_get = hw_info_get,
 515         .dev_config_set = hw_dev_config_set,
 516         .dev_acquisition_start = hw_dev_acquisition_start,
 517         .dev_acquisition_stop = hw_dev_acquisition_stop,
 518         .instances = NULL,
 519 };