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