*/
#include <config.h>
+
+#include <ctype.h>
+
#include "protocol.h"
static const uint32_t scanopts[] = {
static const struct korad_kaxxxxp_model models[] = {
/* Vendor, model name, ID reply, channels, voltage, current, quirks. */
- {"Korad", "KA3005P", "KORADKA3005PV2.0", 1, volts_30, amps_5, 0},
+ {"Korad", "KA3005P", "KORADKA3005PV2.0",
+ 1, volts_30, amps_5, KORAD_QUIRK_ID_TRAILING},
/* Some KA3005P have extra bytes after the ID text. */
{"Korad", "KA3005P", "KORADKA3005PV2.0\x01", 1, volts_30, amps_5, 0},
{"Korad", "KA3005P", "KORADKA3005PV2.0\xBC", 1, volts_30, amps_5, 0},
{"RND", "KA3005P", "RND 320-KA3005P V5.5", 1, volts_30, amps_5, 0},
{"RND", "KD3005P", "RND 320-KD3005P V4.2", 1, volts_30, amps_5, 0},
{"RND", "KA3005P", "RND 320-KA3005P V2.0", 1, volts_30, amps_5, 0},
- {"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0", 1, volts_30, amps_5, 0},
+ {"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
+ 1, volts_30, amps_5, KORAD_QUIRK_ID_NO_VENDOR},
{"Tenma", "72-2535", "TENMA 72-2535 V2.1", 1, volts_30, amps_3, 0},
{"Tenma", "72-2540", "TENMA72-2540V2.0", 1, volts_30, amps_5, 0},
{"Tenma", "72-2540", "TENMA 72-2540 V2.1", 1, volts_30, amps_5, 0},
ALL_ZERO
};
+/*
+ * Bump this when adding new models[] above. Make sure the text buffer
+ * for the ID response can hold the longest sequence that we expect in
+ * the field which consists of: vendor + model [ + version ][ + serno ].
+ * Don't be too generous here, the maximum receive buffer size affects
+ * the timeout within which the first response character is expected.
+ */
+static const size_t id_text_buffer_size = 48;
+
+/*
+ * Check whether the device's "*IDN?" response matches a supported model.
+ * The caller already stripped off the optional serial number.
+ */
+static gboolean model_matches(const struct korad_kaxxxxp_model *model,
+ const char *id_text)
+{
+ gboolean matches;
+ gboolean skip_vendor, accept_trail;
+ const char *want;
+
+ if (!model)
+ return FALSE;
+
+ /*
+ * When the models[] entry contains a specific response text,
+ * then expect to see this very text in literal form. This
+ * lets the driver map weird and untypical responses to a
+ * specific set of display texts for vendor and model names.
+ */
+ if (model->id && model->id[0]) {
+ matches = g_strcmp0(model->id, id_text) == 0;
+ if (matches)
+ sr_dbg("Matches expected ID text: '%s'.", model->id);
+ return matches;
+ }
+
+ /*
+ * A more generic approach which covers most devices: Check
+ * for the very vendor and model names which also are shown
+ * to users (the display texts). Weakened to match responses
+ * more widely: Case insensitive checks, optional whitespace
+ * in responses, optional version details. Optional trailing
+ * garbage. Optional omission of the vendor name. Shall match
+ * all the devices which were individually listed in earlier
+ * implementations of the driver, and shall also match firmware
+ * versions that were not listed before.
+ */
+ skip_vendor = model->quirks & KORAD_QUIRK_ID_NO_VENDOR;
+ accept_trail = model->quirks & KORAD_QUIRK_ID_TRAILING;
+ if (!skip_vendor) {
+ want = model->vendor;
+ matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
+ if (!matches)
+ return FALSE;
+ id_text += strlen(want);
+ while (isspace((int)*id_text))
+ id_text++;
+ }
+ want = model->name;
+ matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
+ if (!matches)
+ return FALSE;
+ id_text += strlen(want);
+ while (isspace((int)*id_text))
+ id_text++;
+ if (*id_text == 'V') {
+ /* TODO Isolate and (also) return version details? */
+ id_text++;
+ while (*id_text == '.' || isdigit((int)*id_text))
+ id_text++;
+ while (isspace((int)*id_text))
+ id_text++;
+ }
+ if (accept_trail) {
+ /*
+ * TODO Determine how many non-printables to accept here
+ * and how strict to check for "known" garbage variants.
+ */
+ switch (*id_text) {
+ case '\x01':
+ case '\xbc':
+ id_text++;
+ break;
+ case '\x00':
+ /* EMPTY */
+ break;
+ default:
+ return FALSE;
+ }
+ }
+ if (*id_text)
+ return FALSE;
+ sr_dbg("Matches generic '[vendor] model [vers] [trail]' pattern.");
+ return TRUE;
+}
+
static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
static const char *serno_prefix = " SN:";
if (serial_open(serial, SERIAL_RDWR) != SR_OK)
return NULL;
- /*
- * Prepare a receive buffer for the identification response that
- * is large enough to hold the longest known model name, and an
- * optional serial number. Communicate the identification request.
- */
- len = 0;
- for (i = 0; models[i].id; i++) {
- if (len < strlen(models[i].id))
- len = strlen(models[i].id);
- }
- len += strlen(serno_prefix) + 12;
+ /* Communicate the identification request. */
+ len = id_text_buffer_size;
if (len > sizeof(reply) - 1)
len = sizeof(reply) - 1;
sr_dbg("Want max %zu bytes.", len);
}
model = NULL;
- for (i = 0; models[i].id; i++) {
- if (g_strcmp0(models[i].id, reply) != 0)
+ for (i = 0; models[i].name; i++) {
+ if (!model_matches(&models[i], reply))
continue;
model = &models[i];
break;
}
if (!model && force_detect) {
- sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
+ sr_warn("Found unknown model ID '%s', trying '%s' spec.",
reply, force_detect);
- for (i = 0; models[i].id; i++) {
- if (strcmp(models[i].id, force_detect) != 0)
+ for (i = 0; models[i].name; i++) {
+ if (!model_matches(&models[i], force_detect))
continue;
sr_info("Found replacement, using it instead.");
model = &models[i];
}
}
if (!model) {
- sr_err("Unknown model ID '%s' detected, aborting.", reply);
+ sr_err("Found unknown model ID '%s', aborting.", reply);
return NULL;
}
- sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
- model - &models[0], model->id);
+ sr_dbg("Found: %s %s (idx %zu).", model->vendor, model->name,
+ model - &models[0]);
sdi = g_malloc0(sizeof(struct sr_dev_inst));
sdi->status = SR_ST_INACTIVE;
projects / libsigrok.git / blobdiff