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