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