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