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