src/hardware/ipdbg-la/protocol.c

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