]> sigrok.org Git - libsigrok.git/blame - src/hardware/manson-hcs-3xxx/api.c
Introduce standard cleanup helper
[libsigrok.git] / src / hardware / manson-hcs-3xxx / api.c
CommitLineData
8f4e922f
UH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Uwe Hermann <uwe@hermann-uwe.de>
25abc8dd 5 * Copyright (C) 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
8f4e922f
UH
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
9740d9bf 22/** @file
c442ffda 23 * <em>Manson HCS-3xxx series</em> power supply driver
9740d9bf
MH
24 * @internal
25 */
26
6ec6c43b 27#include <config.h>
8f4e922f
UH
28#include "protocol.h"
29
f3ba3c11
AJ
30static const uint32_t drvopts[] = {
31 /* Device class */
32 SR_CONF_POWER_SUPPLY,
33};
34
a0e0bb41 35static const uint32_t scanopts[] = {
b5e92647
UH
36 SR_CONF_CONN,
37 SR_CONF_SERIALCOMM,
38};
39
584560f1 40static const uint32_t devopts[] = {
811d6255 41 /* Device class */
b5e92647 42 SR_CONF_POWER_SUPPLY,
f3f19d11 43 /* Acquisition modes. */
b5e92647 44 SR_CONF_CONTINUOUS,
5827f61b
BV
45 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
811d6255 47 /* Device configuration */
7a0b98b5
AJ
48 SR_CONF_VOLTAGE | SR_CONF_GET,
49 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
50 SR_CONF_CURRENT | SR_CONF_GET,
51 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
52 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
b5e92647
UH
53};
54
55/* Note: All models have one power supply output only. */
329733d9 56static const struct hcs_model models[] = {
25abc8dd
MH
57 { MANSON_HCS_3100, "HCS-3100", "3100", { 1, 18, 0.1 }, { 0, 10, 0.10 } },
58 { MANSON_HCS_3102, "HCS-3102", "3102", { 1, 36, 0.1 }, { 0, 5, 0.01 } },
59 { MANSON_HCS_3104, "HCS-3104", "3104", { 1, 60, 0.1 }, { 0, 2.5, 0.01 } },
60 { MANSON_HCS_3150, "HCS-3150", "3150", { 1, 18, 0.1 }, { 0, 15, 0.10 } },
61 { MANSON_HCS_3200, "HCS-3200", "3200", { 1, 18, 0.1 }, { 0, 20, 0.10 } },
62 { MANSON_HCS_3202, "HCS-3202", "3202", { 1, 36, 0.1 }, { 0, 10, 0.10 } },
63 { MANSON_HCS_3204, "HCS-3204", "3204", { 1, 60, 0.1 }, { 0, 5, 0.01 } },
64 { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30, 0.10 } },
65 { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15, 0.10 } },
66 { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0, 8, 0.10 } },
67 { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40, 0.10 } },
68 { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20, 0.10 } },
69 { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10, 0.10 } },
70 { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60, 0.10 } },
71 { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30, 0.10 } },
72 { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15, 0.10 } },
9e9dba7b 73 ALL_ZERO
b5e92647
UH
74};
75
8f4e922f 76SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info;
8f4e922f 77
4f840ce9 78static int dev_clear(const struct sr_dev_driver *di)
b5e92647
UH
79{
80 return std_dev_clear(di, NULL);
81}
82
4f840ce9 83static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
8f4e922f
UH
84{
85 return std_init(sr_ctx, di, LOG_PREFIX);
86}
87
4f840ce9 88static GSList *scan(struct sr_dev_driver *di, GSList *options)
8f4e922f 89{
b5e92647 90 int i, model_id;
8f4e922f 91 struct drv_context *drvc;
b5e92647
UH
92 struct dev_context *devc;
93 struct sr_dev_inst *sdi;
94 struct sr_config *src;
b5e92647
UH
95 GSList *devices, *l;
96 const char *conn, *serialcomm;
97 struct sr_serial_dev_inst *serial;
5437a0ad 98 char reply[50], **tokens, *dummy;
8f4e922f 99
41812aca 100 drvc = di->context;
8f4e922f 101 drvc->instances = NULL;
b5e92647
UH
102 devices = NULL;
103 conn = NULL;
104 serialcomm = NULL;
9740d9bf 105 devc = NULL;
b5e92647
UH
106
107 for (l = options; l; l = l->next) {
108 src = l->data;
109 switch (src->key) {
110 case SR_CONF_CONN:
111 conn = g_variant_get_string(src->data, NULL);
112 break;
113 case SR_CONF_SERIALCOMM:
114 serialcomm = g_variant_get_string(src->data, NULL);
115 break;
116 default:
117 sr_err("Unknown option %d, skipping.", src->key);
118 break;
119 }
120 }
8f4e922f 121
b5e92647
UH
122 if (!conn)
123 return NULL;
124 if (!serialcomm)
125 serialcomm = "9600/8n1";
8f4e922f 126
91219afc 127 serial = sr_serial_dev_inst_new(conn, serialcomm);
8f4e922f 128
b5e92647
UH
129 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
130 return NULL;
8f4e922f 131
b5e92647 132 serial_flush(serial);
8f4e922f 133
b5e92647 134 sr_info("Probing serial port %s.", conn);
8f4e922f 135
b5e92647
UH
136 /* Get the device model. */
137 memset(&reply, 0, sizeof(reply));
9740d9bf
MH
138 if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
139 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
140 return NULL;
b5e92647 141 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
8f4e922f 142
b5e92647 143 model_id = -1;
25abc8dd
MH
144 for (i = 0; models[i].id != NULL; i++) {
145 if (!strcmp(models[i].id, tokens[0]))
b5e92647
UH
146 model_id = i;
147 }
148 if (model_id < 0) {
6e799d07
UH
149 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
150 g_strfreev(tokens);
b5e92647
UH
151 return NULL;
152 }
6e799d07 153 g_strfreev(tokens);
b5e92647 154
9740d9bf 155 /* Init device instance, etc. */
aac29cc1 156 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
157 sdi->status = SR_ST_INACTIVE;
158 sdi->vendor = g_strdup("Manson");
159 sdi->model = g_strdup(models[model_id].name);
b5e92647
UH
160 sdi->inst_type = SR_INST_SERIAL;
161 sdi->conn = serial;
162 sdi->driver = di;
163
5e23fcab 164 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
b5e92647
UH
165
166 devc = g_malloc0(sizeof(struct dev_context));
167 devc->model = &models[model_id];
168
169 sdi->priv = devc;
170
5437a0ad 171 /* Get current voltage, current, status. */
9740d9bf
MH
172 if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
173 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
5437a0ad 174 goto exit_err;
9740d9bf 175 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
6e799d07
UH
176 if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
177 g_strfreev(tokens);
9740d9bf 178 goto exit_err;
6e799d07 179 }
5437a0ad
MH
180 g_strfreev(tokens);
181
182 /* Get max. voltage and current. */
183 if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
184 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
185 goto exit_err;
186 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
187 devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
188 tokens[0][3] = '\0';
189 devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
190 g_strfreev(tokens);
9740d9bf 191
b5e92647
UH
192 drvc->instances = g_slist_append(drvc->instances, sdi);
193 devices = g_slist_append(devices, sdi);
194
195 serial_close(serial);
196 if (!devices)
197 sr_serial_dev_inst_free(serial);
198
199 return devices;
9740d9bf
MH
200
201exit_err:
202 sr_dev_inst_free(sdi);
b1f83103
UH
203 g_free(devc);
204
9740d9bf 205 return NULL;
b5e92647
UH
206}
207
4f840ce9 208static GSList *dev_list(const struct sr_dev_driver *di)
b5e92647 209{
41812aca 210 return ((struct drv_context *)(di->context))->instances;
8f4e922f
UH
211}
212
584560f1 213static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
214 const struct sr_channel_group *cg)
215{
b5e92647 216 struct dev_context *devc;
8f4e922f 217
8f4e922f
UH
218 (void)cg;
219
b5e92647
UH
220 if (!sdi)
221 return SR_ERR_ARG;
222
223 devc = sdi->priv;
224
8f4e922f 225 switch (key) {
b5e92647
UH
226 case SR_CONF_LIMIT_SAMPLES:
227 *data = g_variant_new_uint64(devc->limit_samples);
228 break;
229 case SR_CONF_LIMIT_MSEC:
230 *data = g_variant_new_uint64(devc->limit_msec);
231 break;
7a0b98b5 232 case SR_CONF_VOLTAGE:
ca95e90f
BV
233 *data = g_variant_new_double(devc->voltage);
234 break;
7a0b98b5 235 case SR_CONF_VOLTAGE_TARGET:
ca95e90f
BV
236 *data = g_variant_new_double(devc->voltage_max);
237 break;
7a0b98b5 238 case SR_CONF_CURRENT:
811d6255
MH
239 *data = g_variant_new_double(devc->current);
240 break;
7a0b98b5 241 case SR_CONF_CURRENT_LIMIT:
811d6255
MH
242 *data = g_variant_new_double(devc->current_max);
243 break;
7a0b98b5 244 case SR_CONF_ENABLED:
811d6255
MH
245 *data = g_variant_new_boolean(devc->output_enabled);
246 break;
8f4e922f
UH
247 default:
248 return SR_ERR_NA;
249 }
250
b5e92647 251 return SR_OK;
8f4e922f
UH
252}
253
584560f1 254static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
8f4e922f
UH
255 const struct sr_channel_group *cg)
256{
b5e92647 257 struct dev_context *devc;
811d6255
MH
258 gboolean bval;
259 gdouble dval;
8f4e922f 260
8f4e922f
UH
261 (void)cg;
262
263 if (sdi->status != SR_ST_ACTIVE)
264 return SR_ERR_DEV_CLOSED;
265
b5e92647
UH
266 devc = sdi->priv;
267
8f4e922f 268 switch (key) {
b5e92647
UH
269 case SR_CONF_LIMIT_MSEC:
270 if (g_variant_get_uint64(data) == 0)
271 return SR_ERR_ARG;
272 devc->limit_msec = g_variant_get_uint64(data);
273 break;
274 case SR_CONF_LIMIT_SAMPLES:
275 if (g_variant_get_uint64(data) == 0)
276 return SR_ERR_ARG;
277 devc->limit_samples = g_variant_get_uint64(data);
278 break;
7a0b98b5 279 case SR_CONF_VOLTAGE_TARGET:
ca95e90f
BV
280 dval = g_variant_get_double(data);
281 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
282 return SR_ERR_ARG;
283
284 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
285 (dval / devc->model->voltage[2])) < 0) ||
286 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
287 return SR_ERR;
288 devc->voltage_max = dval;
289 break;
7a0b98b5 290 case SR_CONF_CURRENT_LIMIT:
811d6255 291 dval = g_variant_get_double(data);
5437a0ad 292 if (dval < devc->model->current[0] || dval > devc->current_max_device)
811d6255
MH
293 return SR_ERR_ARG;
294
295 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
296 (dval / devc->model->current[2])) < 0) ||
297 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
298 return SR_ERR;
299 devc->current_max = dval;
300 break;
7a0b98b5 301 case SR_CONF_ENABLED:
811d6255
MH
302 bval = g_variant_get_boolean(data);
303 if (bval == devc->output_enabled) /* Nothing to do. */
304 break;
305 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
306 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
307 return SR_ERR;
308 devc->output_enabled = bval;
309 break;
8f4e922f 310 default:
b5e92647 311 return SR_ERR_NA;
8f4e922f
UH
312 }
313
b5e92647 314 return SR_OK;
8f4e922f
UH
315}
316
584560f1 317static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
318 const struct sr_channel_group *cg)
319{
811d6255
MH
320 struct dev_context *devc;
321 GVariant *gvar;
322 GVariantBuilder gvb;
5437a0ad 323 double dval;
811d6255
MH
324 int idx;
325
8f4e922f
UH
326 (void)cg;
327
b6085eb1
UH
328 /* Always available (with or without sdi). */
329 if (key == SR_CONF_SCAN_OPTIONS) {
330 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
331 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
332 return SR_OK;
333 }
334
335 /* Return drvopts without sdi (and devopts with sdi, see below). */
f3ba3c11
AJ
336 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
337 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
338 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
339 return SR_OK;
340 }
341
b6085eb1 342 /* Every other key needs an sdi. */
811d6255
MH
343 if (!sdi)
344 return SR_ERR_ARG;
345 devc = sdi->priv;
346
8f4e922f 347 switch (key) {
b5e92647 348 case SR_CONF_DEVICE_OPTIONS:
584560f1 349 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 350 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
b5e92647 351 break;
7a0b98b5 352 case SR_CONF_VOLTAGE_TARGET:
811d6255
MH
353 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
354 /* Min, max, step. */
355 for (idx = 0; idx < 3; idx++) {
5437a0ad 356 if (idx == 1)
ca95e90f 357 dval = devc->voltage_max_device;
5437a0ad 358 else
ca95e90f 359 dval = devc->model->voltage[idx];
5437a0ad 360 gvar = g_variant_new_double(dval);
811d6255
MH
361 g_variant_builder_add_value(&gvb, gvar);
362 }
363 *data = g_variant_builder_end(&gvb);
364 break;
7a0b98b5 365 case SR_CONF_CURRENT_LIMIT:
811d6255
MH
366 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
367 /* Min, max, step. */
368 for (idx = 0; idx < 3; idx++) {
5437a0ad 369 if (idx == 1)
ca95e90f 370 dval = devc->current_max_device;
5437a0ad 371 else
ca95e90f 372 dval = devc->model->current[idx];
5437a0ad 373 gvar = g_variant_new_double(dval);
811d6255
MH
374 g_variant_builder_add_value(&gvb, gvar);
375 }
376 *data = g_variant_builder_end(&gvb);
377 break;
8f4e922f
UH
378 default:
379 return SR_ERR_NA;
380 }
381
b5e92647 382 return SR_OK;
8f4e922f
UH
383}
384
695dc859 385static int dev_acquisition_start(const struct sr_dev_inst *sdi)
8f4e922f 386{
b5e92647
UH
387 struct dev_context *devc;
388 struct sr_serial_dev_inst *serial;
8f4e922f
UH
389
390 if (sdi->status != SR_ST_ACTIVE)
391 return SR_ERR_DEV_CLOSED;
392
b5e92647 393 devc = sdi->priv;
b5e92647 394
695dc859 395 std_session_send_df_header(sdi, LOG_PREFIX);
b5e92647
UH
396
397 devc->starttime = g_get_monotonic_time();
398 devc->num_samples = 0;
399 devc->reply_pending = FALSE;
400 devc->req_sent_at = 0;
401
402 /* Poll every 10ms, or whenever some data comes in. */
403 serial = sdi->conn;
102f1239
BV
404 serial_source_add(sdi->session, serial, G_IO_IN, 10,
405 hcs_receive_data, (void *)sdi);
b5e92647 406
8f4e922f
UH
407 return SR_OK;
408}
409
695dc859 410static int dev_acquisition_stop(struct sr_dev_inst *sdi)
8f4e922f 411{
6525d819 412 return std_serial_dev_acquisition_stop(sdi,
b5e92647 413 std_serial_dev_close, sdi->conn, LOG_PREFIX);
8f4e922f
UH
414}
415
416SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info = {
417 .name = "manson-hcs-3xxx",
418 .longname = "Manson HCS-3xxx",
419 .api_version = 1,
420 .init = init,
700d6b64 421 .cleanup = std_cleanup,
8f4e922f
UH
422 .scan = scan,
423 .dev_list = dev_list,
424 .dev_clear = dev_clear,
425 .config_get = config_get,
426 .config_set = config_set,
427 .config_list = config_list,
b5e92647
UH
428 .dev_open = std_serial_dev_open,
429 .dev_close = std_serial_dev_close,
8f4e922f
UH
430 .dev_acquisition_start = dev_acquisition_start,
431 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 432 .context = NULL,
8f4e922f 433};