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