src/scpi/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 <config.h>
  22 #include <glib.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <libsigrok/libsigrok.h>
  26 #include "libsigrok-internal.h"
  27 #include "scpi.h"
  28
  29 #define LOG_PREFIX "scpi_serial"
  30
  31 #ifdef HAVE_SERIAL_COMM
  32
  33 struct scpi_serial {
  34         struct sr_serial_dev_inst *serial;
  35         gboolean got_newline;
  36 };
  37
  38 /* Default serial port options for some known USB devices */
  39 static const struct {
  40         uint16_t vendor_id;
  41         uint16_t product_id;
  42         const char *serialcomm;
  43 } scpi_serial_usb_ids[] = {
  44         { 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
  45         { 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
  46         { 0x0aad, 0x0117, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
  47         { 0x0aad, 0x0118, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
  48         { 0x0aad, 0x0119, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
  49 };
  50
  51 static GSList *scpi_serial_scan(struct drv_context *drvc)
  52 {
  53         GSList *l, *r, *resources = NULL;
  54         gchar *res;
  55         unsigned i;
  56
  57         (void)drvc;
  58
  59         for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
  60                 if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
  61                                         scpi_serial_usb_ids[i].product_id)))
  62                         continue;
  63                 for (r = l; r; r = r->next) {
  64                         if (scpi_serial_usb_ids[i].serialcomm)
  65                                 res = g_strdup_printf("%s:%s", (char *) r->data,
  66                                                       scpi_serial_usb_ids[i].serialcomm);
  67                         else
  68                                 res = g_strdup(r->data);
  69                         resources = g_slist_append(resources, res);
  70                 }
  71                 g_slist_free_full(l, g_free);
  72         }
  73
  74         return resources;
  75 }
  76
  77 static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc,
  78                 const char *resource, char **params, const char *serialcomm)
  79 {
  80         GSList *l, *r;
  81         unsigned i;
  82         struct scpi_serial *sscpi = priv;
  83
  84         (void)drvc;
  85         (void)params;
  86
  87         /* If no serial port option is specified on the command-line using the
  88          * "serialcomm" driver option, but the device is connected through USB
  89          * and it requires a known default serial port option, then used it in
  90          * order to avoid data corruption or even worse problems.
  91          */
  92         if (!serialcomm) {
  93                 for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
  94                         if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
  95                                                 scpi_serial_usb_ids[i].product_id)))
  96                                 continue;
  97                         for (r = l; r; r = r->next)
  98                                 if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm)
  99                                         serialcomm = scpi_serial_usb_ids[i].serialcomm;
 100                         g_slist_free_full(l, g_free);
 101                 }
 102         }
 103
 104         sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);
 105
 106         return SR_OK;
 107 }
 108
 109 static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
 110 {
 111         struct scpi_serial *sscpi = scpi->priv;
 112         struct sr_serial_dev_inst *serial = sscpi->serial;
 113
 114         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 115                 return SR_ERR;
 116
 117         sscpi->got_newline = FALSE;
 118
 119         return SR_OK;
 120 }
 121
 122 static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi,
 123                 char **connection_id)
 124 {
 125         struct scpi_serial *sscpi = scpi->priv;
 126         struct sr_serial_dev_inst *serial = sscpi->serial;
 127
 128         *connection_id = g_strdup(serial->port);
 129
 130         return SR_OK;
 131 }
 132
 133 static int scpi_serial_source_add(struct sr_session *session, void *priv,
 134                 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
 135 {
 136         struct scpi_serial *sscpi = priv;
 137         struct sr_serial_dev_inst *serial = sscpi->serial;
 138
 139         return serial_source_add(session, serial, events, timeout, cb, cb_data);
 140 }
 141
 142 static int scpi_serial_source_remove(struct sr_session *session, void *priv)
 143 {
 144         struct scpi_serial *sscpi = priv;
 145         struct sr_serial_dev_inst *serial = sscpi->serial;
 146
 147         return serial_source_remove(session, serial);
 148 }
 149
 150 static int scpi_serial_send(void *priv, const char *command)
 151 {
 152         int result;
 153         struct scpi_serial *sscpi = priv;
 154         struct sr_serial_dev_inst *serial = sscpi->serial;
 155
 156         result = serial_write_blocking(serial, command, strlen(command), 0);
 157         if (result < 0) {
 158                 sr_err("Error while sending SCPI command '%s': %d.",
 159                         command, result);
 160                 return SR_ERR;
 161         }
 162
 163         sr_spew("Successfully sent SCPI command: '%s'.", command);
 164
 165         return SR_OK;
 166 }
 167
 168 static int scpi_serial_read_begin(void *priv)
 169 {
 170         struct scpi_serial *sscpi = priv;
 171         sscpi->got_newline = FALSE;
 172
 173         return SR_OK;
 174 }
 175
 176 static int scpi_serial_read_data(void *priv, char *buf, int maxlen)
 177 {
 178         struct scpi_serial *sscpi = priv;
 179         int ret;
 180
 181         /* Try to read new data into the buffer. */
 182         ret = serial_read_nonblocking(sscpi->serial, buf, maxlen);
 183
 184         if (ret < 0)
 185                 return ret;
 186
 187         if (ret > 0) {
 188                 if (buf[ret - 1] == '\n') {
 189                         sscpi->got_newline = TRUE;
 190                         sr_spew("Received NL terminator");
 191                 } else if (ret > 1 &&
 192                            buf[ret - 2] == '\n' && buf[ret - 1] == '\r') {
 193                         sscpi->got_newline = TRUE;
 194                         sr_spew("Received NL+CR terminator");
 195                         ret--;
 196                 } else {
 197                         sscpi->got_newline = FALSE;
 198                 }
 199         }
 200
 201         return ret;
 202 }
 203
 204 static int scpi_serial_read_complete(void *priv)
 205 {
 206         struct scpi_serial *sscpi = priv;
 207
 208         return sscpi->got_newline;
 209 }
 210
 211 static int scpi_serial_close(struct sr_scpi_dev_inst *scpi)
 212 {
 213         struct scpi_serial *sscpi = scpi->priv;
 214
 215         return serial_close(sscpi->serial);
 216 }
 217
 218 static void scpi_serial_free(void *priv)
 219 {
 220         struct scpi_serial *sscpi = priv;
 221
 222         sr_serial_dev_inst_free(sscpi->serial);
 223 }
 224
 225 SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
 226         .name          = "serial",
 227         .prefix        = "",
 228         .transport     = SCPI_TRANSPORT_SERIAL,
 229         .priv_size     = sizeof(struct scpi_serial),
 230         .scan          = scpi_serial_scan,
 231         .dev_inst_new  = scpi_serial_dev_inst_new,
 232         .open          = scpi_serial_open,
 233         .connection_id = scpi_serial_connection_id,
 234         .source_add    = scpi_serial_source_add,
 235         .source_remove = scpi_serial_source_remove,
 236         .send          = scpi_serial_send,
 237         .read_begin    = scpi_serial_read_begin,
 238         .read_data     = scpi_serial_read_data,
 239         .read_complete = scpi_serial_read_complete,
 240         .close         = scpi_serial_close,
 241         .free          = scpi_serial_free,
 242 };
 243
 244 #endif