X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkorad-kaxxxxp%2Fapi.c;h=c380aec1cc83f892f97cd0dfe500b0f1dd7da24a;hb=349803b613aa8f0768e5ee11a494def18eab59f2;hp=e571dcfd3cdcc25bac4b6aa251c99ff70e90efc1;hpb=c7275098f6db9ba723cc191810e36a6b8a575b12;p=libsigrok.git diff --git a/src/hardware/korad-kaxxxxp/api.c b/src/hardware/korad-kaxxxxp/api.c index e571dcfd..c380aec1 100644 --- a/src/hardware/korad-kaxxxxp/api.c +++ b/src/hardware/korad-kaxxxxp/api.c @@ -19,6 +19,9 @@ */ #include + +#include + #include "protocol.h" static const uint32_t scanopts[] = { @@ -53,58 +56,134 @@ static const double amps_3[] = { 0, 3.1, 0.001, }; static const double amps_5[] = { 0, 5.1, 0.001, }; static const struct korad_kaxxxxp_model models[] = { - /* Device enum, vendor, model, ID reply, channels, voltage, current, quirks. */ - {KORAD_KA3005P, "Korad", "KA3005P", "KORADKA3005PV2.0", - 1, volts_30, amps_5, 0}, - /* Sometimes the KA3005P has an extra 0x01 after the ID. */ - {KORAD_KA3005P_0X01, "Korad", "KA3005P", "KORADKA3005PV2.0\x01", - 1, volts_30, amps_5, 0}, - /* Sometimes the KA3005P has an extra 0xBC after the ID. */ - {KORAD_KA3005P_0XBC, "Korad", "KA3005P", "KORADKA3005PV2.0\xBC", - 1, volts_30, amps_5, 0}, - {KORAD_KA3005P_V42, "Korad", "KA3005P", "KORAD KA3005P V4.2", - 1, volts_30, amps_5, 0}, - {KORAD_KA3005P_V55, "Korad", "KA3005P", "KORAD KA3005P V5.5", - 1, volts_30, amps_5, 0}, - {KORAD_KD3005P_V20, "Korad", "KD3005P", "KORAD KD3005P V2.0", - 1, volts_30, amps_5, 0}, - {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.0", - 1, volts_30, amps_5, 0}, - {KORAD_KD3005P_V21_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.1", - 1, volts_30, amps_5, 0}, - {KORAD_KD3005P_V41, "Korad", "KD3005P", "KORAD KD3005P V4.1", - 1, volts_30, amps_5, 0}, - {KORAD_KD3005P_V68, "Korad", "KD3005P", "KORAD KD3005P V6.8", - 1, volts_30, amps_5, 0}, - {KORAD_KD6005P, "Korad", "KD6005P", "KORAD KD6005P V2.2", - 1, volts_60, amps_5, 0}, - {RND_320_KA3005P, "RND", "KA3005P", "RND 320-KA3005P V5.5", - 1, volts_30, amps_5, 0}, - {RND_320_KD3005P, "RND", "KD3005P", "RND 320-KD3005P V4.2", - 1, volts_30, amps_5, 0}, - {RND_320K30PV, "RND", "KA3005P", "RND 320-KA3005P V2.0", - 1, volts_30, amps_5, 0}, - {STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31", "S-LS-31 V2.0", - 1, volts_30, amps_5, 0}, - {TENMA_72_2535_V21, "Tenma", "72-2535", "TENMA 72-2535 V2.1", - 1, volts_30, amps_3, 0}, - {TENMA_72_2540_V20, "Tenma", "72-2540", "TENMA72-2540V2.0", - 1, volts_30, amps_5, 0}, - {TENMA_72_2540_V21, "Tenma", "72-2540", "TENMA 72-2540 V2.1", - 1, volts_30, amps_5, 0}, - {TENMA_72_2540_V52, "Tenma", "72-2540", "TENMA 72-2540 V5.2", - 1, volts_30, amps_5, 0}, - {TENMA_72_2550_V2, "Tenma", "72-2550", "TENMA72-2550V2.0", - 1, volts_60, amps_3, 0}, - {TENMA_72_2710_V66, "Tenma", "72-2710", "TENMA 72-2710 V6.6", - 1, volts_30, amps_5, 0}, - {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0", + /* Vendor, model name, ID reply, channels, voltage, current, quirks. */ + {"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}, + {"Korad", "KA3005P", "KORAD KA3005P V4.2", 1, volts_30, amps_5, 0}, + {"Korad", "KA3005P", "KORAD KA3005P V5.5", 1, volts_30, amps_5, 0}, + {"Korad", "KD3005P", "KORAD KD3005P V2.0", 1, volts_30, amps_5, 0}, + {"Korad", "KD3005P", "KORADKD3005PV2.0", 1, volts_30, amps_5, 0}, + {"Korad", "KD3005P", "KORADKD3005PV2.1", 1, volts_30, amps_5, 0}, + {"Korad", "KD3005P", "KORAD KD3005P V4.1", 1, volts_30, amps_5, 0}, + {"Korad", "KD3005P", "KORAD KD3005P V6.8", 1, volts_30, amps_5, 0}, + {"Korad", "KD6005P", "KORAD KD6005P V2.2", 1, volts_60, 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, 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}, + {"Tenma", "72-2540", "TENMA 72-2540 V5.2", 1, volts_30, amps_5, 0}, + {"Tenma", "72-2550", "TENMA72-2550V2.0", 1, volts_60, amps_3, 0}, + {"Tenma", "72-2710", "TENMA 72-2710 V6.6", 1, volts_30, amps_5, 0}, + {"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0", 1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN}, - {VELLEMAN_PS3005D, "Velleman", "PS3005D", "VELLEMANPS3005DV2.0", + {"Velleman", "PS3005D", "VELLEMANPS3005DV2.0", 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:"; @@ -116,8 +195,10 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) const char *conn, *serialcomm; const char *force_detect; struct sr_serial_dev_inst *serial; + size_t i; char reply[50]; - int ret, i, model_id; + int ret; + const struct korad_kaxxxxp_model *model; size_t len; char *serno; @@ -154,17 +235,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) 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); @@ -188,35 +260,35 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) serno += strlen(serno_prefix); } - model_id = -1; - for (i = 0; models[i].id; i++) { - if (g_strcmp0(models[i].id, reply) != 0) + model = NULL; + for (i = 0; models[i].name; i++) { + if (!model_matches(&models[i], reply)) continue; - model_id = i; + model = &models[i]; break; } - if (model_id < 0 && force_detect) { - sr_warn("Found model ID '%s' is unknown, trying '%s' spec.", + if (!model && force_detect) { + 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_id = i; + model = &models[i]; break; } } - if (model_id < 0) { - sr_err("Unknown model ID '%s' detected, aborting.", reply); + if (!model) { + sr_err("Found unknown model ID '%s', aborting.", reply); return NULL; } - sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor, - models[model_id].name, model_id, models[model_id].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; - sdi->vendor = g_strdup(models[model_id].vendor); - sdi->model = g_strdup(models[model_id].name); + sdi->vendor = g_strdup(model->vendor); + sdi->model = g_strdup(model->name); if (serno) sdi->serial_num = g_strdup(serno); sdi->inst_type = SR_INST_SERIAL; @@ -229,7 +301,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) devc = g_malloc0(sizeof(struct dev_context)); sr_sw_limits_init(&devc->limits); g_mutex_init(&devc->rw_mutex); - devc->model = &models[model_id]; + devc->model = model; devc->req_sent_at = 0; devc->cc_mode_1_changed = FALSE; devc->cc_mode_2_changed = FALSE;