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