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