]> sigrok.org Git - libsigrok.git/blame - src/hardware/manson-hcs-3xxx/api.c
Change sr_dev_inst_new() to take no parameters.
[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
a0e0bb41 29static const uint32_t scanopts[] = {
b5e92647
UH
30 SR_CONF_CONN,
31 SR_CONF_SERIALCOMM,
32};
33
584560f1 34static const uint32_t devopts[] = {
811d6255 35 /* Device class */
b5e92647 36 SR_CONF_POWER_SUPPLY,
811d6255 37 /* Aquisition modes. */
b5e92647 38 SR_CONF_CONTINUOUS,
5827f61b
BV
39 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
40 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
811d6255 41 /* Device configuration */
ca95e90f
BV
42 SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET,
43 SR_CONF_OUTPUT_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
5827f61b 44 SR_CONF_OUTPUT_CURRENT | SR_CONF_GET,
ca95e90f 45 SR_CONF_OUTPUT_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
5827f61b 46 SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET,
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;
5437a0ad 94 char reply[50], **tokens, *dummy;
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. */
0af636be
UH
153 sdi = sr_dev_inst_new();
154 sdi->status = SR_ST_INACTIVE;
155 sdi->vendor = g_strdup("Manson");
156 sdi->model = g_strdup(models[model_id].name);
b5e92647
UH
157 sdi->inst_type = SR_INST_SERIAL;
158 sdi->conn = serial;
159 sdi->driver = di;
160
161 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "CH1"))) {
162 sr_err("Failed to create channel.");
9740d9bf 163 goto exit_err;
b5e92647
UH
164 }
165 sdi->channels = g_slist_append(sdi->channels, ch);
166
167 devc = g_malloc0(sizeof(struct dev_context));
168 devc->model = &models[model_id];
169
170 sdi->priv = devc;
171
5437a0ad 172 /* Get current voltage, current, status. */
9740d9bf
MH
173 if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
174 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
5437a0ad 175 goto exit_err;
9740d9bf
MH
176 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
177 if (hcs_parse_volt_curr_mode(sdi, tokens) < 0)
178 goto exit_err;
5437a0ad
MH
179 g_strfreev(tokens);
180
181 /* Get max. voltage and current. */
182 if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
183 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
184 goto exit_err;
185 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
186 devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
187 tokens[0][3] = '\0';
188 devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
189 g_strfreev(tokens);
9740d9bf 190
b5e92647
UH
191 drvc->instances = g_slist_append(drvc->instances, sdi);
192 devices = g_slist_append(devices, sdi);
193
194 serial_close(serial);
195 if (!devices)
196 sr_serial_dev_inst_free(serial);
197
198 return devices;
9740d9bf
MH
199
200exit_err:
201 sr_dev_inst_free(sdi);
202 if (devc)
203 g_free(devc);
204 return NULL;
b5e92647
UH
205}
206
207static GSList *dev_list(void)
208{
209 return ((struct drv_context *)(di->priv))->instances;
8f4e922f
UH
210}
211
212static int cleanup(void)
213{
214 return dev_clear();
215}
216
584560f1 217static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
218 const struct sr_channel_group *cg)
219{
b5e92647 220 struct dev_context *devc;
8f4e922f 221
8f4e922f
UH
222 (void)cg;
223
b5e92647
UH
224 if (!sdi)
225 return SR_ERR_ARG;
226
227 devc = sdi->priv;
228
8f4e922f 229 switch (key) {
b5e92647
UH
230 case SR_CONF_LIMIT_SAMPLES:
231 *data = g_variant_new_uint64(devc->limit_samples);
232 break;
233 case SR_CONF_LIMIT_MSEC:
234 *data = g_variant_new_uint64(devc->limit_msec);
235 break;
ca95e90f
BV
236 case SR_CONF_OUTPUT_VOLTAGE:
237 *data = g_variant_new_double(devc->voltage);
238 break;
239 case SR_CONF_OUTPUT_VOLTAGE_TARGET:
240 *data = g_variant_new_double(devc->voltage_max);
241 break;
811d6255
MH
242 case SR_CONF_OUTPUT_CURRENT:
243 *data = g_variant_new_double(devc->current);
244 break;
ca95e90f 245 case SR_CONF_OUTPUT_CURRENT_LIMIT:
811d6255
MH
246 *data = g_variant_new_double(devc->current_max);
247 break;
248 case SR_CONF_OUTPUT_ENABLED:
249 *data = g_variant_new_boolean(devc->output_enabled);
250 break;
8f4e922f
UH
251 default:
252 return SR_ERR_NA;
253 }
254
b5e92647 255 return SR_OK;
8f4e922f
UH
256}
257
584560f1 258static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
8f4e922f
UH
259 const struct sr_channel_group *cg)
260{
b5e92647 261 struct dev_context *devc;
811d6255
MH
262 gboolean bval;
263 gdouble dval;
8f4e922f 264
8f4e922f
UH
265 (void)cg;
266
267 if (sdi->status != SR_ST_ACTIVE)
268 return SR_ERR_DEV_CLOSED;
269
b5e92647
UH
270 devc = sdi->priv;
271
8f4e922f 272 switch (key) {
b5e92647
UH
273 case SR_CONF_LIMIT_MSEC:
274 if (g_variant_get_uint64(data) == 0)
275 return SR_ERR_ARG;
276 devc->limit_msec = g_variant_get_uint64(data);
277 break;
278 case SR_CONF_LIMIT_SAMPLES:
279 if (g_variant_get_uint64(data) == 0)
280 return SR_ERR_ARG;
281 devc->limit_samples = g_variant_get_uint64(data);
282 break;
ca95e90f
BV
283 case SR_CONF_OUTPUT_VOLTAGE_TARGET:
284 dval = g_variant_get_double(data);
285 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
286 return SR_ERR_ARG;
287
288 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
289 (dval / devc->model->voltage[2])) < 0) ||
290 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
291 return SR_ERR;
292 devc->voltage_max = dval;
293 break;
294 case SR_CONF_OUTPUT_CURRENT_LIMIT:
811d6255 295 dval = g_variant_get_double(data);
5437a0ad 296 if (dval < devc->model->current[0] || dval > devc->current_max_device)
811d6255
MH
297 return SR_ERR_ARG;
298
299 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
300 (dval / devc->model->current[2])) < 0) ||
301 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
302 return SR_ERR;
303 devc->current_max = dval;
304 break;
305 case SR_CONF_OUTPUT_ENABLED:
306 bval = g_variant_get_boolean(data);
307 if (bval == devc->output_enabled) /* Nothing to do. */
308 break;
309 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
310 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
311 return SR_ERR;
312 devc->output_enabled = bval;
313 break;
8f4e922f 314 default:
b5e92647 315 return SR_ERR_NA;
8f4e922f
UH
316 }
317
b5e92647 318 return SR_OK;
8f4e922f
UH
319}
320
584560f1 321static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
322 const struct sr_channel_group *cg)
323{
811d6255
MH
324 struct dev_context *devc;
325 GVariant *gvar;
326 GVariantBuilder gvb;
5437a0ad 327 double dval;
811d6255
MH
328 int idx;
329
8f4e922f
UH
330 (void)cg;
331
811d6255
MH
332 if (!sdi)
333 return SR_ERR_ARG;
334 devc = sdi->priv;
335
8f4e922f 336 switch (key) {
b5e92647 337 case SR_CONF_SCAN_OPTIONS:
584560f1 338 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 339 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
b5e92647
UH
340 break;
341 case SR_CONF_DEVICE_OPTIONS:
584560f1 342 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 343 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
b5e92647 344 break;
ca95e90f 345 case SR_CONF_OUTPUT_VOLTAGE_TARGET:
811d6255
MH
346 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
347 /* Min, max, step. */
348 for (idx = 0; idx < 3; idx++) {
5437a0ad 349 if (idx == 1)
ca95e90f 350 dval = devc->voltage_max_device;
5437a0ad 351 else
ca95e90f 352 dval = devc->model->voltage[idx];
5437a0ad 353 gvar = g_variant_new_double(dval);
811d6255
MH
354 g_variant_builder_add_value(&gvb, gvar);
355 }
356 *data = g_variant_builder_end(&gvb);
357 break;
ca95e90f 358 case SR_CONF_OUTPUT_CURRENT_LIMIT:
811d6255
MH
359 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
360 /* Min, max, step. */
361 for (idx = 0; idx < 3; idx++) {
5437a0ad 362 if (idx == 1)
ca95e90f 363 dval = devc->current_max_device;
5437a0ad 364 else
ca95e90f 365 dval = devc->model->current[idx];
5437a0ad 366 gvar = g_variant_new_double(dval);
811d6255
MH
367 g_variant_builder_add_value(&gvb, gvar);
368 }
369 *data = g_variant_builder_end(&gvb);
370 break;
8f4e922f
UH
371 default:
372 return SR_ERR_NA;
373 }
374
b5e92647 375 return SR_OK;
8f4e922f
UH
376}
377
b5e92647 378static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
8f4e922f 379{
b5e92647
UH
380 struct dev_context *devc;
381 struct sr_serial_dev_inst *serial;
8f4e922f
UH
382
383 if (sdi->status != SR_ST_ACTIVE)
384 return SR_ERR_DEV_CLOSED;
385
b5e92647
UH
386 devc = sdi->priv;
387 devc->cb_data = cb_data;
388
389 /* Send header packet to the session bus. */
390 std_session_send_df_header(cb_data, LOG_PREFIX);
391
392 devc->starttime = g_get_monotonic_time();
393 devc->num_samples = 0;
394 devc->reply_pending = FALSE;
395 devc->req_sent_at = 0;
396
397 /* Poll every 10ms, or whenever some data comes in. */
398 serial = sdi->conn;
102f1239
BV
399 serial_source_add(sdi->session, serial, G_IO_IN, 10,
400 hcs_receive_data, (void *)sdi);
b5e92647 401
8f4e922f
UH
402 return SR_OK;
403}
404
405static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
406{
b5e92647
UH
407 return std_serial_dev_acquisition_stop(sdi, cb_data,
408 std_serial_dev_close, sdi->conn, LOG_PREFIX);
8f4e922f
UH
409}
410
411SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info = {
412 .name = "manson-hcs-3xxx",
413 .longname = "Manson HCS-3xxx",
414 .api_version = 1,
415 .init = init,
416 .cleanup = cleanup,
417 .scan = scan,
418 .dev_list = dev_list,
419 .dev_clear = dev_clear,
420 .config_get = config_get,
421 .config_set = config_set,
422 .config_list = config_list,
b5e92647
UH
423 .dev_open = std_serial_dev_open,
424 .dev_close = std_serial_dev_close,
8f4e922f
UH
425 .dev_acquisition_start = dev_acquisition_start,
426 .dev_acquisition_stop = dev_acquisition_stop,
427 .priv = NULL,
428};