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