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