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 SR_PRIV struct sr_dev_driver korad_kaxxxxp_driver_info;
67 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
69 return std_init(sr_ctx, di, LOG_PREFIX);
72 static GSList *scan(struct sr_dev_driver *di, GSList *options)
74 struct drv_context *drvc;
75 struct dev_context *devc;
77 struct sr_dev_inst *sdi;
78 struct sr_config *src;
79 const char *conn, *serialcomm;
80 struct sr_serial_dev_inst *serial;
89 drvc->instances = NULL;
91 for (l = options; l; l = l->next) {
95 conn = g_variant_get_string(src->data, NULL);
97 case SR_CONF_SERIALCOMM:
98 serialcomm = g_variant_get_string(src->data, NULL);
101 sr_err("Unknown option %d, skipping.", src->key);
109 serialcomm = "9600/8n1";
111 serial = sr_serial_dev_inst_new(conn, serialcomm);
112 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
115 serial_flush(serial);
117 /* Get the device model. */
119 for (i = 0; models[i].id; i++) {
120 if (strlen(models[i].id) > len)
121 len = strlen(models[i].id);
123 memset(&reply, 0, sizeof(reply));
124 sr_dbg("Want max %d bytes.", len);
125 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
128 /* i is used here for debug purposes only. */
129 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
131 sr_dbg("Received: %d, %s", i, reply);
133 for (i = 0; models[i].id; i++) {
134 if (!strcmp(models[i].id, reply))
138 sr_err("Unknown model ID '%s' detected, aborting.", reply);
141 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
142 models[model_id].name, model_id, models[model_id].id);
144 /* Init device instance, etc. */
145 sdi = g_malloc0(sizeof(struct sr_dev_inst));
146 sdi->status = SR_ST_INACTIVE;
147 sdi->vendor = g_strdup(models[model_id].vendor);
148 sdi->model = g_strdup(models[model_id].name);
149 sdi->inst_type = SR_INST_SERIAL;
153 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
155 devc = g_malloc0(sizeof(struct dev_context));
156 devc->model = &models[model_id];
158 devc->req_sent_at = 0;
161 /* Get current status of device. */
162 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
164 drvc->instances = g_slist_append(drvc->instances, sdi);
165 devices = g_slist_append(devices, sdi);
167 serial_close(serial);
169 sr_serial_dev_inst_free(serial);
174 sr_dev_inst_free(sdi);
176 sr_dbg("Scan failed.");
181 static GSList *dev_list(const struct sr_dev_driver *di)
183 return ((struct drv_context *)(di->context))->instances;
186 static int dev_clear(const struct sr_dev_driver *di)
188 return std_dev_clear(di, NULL);
191 static int cleanup(const struct sr_dev_driver *di)
197 static int config_get(uint32_t key, GVariant **data,
198 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
200 struct dev_context *devc;
210 case SR_CONF_LIMIT_SAMPLES:
211 *data = g_variant_new_uint64(devc->limit_samples);
213 case SR_CONF_LIMIT_MSEC:
214 *data = g_variant_new_uint64(devc->limit_msec);
216 case SR_CONF_VOLTAGE:
217 *data = g_variant_new_double(devc->voltage);
219 case SR_CONF_VOLTAGE_TARGET:
220 *data = g_variant_new_double(devc->voltage_max);
222 case SR_CONF_CURRENT:
223 *data = g_variant_new_double(devc->current);
225 case SR_CONF_CURRENT_LIMIT:
226 *data = g_variant_new_double(devc->current_max);
228 case SR_CONF_ENABLED:
229 *data = g_variant_new_boolean(devc->output_enabled);
231 case SR_CONF_REGULATION:
232 /* Dual channel not supported. */
233 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
235 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
236 *data = g_variant_new_boolean(devc->ocp_enabled);
238 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
239 *data = g_variant_new_boolean(devc->ovp_enabled);
248 static int config_set(uint32_t key, GVariant *data,
249 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
251 struct dev_context *devc;
257 if (sdi->status != SR_ST_ACTIVE)
258 return SR_ERR_DEV_CLOSED;
263 case SR_CONF_LIMIT_MSEC:
264 if (g_variant_get_uint64(data) == 0)
266 devc->limit_msec = g_variant_get_uint64(data);
268 case SR_CONF_LIMIT_SAMPLES:
269 if (g_variant_get_uint64(data) == 0)
271 devc->limit_samples = g_variant_get_uint64(data);
273 case SR_CONF_VOLTAGE_TARGET:
274 dval = g_variant_get_double(data);
275 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
277 devc->voltage_max = dval;
278 devc->target = KAXXXXP_VOLTAGE_MAX;
279 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
282 case SR_CONF_CURRENT_LIMIT:
283 dval = g_variant_get_double(data);
284 if (dval < devc->model->current[0] || dval > devc->model->current[1])
286 devc->current_max = dval;
287 devc->target = KAXXXXP_CURRENT_MAX;
288 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
291 case SR_CONF_ENABLED:
292 bval = g_variant_get_boolean(data);
293 /* Set always so it is possible turn off with sigrok-cli. */
294 devc->output_enabled = bval;
295 devc->target = KAXXXXP_OUTPUT;
296 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
299 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
300 bval = g_variant_get_boolean(data);
301 devc->ocp_enabled = bval;
302 devc->target = KAXXXXP_OCP;
303 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
306 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
307 bval = g_variant_get_boolean(data);
308 devc->ovp_enabled = bval;
309 devc->target = KAXXXXP_OVP;
310 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
320 static int config_list(uint32_t key, GVariant **data,
321 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
324 struct dev_context *devc;
332 /* Always available (with or without sdi). */
333 if (key == SR_CONF_SCAN_OPTIONS) {
334 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
335 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
339 /* Return drvopts without sdi (and devopts with sdi, see below). */
340 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
341 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
342 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
346 /* Every other key needs an sdi. */
353 case SR_CONF_DEVICE_OPTIONS:
354 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
355 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
357 case SR_CONF_VOLTAGE_TARGET:
358 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
359 /* Min, max, step. */
360 for (idx = 0; idx < 3; idx++) {
361 dval = devc->model->voltage[idx];
362 gvar = g_variant_new_double(dval);
363 g_variant_builder_add_value(&gvb, gvar);
365 *data = g_variant_builder_end(&gvb);
367 case SR_CONF_CURRENT_LIMIT:
368 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
369 /* Min, max, step. */
370 for (idx = 0; idx < 3; idx++) {
371 dval = devc->model->current[idx];
372 gvar = g_variant_new_double(dval);
373 g_variant_builder_add_value(&gvb, gvar);
375 *data = g_variant_builder_end(&gvb);
384 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
386 struct dev_context *devc;
387 struct sr_serial_dev_inst *serial;
389 if (sdi->status != SR_ST_ACTIVE)
390 return SR_ERR_DEV_CLOSED;
393 devc->cb_data = cb_data;
395 /* Send header packet to the session bus. */
396 std_session_send_df_header(cb_data, LOG_PREFIX);
398 devc->starttime = g_get_monotonic_time();
399 devc->num_samples = 0;
400 devc->reply_pending = FALSE;
401 devc->req_sent_at = 0;
403 serial_source_add(sdi->session, serial, G_IO_IN,
404 KAXXXXP_POLL_INTERVAL_MS,
405 korad_kaxxxxp_receive_data, (void *)sdi);
410 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
412 if (sdi->status != SR_ST_ACTIVE)
413 return SR_ERR_DEV_CLOSED;
415 return std_serial_dev_acquisition_stop(sdi, cb_data,
416 std_serial_dev_close, sdi->conn, LOG_PREFIX);
419 SR_PRIV struct sr_dev_driver korad_kaxxxxp_driver_info = {
420 .name = "korad-kaxxxxp",
421 .longname = "Korad KAxxxxP",
426 .dev_list = dev_list,
427 .dev_clear = dev_clear,
428 .config_get = config_get,
429 .config_set = config_set,
430 .config_list = config_list,
431 .dev_open = std_serial_dev_open,
432 .dev_close = std_serial_dev_close,
433 .dev_acquisition_start = dev_acquisition_start,
434 .dev_acquisition_stop = dev_acquisition_stop,