]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/korad-kaxxxxp/api.c
korad-kaxxxxp: prepare more versatile ID response text checks
[libsigrok.git] / src / hardware / korad-kaxxxxp / api.c
index 18ad93ecb989af2a29bef2a07fc6649c8833e056..366aaabe49f728eb24873424b0f00428ee9843e0 100644 (file)
@@ -53,58 +53,58 @@ 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)
+{
+       /* TODO Implement more versatile ID response text checks. */
+       return g_strcmp0(model->id, id_text) == 0;
+}
+
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        static const char *serno_prefix = " SN:";
@@ -156,17 +156,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);
@@ -192,7 +183,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 
        model = NULL;
        for (i = 0; models[i].id; i++) {
-               if (g_strcmp0(models[i].id, reply) != 0)
+               if (!model_matches(&models[i], reply))
                        continue;
                model = &models[i];
                break;
@@ -201,7 +192,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
                        reply, force_detect);
                for (i = 0; models[i].id; i++) {
-                       if (strcmp(models[i].id, force_detect) != 0)
+                       if (!model_matches(&models[i], force_detect))
                                continue;
                        sr_info("Found replacement, using it instead.");
                        model = &models[i];