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