]> sigrok.org Git - libsigrok.git/blame - src/hardware/manson-hcs-3xxx/api.c
gmc-mh-1x-2x: Shorten some code by using the ternary operator.
[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
d9251a2c
UH
22/**
23 * @file
24 *
25 * <em>Manson HCS-3xxx series</em> power supply driver
26 *
27 * @internal
28 */
9740d9bf 29
6ec6c43b 30#include <config.h>
8f4e922f
UH
31#include "protocol.h"
32
f3ba3c11
AJ
33static const uint32_t drvopts[] = {
34 /* Device class */
35 SR_CONF_POWER_SUPPLY,
36};
37
a0e0bb41 38static const uint32_t scanopts[] = {
b5e92647
UH
39 SR_CONF_CONN,
40 SR_CONF_SERIALCOMM,
41};
42
584560f1 43static const uint32_t devopts[] = {
811d6255 44 /* Device class */
b5e92647 45 SR_CONF_POWER_SUPPLY,
f3f19d11 46 /* Acquisition modes. */
b5e92647 47 SR_CONF_CONTINUOUS,
5827f61b
BV
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
49 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
811d6255 50 /* Device configuration */
7a0b98b5
AJ
51 SR_CONF_VOLTAGE | SR_CONF_GET,
52 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
53 SR_CONF_CURRENT | SR_CONF_GET,
54 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
55 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
b5e92647
UH
56};
57
58/* Note: All models have one power supply output only. */
329733d9 59static const struct hcs_model models[] = {
25abc8dd
MH
60 { MANSON_HCS_3100, "HCS-3100", "3100", { 1, 18, 0.1 }, { 0, 10, 0.10 } },
61 { MANSON_HCS_3102, "HCS-3102", "3102", { 1, 36, 0.1 }, { 0, 5, 0.01 } },
62 { MANSON_HCS_3104, "HCS-3104", "3104", { 1, 60, 0.1 }, { 0, 2.5, 0.01 } },
63 { MANSON_HCS_3150, "HCS-3150", "3150", { 1, 18, 0.1 }, { 0, 15, 0.10 } },
64 { MANSON_HCS_3200, "HCS-3200", "3200", { 1, 18, 0.1 }, { 0, 20, 0.10 } },
65 { MANSON_HCS_3202, "HCS-3202", "3202", { 1, 36, 0.1 }, { 0, 10, 0.10 } },
66 { MANSON_HCS_3204, "HCS-3204", "3204", { 1, 60, 0.1 }, { 0, 5, 0.01 } },
67 { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30, 0.10 } },
68 { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15, 0.10 } },
69 { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0, 8, 0.10 } },
70 { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40, 0.10 } },
71 { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20, 0.10 } },
72 { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10, 0.10 } },
73 { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60, 0.10 } },
74 { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30, 0.10 } },
75 { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15, 0.10 } },
9e9dba7b 76 ALL_ZERO
b5e92647
UH
77};
78
4f840ce9 79static GSList *scan(struct sr_dev_driver *di, GSList *options)
8f4e922f 80{
b5e92647 81 int i, model_id;
b5e92647
UH
82 struct dev_context *devc;
83 struct sr_dev_inst *sdi;
84 struct sr_config *src;
43376f33 85 GSList *l;
b5e92647
UH
86 const char *conn, *serialcomm;
87 struct sr_serial_dev_inst *serial;
5437a0ad 88 char reply[50], **tokens, *dummy;
8f4e922f 89
b5e92647
UH
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;
b5e92647 149
5e23fcab 150 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
b5e92647
UH
151
152 devc = g_malloc0(sizeof(struct dev_context));
a655b3fd 153 sr_sw_limits_init(&devc->limits);
b5e92647
UH
154 devc->model = &models[model_id];
155
156 sdi->priv = devc;
157
5437a0ad 158 /* Get current voltage, current, status. */
9740d9bf
MH
159 if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
160 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
5437a0ad 161 goto exit_err;
9740d9bf 162 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
6e799d07
UH
163 if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
164 g_strfreev(tokens);
9740d9bf 165 goto exit_err;
6e799d07 166 }
5437a0ad
MH
167 g_strfreev(tokens);
168
169 /* Get max. voltage and current. */
170 if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
171 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
172 goto exit_err;
173 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
174 devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
175 tokens[0][3] = '\0';
176 devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
177 g_strfreev(tokens);
9740d9bf 178
b5e92647 179 serial_close(serial);
b5e92647 180
43376f33 181 return std_scan_complete(di, g_slist_append(NULL, sdi));
9740d9bf
MH
182
183exit_err:
184 sr_dev_inst_free(sdi);
b1f83103
UH
185 g_free(devc);
186
9740d9bf 187 return NULL;
b5e92647
UH
188}
189
584560f1 190static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
191 const struct sr_channel_group *cg)
192{
b5e92647 193 struct dev_context *devc;
8f4e922f 194
8f4e922f
UH
195 (void)cg;
196
b5e92647
UH
197 if (!sdi)
198 return SR_ERR_ARG;
199
200 devc = sdi->priv;
201
8f4e922f 202 switch (key) {
b5e92647 203 case SR_CONF_LIMIT_SAMPLES:
b5e92647 204 case SR_CONF_LIMIT_MSEC:
a655b3fd 205 return sr_sw_limits_config_get(&devc->limits, key, data);
7a0b98b5 206 case SR_CONF_VOLTAGE:
ca95e90f
BV
207 *data = g_variant_new_double(devc->voltage);
208 break;
7a0b98b5 209 case SR_CONF_VOLTAGE_TARGET:
ca95e90f
BV
210 *data = g_variant_new_double(devc->voltage_max);
211 break;
7a0b98b5 212 case SR_CONF_CURRENT:
811d6255
MH
213 *data = g_variant_new_double(devc->current);
214 break;
7a0b98b5 215 case SR_CONF_CURRENT_LIMIT:
811d6255
MH
216 *data = g_variant_new_double(devc->current_max);
217 break;
7a0b98b5 218 case SR_CONF_ENABLED:
811d6255
MH
219 *data = g_variant_new_boolean(devc->output_enabled);
220 break;
8f4e922f
UH
221 default:
222 return SR_ERR_NA;
223 }
224
b5e92647 225 return SR_OK;
8f4e922f
UH
226}
227
584560f1 228static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
8f4e922f
UH
229 const struct sr_channel_group *cg)
230{
b5e92647 231 struct dev_context *devc;
811d6255
MH
232 gboolean bval;
233 gdouble dval;
8f4e922f 234
8f4e922f
UH
235 (void)cg;
236
237 if (sdi->status != SR_ST_ACTIVE)
238 return SR_ERR_DEV_CLOSED;
239
b5e92647
UH
240 devc = sdi->priv;
241
8f4e922f 242 switch (key) {
b5e92647 243 case SR_CONF_LIMIT_MSEC:
a655b3fd 244 return sr_sw_limits_config_set(&devc->limits, key, data);
7a0b98b5 245 case SR_CONF_VOLTAGE_TARGET:
ca95e90f
BV
246 dval = g_variant_get_double(data);
247 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
248 return SR_ERR_ARG;
249
250 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
251 (dval / devc->model->voltage[2])) < 0) ||
252 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
253 return SR_ERR;
254 devc->voltage_max = dval;
255 break;
7a0b98b5 256 case SR_CONF_CURRENT_LIMIT:
811d6255 257 dval = g_variant_get_double(data);
5437a0ad 258 if (dval < devc->model->current[0] || dval > devc->current_max_device)
811d6255
MH
259 return SR_ERR_ARG;
260
261 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
262 (dval / devc->model->current[2])) < 0) ||
263 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
264 return SR_ERR;
265 devc->current_max = dval;
266 break;
7a0b98b5 267 case SR_CONF_ENABLED:
811d6255
MH
268 bval = g_variant_get_boolean(data);
269 if (bval == devc->output_enabled) /* Nothing to do. */
270 break;
271 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
272 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
273 return SR_ERR;
274 devc->output_enabled = bval;
275 break;
8f4e922f 276 default:
b5e92647 277 return SR_ERR_NA;
8f4e922f
UH
278 }
279
b5e92647 280 return SR_OK;
8f4e922f
UH
281}
282
584560f1 283static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
8f4e922f
UH
284 const struct sr_channel_group *cg)
285{
811d6255
MH
286 struct dev_context *devc;
287 GVariant *gvar;
288 GVariantBuilder gvb;
5437a0ad 289 double dval;
811d6255
MH
290 int idx;
291
8f4e922f
UH
292 (void)cg;
293
b6085eb1
UH
294 /* Always available (with or without sdi). */
295 if (key == SR_CONF_SCAN_OPTIONS) {
296 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
297 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
298 return SR_OK;
299 }
300
301 /* Return drvopts without sdi (and devopts with sdi, see below). */
f3ba3c11
AJ
302 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
303 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
304 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
305 return SR_OK;
306 }
307
b6085eb1 308 /* Every other key needs an sdi. */
811d6255
MH
309 if (!sdi)
310 return SR_ERR_ARG;
311 devc = sdi->priv;
312
8f4e922f 313 switch (key) {
b5e92647 314 case SR_CONF_DEVICE_OPTIONS:
584560f1 315 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 316 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
b5e92647 317 break;
7a0b98b5 318 case SR_CONF_VOLTAGE_TARGET:
811d6255
MH
319 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
320 /* Min, max, step. */
321 for (idx = 0; idx < 3; idx++) {
5437a0ad 322 if (idx == 1)
ca95e90f 323 dval = devc->voltage_max_device;
5437a0ad 324 else
ca95e90f 325 dval = devc->model->voltage[idx];
5437a0ad 326 gvar = g_variant_new_double(dval);
811d6255
MH
327 g_variant_builder_add_value(&gvb, gvar);
328 }
329 *data = g_variant_builder_end(&gvb);
330 break;
7a0b98b5 331 case SR_CONF_CURRENT_LIMIT:
811d6255
MH
332 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
333 /* Min, max, step. */
334 for (idx = 0; idx < 3; idx++) {
5437a0ad 335 if (idx == 1)
ca95e90f 336 dval = devc->current_max_device;
5437a0ad 337 else
ca95e90f 338 dval = devc->model->current[idx];
5437a0ad 339 gvar = g_variant_new_double(dval);
811d6255
MH
340 g_variant_builder_add_value(&gvb, gvar);
341 }
342 *data = g_variant_builder_end(&gvb);
343 break;
8f4e922f
UH
344 default:
345 return SR_ERR_NA;
346 }
347
b5e92647 348 return SR_OK;
8f4e922f
UH
349}
350
695dc859 351static int dev_acquisition_start(const struct sr_dev_inst *sdi)
8f4e922f 352{
b5e92647
UH
353 struct dev_context *devc;
354 struct sr_serial_dev_inst *serial;
8f4e922f
UH
355
356 if (sdi->status != SR_ST_ACTIVE)
357 return SR_ERR_DEV_CLOSED;
358
b5e92647 359 devc = sdi->priv;
b5e92647 360
a655b3fd 361 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 362 std_session_send_df_header(sdi);
b5e92647 363
b5e92647
UH
364 devc->reply_pending = FALSE;
365 devc->req_sent_at = 0;
366
367 /* Poll every 10ms, or whenever some data comes in. */
368 serial = sdi->conn;
102f1239
BV
369 serial_source_add(sdi->session, serial, G_IO_IN, 10,
370 hcs_receive_data, (void *)sdi);
b5e92647 371
8f4e922f
UH
372 return SR_OK;
373}
374
dd5c48a6 375static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
8f4e922f
UH
376 .name = "manson-hcs-3xxx",
377 .longname = "Manson HCS-3xxx",
378 .api_version = 1,
c2fdcc25 379 .init = std_init,
700d6b64 380 .cleanup = std_cleanup,
8f4e922f 381 .scan = scan,
c01bf34c 382 .dev_list = std_dev_list,
8f4e922f
UH
383 .config_get = config_get,
384 .config_set = config_set,
385 .config_list = config_list,
b5e92647
UH
386 .dev_open = std_serial_dev_open,
387 .dev_close = std_serial_dev_close,
8f4e922f 388 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 389 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
41812aca 390 .context = NULL,
8f4e922f 391};
dd5c48a6 392SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);