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