src/hardware/openbench-logic-sniffer/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "protocol.h"
  21 #include <libserialport.h>
  22
  23 extern SR_PRIV struct sr_dev_driver ols_driver_info;
  24
  25 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
  26                 uint8_t command)
  27 {
  28         char buf[1];
  29
  30         sr_dbg("Sending cmd 0x%.2x.", command);
  31         buf[0] = command;
  32         if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
  33                 return SR_ERR;
  34
  35         if (serial_drain(serial) != 0)
  36                 return SR_ERR;
  37
  38         return SR_OK;
  39 }
  40
  41 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
  42                 uint8_t command, uint8_t *data)
  43 {
  44         char buf[5];
  45
  46         sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
  47                         data[0], data[1], data[2], data[3]);
  48         buf[0] = command;
  49         buf[1] = data[0];
  50         buf[2] = data[1];
  51         buf[3] = data[2];
  52         buf[4] = data[3];
  53         if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
  54                 return SR_ERR;
  55
  56         if (serial_drain(serial) != 0)
  57                 return SR_ERR;
  58
  59         return SR_OK;
  60 }
  61
  62 /* Configures the channel mask based on which channels are enabled. */
  63 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
  64 {
  65         struct dev_context *devc;
  66         struct sr_channel *channel;
  67         const GSList *l;
  68
  69         devc = sdi->priv;
  70
  71         devc->channel_mask = 0;
  72         for (l = sdi->channels; l; l = l->next) {
  73                 channel = l->data;
  74                 if (channel->enabled)
  75                         devc->channel_mask |= 1 << channel->index;
  76         }
  77 }
  78
  79 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
  80 {
  81         struct dev_context *devc;
  82         struct sr_trigger *trigger;
  83         struct sr_trigger_stage *stage;
  84         struct sr_trigger_match *match;
  85         const GSList *l, *m;
  86         int i;
  87
  88         devc = sdi->priv;
  89
  90         devc->num_stages = 0;
  91         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
  92                 devc->trigger_mask[i] = 0;
  93                 devc->trigger_value[i] = 0;
  94         }
  95
  96         if (!(trigger = sr_session_trigger_get(sdi->session)))
  97                 return SR_OK;
  98
  99         devc->num_stages = g_slist_length(trigger->stages);
 100         if (devc->num_stages > NUM_TRIGGER_STAGES) {
 101                 sr_err("This device only supports %d trigger stages.",
 102                                 NUM_TRIGGER_STAGES);
 103                 return SR_ERR;
 104         }
 105
 106         for (l = trigger->stages; l; l = l->next) {
 107                 stage = l->data;
 108                 for (m = stage->matches; m; m = m->next) {
 109                         match = m->data;
 110                         if (!match->channel->enabled)
 111                                 /* Ignore disabled channels with a trigger. */
 112                                 continue;
 113                         devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
 114                         if (match->match == SR_TRIGGER_ONE)
 115                                 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
 116                 }
 117         }
 118
 119         return SR_OK;
 120 }
 121
 122 SR_PRIV struct dev_context *ols_dev_new(void)
 123 {
 124         struct dev_context *devc;
 125
 126         devc = g_malloc0(sizeof(struct dev_context));
 127
 128         /* Device-specific settings */
 129         devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
 130
 131         /* Acquisition settings */
 132         devc->limit_samples = devc->capture_ratio = 0;
 133         devc->trigger_at = -1;
 134         devc->channel_mask = 0xffffffff;
 135         devc->flag_reg = 0;
 136
 137         return devc;
 138 }
 139
 140 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
 141 {
 142         struct sr_dev_inst *sdi;
 143         struct dev_context *devc;
 144         uint32_t tmp_int, ui;
 145         uint8_t key, type, token;
 146         int delay_ms;
 147         GString *tmp_str, *devname, *version;
 148         guchar tmp_c;
 149
 150         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 151         sdi->status = SR_ST_INACTIVE;
 152         sdi->driver = &ols_driver_info;
 153         devc = ols_dev_new();
 154         sdi->priv = devc;
 155
 156         devname = g_string_new("");
 157         version = g_string_new("");
 158
 159         key = 0xff;
 160         while (key) {
 161                 delay_ms = serial_timeout(serial, 1);
 162                 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
 163                         break;
 164                 if (key == 0x00) {
 165                         sr_dbg("Got metadata key 0x00, metadata ends.");
 166                         break;
 167                 }
 168                 type = key >> 5;
 169                 token = key & 0x1f;
 170                 switch (type) {
 171                 case 0:
 172                         /* NULL-terminated string */
 173                         tmp_str = g_string_new("");
 174                         delay_ms = serial_timeout(serial, 1);
 175                         while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
 176                                 g_string_append_c(tmp_str, tmp_c);
 177                         sr_dbg("Got metadata key 0x%.2x value '%s'.",
 178                                key, tmp_str->str);
 179                         switch (token) {
 180                         case 0x01:
 181                                 /* Device name */
 182                                 devname = g_string_append(devname, tmp_str->str);
 183                                 break;
 184                         case 0x02:
 185                                 /* FPGA firmware version */
 186                                 if (version->len)
 187                                         g_string_append(version, ", ");
 188                                 g_string_append(version, "FPGA version ");
 189                                 g_string_append(version, tmp_str->str);
 190                                 break;
 191                         case 0x03:
 192                                 /* Ancillary version */
 193                                 if (version->len)
 194                                         g_string_append(version, ", ");
 195                                 g_string_append(version, "Ancillary version ");
 196                                 g_string_append(version, tmp_str->str);
 197                                 break;
 198                         default:
 199                                 sr_info("ols: unknown token 0x%.2x: '%s'",
 200                                         token, tmp_str->str);
 201                                 break;
 202                         }
 203                         g_string_free(tmp_str, TRUE);
 204                         break;
 205                 case 1:
 206                         /* 32-bit unsigned integer */
 207                         delay_ms = serial_timeout(serial, 4);
 208                         if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
 209                                 break;
 210                         tmp_int = RB32(&tmp_int);
 211                         sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
 212                                key, tmp_int);
 213                         switch (token) {
 214                         case 0x00:
 215                                 /* Number of usable channels */
 216                                 for (ui = 0; ui < tmp_int; ui++)
 217                                         sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
 218                                                         ols_channel_names[ui]);
 219                                 break;
 220                         case 0x01:
 221                                 /* Amount of sample memory available (bytes) */
 222                                 devc->max_samples = tmp_int;
 223                                 break;
 224                         case 0x02:
 225                                 /* Amount of dynamic memory available (bytes) */
 226                                 /* what is this for? */
 227                                 break;
 228                         case 0x03:
 229                                 /* Maximum sample rate (hz) */
 230                                 devc->max_samplerate = tmp_int;
 231                                 break;
 232                         case 0x04:
 233                                 /* protocol version */
 234                                 devc->protocol_version = tmp_int;
 235                                 break;
 236                         default:
 237                                 sr_info("Unknown token 0x%.2x: 0x%.8x.",
 238                                         token, tmp_int);
 239                                 break;
 240                         }
 241                         break;
 242                 case 2:
 243                         /* 8-bit unsigned integer */
 244                         delay_ms = serial_timeout(serial, 1);
 245                         if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
 246                                 break;
 247                         sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
 248                                key, tmp_c);
 249                         switch (token) {
 250                         case 0x00:
 251                                 /* Number of usable channels */
 252                                 for (ui = 0; ui < tmp_c; ui++)
 253                                         sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
 254                                                         ols_channel_names[ui]);
 255                                 break;
 256                         case 0x01:
 257                                 /* protocol version */
 258                                 devc->protocol_version = tmp_c;
 259                                 break;
 260                         default:
 261                                 sr_info("Unknown token 0x%.2x: 0x%.2x.",
 262                                         token, tmp_c);
 263                                 break;
 264                         }
 265                         break;
 266                 default:
 267                         /* unknown type */
 268                         break;
 269                 }
 270         }
 271
 272         sdi->model = devname->str;
 273         sdi->version = version->str;
 274         g_string_free(devname, FALSE);
 275         g_string_free(version, FALSE);
 276
 277         return sdi;
 278 }
 279
 280 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
 281                 const uint64_t samplerate)
 282 {
 283         struct dev_context *devc;
 284
 285         devc = sdi->priv;
 286         if (devc->max_samplerate && samplerate > devc->max_samplerate)
 287                 return SR_ERR_SAMPLERATE;
 288
 289         if (samplerate > CLOCK_RATE) {
 290                 sr_info("Enabling demux mode.");
 291                 devc->flag_reg |= FLAG_DEMUX;
 292                 devc->flag_reg &= ~FLAG_FILTER;
 293                 devc->max_channels = NUM_CHANNELS / 2;
 294                 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
 295         } else {
 296                 sr_info("Disabling demux mode.");
 297                 devc->flag_reg &= ~FLAG_DEMUX;
 298                 devc->flag_reg |= FLAG_FILTER;
 299                 devc->max_channels = NUM_CHANNELS;
 300                 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
 301         }
 302
 303         /* Calculate actual samplerate used and complain if it is different
 304          * from the requested.
 305          */
 306         devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
 307         if (devc->flag_reg & FLAG_DEMUX)
 308                 devc->cur_samplerate *= 2;
 309         if (devc->cur_samplerate != samplerate)
 310                 sr_info("Can't match samplerate %" PRIu64 ", using %"
 311                        PRIu64 ".", samplerate, devc->cur_samplerate);
 312
 313         return SR_OK;
 314 }
 315
 316 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
 317 {
 318         struct sr_datafeed_packet packet;
 319         struct sr_serial_dev_inst *serial;
 320
 321         serial = sdi->conn;
 322         serial_source_remove(sdi->session, serial);
 323
 324         /* Terminate session */
 325         packet.type = SR_DF_END;
 326         sr_session_send(sdi, &packet);
 327 }
 328
 329 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
 330 {
 331         struct dev_context *devc;
 332         struct sr_dev_inst *sdi;
 333         struct sr_serial_dev_inst *serial;
 334         struct sr_datafeed_packet packet;
 335         struct sr_datafeed_logic logic;
 336         uint32_t sample;
 337         int num_ols_changrp, offset, j;
 338         unsigned int i;
 339         unsigned char byte;
 340
 341         (void)fd;
 342
 343         sdi = cb_data;
 344         serial = sdi->conn;
 345         devc = sdi->priv;
 346
 347         if (devc->num_transfers++ == 0) {
 348                 /*
 349                  * First time round, means the device started sending data,
 350                  * and will not stop until done. If it stops sending for
 351                  * longer than it takes to send a byte, that means it's
 352                  * finished. We'll double that to 30ms to be sure...
 353                  */
 354                 serial_source_remove(sdi->session, serial);
 355                 serial_source_add(sdi->session, serial, G_IO_IN, 30,
 356                                 ols_receive_data, cb_data);
 357                 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
 358                 if (!devc->raw_sample_buf) {
 359                         sr_err("Sample buffer malloc failed.");
 360                         return FALSE;
 361                 }
 362                 /* fill with 1010... for debugging */
 363                 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
 364         }
 365
 366         num_ols_changrp = 0;
 367         for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
 368                 if ((devc->flag_reg & i) == 0) {
 369                         num_ols_changrp++;
 370                 }
 371         }
 372
 373         if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
 374                 if (serial_read_nonblocking(serial, &byte, 1) != 1)
 375                         return FALSE;
 376                 devc->cnt_bytes++;
 377
 378                 /* Ignore it if we've read enough. */
 379                 if (devc->num_samples >= devc->limit_samples)
 380                         return TRUE;
 381
 382                 devc->sample[devc->num_bytes++] = byte;
 383                 sr_spew("Received byte 0x%.2x.", byte);
 384                 if (devc->num_bytes == num_ols_changrp) {
 385                         devc->cnt_samples++;
 386                         devc->cnt_samples_rle++;
 387                         /*
 388                          * Got a full sample. Convert from the OLS's little-endian
 389                          * sample to the local format.
 390                          */
 391                         sample = devc->sample[0] | (devc->sample[1] << 8) \
 392                                         | (devc->sample[2] << 16) | (devc->sample[3] << 24);
 393                         sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
 394                         if (devc->flag_reg & FLAG_RLE) {
 395                                 /*
 396                                  * In RLE mode the high bit of the sample is the
 397                                  * "count" flag, meaning this sample is the number
 398                                  * of times the previous sample occurred.
 399                                  */
 400                                 if (devc->sample[devc->num_bytes - 1] & 0x80) {
 401                                         /* Clear the high bit. */
 402                                         sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
 403                                         devc->rle_count = sample;
 404                                         devc->cnt_samples_rle += devc->rle_count;
 405                                         sr_dbg("RLE count: %u.", devc->rle_count);
 406                                         devc->num_bytes = 0;
 407                                         return TRUE;
 408                                 }
 409                         }
 410                         devc->num_samples += devc->rle_count + 1;
 411                         if (devc->num_samples > devc->limit_samples) {
 412                                 /* Save us from overrunning the buffer. */
 413                                 devc->rle_count -= devc->num_samples - devc->limit_samples;
 414                                 devc->num_samples = devc->limit_samples;
 415                         }
 416
 417                         if (num_ols_changrp < 4) {
 418                                 /*
 419                                  * Some channel groups may have been turned
 420                                  * off, to speed up transfer between the
 421                                  * hardware and the PC. Expand that here before
 422                                  * submitting it over the session bus --
 423                                  * whatever is listening on the bus will be
 424                                  * expecting a full 32-bit sample, based on
 425                                  * the number of channels.
 426                                  */
 427                                 j = 0;
 428                                 memset(devc->tmp_sample, 0, 4);
 429                                 for (i = 0; i < 4; i++) {
 430                                         if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
 431                                                 /*
 432                                                  * This channel group was
 433                                                  * enabled, copy from received
 434                                                  * sample.
 435                                                  */
 436                                                 devc->tmp_sample[i] = devc->sample[j++];
 437                                         } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
 438                                                 /* group 2 & 3 get added to 0 & 1 */
 439                                                 devc->tmp_sample[i - 2] = devc->sample[j++];
 440                                         }
 441                                 }
 442                                 memcpy(devc->sample, devc->tmp_sample, 4);
 443                                 sr_spew("Expanded sample: 0x%.8x.", sample);
 444                         }
 445
 446                         /*
 447                          * the OLS sends its sample buffer backwards.
 448                          * store it in reverse order here, so we can dump
 449                          * this on the session bus later.
 450                          */
 451                         offset = (devc->limit_samples - devc->num_samples) * 4;
 452                         for (i = 0; i <= devc->rle_count; i++) {
 453                                 memcpy(devc->raw_sample_buf + offset + (i * 4),
 454                                        devc->sample, 4);
 455                         }
 456                         memset(devc->sample, 0, 4);
 457                         devc->num_bytes = 0;
 458                         devc->rle_count = 0;
 459                 }
 460         } else {
 461                 /*
 462                  * This is the main loop telling us a timeout was reached, or
 463                  * we've acquired all the samples we asked for -- we're done.
 464                  * Send the (properly-ordered) buffer to the frontend.
 465                  */
 466                 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
 467                                 devc->cnt_bytes, devc->cnt_samples,
 468                                 devc->cnt_samples_rle);
 469                 if (devc->trigger_at != -1) {
 470                         /*
 471                          * A trigger was set up, so we need to tell the frontend
 472                          * about it.
 473                          */
 474                         if (devc->trigger_at > 0) {
 475                                 /* There are pre-trigger samples, send those first. */
 476                                 packet.type = SR_DF_LOGIC;
 477                                 packet.payload = &logic;
 478                                 logic.length = devc->trigger_at * 4;
 479                                 logic.unitsize = 4;
 480                                 logic.data = devc->raw_sample_buf +
 481                                         (devc->limit_samples - devc->num_samples) * 4;
 482                                 sr_session_send(cb_data, &packet);
 483                         }
 484
 485                         /* Send the trigger. */
 486                         packet.type = SR_DF_TRIGGER;
 487                         sr_session_send(cb_data, &packet);
 488
 489                         /* Send post-trigger samples. */
 490                         packet.type = SR_DF_LOGIC;
 491                         packet.payload = &logic;
 492                         logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
 493                         logic.unitsize = 4;
 494                         logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
 495                                 (devc->limit_samples - devc->num_samples) * 4;
 496                         sr_session_send(cb_data, &packet);
 497                 } else {
 498                         /* no trigger was used */
 499                         packet.type = SR_DF_LOGIC;
 500                         packet.payload = &logic;
 501                         logic.length = devc->num_samples * 4;
 502                         logic.unitsize = 4;
 503                         logic.data = devc->raw_sample_buf +
 504                                 (devc->limit_samples - devc->num_samples) * 4;
 505                         sr_session_send(cb_data, &packet);
 506                 }
 507                 g_free(devc->raw_sample_buf);
 508
 509                 serial_flush(serial);
 510                 abort_acquisition(sdi);
 511         }
 512
 513         return TRUE;
 514 }