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