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