X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fcommon%2Fscpi.c;h=beb33423934224df8287378a2dad942ccf783162;hb=e22aa87808624c86ec52ea8d57d0a6f35c9e018e;hp=ff18b6e507fb75287850f70db2b0e3cf2221f24f;hpb=d5976d8be5ee72a89e82b4a3baeae6eba48a8d3a;p=libsigrok.git diff --git a/hardware/common/scpi.c b/hardware/common/scpi.c index ff18b6e5..beb33423 100644 --- a/hardware/common/scpi.c +++ b/hardware/common/scpi.c @@ -23,13 +23,7 @@ #include #include -/* Message logging helpers with subsystem-specific prefix string. */ -#define LOG_PREFIX "scpi: " -#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" #define SCPI_READ_RETRIES 100 #define SCPI_READ_RETRY_TIMEOUT 10000 @@ -71,116 +65,270 @@ static int parse_strict_bool(const char *str, gboolean *ret) return SR_ERR; } +SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev; +SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev; +SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev; +SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_dev; +SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev; + +static const struct sr_scpi_dev_inst *scpi_devs[] = { + &scpi_tcp_raw_dev, + &scpi_tcp_rigol_dev, + &scpi_usbtmc_dev, +#ifdef HAVE_RPC + &scpi_vxi_dev, +#endif +#ifdef HAVE_LIBSERIALPORT + &scpi_serial_dev, /* must be last as it matches any resource */ +#endif +}; + +SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(const char *resource, + const char *serialcomm) +{ + struct sr_scpi_dev_inst *scpi = NULL; + const struct sr_scpi_dev_inst *scpi_dev; + gchar **params; + unsigned i; + + for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { + scpi_dev = scpi_devs[i]; + if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) { + sr_dbg("Opening %s device %s.", scpi_dev->name, resource); + scpi = g_malloc(sizeof(*scpi)); + *scpi = *scpi_dev; + scpi->priv = g_malloc0(scpi->priv_size); + params = g_strsplit(resource, "/", 0); + if (scpi->dev_inst_new(scpi->priv, resource, + params, serialcomm) != SR_OK) { + sr_scpi_free(scpi); + scpi = NULL; + } + g_strfreev(params); + break; + } + } + + return scpi; +} + +/** + * Open SCPI device. + * + * @param scpi Previously initialized SCPI device structure. + * + * @return SR_OK on success, SR_ERR on failure. + */ +SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi) +{ + return scpi->open(scpi->priv); +} + +/** + * Add an event source for an SCPI device. + * + * @param scpi Previously initialized SCPI device structure. + * @param events Events to check for. + * @param timeout Max time to wait before the callback is called, ignored if 0. + * @param cb Callback function to add. Must not be NULL. + * @param cb_data Data for the callback function. Can be NULL. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or + * SR_ERR_MALLOC upon memory allocation errors. + */ +SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events, + int timeout, sr_receive_data_callback_t cb, void *cb_data) +{ + return scpi->source_add(scpi->priv, events, timeout, cb, cb_data); +} + +/** + * Remove event source for an SCPI device. + * + * @param scpi Previously initialized SCPI device structure. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or + * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon + * internal errors. + */ +SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi) +{ + return scpi->source_remove(scpi->priv); +} + /** * Send a SCPI command. * - * @param serial Previously initialized serial port structure. - * @param command The SCPI command to send to the device. + * @param scpi Previously initialized SCPI device structure. + * @param format Format string, to be followed by any necessary arguments. * * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_send(struct sr_serial_dev_inst *serial, - const char *command) +SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, + const char *format, ...) { - int len, out; - gchar *terminated_command; + va_list args; + int ret; - terminated_command = g_strconcat(command, "\n", NULL); - len = strlen(terminated_command); - out = serial_write(serial, terminated_command, len); - g_free(terminated_command); + va_start(args, format); + ret = sr_scpi_send_variadic(scpi, format, args); + va_end(args); - if (out != len) { - sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", out, - len, command); - return SR_ERR; - } + return ret; +} + +/** + * Send a SCPI command with a variadic argument list. + * + * @param scpi Previously initialized SCPI device structure. + * @param format Format string. + * @param args Argument list. + * + * @return SR_OK on success, SR_ERR on failure. + */ +SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, + const char *format, va_list args) +{ + va_list args_copy; + char *buf; + int len, ret; - sr_spew("Successfully sent SCPI command: '%s'.", command); + /* Get length of buffer required. */ + va_copy(args_copy, args); + len = vsnprintf(NULL, 0, format, args_copy); + va_end(args_copy); - return SR_OK; + /* Allocate buffer and write out command. */ + buf = g_malloc(len + 1); + vsprintf(buf, format, args); + + /* Send command. */ + ret = scpi->send(scpi->priv, buf); + + /* Free command buffer. */ + g_free(buf); + + return ret; +} + +/** + * Begin receiving an SCPI reply. + * + * @param scpi Previously initialised SCPI device structure. + * + * @return SR_OK on success, SR_ERR on failure. + */ +SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi) +{ + return scpi->read_begin(scpi->priv); +} + +/** + * Read part of a response from SCPI device. + * + * @param scpi Previously initialised SCPI device structure. + * @param buf Buffer to store result. + * @param maxlen Maximum number of bytes to read. + * + * @return Number of bytes read, or SR_ERR upon failure. + */ +SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, + char *buf, int maxlen) +{ + return scpi->read_data(scpi->priv, buf, maxlen); +} + +/** + * Check whether a complete SCPI response has been received. + * + * @param scpi Previously initialised SCPI device structure. + * + * @return 1 if complete, 0 otherwise. + */ +SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi) +{ + return scpi->read_complete(scpi->priv); +} + +/** + * Close SCPI device. + * + * @param scpi Previously initialized SCPI device structure. + * + * @return SR_OK on success, SR_ERR on failure. + */ +SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi) +{ + return scpi->close(scpi->priv); +} + +/** + * Free SCPI device. + * + * @param scpi Previously initialized SCPI device structure. + * + * @return SR_OK on success, SR_ERR on failure. + */ +SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi) +{ + scpi->free(scpi->priv); + g_free(scpi->priv); + g_free(scpi); } /** * Send a SCPI command, receive the reply and store the reply in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the SCPI response. * - * @return SR_OK upon fetching a full SCPI response, SR_ERR upon fetching an - * incomplete or no response. The allocated response must be freed by - * the caller in the case of a full response as well in the case of - * an incomplete. + * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_string(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, const char *command, char **scpi_response) { - int len, ret; char buf[256]; - unsigned int i; + int len; GString *response; if (command) - if (sr_scpi_send(serial, command) != SR_OK) + if (sr_scpi_send(scpi, command) != SR_OK) return SR_ERR; - 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 (sr_scpi_read_begin(scpi) != SR_OK) + return SR_ERR; - if (response->len > 0 && - response->str[response->len-1] == '\n') { - sr_spew("Fetched full SCPI response."); - break; - } + response = g_string_new(""); - g_usleep(SCPI_READ_RETRY_TIMEOUT); - } + *scpi_response = NULL; - 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; + while (!sr_scpi_read_complete(scpi)) { + len = sr_scpi_read_data(scpi, buf, sizeof(buf)); + if (len < 0) { + g_string_free(response, TRUE); + return SR_ERR; + } + g_string_append_len(response, buf, len); } - /* Minor optimization: steal the string instead of copying. */ *scpi_response = response->str; - - /* A SCPI response can be quite large, print at most 50 characters. */ - sr_dbg("SCPI response for command %s received (length %d): '%.50s'", - command, response->len, response->str); - g_string_free(response, FALSE); - return ret; + return SR_OK; } /** * Send a SCPI command, read the reply, parse it as a bool value and store the * result in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the parsed result. * * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_bool(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, const char *command, gboolean *scpi_response) { int ret; @@ -188,7 +336,7 @@ SR_PRIV int sr_scpi_get_bool(struct sr_serial_dev_inst *serial, response = NULL; - if (sr_scpi_get_string(serial, command, &response) != SR_OK) + if (sr_scpi_get_string(scpi, command, &response) != SR_OK) if (!response) return SR_ERR; @@ -206,13 +354,13 @@ SR_PRIV int sr_scpi_get_bool(struct sr_serial_dev_inst *serial, * Send a SCPI command, read the reply, parse it as an integer and store the * result in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the parsed result. * * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_int(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, const char *command, int *scpi_response) { int ret; @@ -220,7 +368,7 @@ SR_PRIV int sr_scpi_get_int(struct sr_serial_dev_inst *serial, response = NULL; - if (sr_scpi_get_string(serial, command, &response) != SR_OK) + if (sr_scpi_get_string(scpi, command, &response) != SR_OK) if (!response) return SR_ERR; @@ -238,13 +386,13 @@ SR_PRIV int sr_scpi_get_int(struct sr_serial_dev_inst *serial, * Send a SCPI command, read the reply, parse it as a float and store the * result in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the parsed result. * * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_float(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, const char *command, float *scpi_response) { int ret; @@ -252,7 +400,7 @@ SR_PRIV int sr_scpi_get_float(struct sr_serial_dev_inst *serial, response = NULL; - if (sr_scpi_get_string(serial, command, &response) != SR_OK) + if (sr_scpi_get_string(scpi, command, &response) != SR_OK) if (!response) return SR_ERR; @@ -270,13 +418,13 @@ SR_PRIV int sr_scpi_get_float(struct sr_serial_dev_inst *serial, * Send a SCPI command, read the reply, parse it as a double and store the * result in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the parsed result. * * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_double(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, const char *command, double *scpi_response) { int ret; @@ -284,7 +432,7 @@ SR_PRIV int sr_scpi_get_double(struct sr_serial_dev_inst *serial, response = NULL; - if (sr_scpi_get_string(serial, command, &response) != SR_OK) + if (sr_scpi_get_string(scpi, command, &response) != SR_OK) if (!response) return SR_ERR; @@ -302,17 +450,17 @@ SR_PRIV int sr_scpi_get_double(struct sr_serial_dev_inst *serial, * Send a SCPI *OPC? command, read the reply and return the result of the * command. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * * @return SR_OK on success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_opc(struct sr_serial_dev_inst *serial) +SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi) { unsigned int i; gboolean opc; for (i = 0; i < SCPI_READ_RETRIES; ++i) { - sr_scpi_get_bool(serial, SCPI_CMD_OPC, &opc); + sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc); if (opc) return SR_OK; g_usleep(SCPI_READ_RETRY_TIMEOUT); @@ -325,7 +473,7 @@ SR_PRIV int sr_scpi_get_opc(struct sr_serial_dev_inst *serial) * Send a SCPI command, read the reply, parse it as comma separated list of * floats and store the as an result in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the parsed result. * @@ -334,7 +482,7 @@ SR_PRIV int sr_scpi_get_opc(struct sr_serial_dev_inst *serial) * the caller in the case of an SR_OK as well as in the case of * parsing error. */ -SR_PRIV int sr_scpi_get_floatv(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, const char *command, GArray **scpi_response) { int ret; @@ -347,7 +495,7 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_serial_dev_inst *serial, response = NULL; tokens = NULL; - if (sr_scpi_get_string(serial, command, &response) != SR_OK) + if (sr_scpi_get_string(scpi, command, &response) != SR_OK) if (!response) return SR_ERR; @@ -383,7 +531,7 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_serial_dev_inst *serial, * Send a SCPI command, read the reply, parse it as comma separated list of * unsigned 8 bit integers and store the as an result in scpi_response. * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param command The SCPI command to send to the device (can be NULL). * @param scpi_response Pointer where to store the parsed result. * @@ -392,7 +540,7 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_serial_dev_inst *serial, * the caller in the case of an SR_OK as well as in the case of * parsing error. */ -SR_PRIV int sr_scpi_get_uint8v(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, const char *command, GArray **scpi_response) { int tmp, ret; @@ -404,7 +552,7 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_serial_dev_inst *serial, response = NULL; tokens = NULL; - if (sr_scpi_get_string(serial, command, &response) != SR_OK) + if (sr_scpi_get_string(scpi, command, &response) != SR_OK) if (!response) return SR_ERR; @@ -442,26 +590,33 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_serial_dev_inst *serial, * * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free(). * - * @param serial Previously initialized serial port structure. + * @param scpi Previously initialised SCPI device structure. * @param scpi_response Pointer where to store the hw_info structure. * * @return SR_OK upon success, SR_ERR on failure. */ -SR_PRIV int sr_scpi_get_hw_id(struct sr_serial_dev_inst *serial, +SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, struct sr_scpi_hw_info **scpi_response) { int num_tokens; char *response; + char *newline; gchar **tokens; struct sr_scpi_hw_info *hw_info; response = NULL; tokens = NULL; - if (sr_scpi_get_string(serial, SCPI_CMD_IDN, &response) != SR_OK) + if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK) if (!response) return SR_ERR; + sr_info("Got IDN string: '%s'", response); + + /* Remove trailing newline if present. */ + if ((newline = g_strrstr(response, "\n"))) + newline[0] = '\0'; + /* * The response to a '*IDN?' is specified by the SCPI spec. It contains * a comma-separated list containing the manufacturer name, instrument