#include <glib.h>
#include <string.h>
-/* Message logging helpers with subsystem-specific prefix string. */
-#define LOG_PREFIX "scpi_serial: "
-#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
-#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
-#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
-#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
-#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define LOG_PREFIX "scpi_serial"
#define SCPI_READ_RETRIES 100
#define SCPI_READ_RETRY_TIMEOUT 10000
-SR_PRIV int scpi_serial_open(void *priv)
+struct scpi_serial {
+ struct sr_serial_dev_inst *serial;
+ char last_character;
+};
+
+static int scpi_serial_dev_inst_new(void *priv, const char *resource,
+ char **params, const char *serialcomm)
{
- struct sr_serial_dev_inst *serial = priv;
+ struct scpi_serial *sscpi = priv;
+
+ (void)params;
+
+ if (!(sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm)))
+ return SR_ERR;
- return serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK);
+ return SR_OK;
}
-SR_PRIV int scpi_serial_source_add(void *priv, int events, int timeout,
+static int scpi_serial_open(void *priv)
+{
+ struct scpi_serial *sscpi = priv;
+ struct sr_serial_dev_inst *serial = sscpi->serial;
+
+ if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+ return SR_ERR;
+
+ if (serial_flush(serial) != SR_OK)
+ return SR_ERR;
+
+ return SR_OK;
+}
+
+static int scpi_serial_source_add(void *priv, int events, int timeout,
sr_receive_data_callback_t cb, void *cb_data)
{
- struct sr_serial_dev_inst *serial = priv;
+ struct scpi_serial *sscpi = priv;
+ struct sr_serial_dev_inst *serial = sscpi->serial;
- return sr_source_add(serial->fd, events, timeout, cb, cb_data);
+ return serial_source_add(serial, events, timeout, cb, cb_data);
}
-SR_PRIV int scpi_serial_source_remove(void *priv)
+static int scpi_serial_source_remove(void *priv)
{
- struct sr_serial_dev_inst *serial = priv;
+ struct scpi_serial *sscpi = priv;
+ struct sr_serial_dev_inst *serial = sscpi->serial;
- return sr_source_remove(serial->fd);
+ return serial_source_remove(serial);
}
-SR_PRIV int scpi_serial_send(void *priv, const char *command)
+static int scpi_serial_send(void *priv, const char *command)
{
- int len, out;
+ int len, result, written;
gchar *terminated_command;
- struct sr_serial_dev_inst *serial = priv;
+ struct scpi_serial *sscpi = priv;
+ struct sr_serial_dev_inst *serial = sscpi->serial;
terminated_command = g_strconcat(command, "\n", NULL);
len = strlen(terminated_command);
- out = serial_write(serial, terminated_command, len);
- g_free(terminated_command);
-
- if (out != len) {
- sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", out,
- len, command);
- return SR_ERR;
+ written = 0;
+ while (written < len) {
+ result = serial_write(serial, terminated_command + written, len - written);
+ if (result < 0) {
+ sr_err("Error while sending SCPI command: '%s'.", command);
+ g_free(terminated_command);
+ return SR_ERR;
+ }
+ written += result;
}
+ g_free(terminated_command);
+
sr_spew("Successfully sent SCPI command: '%s'.", command);
return SR_OK;
}
-SR_PRIV int scpi_serial_receive(void *priv, char **scpi_response)
+static int scpi_serial_read_begin(void *priv)
{
- int len, ret;
- char buf[256];
- unsigned int i;
- GString *response;
- struct sr_serial_dev_inst *serial = priv;
-
- response = g_string_sized_new(1024);
-
- for (i = 0; i <= SCPI_READ_RETRIES; i++) {
- while ((len = serial_read(serial, buf, sizeof(buf))) > 0)
- response = g_string_append_len(response, buf, len);
-
- if (response->len > 0 &&
- response->str[response->len-1] == '\n') {
- sr_spew("Fetched full SCPI response.");
- break;
- }
+ struct scpi_serial *sscpi = priv;
- g_usleep(SCPI_READ_RETRY_TIMEOUT);
- }
+ sscpi->last_character = '\0';
- if (response->len == 0) {
- sr_dbg("No SCPI response received.");
- g_string_free(response, TRUE);
- *scpi_response = NULL;
- return SR_ERR;
- } else if (response->str[response->len - 1] == '\n') {
- /*
- * The SCPI response contains a LF ('\n') at the end and we
- * don't need this so replace it with a '\0' and decrement
- * the length.
- */
- response->str[--response->len] = '\0';
- ret = SR_OK;
- } else {
- sr_warn("Incomplete SCPI response received!");
- ret = SR_ERR;
- }
+ return SR_OK;
+}
- /* Minor optimization: steal the string instead of copying. */
- *scpi_response = response->str;
+static int scpi_serial_read_data(void *priv, char *buf, int maxlen)
+{
+ struct scpi_serial *sscpi = priv;
+ int ret;
- /* A SCPI response can be quite large, print at most 50 characters. */
- sr_dbg("SCPI response received (length %d): '%.50s'",
- response->len, response->str);
+ ret = serial_read(sscpi->serial, buf, maxlen);
- g_string_free(response, FALSE);
+ if (ret < 0)
+ return ret;
+
+ if (ret > 0) {
+ sscpi->last_character = buf[ret - 1];
+ if (sscpi->last_character == '\n')
+ ret--;
+ }
return ret;
}
-SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
- const char *serialcomm)
+static int scpi_serial_read_complete(void *priv)
{
- struct sr_scpi_dev_inst *scpi;
- struct sr_serial_dev_inst *serial;
+ struct scpi_serial *sscpi = priv;
- scpi = g_try_malloc(sizeof(struct sr_scpi_dev_inst));
+ return (sscpi->last_character == '\n');
+}
- if (!(serial = sr_serial_dev_inst_new(port, serialcomm)))
- {
- g_free(scpi);
- return NULL;
- }
+static int scpi_serial_close(void *priv)
+{
+ struct scpi_serial *sscpi = priv;
- scpi->open = scpi_serial_open;
- scpi->source_add = scpi_serial_source_add;
- scpi->source_remove = scpi_serial_source_remove;
- scpi->send = scpi_serial_send;
- scpi->receive = scpi_serial_receive;
- scpi->close = serial_close;
- scpi->free = sr_serial_dev_inst_free;
- scpi->priv = serial;
+ return serial_close(sscpi->serial);
+}
+
+static void scpi_serial_free(void *priv)
+{
+ struct scpi_serial *sscpi = priv;
- return scpi;
+ sr_serial_dev_inst_free(sscpi->serial);
}
+
+SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
+ .name = "serial",
+ .prefix = "",
+ .priv_size = sizeof(struct scpi_serial),
+ .dev_inst_new = scpi_serial_dev_inst_new,
+ .open = scpi_serial_open,
+ .source_add = scpi_serial_source_add,
+ .source_remove = scpi_serial_source_remove,
+ .send = scpi_serial_send,
+ .read_begin = scpi_serial_read_begin,
+ .read_data = scpi_serial_read_data,
+ .read_complete = scpi_serial_read_complete,
+ .close = scpi_serial_close,
+ .free = scpi_serial_free,
+};
projects / libsigrok.git / blobdiff