]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2014 Bert Vermeulen <bert@biot.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 <string.h> | |
22 | #include "protocol.h" | |
23 | ||
24 | /* | |
25 | * The default serial communication settings on the device are 9600 | |
26 | * baud, 9 data bits. The 9th bit isn't actually used, and the vendor | |
27 | * software uses Mark parity to absorb the extra bit. | |
28 | * | |
29 | * Since 9 data bits is not a standard available in POSIX, we use two | |
30 | * stop bits to skip over the extra bit instead. | |
31 | */ | |
32 | #define SERIALCOMM "9600/8n2" | |
33 | ||
34 | static const uint32_t scanopts[] = { | |
35 | SR_CONF_CONN, | |
36 | SR_CONF_SERIALCOMM, | |
37 | }; | |
38 | ||
39 | static const uint32_t drvopts[] = { | |
40 | SR_CONF_POWER_SUPPLY, | |
41 | }; | |
42 | ||
43 | static const uint32_t devopts[] = { | |
44 | SR_CONF_CONTINUOUS | SR_CONF_SET, | |
45 | SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
46 | SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET, | |
47 | }; | |
48 | ||
49 | static const uint32_t devopts_cg[] = { | |
50 | SR_CONF_VOLTAGE | SR_CONF_GET, | |
51 | SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
52 | SR_CONF_CURRENT | SR_CONF_GET, | |
53 | SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
54 | SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET, | |
55 | }; | |
56 | ||
57 | static const char *channel_modes[] = { | |
58 | "Independent", | |
59 | "Series", | |
60 | "Parallel", | |
61 | }; | |
62 | ||
63 | static const struct pps_model models[] = { | |
64 | { PPS_3203T_3S, "PPS3203T-3S", | |
65 | CHANMODE_INDEPENDENT | CHANMODE_SERIES | CHANMODE_PARALLEL, | |
66 | 3, | |
67 | { | |
68 | /* Channel 1 */ | |
69 | { { 0, 32, 0.01 }, { 0, 3, 0.001 } }, | |
70 | /* Channel 2 */ | |
71 | { { 0, 32, 0.01 }, { 0, 3, 0.001 } }, | |
72 | /* Channel 3 */ | |
73 | { { 0, 6, 0.01 }, { 0, 3, 0.001 } }, | |
74 | }, | |
75 | }, | |
76 | }; | |
77 | ||
78 | SR_PRIV struct sr_dev_driver atten_pps3203_driver_info; | |
79 | ||
80 | static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx) | |
81 | { | |
82 | return std_init(sr_ctx, di, LOG_PREFIX); | |
83 | } | |
84 | ||
85 | static GSList *scan(struct sr_dev_driver *di, GSList *options, int modelid) | |
86 | { | |
87 | struct sr_dev_inst *sdi; | |
88 | struct drv_context *drvc; | |
89 | struct dev_context *devc; | |
90 | struct sr_config *src; | |
91 | struct sr_channel *ch; | |
92 | struct sr_channel_group *cg; | |
93 | struct sr_serial_dev_inst *serial; | |
94 | GSList *l, *devices; | |
95 | const struct pps_model *model; | |
96 | uint8_t packet[PACKET_SIZE]; | |
97 | unsigned int i; | |
98 | int delay_ms, ret; | |
99 | const char *conn, *serialcomm; | |
100 | char channel[10]; | |
101 | ||
102 | devices = NULL; | |
103 | drvc = di->context; | |
104 | drvc->instances = NULL; | |
105 | ||
106 | conn = serialcomm = NULL; | |
107 | for (l = options; l; l = l->next) { | |
108 | src = l->data; | |
109 | switch (src->key) { | |
110 | case SR_CONF_CONN: | |
111 | conn = g_variant_get_string(src->data, NULL); | |
112 | break; | |
113 | case SR_CONF_SERIALCOMM: | |
114 | serialcomm = g_variant_get_string(src->data, NULL); | |
115 | break; | |
116 | } | |
117 | } | |
118 | if (!conn) | |
119 | return NULL; | |
120 | if (!serialcomm) | |
121 | serialcomm = SERIALCOMM; | |
122 | ||
123 | serial = sr_serial_dev_inst_new(conn, serialcomm); | |
124 | ||
125 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) | |
126 | return NULL; | |
127 | ||
128 | serial_flush(serial); | |
129 | ||
130 | /* This is how the vendor software scans for hardware. */ | |
131 | memset(packet, 0, PACKET_SIZE); | |
132 | packet[0] = 0xaa; | |
133 | packet[1] = 0xaa; | |
134 | delay_ms = serial_timeout(serial, PACKET_SIZE); | |
135 | if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) { | |
136 | sr_err("Unable to write while probing for hardware."); | |
137 | return NULL; | |
138 | } | |
139 | /* The device responds with a 24-byte packet when it receives a packet. | |
140 | * At 9600 baud, 300ms is long enough for it to have arrived. */ | |
141 | g_usleep(300 * 1000); | |
142 | memset(packet, 0, PACKET_SIZE); | |
143 | if ((ret = serial_read_nonblocking(serial, packet, PACKET_SIZE)) < 0) { | |
144 | sr_err("Unable to read while probing for hardware: %s", | |
145 | sr_strerror(ret)); | |
146 | return NULL; | |
147 | } | |
148 | if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) { | |
149 | /* Doesn't look like an Atten PPS. */ | |
150 | return NULL; | |
151 | } | |
152 | ||
153 | model = NULL; | |
154 | for (i = 0; i < ARRAY_SIZE(models); i++) { | |
155 | if (models[i].modelid == modelid) { | |
156 | model = &models[i]; | |
157 | break; | |
158 | } | |
159 | } | |
160 | if (!model) { | |
161 | sr_err("Unknown modelid %d", modelid); | |
162 | return NULL; | |
163 | } | |
164 | ||
165 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
166 | sdi->status = SR_ST_INACTIVE; | |
167 | sdi->vendor = g_strdup("Atten"); | |
168 | sdi->model = g_strdup(model->name); | |
169 | sdi->driver = di; | |
170 | sdi->inst_type = SR_INST_SERIAL; | |
171 | sdi->conn = serial; | |
172 | for (i = 0; i < MAX_CHANNELS; i++) { | |
173 | snprintf(channel, 10, "CH%d", i + 1); | |
174 | ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel); | |
175 | cg = g_malloc(sizeof(struct sr_channel_group)); | |
176 | cg->name = g_strdup(channel); | |
177 | cg->channels = g_slist_append(NULL, ch); | |
178 | cg->priv = NULL; | |
179 | sdi->channel_groups = g_slist_append(sdi->channel_groups, cg); | |
180 | } | |
181 | ||
182 | devc = g_malloc0(sizeof(struct dev_context)); | |
183 | devc->model = model; | |
184 | devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels); | |
185 | devc->delay_ms = delay_ms; | |
186 | sdi->priv = devc; | |
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; | |
195 | } | |
196 | ||
197 | static GSList *scan_3203(struct sr_dev_driver *di, GSList *options) | |
198 | { | |
199 | return scan(di, options, PPS_3203T_3S); | |
200 | } | |
201 | ||
202 | static GSList *dev_list(const struct sr_dev_driver *di) | |
203 | { | |
204 | return ((struct drv_context *)(di->context))->instances; | |
205 | } | |
206 | ||
207 | static int cleanup(const struct sr_dev_driver *di) | |
208 | { | |
209 | return std_dev_clear(di, NULL); | |
210 | } | |
211 | ||
212 | static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, | |
213 | const struct sr_channel_group *cg) | |
214 | { | |
215 | struct dev_context *devc; | |
216 | struct sr_channel *ch; | |
217 | int channel, ret; | |
218 | ||
219 | if (!sdi) | |
220 | return SR_ERR_ARG; | |
221 | ||
222 | devc = sdi->priv; | |
223 | ||
224 | ret = SR_OK; | |
225 | if (!cg) { | |
226 | /* No channel group: global options. */ | |
227 | switch (key) { | |
228 | case SR_CONF_CHANNEL_CONFIG: | |
229 | *data = g_variant_new_string(channel_modes[devc->channel_mode]); | |
230 | break; | |
231 | case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED: | |
232 | *data = g_variant_new_boolean(devc->over_current_protection); | |
233 | break; | |
234 | default: | |
235 | return SR_ERR_NA; | |
236 | } | |
237 | } else { | |
238 | /* We only ever have one channel per channel group in this driver. */ | |
239 | ch = cg->channels->data; | |
240 | channel = ch->index; | |
241 | ||
242 | switch (key) { | |
243 | case SR_CONF_VOLTAGE: | |
244 | *data = g_variant_new_double(devc->config[channel].output_voltage_last); | |
245 | break; | |
246 | case SR_CONF_VOLTAGE_TARGET: | |
247 | *data = g_variant_new_double(devc->config[channel].output_voltage_max); | |
248 | break; | |
249 | case SR_CONF_CURRENT: | |
250 | *data = g_variant_new_double(devc->config[channel].output_current_last); | |
251 | break; | |
252 | case SR_CONF_CURRENT_LIMIT: | |
253 | *data = g_variant_new_double(devc->config[channel].output_current_max); | |
254 | break; | |
255 | case SR_CONF_ENABLED: | |
256 | *data = g_variant_new_boolean(devc->config[channel].output_enabled); | |
257 | break; | |
258 | default: | |
259 | return SR_ERR_NA; | |
260 | } | |
261 | } | |
262 | ||
263 | return ret; | |
264 | } | |
265 | ||
266 | static int find_str(const char *str, const char **strings, int array_size) | |
267 | { | |
268 | int idx, i; | |
269 | ||
270 | idx = -1; | |
271 | for (i = 0; i < array_size; i++) { | |
272 | if (!strcmp(str, strings[i])) { | |
273 | idx = i; | |
274 | break; | |
275 | } | |
276 | } | |
277 | ||
278 | return idx; | |
279 | } | |
280 | ||
281 | static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, | |
282 | const struct sr_channel_group *cg) | |
283 | { | |
284 | struct dev_context *devc; | |
285 | struct sr_channel *ch; | |
286 | gdouble dval; | |
287 | int channel, ret, ival; | |
288 | const char *sval; | |
289 | gboolean bval; | |
290 | ||
291 | if (sdi->status != SR_ST_ACTIVE) | |
292 | return SR_ERR_DEV_CLOSED; | |
293 | ||
294 | ret = SR_OK; | |
295 | devc = sdi->priv; | |
296 | if (!cg) { | |
297 | /* No channel group: global options. */ | |
298 | switch (key) { | |
299 | case SR_CONF_CHANNEL_CONFIG: | |
300 | sval = g_variant_get_string(data, NULL); | |
301 | if ((ival = find_str(sval, channel_modes, | |
302 | ARRAY_SIZE(channel_modes))) == -1) { | |
303 | ret = SR_ERR_ARG; | |
304 | break; | |
305 | } | |
306 | if (devc->model->channel_modes && (1 << ival) == 0) { | |
307 | /* Not supported on this model. */ | |
308 | ret = SR_ERR_ARG; | |
309 | } | |
310 | if (ival == devc->channel_mode_set) | |
311 | /* Nothing to do. */ | |
312 | break; | |
313 | devc->channel_mode_set = ival; | |
314 | devc->config_dirty = TRUE; | |
315 | break; | |
316 | case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED: | |
317 | bval = g_variant_get_boolean(data); | |
318 | if (bval == devc->over_current_protection_set) | |
319 | /* Nothing to do. */ | |
320 | break; | |
321 | devc->over_current_protection_set = bval; | |
322 | devc->config_dirty = TRUE; | |
323 | break; | |
324 | default: | |
325 | return SR_ERR_NA; | |
326 | } | |
327 | } else { | |
328 | /* Channel group specified: per-channel options. */ | |
329 | /* We only ever have one channel per channel group in this driver. */ | |
330 | ch = cg->channels->data; | |
331 | channel = ch->index; | |
332 | ||
333 | switch (key) { | |
334 | case SR_CONF_VOLTAGE_TARGET: | |
335 | dval = g_variant_get_double(data); | |
336 | if (dval < 0 || dval > devc->model->channels[channel].voltage[1]) | |
337 | ret = SR_ERR_ARG; | |
338 | devc->config[channel].output_voltage_max = dval; | |
339 | devc->config_dirty = TRUE; | |
340 | break; | |
341 | case SR_CONF_CURRENT_LIMIT: | |
342 | dval = g_variant_get_double(data); | |
343 | if (dval < 0 || dval > devc->model->channels[channel].current[1]) | |
344 | ret = SR_ERR_ARG; | |
345 | devc->config[channel].output_current_max = dval; | |
346 | devc->config_dirty = TRUE; | |
347 | break; | |
348 | case SR_CONF_ENABLED: | |
349 | bval = g_variant_get_boolean(data); | |
350 | if (bval == devc->config[channel].output_enabled_set) | |
351 | /* Nothing to do. */ | |
352 | break; | |
353 | devc->config[channel].output_enabled_set = bval; | |
354 | devc->config_dirty = TRUE; | |
355 | break; | |
356 | default: | |
357 | ret = SR_ERR_NA; | |
358 | } | |
359 | } | |
360 | ||
361 | return ret; | |
362 | } | |
363 | ||
364 | static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, | |
365 | const struct sr_channel_group *cg) | |
366 | { | |
367 | struct dev_context *devc; | |
368 | struct sr_channel *ch; | |
369 | GVariant *gvar; | |
370 | GVariantBuilder gvb; | |
371 | int channel, ret, i; | |
372 | ||
373 | /* Always available. */ | |
374 | if (key == SR_CONF_SCAN_OPTIONS) { | |
375 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
376 | scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); | |
377 | return SR_OK; | |
378 | } | |
379 | ||
380 | if (key == SR_CONF_DEVICE_OPTIONS && !sdi) { | |
381 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
382 | drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t)); | |
383 | return SR_OK; | |
384 | } | |
385 | ||
386 | if (!sdi) | |
387 | return SR_ERR_ARG; | |
388 | ||
389 | devc = sdi->priv; | |
390 | ret = SR_OK; | |
391 | if (!cg) { | |
392 | /* No channel group: global options. */ | |
393 | switch (key) { | |
394 | case SR_CONF_DEVICE_OPTIONS: | |
395 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
396 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); | |
397 | break; | |
398 | case SR_CONF_CHANNEL_CONFIG: | |
399 | if (devc->model->channel_modes == CHANMODE_INDEPENDENT) { | |
400 | /* The 1-channel models. */ | |
401 | *data = g_variant_new_strv(channel_modes, 1); | |
402 | } else { | |
403 | /* The other models support all modes. */ | |
404 | *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes)); | |
405 | } | |
406 | break; | |
407 | default: | |
408 | return SR_ERR_NA; | |
409 | } | |
410 | } else { | |
411 | /* Channel group specified: per-channel options. */ | |
412 | if (!sdi) | |
413 | return SR_ERR_ARG; | |
414 | /* We only ever have one channel per channel group in this driver. */ | |
415 | ch = cg->channels->data; | |
416 | channel = ch->index; | |
417 | ||
418 | switch (key) { | |
419 | case SR_CONF_DEVICE_OPTIONS: | |
420 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
421 | devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t)); | |
422 | break; | |
423 | case SR_CONF_VOLTAGE_TARGET: | |
424 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
425 | /* Min, max, step. */ | |
426 | for (i = 0; i < 3; i++) { | |
427 | gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]); | |
428 | g_variant_builder_add_value(&gvb, gvar); | |
429 | } | |
430 | *data = g_variant_builder_end(&gvb); | |
431 | break; | |
432 | case SR_CONF_CURRENT_LIMIT: | |
433 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
434 | /* Min, max, step. */ | |
435 | for (i = 0; i < 3; i++) { | |
436 | gvar = g_variant_new_double(devc->model->channels[channel].current[i]); | |
437 | g_variant_builder_add_value(&gvb, gvar); | |
438 | } | |
439 | *data = g_variant_builder_end(&gvb); | |
440 | break; | |
441 | default: | |
442 | return SR_ERR_NA; | |
443 | } | |
444 | } | |
445 | ||
446 | return ret; | |
447 | } | |
448 | ||
449 | static int dev_close(struct sr_dev_inst *sdi) | |
450 | { | |
451 | struct dev_context *devc; | |
452 | ||
453 | devc = sdi->priv; | |
454 | if (devc->config_dirty) | |
455 | /* Some configuration changes were queued up but didn't | |
456 | * get sent to the device, likely because we were never | |
457 | * in acquisition mode. Send them out now. */ | |
458 | send_config(sdi); | |
459 | ||
460 | return std_serial_dev_close(sdi); | |
461 | } | |
462 | ||
463 | static int dev_acquisition_start(const struct sr_dev_inst *sdi, | |
464 | void *cb_data) | |
465 | { | |
466 | struct dev_context *devc; | |
467 | struct sr_serial_dev_inst *serial; | |
468 | uint8_t packet[PACKET_SIZE]; | |
469 | ||
470 | (void)cb_data; | |
471 | ||
472 | if (sdi->status != SR_ST_ACTIVE) | |
473 | return SR_ERR_DEV_CLOSED; | |
474 | ||
475 | devc = sdi->priv; | |
476 | memset(devc->packet, 0x44, PACKET_SIZE); | |
477 | devc->packet_size = 0; | |
478 | ||
479 | devc->acquisition_running = TRUE; | |
480 | ||
481 | serial = sdi->conn; | |
482 | serial_source_add(sdi->session, serial, G_IO_IN, 50, | |
483 | atten_pps3xxx_receive_data, (void *)sdi); | |
484 | std_session_send_df_header(cb_data, LOG_PREFIX); | |
485 | ||
486 | /* Send a "channel" configuration packet now. */ | |
487 | memset(packet, 0, PACKET_SIZE); | |
488 | packet[0] = 0xaa; | |
489 | packet[1] = 0xaa; | |
490 | send_packet(sdi, packet); | |
491 | ||
492 | return SR_OK; | |
493 | } | |
494 | ||
495 | static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) | |
496 | { | |
497 | struct dev_context *devc; | |
498 | ||
499 | (void)cb_data; | |
500 | ||
501 | if (sdi->status != SR_ST_ACTIVE) | |
502 | return SR_ERR_DEV_CLOSED; | |
503 | ||
504 | devc = sdi->priv; | |
505 | devc->acquisition_running = FALSE; | |
506 | ||
507 | return SR_OK; | |
508 | } | |
509 | ||
510 | SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = { | |
511 | .name = "atten-pps3203", | |
512 | .longname = "Atten PPS3203T-3S", | |
513 | .api_version = 1, | |
514 | .init = init, | |
515 | .cleanup = cleanup, | |
516 | .scan = scan_3203, | |
517 | .dev_list = dev_list, | |
518 | .dev_clear = NULL, | |
519 | .config_get = config_get, | |
520 | .config_set = config_set, | |
521 | .config_list = config_list, | |
522 | .dev_open = std_serial_dev_open, | |
523 | .dev_close = dev_close, | |
524 | .dev_acquisition_start = dev_acquisition_start, | |
525 | .dev_acquisition_stop = dev_acquisition_stop, | |
526 | .context = NULL, | |
527 | }; |