hardware/common/scpi_tcp.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li>
   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 #define _WIN32_WINNT 0x0501
  21
  22 #include "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24
  25 #include <glib.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28 #ifdef _WIN32
  29 #include <winsock2.h>
  30 #include <ws2tcpip.h>
  31 #else
  32 #include <sys/socket.h>
  33 #include <netinet/in.h>
  34 #include <arpa/inet.h>
  35 #include <netdb.h>
  36 #endif
  37 #include <errno.h>
  38
  39 /* Message logging helpers with subsystem-specific prefix string. */
  40 #define LOG_PREFIX "scpi_tcp: "
  41 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  42 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  43 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  44 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  45 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  46
  47 struct scpi_tcp {
  48         char *address;
  49         char *port;
  50         int socket;
  51 };
  52
  53 SR_PRIV int scpi_tcp_open(void *priv)
  54 {
  55         struct scpi_tcp *tcp = priv;
  56         struct addrinfo hints;
  57         struct addrinfo *results, *res;
  58         int err;
  59
  60         memset(&hints, 0, sizeof(hints));
  61         hints.ai_family = AF_UNSPEC;
  62         hints.ai_socktype = SOCK_STREAM;
  63         hints.ai_protocol = IPPROTO_TCP;
  64
  65         err = getaddrinfo(tcp->address, tcp->port, &hints, &results);
  66
  67         if (err) {
  68                 sr_err("Address lookup failed: %s:%d: %s", tcp->address, tcp->port,
  69                         gai_strerror(err));
  70                 return SR_ERR;
  71         }
  72
  73         for (res = results; res; res = res->ai_next) {
  74                 if ((tcp->socket = socket(res->ai_family, res->ai_socktype,
  75                                                 res->ai_protocol)) < 0)
  76                         continue;
  77                 if (connect(tcp->socket, res->ai_addr, res->ai_addrlen) != 0) {
  78                         close(tcp->socket);
  79                         tcp->socket = -1;
  80                         continue;
  81                 }
  82                 break;
  83         }
  84
  85         freeaddrinfo(results);
  86
  87         if (tcp->socket < 0) {
  88                 sr_err("Failed to connect to %s:%s: %s", tcp->address, tcp->port,
  89                                 strerror(errno));
  90                 return SR_ERR;
  91         }
  92
  93         return SR_OK;
  94 }
  95
  96 SR_PRIV int scpi_tcp_source_add(void *priv, int events, int timeout,
  97                         sr_receive_data_callback_t cb, void *cb_data)
  98 {
  99         struct scpi_tcp *tcp = priv;
 100
 101         return sr_source_add(tcp->socket, events, timeout, cb, cb_data);
 102 }
 103
 104 SR_PRIV int scpi_tcp_source_remove(void *priv)
 105 {
 106         struct scpi_tcp *tcp = priv;
 107
 108         return sr_source_remove(tcp->socket);
 109 }
 110
 111 SR_PRIV int scpi_tcp_send(void *priv, const char *command)
 112 {
 113         struct scpi_tcp *tcp = priv;
 114         int len, out;
 115         char *terminated_command;
 116
 117         terminated_command = g_strdup_printf("%s\r\n", command);
 118         len = strlen(terminated_command);
 119         out = send(tcp->socket, terminated_command, len, 0);
 120         g_free(terminated_command);
 121
 122         if (out < 0) {
 123                 sr_err("Send error: %s", strerror(errno));
 124                 return SR_ERR;
 125         }
 126
 127         if (out < len) {
 128                 sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", out,
 129                        len, command);
 130         }
 131
 132         sr_spew("Successfully sent SCPI command: '%s'.", command);
 133
 134         return SR_OK;
 135 }
 136
 137 SR_PRIV int scpi_tcp_receive(void *priv, char **scpi_response)
 138 {
 139         struct scpi_tcp *tcp = priv;
 140         GString *response;
 141         char buf[256];
 142         int len;
 143
 144         response = g_string_sized_new(1024);
 145
 146         len = recv(tcp->socket, buf, sizeof(buf), 0);
 147
 148         if (len < 0) {
 149                 sr_err("Receive error: %s", strerror(errno));
 150                 g_string_free(response, TRUE);
 151                 return SR_ERR;
 152         }
 153
 154         response = g_string_append_len(response, buf + 4, len - 4);
 155
 156         *scpi_response = response->str;
 157
 158         sr_dbg("SCPI response received (length %d): '%.50s'",
 159                response->len, response->str);
 160
 161         g_string_free(response, FALSE);
 162
 163         return SR_OK;
 164 }
 165
 166 SR_PRIV int scpi_tcp_read(void *priv, char *buf, int maxlen)
 167 {
 168         struct scpi_tcp *tcp = priv;
 169         int len;
 170
 171         len = recv(tcp->socket, buf, maxlen, 0);
 172
 173         if (len < 0) {
 174                 sr_err("Receive error: %s", strerror(errno));
 175                 return SR_ERR;
 176         }
 177
 178         return len;
 179 }
 180
 181 SR_PRIV int scpi_tcp_close(void *priv)
 182 {
 183         struct scpi_tcp *tcp = priv;
 184
 185         if (close(tcp->socket) < 0)
 186                 return SR_ERR;
 187
 188         return SR_OK;
 189 }
 190
 191 SR_PRIV void scpi_tcp_free(void *priv)
 192 {
 193         struct scpi_tcp *tcp = priv;
 194
 195         g_free(tcp->address);
 196         g_free(tcp->port);
 197         g_free(tcp);
 198 }
 199
 200 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
 201                 const char *port)
 202 {
 203         struct sr_scpi_dev_inst *scpi;
 204         struct scpi_tcp *tcp;
 205
 206         scpi = g_malloc(sizeof(struct sr_scpi_dev_inst));
 207         tcp = g_malloc0(sizeof(struct scpi_tcp));
 208
 209         tcp->address = g_strdup(address);
 210         tcp->port = g_strdup(port);
 211         tcp->socket = -1;
 212
 213         scpi->open = scpi_tcp_open;
 214         scpi->source_add = scpi_tcp_source_add;
 215         scpi->source_remove = scpi_tcp_source_remove;
 216         scpi->send = scpi_tcp_send;
 217         scpi->receive = scpi_tcp_receive;
 218         scpi->read = scpi_tcp_read;
 219         scpi->close = scpi_tcp_close;
 220         scpi->free = scpi_tcp_free;
 221         scpi->priv = tcp;
 222
 223         return scpi;
 224 }