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