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