src/hardware/ipdbg-logic-analyser/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2016 danselmi <da@da>
   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
  22 #ifdef _WIN32
  23 #define _WIN32_WINNT 0x0501
  24 #include <winsock2.h>
  25 #include <ws2tcpip.h>
  26 #endif
  27
  28 #include <string.h>
  29 #include <unistd.h>
  30
  31 #ifndef _WIN32
  32 #include <sys/socket.h>
  33 #include <netinet/in.h>
  34 #include <arpa/inet.h>
  35 #include <netdb.h>
  36 #endif
  37
  38 #include <errno.h>
  39 #include "protocol.h"
  40
  41 #include <sys/ioctl.h>
  42
  43 #define BUFFER_SIZE 4
  44
  45 /* Top-level command opcodes */
  46 #define CMD_SET_TRIGGER            0x00
  47 #define CMD_CFG_TRIGGER            0xF0
  48 #define CMD_CFG_LA                 0x0F
  49 #define CMD_START                  0xFE
  50 #define CMD_RESET                  0xEE
  51
  52 #define CMD_GET_BUS_WIDTHS         0xAA
  53 #define CMD_GET_LA_ID              0xBB
  54 #define CMD_ESCAPE                 0x55
  55
  56 /* Trigger subfunction command opcodes */
  57 #define CMD_TRIG_MASKS             0xF1
  58 #define CMD_TRIG_MASK              0xF3
  59 #define CMD_TRIG_VALUE             0xF7
  60
  61 #define CMD_TRIG_MASKS_LAST        0xF9
  62 #define CMD_TRIG_MASK_LAST         0xFB
  63 #define CMD_TRIG_VALUE_LAST        0xFF
  64
  65 #define CMD_TRIG_SELECT_EDGE_MASK  0xF5
  66 #define CMD_TRIG_SET_EDGE_MASK     0xF6
  67
  68 /* LA subfunction command opcodes */
  69 #define CMD_LA_DELAY               0x1F
  70
  71 SR_PRIV int data_available(struct ipdbg_org_la_tcp *tcp)
  72 {
  73 #ifdef __WIN32__
  74         ioctlsocket(tcp->socket, FIONREAD, &bytes_available);
  75 #else
  76         int status;
  77
  78         if (ioctl(tcp->socket, FIONREAD, &status) < 0) {        // TIOCMGET
  79                 sr_err("FIONREAD failed: %s\n", strerror(errno));
  80                 return 0;
  81         }
  82
  83         return (status < 1) ? 0 : 1;
  84 #endif  // __WIN32__
  85 }
  86
  87 SR_PRIV struct ipdbg_org_la_tcp *ipdbg_org_la_tcp_new(void)
  88 {
  89         struct ipdbg_org_la_tcp *tcp;
  90
  91         tcp = g_malloc0(sizeof(struct ipdbg_org_la_tcp));
  92
  93         tcp->address = NULL;
  94         tcp->port = NULL;
  95         tcp->socket = -1;
  96
  97         return tcp;
  98 }
  99
 100 SR_PRIV void ipdbg_org_la_tcp_free(struct ipdbg_org_la_tcp *tcp)
 101 {
 102         g_free(tcp->address);
 103         g_free(tcp->port);
 104 }
 105
 106 SR_PRIV int ipdbg_org_la_tcp_open(struct ipdbg_org_la_tcp *tcp)
 107 {
 108         struct addrinfo hints;
 109         struct addrinfo *results, *res;
 110         int err;
 111
 112         memset(&hints, 0, sizeof(hints));
 113         hints.ai_family = AF_UNSPEC;
 114         hints.ai_socktype = SOCK_STREAM;
 115         hints.ai_protocol = IPPROTO_TCP;
 116
 117         err = getaddrinfo(tcp->address, tcp->port, &hints, &results);
 118
 119         if (err) {
 120                 sr_err("Address lookup failed: %s:%s: %s", tcp->address,
 121                         tcp->port, gai_strerror(err));
 122                 return SR_ERR;
 123         }
 124
 125         for (res = results; res; res = res->ai_next) {
 126                 if ((tcp->socket = socket(res->ai_family, res->ai_socktype,
 127                         res->ai_protocol)) < 0)
 128                         continue;
 129                 if (connect(tcp->socket, res->ai_addr, res->ai_addrlen) != 0) {
 130                         close(tcp->socket);
 131                         tcp->socket = -1;
 132                         continue;
 133                 }
 134                 break;
 135         }
 136
 137         freeaddrinfo(results);
 138
 139         if (tcp->socket < 0) {
 140                 sr_err("Failed to connect to %s:%s: %s", tcp->address, tcp->port,
 141                         g_strerror(errno));
 142                 return SR_ERR;
 143         }
 144
 145         return SR_OK;
 146 }
 147
 148 SR_PRIV int ipdbg_org_la_tcp_close(struct ipdbg_org_la_tcp *tcp)
 149 {
 150         int ret = SR_OK;
 151
 152         if (close(tcp->socket) < 0)
 153                 ret = SR_ERR;
 154
 155         tcp->socket = -1;
 156
 157         return ret;
 158 }
 159
 160 SR_PRIV int ipdbg_org_la_tcp_send(struct ipdbg_org_la_tcp *tcp,
 161         const uint8_t *buf, size_t len)
 162 {
 163         int out;
 164         out = send(tcp->socket, (char*)buf, len, 0);
 165
 166         if (out < 0) {
 167                 sr_err("Send error: %s", g_strerror(errno));
 168                 return SR_ERR;
 169         }
 170
 171         if (out < (int)len)
 172                 sr_dbg("Only sent %d/%d bytes of data.", out, (int)len);
 173
 174         return SR_OK;
 175 }
 176
 177 SR_PRIV int ipdbg_org_la_tcp_receive_blocking(struct ipdbg_org_la_tcp *tcp,
 178         uint8_t *buf, int bufsize)
 179 {
 180         int received = 0;
 181         int error_count = 0;
 182
 183         /* Timeout after 500ms of not receiving data */
 184         while ((received < bufsize) && (error_count < 500)) {
 185                 if (ipdbg_org_la_tcp_receive(tcp, buf) > 0) {
 186                         buf++;
 187                         received++;
 188                 } else {
 189                         error_count++;
 190                         g_usleep(1000);  /* Sleep for 1ms */
 191                 }
 192         }
 193
 194         return received;
 195 }
 196
 197 SR_PRIV int ipdbg_org_la_tcp_receive(struct ipdbg_org_la_tcp *tcp,
 198         uint8_t *buf)
 199 {
 200         int received = 0;
 201
 202         if (data_available(tcp)) {
 203                 while (received < 1) {
 204                         int len = recv(tcp->socket, buf, 1, 0);
 205
 206                         if (len < 0) {
 207                                 sr_err("Receive error: %s", g_strerror(errno));
 208                                 return SR_ERR;
 209                         } else
 210                                 received += len;
 211                 }
 212
 213                 return received;
 214         } else
 215                 return -1;
 216 }
 217
 218 SR_PRIV int ipdbg_org_la_convert_trigger(const struct sr_dev_inst *sdi)
 219 {
 220         struct ipdbg_org_la_dev_context *devc;
 221         struct sr_trigger *trigger;
 222         struct sr_trigger_stage *stage;
 223         struct sr_trigger_match *match;
 224         const GSList *l, *m;
 225
 226         devc = sdi->priv;
 227
 228         devc->num_stages = 0;
 229         devc->num_transfers = 0;
 230         devc->raw_sample_buf = NULL;
 231
 232         for (uint64_t i = 0; i < devc->DATA_WIDTH_BYTES; i++) {
 233                 devc->trigger_mask[i] = 0;
 234                 devc->trigger_value[i] = 0;
 235                 devc->trigger_mask_last[i] = 0;
 236                 devc->trigger_value_last[i] = 0;
 237                 devc->trigger_edge_mask[i] = 0;
 238         }
 239
 240         if (!(trigger = sr_session_trigger_get(sdi->session)))
 241                 return SR_OK;
 242
 243         for (l = trigger->stages; l; l = l->next) {
 244                 stage = l->data;
 245                 for (m = stage->matches; m; m = m->next) {
 246                         match = m->data;
 247                         int byte_idx = match->channel->index / 8;
 248                         uint8_t match_bit = 1 << (match->channel->index % 8);
 249
 250                         if (!match->channel->enabled)
 251                                 /* Ignore disabled channels with a trigger. */
 252                                 continue;
 253
 254                         if (match->match == SR_TRIGGER_ONE) {
 255                                 devc->trigger_value[byte_idx] |= match_bit;
 256                                 devc->trigger_mask[byte_idx] |= match_bit;
 257                                 devc->trigger_mask_last[byte_idx] &= ~match_bit;
 258                                 devc->trigger_edge_mask[byte_idx] &= ~match_bit;
 259                         } else if (match->match == SR_TRIGGER_ZERO) {
 260                                 devc->trigger_value[byte_idx] &= ~match_bit;
 261                                 devc->trigger_mask[byte_idx] |= match_bit;
 262                                 devc->trigger_mask_last[byte_idx] &= ~match_bit;
 263                                 devc->trigger_edge_mask[byte_idx] &= ~match_bit;
 264                         } else if (match->match == SR_TRIGGER_RISING) {
 265                                 devc->trigger_value[byte_idx] |= match_bit;
 266                                 devc->trigger_value_last[byte_idx] &=
 267                                     ~match_bit;
 268                                 devc->trigger_mask[byte_idx] |= match_bit;
 269                                 devc->trigger_mask_last[byte_idx] |= match_bit;
 270                                 devc->trigger_edge_mask[byte_idx] &= ~match_bit;
 271                         } else if (match->match == SR_TRIGGER_FALLING) {
 272                                 devc->trigger_value[byte_idx] &= ~match_bit;
 273                                 devc->trigger_value_last[byte_idx] |= match_bit;
 274                                 devc->trigger_mask[byte_idx] |= match_bit;
 275                                 devc->trigger_mask_last[byte_idx] |= match_bit;
 276                                 devc->trigger_edge_mask[byte_idx] &= ~match_bit;
 277                         } else if (match->match == SR_TRIGGER_EDGE) {
 278                                 devc->trigger_mask[byte_idx] &= ~match_bit;
 279                                 devc->trigger_mask_last[byte_idx] &= ~match_bit;
 280                                 devc->trigger_edge_mask[byte_idx] |= match_bit;
 281                         }
 282                 }
 283         }
 284
 285         return SR_OK;
 286 }
 287
 288 SR_PRIV int ipdbg_org_la_receive_data(int fd, int revents, void *cb_data)
 289 {
 290         const struct sr_dev_inst *sdi;
 291         struct ipdbg_org_la_dev_context *devc;
 292
 293         (void)fd;
 294         (void)revents;
 295
 296         sdi = (const struct sr_dev_inst *)cb_data;
 297         if (!sdi)
 298                 return FALSE;
 299
 300         if (!(devc = sdi->priv))
 301                 return FALSE;
 302
 303         struct ipdbg_org_la_tcp *tcp = sdi->conn;
 304         struct sr_datafeed_packet packet;
 305         struct sr_datafeed_logic logic;
 306
 307         if (!devc->raw_sample_buf) {
 308                 devc->raw_sample_buf =
 309                         g_try_malloc(devc->limit_samples * devc->DATA_WIDTH_BYTES);
 310                 if (!devc->raw_sample_buf) {
 311                         sr_warn("Sample buffer malloc failed.");
 312                         return FALSE;
 313                 }
 314         }
 315
 316         if (devc->num_transfers <
 317                 (devc->limit_samples_max * devc->DATA_WIDTH_BYTES)) {
 318                 uint8_t byte;
 319
 320                 if (ipdbg_org_la_tcp_receive(tcp, &byte) == 1) {
 321                         if (devc->num_transfers <
 322                                 (devc->limit_samples * devc->DATA_WIDTH_BYTES))
 323                                 devc->raw_sample_buf[devc->num_transfers] = byte;
 324
 325                         devc->num_transfers++;
 326                 }
 327         } else {
 328                 if (devc->delay_value > 0) {
 329                         /* There are pre-trigger samples, send those first. */
 330                         packet.type = SR_DF_LOGIC;
 331                         packet.payload = &logic;
 332                         logic.length = devc->delay_value * devc->DATA_WIDTH_BYTES;
 333                         logic.unitsize = devc->DATA_WIDTH_BYTES;
 334                         logic.data = devc->raw_sample_buf;
 335                         sr_session_send(cb_data, &packet);
 336                 }
 337
 338                 /* Send the trigger. */
 339                 packet.type = SR_DF_TRIGGER;
 340                 sr_session_send(cb_data, &packet);
 341
 342                 /* Send post-trigger samples. */
 343                 packet.type = SR_DF_LOGIC;
 344                 packet.payload = &logic;
 345                 logic.length = (devc->limit_samples - devc->delay_value) *
 346                         devc->DATA_WIDTH_BYTES;
 347                 logic.unitsize = devc->DATA_WIDTH_BYTES;
 348                 logic.data = devc->raw_sample_buf +
 349                         (devc->delay_value * devc->DATA_WIDTH_BYTES);
 350                 sr_session_send(cb_data, &packet);
 351
 352                 g_free(devc->raw_sample_buf);
 353                 devc->raw_sample_buf = NULL;
 354
 355                 ipdbg_org_la_abort_acquisition(sdi);
 356         }
 357
 358         return TRUE;
 359 }
 360
 361 SR_PRIV int ipdbg_org_la_send_delay(struct ipdbg_org_la_dev_context *devc,
 362         struct ipdbg_org_la_tcp *tcp)
 363 {
 364         devc->delay_value = (devc->limit_samples / 100.0) * devc->capture_ratio;
 365
 366         uint8_t buf;
 367         buf = CMD_CFG_LA;
 368         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 369         buf = CMD_LA_DELAY;
 370         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 371
 372         uint8_t delay_buf[4] = { devc->delay_value & 0x000000ff,
 373                 (devc->delay_value >> 8) & 0x000000ff,
 374                 (devc->delay_value >> 16) & 0x000000ff,
 375                 (devc->delay_value >> 24) & 0x000000ff
 376         };
 377
 378         for (uint64_t i = 0; i < devc->ADDR_WIDTH_BYTES; i++)
 379                 send_escaping(tcp, &(delay_buf[devc->ADDR_WIDTH_BYTES - 1 - i]), 1);
 380
 381         return SR_OK;
 382 }
 383
 384 SR_PRIV int ipdbg_org_la_send_trigger(struct ipdbg_org_la_dev_context *devc,
 385         struct ipdbg_org_la_tcp *tcp)
 386 {
 387         uint8_t buf;
 388
 389         /* Mask */
 390         buf = CMD_CFG_TRIGGER;
 391         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 392         buf = CMD_TRIG_MASKS;
 393         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 394         buf = CMD_TRIG_MASK;
 395         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 396
 397         for (size_t i = 0; i < devc->DATA_WIDTH_BYTES; i++)
 398                 send_escaping(tcp,
 399                         devc->trigger_mask + devc->DATA_WIDTH_BYTES - 1 - i, 1);
 400
 401         /* Value */
 402         buf = CMD_CFG_TRIGGER;
 403         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 404         buf = CMD_TRIG_MASKS;
 405         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 406         buf = CMD_TRIG_VALUE;
 407         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 408
 409         for (size_t i = 0; i < devc->DATA_WIDTH_BYTES; i++)
 410                 send_escaping(tcp,
 411                         devc->trigger_value + devc->DATA_WIDTH_BYTES - 1 - i, 1);
 412
 413         /* Mask_last */
 414         buf = CMD_CFG_TRIGGER;
 415         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 416         buf = CMD_TRIG_MASKS_LAST;
 417         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 418         buf = CMD_TRIG_MASK_LAST;
 419         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 420
 421         for (size_t i = 0; i < devc->DATA_WIDTH_BYTES; i++)
 422                 send_escaping(tcp,
 423                         devc->trigger_mask_last + devc->DATA_WIDTH_BYTES - 1 - i, 1);
 424
 425         /* Value_last */
 426         buf = CMD_CFG_TRIGGER;
 427         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 428         buf = CMD_TRIG_MASKS_LAST;
 429         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 430         buf = CMD_TRIG_VALUE_LAST;
 431         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 432
 433         for (size_t i = 0; i < devc->DATA_WIDTH_BYTES; i++)
 434                 send_escaping(tcp,
 435                         devc->trigger_value_last + devc->DATA_WIDTH_BYTES - 1 - i, 1);
 436
 437         /* Edge_mask */
 438         buf = CMD_CFG_TRIGGER;
 439         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 440         buf = CMD_TRIG_SELECT_EDGE_MASK;
 441         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 442         buf = CMD_TRIG_SET_EDGE_MASK;
 443         ipdbg_org_la_tcp_send(tcp, &buf, 1);
 444
 445         for (size_t i = 0; i < devc->DATA_WIDTH_BYTES; i++)
 446                 send_escaping(tcp,
 447                         devc->trigger_edge_mask + devc->DATA_WIDTH_BYTES - 1 - i, 1);
 448
 449         return SR_OK;
 450 }
 451
 452 SR_PRIV int send_escaping(struct ipdbg_org_la_tcp *tcp, uint8_t *dataToSend,
 453         uint32_t length)
 454 {
 455         uint8_t escape = CMD_ESCAPE;
 456
 457         while (length--) {
 458                 uint8_t payload = *dataToSend++;
 459
 460                 if (payload == (uint8_t) CMD_RESET)
 461                         if (ipdbg_org_la_tcp_send(tcp, &escape, 1) != SR_OK)
 462                                 sr_warn("Couldn't send escape");
 463
 464                 if (payload == (uint8_t) CMD_ESCAPE)
 465                         if (ipdbg_org_la_tcp_send(tcp, &escape, 1) != SR_OK)
 466                                 sr_warn("Couldn't send escape");
 467
 468                 if (ipdbg_org_la_tcp_send(tcp, &payload, 1) != SR_OK)
 469                         sr_warn("Couldn't send data");
 470         }
 471
 472         return SR_OK;
 473 }
 474
 475 SR_PRIV void ipdbg_org_la_get_addrwidth_and_datawidth(
 476         struct ipdbg_org_la_tcp *tcp, struct ipdbg_org_la_dev_context *devc)
 477 {
 478         uint8_t buf[8];
 479         uint8_t read_cmd = CMD_GET_BUS_WIDTHS;
 480
 481         if (ipdbg_org_la_tcp_send(tcp, &read_cmd, 1) != SR_OK)
 482                 sr_warn("Can't send read command");
 483
 484         if (ipdbg_org_la_tcp_receive_blocking(tcp, buf, 8) != 8)
 485                 sr_warn("Can't get address and data width from device");
 486
 487         devc->DATA_WIDTH = buf[0] & 0x000000FF;
 488         devc->DATA_WIDTH |= (buf[1] << 8) & 0x0000FF00;
 489         devc->DATA_WIDTH |= (buf[2] << 16) & 0x00FF0000;
 490         devc->DATA_WIDTH |= (buf[3] << 24) & 0xFF000000;
 491
 492         devc->ADDR_WIDTH = buf[4] & 0x000000FF;
 493         devc->ADDR_WIDTH |= (buf[5] << 8) & 0x0000FF00;
 494         devc->ADDR_WIDTH |= (buf[6] << 16) & 0x00FF0000;
 495         devc->ADDR_WIDTH |= (buf[7] << 24) & 0xFF000000;
 496
 497         uint8_t HOST_WORD_SIZE = 8;
 498
 499         devc->DATA_WIDTH_BYTES =
 500                 (devc->DATA_WIDTH + HOST_WORD_SIZE - 1) / HOST_WORD_SIZE;
 501         devc->ADDR_WIDTH_BYTES =
 502                 (devc->ADDR_WIDTH + HOST_WORD_SIZE - 1) / HOST_WORD_SIZE;
 503
 504         devc->limit_samples_max = (0x01 << devc->ADDR_WIDTH);
 505         devc->limit_samples = devc->limit_samples_max;
 506
 507         devc->trigger_mask = g_malloc0(devc->DATA_WIDTH_BYTES);
 508         devc->trigger_value = g_malloc0(devc->DATA_WIDTH_BYTES);
 509         devc->trigger_mask_last = g_malloc0(devc->DATA_WIDTH_BYTES);
 510         devc->trigger_value_last = g_malloc0(devc->DATA_WIDTH_BYTES);
 511         devc->trigger_edge_mask = g_malloc0(devc->DATA_WIDTH_BYTES);
 512 }
 513
 514 SR_PRIV struct ipdbg_org_la_dev_context *ipdbg_org_la_dev_new(void)
 515 {
 516         struct ipdbg_org_la_dev_context *devc;
 517
 518         devc = g_malloc0(sizeof(struct ipdbg_org_la_dev_context));
 519         devc->capture_ratio = 50;
 520
 521         return devc;
 522 }
 523
 524 SR_PRIV int ipdbg_org_la_send_reset(struct ipdbg_org_la_tcp *tcp)
 525 {
 526         uint8_t buf = CMD_RESET;
 527         if (ipdbg_org_la_tcp_send(tcp, &buf, 1) != SR_OK)
 528                 sr_warn("Couldn't send reset");
 529
 530         return SR_OK;
 531 }
 532
 533 SR_PRIV int ipdbg_org_la_request_id(struct ipdbg_org_la_tcp *tcp)
 534 {
 535         uint8_t buf = CMD_GET_LA_ID;
 536         if (ipdbg_org_la_tcp_send(tcp, &buf, 1) != SR_OK)
 537                 sr_warn("Couldn't send ID request");
 538
 539         char id[4];
 540         if (ipdbg_org_la_tcp_receive_blocking(tcp, (uint8_t*)id, 4) != 4) {
 541                 sr_err("Couldn't read device ID");
 542                 return SR_ERR;
 543         }
 544
 545         if (strncmp(id, "IDBG", 4)) {
 546                 sr_err("Invalid device ID: expected 'IDBG', got '%c%c%c%c'.",
 547                         id[0], id[1], id[2], id[3]);
 548                 return SR_ERR;
 549         }
 550
 551         return SR_OK;
 552 }
 553
 554 SR_PRIV void ipdbg_org_la_abort_acquisition(const struct sr_dev_inst *sdi)
 555 {
 556         struct ipdbg_org_la_tcp *tcp = sdi->conn;
 557
 558         sr_session_source_remove(sdi->session, tcp->socket);
 559
 560         std_session_send_df_end(sdi);
 561 }
 562
 563 SR_PRIV int ipdbg_org_la_send_start(struct ipdbg_org_la_tcp *tcp)
 564 {
 565         uint8_t buf = CMD_START;
 566
 567         if (ipdbg_org_la_tcp_send(tcp, &buf, 1) != SR_OK)
 568                 sr_warn("Couldn't send start");
 569
 570         return SR_OK;
 571 }