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