]>
Commit | Line | Data |
---|---|---|
e75ee7de HV |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <config.h> | |
21 | #include "protocol.h" | |
22 | ||
d7083042 HV |
23 | static const uint32_t drvopts[] = { |
24 | /* Device class */ | |
25 | SR_CONF_POWER_SUPPLY, | |
26 | }; | |
27 | ||
28 | static const uint32_t scanopts[] = { | |
29 | SR_CONF_CONN, | |
30 | SR_CONF_SERIALCOMM, | |
31 | }; | |
32 | ||
33 | static const uint32_t devopts[] = { | |
34 | /* Device class */ | |
35 | SR_CONF_POWER_SUPPLY, | |
36 | /* Acquisition modes. */ | |
37 | SR_CONF_CONTINUOUS, | |
38 | SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, | |
39 | SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET, | |
40 | /* Device configuration */ | |
41 | SR_CONF_VOLTAGE | SR_CONF_GET, | |
42 | SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
43 | SR_CONF_CURRENT | SR_CONF_GET, | |
44 | SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
45 | SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET, | |
b16d975a | 46 | SR_CONF_REGULATION | SR_CONF_GET, |
c40ed60f HV |
47 | SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET, |
48 | SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET, | |
d7083042 HV |
49 | }; |
50 | ||
16fc7ee2 | 51 | static const struct korad_kaxxxxp_model models[] = { |
d7083042 | 52 | /* Device enum, vendor, model, ID reply, channels, voltage, current */ |
ae9ca5b1 UH |
53 | {VELLEMAN_PS3005D, "Velleman", "PS3005D", |
54 | "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}}, | |
55 | {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D", | |
d7083042 | 56 | "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}}, |
bcf9384d | 57 | {KORAD_KA3005P, "Korad", "KA3005P", |
2c5bdf1b | 58 | "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}}, |
a078d3ec UH |
59 | /* Sometimes the KA3005P has an extra 0x01 after the ID. */ |
60 | {KORAD_KA3005P_0X01, "Korad", "KA3005P", | |
61 | "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5, 0.001}}, | |
9e9dba7b | 62 | ALL_ZERO |
d7083042 HV |
63 | }; |
64 | ||
e75ee7de HV |
65 | static GSList *scan(struct sr_dev_driver *di, GSList *options) |
66 | { | |
d7083042 HV |
67 | struct dev_context *devc; |
68 | GSList *devices, *l; | |
69 | struct sr_dev_inst *sdi; | |
70 | struct sr_config *src; | |
71 | const char *conn, *serialcomm; | |
72 | struct sr_serial_dev_inst *serial; | |
73 | char reply[50]; | |
74 | int i, model_id; | |
75 | unsigned int len; | |
e75ee7de HV |
76 | |
77 | devices = NULL; | |
d7083042 HV |
78 | conn = NULL; |
79 | serialcomm = NULL; | |
e75ee7de | 80 | |
d7083042 HV |
81 | for (l = options; l; l = l->next) { |
82 | src = l->data; | |
83 | switch (src->key) { | |
84 | case SR_CONF_CONN: | |
85 | conn = g_variant_get_string(src->data, NULL); | |
86 | break; | |
87 | case SR_CONF_SERIALCOMM: | |
88 | serialcomm = g_variant_get_string(src->data, NULL); | |
89 | break; | |
90 | default: | |
91 | sr_err("Unknown option %d, skipping.", src->key); | |
92 | break; | |
93 | } | |
94 | } | |
95 | ||
96 | if (!conn) | |
97 | return NULL; | |
98 | if (!serialcomm) | |
99 | serialcomm = "9600/8n1"; | |
100 | ||
101 | serial = sr_serial_dev_inst_new(conn, serialcomm); | |
102 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) | |
103 | return NULL; | |
104 | ||
105 | serial_flush(serial); | |
106 | ||
107 | /* Get the device model. */ | |
108 | len = 0; | |
109 | for (i = 0; models[i].id; i++) { | |
110 | if (strlen(models[i].id) > len) | |
111 | len = strlen(models[i].id); | |
112 | } | |
113 | memset(&reply, 0, sizeof(reply)); | |
114 | sr_dbg("Want max %d bytes.", len); | |
16fc7ee2 | 115 | if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0)) |
d7083042 HV |
116 | return NULL; |
117 | ||
118 | /* i is used here for debug purposes only. */ | |
16fc7ee2 | 119 | if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0) |
d7083042 HV |
120 | return NULL; |
121 | sr_dbg("Received: %d, %s", i, reply); | |
122 | model_id = -1; | |
123 | for (i = 0; models[i].id; i++) { | |
124 | if (!strcmp(models[i].id, reply)) | |
125 | model_id = i; | |
126 | } | |
127 | if (model_id < 0) { | |
128 | sr_err("Unknown model ID '%s' detected, aborting.", reply); | |
129 | return NULL; | |
130 | } | |
a078d3ec UH |
131 | sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor, |
132 | models[model_id].name, model_id, models[model_id].id); | |
d7083042 HV |
133 | |
134 | /* Init device instance, etc. */ | |
135 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
136 | sdi->status = SR_ST_INACTIVE; | |
137 | sdi->vendor = g_strdup(models[model_id].vendor); | |
138 | sdi->model = g_strdup(models[model_id].name); | |
139 | sdi->inst_type = SR_INST_SERIAL; | |
140 | sdi->conn = serial; | |
d7083042 HV |
141 | |
142 | sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1"); | |
143 | ||
144 | devc = g_malloc0(sizeof(struct dev_context)); | |
597deef9 | 145 | sr_sw_limits_init(&devc->limits); |
d7083042 HV |
146 | devc->model = &models[model_id]; |
147 | devc->reply[5] = 0; | |
148 | devc->req_sent_at = 0; | |
149 | sdi->priv = devc; | |
150 | ||
151 | /* Get current status of device. */ | |
16fc7ee2 | 152 | if (korad_kaxxxxp_get_all_values(serial, devc) < 0) |
d7083042 | 153 | goto exit_err; |
d7083042 HV |
154 | devices = g_slist_append(devices, sdi); |
155 | ||
156 | serial_close(serial); | |
157 | if (!devices) | |
158 | sr_serial_dev_inst_free(serial); | |
e75ee7de | 159 | |
15a5bfe4 | 160 | return std_scan_complete(di, devices); |
d7083042 HV |
161 | |
162 | exit_err: | |
163 | sr_dev_inst_free(sdi); | |
164 | g_free(devc); | |
165 | sr_dbg("Scan failed."); | |
166 | ||
167 | return NULL; | |
e75ee7de HV |
168 | } |
169 | ||
e75ee7de HV |
170 | static int config_get(uint32_t key, GVariant **data, |
171 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
172 | { | |
d7083042 | 173 | struct dev_context *devc; |
e75ee7de | 174 | |
e75ee7de HV |
175 | (void)cg; |
176 | ||
d7083042 HV |
177 | if (!sdi || !data) |
178 | return SR_ERR_ARG; | |
179 | ||
180 | devc = sdi->priv; | |
181 | ||
e75ee7de | 182 | switch (key) { |
597deef9 | 183 | return sr_sw_limits_config_get(&devc->limits, key, data); |
d7083042 HV |
184 | case SR_CONF_VOLTAGE: |
185 | *data = g_variant_new_double(devc->voltage); | |
186 | break; | |
187 | case SR_CONF_VOLTAGE_TARGET: | |
188 | *data = g_variant_new_double(devc->voltage_max); | |
189 | break; | |
190 | case SR_CONF_CURRENT: | |
191 | *data = g_variant_new_double(devc->current); | |
192 | break; | |
193 | case SR_CONF_CURRENT_LIMIT: | |
194 | *data = g_variant_new_double(devc->current_max); | |
195 | break; | |
196 | case SR_CONF_ENABLED: | |
197 | *data = g_variant_new_boolean(devc->output_enabled); | |
198 | break; | |
b16d975a HV |
199 | case SR_CONF_REGULATION: |
200 | /* Dual channel not supported. */ | |
9e5366df | 201 | *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV"); |
b16d975a | 202 | break; |
c40ed60f | 203 | case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED: |
9e5366df | 204 | *data = g_variant_new_boolean(devc->ocp_enabled); |
c40ed60f HV |
205 | break; |
206 | case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED: | |
9e5366df | 207 | *data = g_variant_new_boolean(devc->ovp_enabled); |
c40ed60f | 208 | break; |
e75ee7de HV |
209 | default: |
210 | return SR_ERR_NA; | |
211 | } | |
212 | ||
d7083042 | 213 | return SR_OK; |
e75ee7de HV |
214 | } |
215 | ||
216 | static int config_set(uint32_t key, GVariant *data, | |
217 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
218 | { | |
d7083042 HV |
219 | struct dev_context *devc; |
220 | double dval; | |
221 | gboolean bval; | |
e75ee7de | 222 | |
e75ee7de HV |
223 | (void)cg; |
224 | ||
225 | if (sdi->status != SR_ST_ACTIVE) | |
226 | return SR_ERR_DEV_CLOSED; | |
227 | ||
d7083042 HV |
228 | devc = sdi->priv; |
229 | ||
e75ee7de | 230 | switch (key) { |
d7083042 | 231 | case SR_CONF_LIMIT_MSEC: |
d7083042 | 232 | case SR_CONF_LIMIT_SAMPLES: |
597deef9 | 233 | return sr_sw_limits_config_set(&devc->limits, key, data); |
d7083042 HV |
234 | case SR_CONF_VOLTAGE_TARGET: |
235 | dval = g_variant_get_double(data); | |
236 | if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1]) | |
237 | return SR_ERR_ARG; | |
238 | devc->voltage_max = dval; | |
16fc7ee2 UH |
239 | devc->target = KAXXXXP_VOLTAGE_MAX; |
240 | if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0) | |
d7083042 HV |
241 | return SR_ERR; |
242 | break; | |
243 | case SR_CONF_CURRENT_LIMIT: | |
244 | dval = g_variant_get_double(data); | |
245 | if (dval < devc->model->current[0] || dval > devc->model->current[1]) | |
246 | return SR_ERR_ARG; | |
247 | devc->current_max = dval; | |
16fc7ee2 UH |
248 | devc->target = KAXXXXP_CURRENT_MAX; |
249 | if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0) | |
d7083042 HV |
250 | return SR_ERR; |
251 | break; | |
252 | case SR_CONF_ENABLED: | |
253 | bval = g_variant_get_boolean(data); | |
254 | /* Set always so it is possible turn off with sigrok-cli. */ | |
255 | devc->output_enabled = bval; | |
16fc7ee2 UH |
256 | devc->target = KAXXXXP_OUTPUT; |
257 | if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0) | |
d7083042 | 258 | return SR_ERR; |
c40ed60f HV |
259 | break; |
260 | case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED: | |
261 | bval = g_variant_get_boolean(data); | |
9e5366df | 262 | devc->ocp_enabled = bval; |
16fc7ee2 UH |
263 | devc->target = KAXXXXP_OCP; |
264 | if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0) | |
c40ed60f HV |
265 | return SR_ERR; |
266 | break; | |
267 | case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED: | |
268 | bval = g_variant_get_boolean(data); | |
9e5366df | 269 | devc->ovp_enabled = bval; |
16fc7ee2 UH |
270 | devc->target = KAXXXXP_OVP; |
271 | if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0) | |
c40ed60f | 272 | return SR_ERR; |
d7083042 | 273 | break; |
e75ee7de | 274 | default: |
d7083042 | 275 | return SR_ERR_NA; |
e75ee7de HV |
276 | } |
277 | ||
d7083042 | 278 | return SR_OK; |
e75ee7de HV |
279 | } |
280 | ||
281 | static int config_list(uint32_t key, GVariant **data, | |
282 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
283 | { | |
d7083042 HV |
284 | struct dev_context *devc; |
285 | GVariant *gvar; | |
286 | GVariantBuilder gvb; | |
287 | double dval; | |
288 | int idx; | |
289 | ||
e75ee7de HV |
290 | (void)cg; |
291 | ||
d7083042 HV |
292 | /* Always available (with or without sdi). */ |
293 | if (key == SR_CONF_SCAN_OPTIONS) { | |
294 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
295 | scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); | |
296 | return SR_OK; | |
297 | } | |
298 | ||
299 | /* Return drvopts without sdi (and devopts with sdi, see below). */ | |
300 | if (key == SR_CONF_DEVICE_OPTIONS && !sdi) { | |
301 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
302 | drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t)); | |
303 | return SR_OK; | |
304 | } | |
305 | ||
306 | /* Every other key needs an sdi. */ | |
307 | if (!sdi) | |
308 | return SR_ERR_ARG; | |
309 | ||
310 | devc = sdi->priv; | |
311 | ||
e75ee7de | 312 | switch (key) { |
d7083042 HV |
313 | case SR_CONF_DEVICE_OPTIONS: |
314 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
315 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); | |
316 | break; | |
317 | case SR_CONF_VOLTAGE_TARGET: | |
318 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
319 | /* Min, max, step. */ | |
320 | for (idx = 0; idx < 3; idx++) { | |
321 | dval = devc->model->voltage[idx]; | |
322 | gvar = g_variant_new_double(dval); | |
323 | g_variant_builder_add_value(&gvb, gvar); | |
324 | } | |
325 | *data = g_variant_builder_end(&gvb); | |
326 | break; | |
327 | case SR_CONF_CURRENT_LIMIT: | |
328 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
329 | /* Min, max, step. */ | |
330 | for (idx = 0; idx < 3; idx++) { | |
331 | dval = devc->model->current[idx]; | |
332 | gvar = g_variant_new_double(dval); | |
333 | g_variant_builder_add_value(&gvb, gvar); | |
334 | } | |
335 | *data = g_variant_builder_end(&gvb); | |
336 | break; | |
e75ee7de HV |
337 | default: |
338 | return SR_ERR_NA; | |
339 | } | |
340 | ||
d7083042 | 341 | return SR_OK; |
e75ee7de HV |
342 | } |
343 | ||
695dc859 | 344 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
e75ee7de | 345 | { |
d7083042 HV |
346 | struct dev_context *devc; |
347 | struct sr_serial_dev_inst *serial; | |
e75ee7de HV |
348 | |
349 | if (sdi->status != SR_ST_ACTIVE) | |
350 | return SR_ERR_DEV_CLOSED; | |
351 | ||
d7083042 | 352 | devc = sdi->priv; |
d7083042 | 353 | |
597deef9 | 354 | sr_sw_limits_acquisition_start(&devc->limits); |
695dc859 | 355 | std_session_send_df_header(sdi, LOG_PREFIX); |
d7083042 | 356 | |
d7083042 HV |
357 | devc->reply_pending = FALSE; |
358 | devc->req_sent_at = 0; | |
359 | serial = sdi->conn; | |
360 | serial_source_add(sdi->session, serial, G_IO_IN, | |
16fc7ee2 UH |
361 | KAXXXXP_POLL_INTERVAL_MS, |
362 | korad_kaxxxxp_receive_data, (void *)sdi); | |
e75ee7de HV |
363 | |
364 | return SR_OK; | |
365 | } | |
366 | ||
695dc859 | 367 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
e75ee7de | 368 | { |
e75ee7de HV |
369 | if (sdi->status != SR_ST_ACTIVE) |
370 | return SR_ERR_DEV_CLOSED; | |
371 | ||
6525d819 | 372 | return std_serial_dev_acquisition_stop(sdi, |
d7083042 | 373 | std_serial_dev_close, sdi->conn, LOG_PREFIX); |
e75ee7de HV |
374 | } |
375 | ||
dd5c48a6 | 376 | static struct sr_dev_driver korad_kaxxxxp_driver_info = { |
16fc7ee2 UH |
377 | .name = "korad-kaxxxxp", |
378 | .longname = "Korad KAxxxxP", | |
e75ee7de | 379 | .api_version = 1, |
c2fdcc25 | 380 | .init = std_init, |
700d6b64 | 381 | .cleanup = std_cleanup, |
e75ee7de | 382 | .scan = scan, |
c01bf34c | 383 | .dev_list = std_dev_list, |
e75ee7de HV |
384 | .config_get = config_get, |
385 | .config_set = config_set, | |
386 | .config_list = config_list, | |
d7083042 HV |
387 | .dev_open = std_serial_dev_open, |
388 | .dev_close = std_serial_dev_close, | |
e75ee7de HV |
389 | .dev_acquisition_start = dev_acquisition_start, |
390 | .dev_acquisition_stop = dev_acquisition_stop, | |
391 | .context = NULL, | |
392 | }; | |
dd5c48a6 | 393 | SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info); |