src/hardware/chronovu-la/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011-2014 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 <config.h>
  22 #include "protocol.h"
  23
  24 SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
  25 static struct sr_dev_driver *di = &chronovu_la_driver_info;
  26
  27 static const uint32_t devopts[] = {
  28         SR_CONF_LOGIC_ANALYZER,
  29         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  30         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
  31         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  32         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  33 };
  34
  35 static const int32_t trigger_matches[] = {
  36         SR_TRIGGER_ZERO,
  37         SR_TRIGGER_ONE,
  38         SR_TRIGGER_RISING,
  39         SR_TRIGGER_FALLING,
  40 };
  41
  42 /* The ChronoVu LA8/LA16 can have multiple VID/PID pairs. */
  43 static const struct {
  44         uint16_t vid;
  45         uint16_t pid;
  46         int model;
  47         const char *iproduct;
  48 } vid_pid[] = {
  49         { 0x0403, 0x6001, CHRONOVU_LA8,  "ChronoVu LA8"  },
  50         { 0x0403, 0x8867, CHRONOVU_LA8,  "ChronoVu LA8"  },
  51         { 0x0403, 0x6001, CHRONOVU_LA16, "ChronoVu LA16" },
  52         { 0x0403, 0x8867, CHRONOVU_LA16, "ChronoVu LA16" },
  53 };
  54
  55 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
  56
  57 static void clear_helper(void *priv)
  58 {
  59         struct dev_context *devc;
  60
  61         devc = priv;
  62
  63         ftdi_free(devc->ftdic);
  64         g_free(devc->final_buf);
  65 }
  66
  67 static int dev_clear(const struct sr_dev_driver *di)
  68 {
  69         return std_dev_clear(di, clear_helper);
  70 }
  71
  72 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  73 {
  74         return std_init(sr_ctx, di, LOG_PREFIX);
  75 }
  76
  77 static int add_device(int idx, int model, GSList **devices)
  78 {
  79         int ret;
  80         unsigned int i;
  81         struct sr_dev_inst *sdi;
  82         struct drv_context *drvc;
  83         struct dev_context *devc;
  84
  85         ret = SR_OK;
  86
  87         drvc = di->context;
  88
  89         /* Allocate memory for our private device context. */
  90         devc = g_malloc0(sizeof(struct dev_context));
  91
  92         /* Set some sane defaults. */
  93         devc->prof = &cv_profiles[model];
  94         devc->ftdic = NULL; /* Will be set in the open() API call. */
  95         devc->cur_samplerate = 0; /* Set later (different for LA8/LA16). */
  96         devc->limit_msec = 0;
  97         devc->limit_samples = 0;
  98         devc->cb_data = NULL;
  99         memset(devc->mangled_buf, 0, BS);
 100         devc->final_buf = NULL;
 101         devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
 102         devc->trigger_mask = 0x0000; /* All channels: "don't care". */
 103         devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
 104         devc->trigger_found = 0;
 105         devc->done = 0;
 106         devc->block_counter = 0;
 107         devc->divcount = 0;
 108         devc->usb_vid = vid_pid[idx].vid;
 109         devc->usb_pid = vid_pid[idx].pid;
 110         memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
 111
 112         /* Allocate memory where we'll store the de-mangled data. */
 113         if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
 114                 sr_err("Failed to allocate memory for sample buffer.");
 115                 ret = SR_ERR_MALLOC;
 116                 goto err_free_devc;
 117         }
 118
 119         /* We now know the device, set its max. samplerate as default. */
 120         devc->cur_samplerate = devc->prof->max_samplerate;
 121
 122         /* Register the device with libsigrok. */
 123         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 124         sdi->status = SR_ST_INITIALIZING;
 125         sdi->vendor = g_strdup("ChronoVu");
 126         sdi->model = g_strdup(devc->prof->modelname);
 127         sdi->driver = di;
 128         sdi->priv = devc;
 129
 130         for (i = 0; i < devc->prof->num_channels; i++)
 131                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
 132                                 cv_channel_names[i]);
 133
 134         *devices = g_slist_append(*devices, sdi);
 135         drvc->instances = g_slist_append(drvc->instances, sdi);
 136
 137         if (ret == SR_OK)
 138                 return SR_OK;
 139
 140 err_free_devc:
 141         g_free(devc);
 142
 143         return ret;
 144 }
 145
 146 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 147 {
 148         int ret;
 149         unsigned int i;
 150         GSList *devices;
 151         struct ftdi_context *ftdic;
 152
 153         (void)di;
 154         (void)options;
 155
 156         devices = NULL;
 157
 158         /* Allocate memory for the FTDI context and initialize it. */
 159         if (!(ftdic = ftdi_new())) {
 160                 sr_err("Failed to initialize libftdi.");
 161                 return NULL;
 162         }
 163
 164         /* Check for LA8 and/or LA16 devices with various VID/PIDs. */
 165         for (i = 0; i < ARRAY_SIZE(vid_pid); i++) {
 166                 ret = ftdi_usb_open_desc(ftdic, vid_pid[i].vid,
 167                         vid_pid[i].pid, vid_pid[i].iproduct, NULL);
 168                 /* Show errors other than "device not found". */
 169                 if (ret < 0 && ret != -3)
 170                         sr_dbg("Error finding/opening device (%d): %s.",
 171                                ret, ftdi_get_error_string(ftdic));
 172                 if (ret < 0)
 173                         continue; /* No device found, or not usable. */
 174
 175                 sr_dbg("Found %s device (%04x:%04x).",
 176                        vid_pid[i].iproduct, vid_pid[i].vid, vid_pid[i].pid);
 177
 178                 if ((ret = add_device(i, vid_pid[i].model, &devices)) < 0)
 179                         sr_dbg("Failed to add device: %d.", ret);
 180
 181                 if ((ret = ftdi_usb_close(ftdic)) < 0)
 182                         sr_dbg("Failed to close FTDI device (%d): %s.",
 183                                ret, ftdi_get_error_string(ftdic));
 184         }
 185
 186         /* Close USB device, deinitialize and free the FTDI context. */
 187         ftdi_free(ftdic);
 188         ftdic = NULL;
 189
 190         return devices;
 191 }
 192
 193 static GSList *dev_list(const struct sr_dev_driver *di)
 194 {
 195         return ((struct drv_context *)(di->context))->instances;
 196 }
 197
 198 static int dev_open(struct sr_dev_inst *sdi)
 199 {
 200         struct dev_context *devc;
 201         int ret;
 202
 203         if (!(devc = sdi->priv))
 204                 return SR_ERR_BUG;
 205
 206         /* Allocate memory for the FTDI context and initialize it. */
 207         if (!(devc->ftdic = ftdi_new())) {
 208                 sr_err("Failed to initialize libftdi.");
 209                 return SR_ERR;
 210         }
 211
 212         sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
 213                devc->usb_vid, devc->usb_pid);
 214
 215         /* Open the device. */
 216         if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
 217                         devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
 218                 sr_err("Failed to open FTDI device (%d): %s.",
 219                        ret, ftdi_get_error_string(devc->ftdic));
 220                 goto err_ftdi_free;
 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("Failed to purge FTDI buffers (%d): %s.",
 227                        ret, ftdi_get_error_string(devc->ftdic));
 228                 goto err_ftdi_free;
 229         }
 230         sr_dbg("FTDI buffers purged successfully.");
 231
 232         /* Enable flow control in the FTDI chip. */
 233         if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
 234                 sr_err("Failed to enable FTDI flow control (%d): %s.",
 235                        ret, ftdi_get_error_string(devc->ftdic));
 236                 goto err_ftdi_free;
 237         }
 238         sr_dbg("FTDI flow control enabled successfully.");
 239
 240         /* Wait 100ms. */
 241         g_usleep(100 * 1000);
 242
 243         sdi->status = SR_ST_ACTIVE;
 244
 245         if (ret == SR_OK)
 246                 return SR_OK;
 247
 248 err_ftdi_free:
 249         ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
 250         devc->ftdic = NULL;
 251         return ret;
 252 }
 253
 254 static int dev_close(struct sr_dev_inst *sdi)
 255 {
 256         int ret;
 257         struct dev_context *devc;
 258
 259         if (sdi->status != SR_ST_ACTIVE)
 260                 return SR_OK;
 261
 262         devc = sdi->priv;
 263
 264         if (devc->ftdic && (ret = ftdi_usb_close(devc->ftdic)) < 0)
 265                 sr_err("Failed to close FTDI device (%d): %s.",
 266                        ret, ftdi_get_error_string(devc->ftdic));
 267         sdi->status = SR_ST_INACTIVE;
 268
 269         return SR_OK;
 270 }
 271
 272 static int cleanup(const struct sr_dev_driver *di)
 273 {
 274         return dev_clear(di);
 275 }
 276
 277 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 278                 const struct sr_channel_group *cg)
 279 {
 280         struct dev_context *devc;
 281
 282         (void)cg;
 283
 284         switch (key) {
 285         case SR_CONF_SAMPLERATE:
 286                 if (!sdi || !(devc = sdi->priv))
 287                         return SR_ERR_BUG;
 288                 *data = g_variant_new_uint64(devc->cur_samplerate);
 289                 break;
 290         default:
 291                 return SR_ERR_NA;
 292         }
 293
 294         return SR_OK;
 295 }
 296
 297 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 298                 const struct sr_channel_group *cg)
 299 {
 300         struct dev_context *devc;
 301
 302         (void)cg;
 303
 304         if (sdi->status != SR_ST_ACTIVE)
 305                 return SR_ERR_DEV_CLOSED;
 306
 307         if (!(devc = sdi->priv))
 308                 return SR_ERR_BUG;
 309
 310         switch (key) {
 311         case SR_CONF_SAMPLERATE:
 312                 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
 313                         return SR_ERR;
 314                 break;
 315         case SR_CONF_LIMIT_MSEC:
 316                 if (g_variant_get_uint64(data) == 0)
 317                         return SR_ERR_ARG;
 318                 devc->limit_msec = g_variant_get_uint64(data);
 319                 break;
 320         case SR_CONF_LIMIT_SAMPLES:
 321                 if (g_variant_get_uint64(data) == 0)
 322                         return SR_ERR_ARG;
 323                 devc->limit_samples = g_variant_get_uint64(data);
 324                 break;
 325         default:
 326                 return SR_ERR_NA;
 327         }
 328
 329         return SR_OK;
 330 }
 331
 332 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 333                 const struct sr_channel_group *cg)
 334 {
 335         GVariant *gvar, *grange[2];
 336         GVariantBuilder gvb;
 337         struct dev_context *devc;
 338
 339         (void)cg;
 340
 341         switch (key) {
 342         case SR_CONF_DEVICE_OPTIONS:
 343                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 344                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 345                 break;
 346         case SR_CONF_SAMPLERATE:
 347                 if (!sdi || !sdi->priv || !(devc = sdi->priv))
 348                         return SR_ERR_BUG;
 349                 cv_fill_samplerates_if_needed(sdi);
 350                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 351                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 352                                 devc->samplerates,
 353                                 ARRAY_SIZE(devc->samplerates),
 354                                 sizeof(uint64_t));
 355                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 356                 *data = g_variant_builder_end(&gvb);
 357                 break;
 358         case SR_CONF_LIMIT_SAMPLES:
 359                 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
 360                         return SR_ERR_BUG;
 361                 grange[0] = g_variant_new_uint64(0);
 362                 if (devc->prof->model == CHRONOVU_LA8)
 363                         grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
 364                 else
 365                         grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES / 2);
 366                 *data = g_variant_new_tuple(grange, 2);
 367                 break;
 368         case SR_CONF_TRIGGER_MATCH:
 369                 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
 370                         return SR_ERR_BUG;
 371                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 372                                 trigger_matches, devc->prof->num_trigger_matches,
 373                                 sizeof(int32_t));
 374                 break;
 375         default:
 376                 return SR_ERR_NA;
 377         }
 378
 379         return SR_OK;
 380 }
 381
 382 static int receive_data(int fd, int revents, void *cb_data)
 383 {
 384         int i, ret;
 385         struct sr_dev_inst *sdi;
 386         struct dev_context *devc;
 387
 388         (void)fd;
 389         (void)revents;
 390
 391         if (!(sdi = cb_data)) {
 392                 sr_err("cb_data was NULL.");
 393                 return FALSE;
 394         }
 395
 396         if (!(devc = sdi->priv)) {
 397                 sr_err("sdi->priv was NULL.");
 398                 return FALSE;
 399         }
 400
 401         if (!devc->ftdic) {
 402                 sr_err("devc->ftdic was NULL.");
 403                 return FALSE;
 404         }
 405
 406         /* Get one block of data. */
 407         if ((ret = cv_read_block(devc)) < 0) {
 408                 sr_err("Failed to read data block: %d.", ret);
 409                 dev_acquisition_stop(sdi, sdi);
 410                 return FALSE;
 411         }
 412
 413         /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
 414         if (devc->block_counter != (NUM_BLOCKS - 1)) {
 415                 devc->block_counter++;
 416                 return TRUE;
 417         }
 418
 419         sr_dbg("Sampling finished, sending data to session bus now.");
 420
 421         /*
 422          * All data was received and demangled, send it to the session bus.
 423          *
 424          * Note: Due to the method how data is spread across the 8MByte of
 425          * SDRAM, we can _not_ send it to the session bus in a streaming
 426          * manner while we receive it. We have to receive and de-mangle the
 427          * full 8MByte first, only then the whole buffer contains valid data.
 428          */
 429         for (i = 0; i < NUM_BLOCKS; i++)
 430                 cv_send_block_to_session_bus(devc, i);
 431
 432         dev_acquisition_stop(sdi, sdi);
 433
 434         return TRUE;
 435 }
 436
 437 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 438 {
 439         struct dev_context *devc;
 440         uint8_t buf[8];
 441         int bytes_to_write, bytes_written;
 442
 443         if (sdi->status != SR_ST_ACTIVE)
 444                 return SR_ERR_DEV_CLOSED;
 445
 446         if (!(devc = sdi->priv)) {
 447                 sr_err("sdi->priv was NULL.");
 448                 return SR_ERR_BUG;
 449         }
 450
 451         if (!devc->ftdic) {
 452                 sr_err("devc->ftdic was NULL.");
 453                 return SR_ERR_BUG;
 454         }
 455
 456         devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
 457         if (devc->divcount == 0xff) {
 458                 sr_err("Invalid divcount/samplerate.");
 459                 return SR_ERR;
 460         }
 461
 462         if (cv_convert_trigger(sdi) != SR_OK) {
 463                 sr_err("Failed to configure trigger.");
 464                 return SR_ERR;
 465         }
 466
 467         /* Fill acquisition parameters into buf[]. */
 468         if (devc->prof->model == CHRONOVU_LA8) {
 469                 buf[0] = devc->divcount;
 470                 buf[1] = 0xff; /* This byte must always be 0xff. */
 471                 buf[2] = devc->trigger_pattern & 0xff;
 472                 buf[3] = devc->trigger_mask & 0xff;
 473                 bytes_to_write = 4;
 474         } else {
 475                 buf[0] = devc->divcount;
 476                 buf[1] = 0xff; /* This byte must always be 0xff. */
 477                 buf[2] = (devc->trigger_pattern & 0xff00) >> 8;  /* LSB */
 478                 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0;  /* MSB */
 479                 buf[4] = (devc->trigger_mask & 0xff00) >> 8;     /* LSB */
 480                 buf[5] = (devc->trigger_mask & 0x00ff) >> 0;     /* MSB */
 481                 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
 482                 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
 483                 bytes_to_write = 8;
 484         }
 485
 486         /* Start acquisition. */
 487         bytes_written = cv_write(devc, buf, bytes_to_write);
 488
 489         if (bytes_written < 0 || bytes_written != bytes_to_write) {
 490                 sr_err("Acquisition failed to start.");
 491                 return SR_ERR;
 492         }
 493
 494         sr_dbg("Hardware acquisition started successfully.");
 495
 496         devc->cb_data = cb_data;
 497
 498         /* Send header packet to the session bus. */
 499         std_session_send_df_header(sdi, LOG_PREFIX);
 500
 501         /* Time when we should be done (for detecting trigger timeouts). */
 502         devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
 503                         g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
 504         devc->block_counter = 0;
 505         devc->trigger_found = 0;
 506
 507         /* Hook up a dummy handler to receive data from the device. */
 508         sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
 509
 510         return SR_OK;
 511 }
 512
 513 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 514 {
 515         struct sr_datafeed_packet packet;
 516
 517         (void)cb_data;
 518
 519         sr_dbg("Stopping acquisition.");
 520         sr_session_source_remove(sdi->session, -1);
 521
 522         /* Send end packet to the session bus. */
 523         sr_dbg("Sending SR_DF_END.");
 524         packet.type = SR_DF_END;
 525         sr_session_send(sdi, &packet);
 526
 527         return SR_OK;
 528 }
 529
 530 SR_PRIV struct sr_dev_driver chronovu_la_driver_info = {
 531         .name = "chronovu-la",
 532         .longname = "ChronoVu LA8/LA16",
 533         .api_version = 1,
 534         .init = init,
 535         .cleanup = cleanup,
 536         .scan = scan,
 537         .dev_list = dev_list,
 538         .dev_clear = dev_clear,
 539         .config_get = config_get,
 540         .config_set = config_set,
 541         .config_list = config_list,
 542         .dev_open = dev_open,
 543         .dev_close = dev_close,
 544         .dev_acquisition_start = dev_acquisition_start,
 545         .dev_acquisition_stop = dev_acquisition_stop,
 546         .context = NULL,
 547 };