]> sigrok.org Git - libsigrok.git/blame - src/hardware/manson-hcs-3xxx/api.c
Don't reset instance list in scan() callback
[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
4f840ce9 76static GSList *scan(struct sr_dev_driver *di, GSList *options)
8f4e922f 77{
b5e92647 78 int i, model_id;
8f4e922f 79 struct drv_context *drvc;
b5e92647
UH
80 struct dev_context *devc;
81 struct sr_dev_inst *sdi;
82 struct sr_config *src;
b5e92647
UH
83 GSList *devices, *l;
84 const char *conn, *serialcomm;
85 struct sr_serial_dev_inst *serial;
5437a0ad 86 char reply[50], **tokens, *dummy;
8f4e922f 87
41812aca 88 drvc = di->context;
b5e92647
UH
89 devices = NULL;
90 conn = NULL;
91 serialcomm = NULL;
9740d9bf 92 devc = NULL;
b5e92647
UH
93
94 for (l = options; l; l = l->next) {
95 src = l->data;
96 switch (src->key) {
97 case SR_CONF_CONN:
98 conn = g_variant_get_string(src->data, NULL);
99 break;
100 case SR_CONF_SERIALCOMM:
101 serialcomm = g_variant_get_string(src->data, NULL);
102 break;
103 default:
104 sr_err("Unknown option %d, skipping.", src->key);
105 break;
106 }
107 }
8f4e922f 108
b5e92647
UH
109 if (!conn)
110 return NULL;
111 if (!serialcomm)
112 serialcomm = "9600/8n1";
8f4e922f 113
91219afc 114 serial = sr_serial_dev_inst_new(conn, serialcomm);
8f4e922f 115
b5e92647
UH
116 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
117 return NULL;
8f4e922f 118
b5e92647 119 serial_flush(serial);
8f4e922f 120
b5e92647 121 sr_info("Probing serial port %s.", conn);
8f4e922f 122
b5e92647
UH
123 /* Get the device model. */
124 memset(&reply, 0, sizeof(reply));
9740d9bf
MH
125 if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
126 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
127 return NULL;
b5e92647 128 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
8f4e922f 129
b5e92647 130 model_id = -1;
25abc8dd
MH
131 for (i = 0; models[i].id != NULL; i++) {
132 if (!strcmp(models[i].id, tokens[0]))
b5e92647
UH
133 model_id = i;
134 }
135 if (model_id < 0) {
6e799d07
UH
136 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
137 g_strfreev(tokens);
b5e92647
UH
138 return NULL;
139 }
6e799d07 140 g_strfreev(tokens);
b5e92647 141
9740d9bf 142 /* Init device instance, etc. */
aac29cc1 143 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
144 sdi->status = SR_ST_INACTIVE;
145 sdi->vendor = g_strdup("Manson");
146 sdi->model = g_strdup(models[model_id].name);
b5e92647
UH
147 sdi->inst_type = SR_INST_SERIAL;
148 sdi->conn = serial;
149 sdi->driver = di;
150
5e23fcab 151 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
b5e92647
UH
152
153 devc = g_malloc0(sizeof(struct dev_context));
a655b3fd 154 sr_sw_limits_init(&devc->limits);
b5e92647
UH
155 devc->model = &models[model_id];
156
157 sdi->priv = devc;
158
5437a0ad 159 /* Get current voltage, current, status. */
9740d9bf
MH
160 if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
161 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
5437a0ad 162 goto exit_err;
9740d9bf 163 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
6e799d07
UH
164 if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
165 g_strfreev(tokens);
9740d9bf 166 goto exit_err;
6e799d07 167 }
5437a0ad
MH
168 g_strfreev(tokens);
169
170 /* Get max. voltage and current. */
171 if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
172 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
173 goto exit_err;
174 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
175 devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
176 tokens[0][3] = '\0';
177 devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
178 g_strfreev(tokens);
9740d9bf 179
b5e92647
UH
180 drvc->instances = g_slist_append(drvc->instances, sdi);
181 devices = g_slist_append(devices, sdi);
182
183 serial_close(serial);
184 if (!devices)
185 sr_serial_dev_inst_free(serial);
186
187 return devices;
9740d9bf
MH
188
189exit_err:
190 sr_dev_inst_free(sdi);
b1f83103
UH
191 g_free(devc);
192
9740d9bf 193 return NULL;
b5e92647
UH
194}
195
584560f1 196static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
197 const struct sr_channel_group *cg)
198{
b5e92647 199 struct dev_context *devc;
8f4e922f 200
8f4e922f
UH
201 (void)cg;
202
b5e92647
UH
203 if (!sdi)
204 return SR_ERR_ARG;
205
206 devc = sdi->priv;
207
8f4e922f 208 switch (key) {
b5e92647 209 case SR_CONF_LIMIT_SAMPLES:
b5e92647 210 case SR_CONF_LIMIT_MSEC:
a655b3fd 211 return sr_sw_limits_config_get(&devc->limits, key, data);
7a0b98b5 212 case SR_CONF_VOLTAGE:
ca95e90f
BV
213 *data = g_variant_new_double(devc->voltage);
214 break;
7a0b98b5 215 case SR_CONF_VOLTAGE_TARGET:
ca95e90f
BV
216 *data = g_variant_new_double(devc->voltage_max);
217 break;
7a0b98b5 218 case SR_CONF_CURRENT:
811d6255
MH
219 *data = g_variant_new_double(devc->current);
220 break;
7a0b98b5 221 case SR_CONF_CURRENT_LIMIT:
811d6255
MH
222 *data = g_variant_new_double(devc->current_max);
223 break;
7a0b98b5 224 case SR_CONF_ENABLED:
811d6255
MH
225 *data = g_variant_new_boolean(devc->output_enabled);
226 break;
8f4e922f
UH
227 default:
228 return SR_ERR_NA;
229 }
230
b5e92647 231 return SR_OK;
8f4e922f
UH
232}
233
584560f1 234static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
8f4e922f
UH
235 const struct sr_channel_group *cg)
236{
b5e92647 237 struct dev_context *devc;
811d6255
MH
238 gboolean bval;
239 gdouble dval;
8f4e922f 240
8f4e922f
UH
241 (void)cg;
242
243 if (sdi->status != SR_ST_ACTIVE)
244 return SR_ERR_DEV_CLOSED;
245
b5e92647
UH
246 devc = sdi->priv;
247
8f4e922f 248 switch (key) {
b5e92647 249 case SR_CONF_LIMIT_MSEC:
a655b3fd 250 return sr_sw_limits_config_set(&devc->limits, key, data);
7a0b98b5 251 case SR_CONF_VOLTAGE_TARGET:
ca95e90f
BV
252 dval = g_variant_get_double(data);
253 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
254 return SR_ERR_ARG;
255
256 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
257 (dval / devc->model->voltage[2])) < 0) ||
258 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
259 return SR_ERR;
260 devc->voltage_max = dval;
261 break;
7a0b98b5 262 case SR_CONF_CURRENT_LIMIT:
811d6255 263 dval = g_variant_get_double(data);
5437a0ad 264 if (dval < devc->model->current[0] || dval > devc->current_max_device)
811d6255
MH
265 return SR_ERR_ARG;
266
267 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
268 (dval / devc->model->current[2])) < 0) ||
269 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
270 return SR_ERR;
271 devc->current_max = dval;
272 break;
7a0b98b5 273 case SR_CONF_ENABLED:
811d6255
MH
274 bval = g_variant_get_boolean(data);
275 if (bval == devc->output_enabled) /* Nothing to do. */
276 break;
277 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
278 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
279 return SR_ERR;
280 devc->output_enabled = bval;
281 break;
8f4e922f 282 default:
b5e92647 283 return SR_ERR_NA;
8f4e922f
UH
284 }
285
b5e92647 286 return SR_OK;
8f4e922f
UH
287}
288
584560f1 289static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
290 const struct sr_channel_group *cg)
291{
811d6255
MH
292 struct dev_context *devc;
293 GVariant *gvar;
294 GVariantBuilder gvb;
5437a0ad 295 double dval;
811d6255
MH
296 int idx;
297
8f4e922f
UH
298 (void)cg;
299
b6085eb1
UH
300 /* Always available (with or without sdi). */
301 if (key == SR_CONF_SCAN_OPTIONS) {
302 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
303 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
304 return SR_OK;
305 }
306
307 /* Return drvopts without sdi (and devopts with sdi, see below). */
f3ba3c11
AJ
308 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
309 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
310 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
311 return SR_OK;
312 }
313
b6085eb1 314 /* Every other key needs an sdi. */
811d6255
MH
315 if (!sdi)
316 return SR_ERR_ARG;
317 devc = sdi->priv;
318
8f4e922f 319 switch (key) {
b5e92647 320 case SR_CONF_DEVICE_OPTIONS:
584560f1 321 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 322 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
b5e92647 323 break;
7a0b98b5 324 case SR_CONF_VOLTAGE_TARGET:
811d6255
MH
325 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
326 /* Min, max, step. */
327 for (idx = 0; idx < 3; idx++) {
5437a0ad 328 if (idx == 1)
ca95e90f 329 dval = devc->voltage_max_device;
5437a0ad 330 else
ca95e90f 331 dval = devc->model->voltage[idx];
5437a0ad 332 gvar = g_variant_new_double(dval);
811d6255
MH
333 g_variant_builder_add_value(&gvb, gvar);
334 }
335 *data = g_variant_builder_end(&gvb);
336 break;
7a0b98b5 337 case SR_CONF_CURRENT_LIMIT:
811d6255
MH
338 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
339 /* Min, max, step. */
340 for (idx = 0; idx < 3; idx++) {
5437a0ad 341 if (idx == 1)
ca95e90f 342 dval = devc->current_max_device;
5437a0ad 343 else
ca95e90f 344 dval = devc->model->current[idx];
5437a0ad 345 gvar = g_variant_new_double(dval);
811d6255
MH
346 g_variant_builder_add_value(&gvb, gvar);
347 }
348 *data = g_variant_builder_end(&gvb);
349 break;
8f4e922f
UH
350 default:
351 return SR_ERR_NA;
352 }
353
b5e92647 354 return SR_OK;
8f4e922f
UH
355}
356
695dc859 357static int dev_acquisition_start(const struct sr_dev_inst *sdi)
8f4e922f 358{
b5e92647
UH
359 struct dev_context *devc;
360 struct sr_serial_dev_inst *serial;
8f4e922f
UH
361
362 if (sdi->status != SR_ST_ACTIVE)
363 return SR_ERR_DEV_CLOSED;
364
b5e92647 365 devc = sdi->priv;
b5e92647 366
a655b3fd 367 sr_sw_limits_acquisition_start(&devc->limits);
695dc859 368 std_session_send_df_header(sdi, LOG_PREFIX);
b5e92647 369
b5e92647
UH
370 devc->reply_pending = FALSE;
371 devc->req_sent_at = 0;
372
373 /* Poll every 10ms, or whenever some data comes in. */
374 serial = sdi->conn;
102f1239
BV
375 serial_source_add(sdi->session, serial, G_IO_IN, 10,
376 hcs_receive_data, (void *)sdi);
b5e92647 377
8f4e922f
UH
378 return SR_OK;
379}
380
695dc859 381static int dev_acquisition_stop(struct sr_dev_inst *sdi)
8f4e922f 382{
6525d819 383 return std_serial_dev_acquisition_stop(sdi,
b5e92647 384 std_serial_dev_close, sdi->conn, LOG_PREFIX);
8f4e922f
UH
385}
386
dd5c48a6 387static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
8f4e922f
UH
388 .name = "manson-hcs-3xxx",
389 .longname = "Manson HCS-3xxx",
390 .api_version = 1,
c2fdcc25 391 .init = std_init,
700d6b64 392 .cleanup = std_cleanup,
8f4e922f 393 .scan = scan,
c01bf34c 394 .dev_list = std_dev_list,
8f4e922f
UH
395 .config_get = config_get,
396 .config_set = config_set,
397 .config_list = config_list,
b5e92647
UH
398 .dev_open = std_serial_dev_open,
399 .dev_close = std_serial_dev_close,
8f4e922f
UH
400 .dev_acquisition_start = dev_acquisition_start,
401 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 402 .context = NULL,
8f4e922f 403};
dd5c48a6 404SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);