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