hardware/common/scpi_serial.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
   5  * Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include "libsigrok.h"
  22 #include "libsigrok-internal.h"
  23
  24 #include <glib.h>
  25 #include <string.h>
  26
  27 /* Message logging helpers with subsystem-specific prefix string. */
  28 #define LOG_PREFIX "scpi_serial: "
  29 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  30 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  31 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  32 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  33 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  34
  35 #define SCPI_READ_RETRIES 100
  36 #define SCPI_READ_RETRY_TIMEOUT 10000
  37
  38 SR_PRIV int scpi_serial_open(void *priv)
  39 {
  40         struct sr_serial_dev_inst *serial = priv;
  41
  42         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
  43                 return SR_ERR;
  44
  45         if (serial_flush(serial) != SR_OK)
  46                 return SR_ERR;
  47
  48         return SR_OK;
  49 }
  50
  51 SR_PRIV int scpi_serial_source_add(void *priv, int events, int timeout,
  52                         sr_receive_data_callback_t cb, void *cb_data)
  53 {
  54         struct sr_serial_dev_inst *serial = priv;
  55
  56         return sr_source_add(serial->fd, events, timeout, cb, cb_data);
  57 }
  58
  59 SR_PRIV int scpi_serial_source_remove(void *priv)
  60 {
  61         struct sr_serial_dev_inst *serial = priv;
  62
  63         return sr_source_remove(serial->fd);
  64 }
  65
  66 SR_PRIV int scpi_serial_send(void *priv, const char *command)
  67 {
  68         int len, out;
  69         gchar *terminated_command;
  70         struct sr_serial_dev_inst *serial = priv;
  71
  72         terminated_command = g_strconcat(command, "\n", NULL);
  73         len = strlen(terminated_command);
  74         out = serial_write(serial, terminated_command, len);
  75         g_free(terminated_command);
  76
  77         if (out != len) {
  78                 sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", out,
  79                        len, command);
  80                 return SR_ERR;
  81         }
  82
  83         sr_spew("Successfully sent SCPI command: '%s'.", command);
  84
  85         return SR_OK;
  86 }
  87
  88 SR_PRIV int scpi_serial_receive(void *priv, char **scpi_response)
  89 {
  90         int len, ret;
  91         char buf[256];
  92         unsigned int i;
  93         GString *response;
  94         struct sr_serial_dev_inst *serial = priv;
  95
  96         response = g_string_sized_new(1024);
  97
  98         for (i = 0; i <= SCPI_READ_RETRIES; i++) {
  99                 while ((len = serial_read(serial, buf, sizeof(buf))) > 0)
 100                         response = g_string_append_len(response, buf, len);
 101
 102                 if (response->len > 0 &&
 103                     response->str[response->len-1] == '\n') {
 104                         sr_spew("Fetched full SCPI response.");
 105                         break;
 106                 }
 107
 108                 g_usleep(SCPI_READ_RETRY_TIMEOUT);
 109         }
 110
 111         if (response->len == 0) {
 112                 sr_dbg("No SCPI response received.");
 113                 g_string_free(response, TRUE);
 114                 *scpi_response = NULL;
 115                 return SR_ERR;
 116         } else if (response->str[response->len - 1] == '\n') {
 117                 /*
 118                  * The SCPI response contains a LF ('\n') at the end and we
 119                  * don't need this so replace it with a '\0' and decrement
 120                  * the length.
 121                  */
 122                 response->str[--response->len] = '\0';
 123                 ret = SR_OK;
 124         } else {
 125                 sr_warn("Incomplete SCPI response received!");
 126                 ret = SR_ERR;
 127         }
 128
 129         /* Minor optimization: steal the string instead of copying. */
 130         *scpi_response = response->str;
 131
 132         /* A SCPI response can be quite large, print at most 50 characters. */
 133         sr_dbg("SCPI response received (length %d): '%.50s'",
 134                response->len, response->str);
 135
 136         g_string_free(response, FALSE);
 137
 138         return ret;
 139 }
 140
 141 /* Some stubs to keep the compiler from whining. */
 142 static int scpi_serial_read(void *priv, char *buf, int maxlen)
 143 {
 144         return serial_read(priv, buf, maxlen);
 145 }
 146 static int scpi_serial_close(void *priv)
 147 {
 148         return serial_close(priv);
 149 }
 150 static void scpi_serial_free(void *priv)
 151 {
 152         return sr_serial_dev_inst_free(priv);
 153 }
 154
 155 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
 156                 const char *serialcomm)
 157 {
 158         struct sr_scpi_dev_inst *scpi;
 159         struct sr_serial_dev_inst *serial;
 160
 161         scpi = g_try_malloc(sizeof(struct sr_scpi_dev_inst));
 162
 163         if (!(serial = sr_serial_dev_inst_new(port, serialcomm)))
 164         {
 165                 g_free(scpi);
 166                 return NULL;
 167         }
 168
 169         scpi->open = scpi_serial_open;
 170         scpi->source_add = scpi_serial_source_add;
 171         scpi->source_remove = scpi_serial_source_remove;
 172         scpi->send = scpi_serial_send;
 173         scpi->receive = scpi_serial_receive;
 174         scpi->read = scpi_serial_read;
 175         scpi->close = scpi_serial_close;
 176         scpi->free = scpi_serial_free;
 177         scpi->priv = serial;
 178
 179         return scpi;
 180 }