2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 static const uint32_t drvopts[] = {
28 static const uint32_t scanopts[] = {
33 static const uint32_t devopts[] = {
36 /* Acquisition modes. */
38 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
40 /* Device configuration */
41 SR_CONF_VOLTAGE | SR_CONF_GET,
42 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_CURRENT | SR_CONF_GET,
44 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
45 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_REGULATION | SR_CONF_GET,
47 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
48 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
51 static const struct korad_kaxxxxp_model models[] = {
52 /* Device enum, vendor, model, ID reply, channels, voltage, current */
53 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
54 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
55 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
56 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
57 {KORAD_KA3005P, "Korad", "KA3005P",
58 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
59 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
60 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
61 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5, 0.001}},
65 static GSList *scan(struct sr_dev_driver *di, GSList *options)
67 struct dev_context *devc;
69 struct sr_dev_inst *sdi;
70 struct sr_config *src;
71 const char *conn, *serialcomm;
72 struct sr_serial_dev_inst *serial;
80 for (l = options; l; l = l->next) {
84 conn = g_variant_get_string(src->data, NULL);
86 case SR_CONF_SERIALCOMM:
87 serialcomm = g_variant_get_string(src->data, NULL);
90 sr_err("Unknown option %d, skipping.", src->key);
98 serialcomm = "9600/8n1";
100 serial = sr_serial_dev_inst_new(conn, serialcomm);
101 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
104 serial_flush(serial);
106 /* Get the device model. */
108 for (i = 0; models[i].id; i++) {
109 if (strlen(models[i].id) > len)
110 len = strlen(models[i].id);
112 memset(&reply, 0, sizeof(reply));
113 sr_dbg("Want max %d bytes.", len);
114 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
117 /* i is used here for debug purposes only. */
118 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
120 sr_dbg("Received: %d, %s", i, reply);
122 for (i = 0; models[i].id; i++) {
123 if (!strcmp(models[i].id, reply))
127 sr_err("Unknown model ID '%s' detected, aborting.", reply);
130 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
131 models[model_id].name, model_id, models[model_id].id);
133 /* Init device instance, etc. */
134 sdi = g_malloc0(sizeof(struct sr_dev_inst));
135 sdi->status = SR_ST_INACTIVE;
136 sdi->vendor = g_strdup(models[model_id].vendor);
137 sdi->model = g_strdup(models[model_id].name);
138 sdi->inst_type = SR_INST_SERIAL;
141 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
143 devc = g_malloc0(sizeof(struct dev_context));
144 sr_sw_limits_init(&devc->limits);
145 devc->model = &models[model_id];
147 devc->req_sent_at = 0;
150 /* Get current status of device. */
151 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
154 serial_close(serial);
156 return std_scan_complete(di, g_slist_append(NULL, sdi));
159 sr_dev_inst_free(sdi);
161 sr_dbg("Scan failed.");
166 static int config_get(uint32_t key, GVariant **data,
167 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
169 struct dev_context *devc;
179 return sr_sw_limits_config_get(&devc->limits, key, data);
180 case SR_CONF_VOLTAGE:
181 *data = g_variant_new_double(devc->voltage);
183 case SR_CONF_VOLTAGE_TARGET:
184 *data = g_variant_new_double(devc->voltage_max);
186 case SR_CONF_CURRENT:
187 *data = g_variant_new_double(devc->current);
189 case SR_CONF_CURRENT_LIMIT:
190 *data = g_variant_new_double(devc->current_max);
192 case SR_CONF_ENABLED:
193 *data = g_variant_new_boolean(devc->output_enabled);
195 case SR_CONF_REGULATION:
196 /* Dual channel not supported. */
197 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
199 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
200 *data = g_variant_new_boolean(devc->ocp_enabled);
202 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
203 *data = g_variant_new_boolean(devc->ovp_enabled);
212 static int config_set(uint32_t key, GVariant *data,
213 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
215 struct dev_context *devc;
221 if (sdi->status != SR_ST_ACTIVE)
222 return SR_ERR_DEV_CLOSED;
227 case SR_CONF_LIMIT_MSEC:
228 case SR_CONF_LIMIT_SAMPLES:
229 return sr_sw_limits_config_set(&devc->limits, key, data);
230 case SR_CONF_VOLTAGE_TARGET:
231 dval = g_variant_get_double(data);
232 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
234 devc->voltage_max = dval;
235 devc->target = KAXXXXP_VOLTAGE_MAX;
236 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
239 case SR_CONF_CURRENT_LIMIT:
240 dval = g_variant_get_double(data);
241 if (dval < devc->model->current[0] || dval > devc->model->current[1])
243 devc->current_max = dval;
244 devc->target = KAXXXXP_CURRENT_MAX;
245 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
248 case SR_CONF_ENABLED:
249 bval = g_variant_get_boolean(data);
250 /* Set always so it is possible turn off with sigrok-cli. */
251 devc->output_enabled = bval;
252 devc->target = KAXXXXP_OUTPUT;
253 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
256 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
257 bval = g_variant_get_boolean(data);
258 devc->ocp_enabled = bval;
259 devc->target = KAXXXXP_OCP;
260 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
263 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
264 bval = g_variant_get_boolean(data);
265 devc->ovp_enabled = bval;
266 devc->target = KAXXXXP_OVP;
267 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
277 static int config_list(uint32_t key, GVariant **data,
278 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
280 struct dev_context *devc;
288 /* Always available (with or without sdi). */
289 if (key == SR_CONF_SCAN_OPTIONS) {
290 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
291 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
295 /* Return drvopts without sdi (and devopts with sdi, see below). */
296 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
297 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
298 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
302 /* Every other key needs an sdi. */
309 case SR_CONF_DEVICE_OPTIONS:
310 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
311 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
313 case SR_CONF_VOLTAGE_TARGET:
314 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
315 /* Min, max, step. */
316 for (idx = 0; idx < 3; idx++) {
317 dval = devc->model->voltage[idx];
318 gvar = g_variant_new_double(dval);
319 g_variant_builder_add_value(&gvb, gvar);
321 *data = g_variant_builder_end(&gvb);
323 case SR_CONF_CURRENT_LIMIT:
324 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
325 /* Min, max, step. */
326 for (idx = 0; idx < 3; idx++) {
327 dval = devc->model->current[idx];
328 gvar = g_variant_new_double(dval);
329 g_variant_builder_add_value(&gvb, gvar);
331 *data = g_variant_builder_end(&gvb);
340 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
342 struct dev_context *devc;
343 struct sr_serial_dev_inst *serial;
345 if (sdi->status != SR_ST_ACTIVE)
346 return SR_ERR_DEV_CLOSED;
350 sr_sw_limits_acquisition_start(&devc->limits);
351 std_session_send_df_header(sdi, LOG_PREFIX);
353 devc->reply_pending = FALSE;
354 devc->req_sent_at = 0;
356 serial_source_add(sdi->session, serial, G_IO_IN,
357 KAXXXXP_POLL_INTERVAL_MS,
358 korad_kaxxxxp_receive_data, (void *)sdi);
363 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
365 if (sdi->status != SR_ST_ACTIVE)
366 return SR_ERR_DEV_CLOSED;
368 return std_serial_dev_acquisition_stop(sdi,
369 std_serial_dev_close, sdi->conn, LOG_PREFIX);
372 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
373 .name = "korad-kaxxxxp",
374 .longname = "Korad KAxxxxP",
377 .cleanup = std_cleanup,
379 .dev_list = std_dev_list,
380 .config_get = config_get,
381 .config_set = config_set,
382 .config_list = config_list,
383 .dev_open = std_serial_dev_open,
384 .dev_close = std_serial_dev_close,
385 .dev_acquisition_start = dev_acquisition_start,
386 .dev_acquisition_stop = dev_acquisition_stop,
389 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);