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