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