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