]> sigrok.org Git - libsigrok.git/blame - src/hardware/atten-pps3xxx/api.c
Add helper function for scan completion
[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->inst_type = SR_INST_SERIAL;
162 sdi->conn = serial;
163 for (i = 0; i < MAX_CHANNELS; i++) {
164 snprintf(channel, 10, "CH%d", i + 1);
5e23fcab 165 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
40fd0264
UH
166 cg = g_malloc(sizeof(struct sr_channel_group));
167 cg->name = g_strdup(channel);
ba7dd8bb 168 cg->channels = g_slist_append(NULL, ch);
40fd0264
UH
169 cg->priv = NULL;
170 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
33c40990
BV
171 }
172
173 devc = g_malloc0(sizeof(struct dev_context));
174 devc->model = model;
175 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
2eb1612d 176 devc->delay_ms = delay_ms;
33c40990 177 sdi->priv = devc;
33c40990
BV
178 devices = g_slist_append(devices, sdi);
179
180 serial_close(serial);
181 if (!devices)
182 sr_serial_dev_inst_free(serial);
fa0d6afe 183
15a5bfe4 184 return std_scan_complete(di, devices);
fa0d6afe
BV
185}
186
4f840ce9 187static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
33c40990 188{
4f840ce9 189 return scan(di, options, PPS_3203T_3S);
33c40990
BV
190}
191
584560f1 192static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 193 const struct sr_channel_group *cg)
fa0d6afe 194{
33c40990 195 struct dev_context *devc;
ba7dd8bb 196 struct sr_channel *ch;
33c40990
BV
197 int channel, ret;
198
199 if (!sdi)
200 return SR_ERR_ARG;
fa0d6afe 201
33c40990 202 devc = sdi->priv;
fa0d6afe
BV
203
204 ret = SR_OK;
53b4680f 205 if (!cg) {
660e398f 206 /* No channel group: global options. */
33c40990 207 switch (key) {
7a0b98b5 208 case SR_CONF_CHANNEL_CONFIG:
fe997353 209 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
33c40990 210 break;
a1eaa9e0 211 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
33c40990
BV
212 *data = g_variant_new_boolean(devc->over_current_protection);
213 break;
214 default:
215 return SR_ERR_NA;
216 }
217 } else {
660e398f 218 /* We only ever have one channel per channel group in this driver. */
ba7dd8bb
UH
219 ch = cg->channels->data;
220 channel = ch->index;
33c40990
BV
221
222 switch (key) {
7a0b98b5 223 case SR_CONF_VOLTAGE:
33c40990
BV
224 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
225 break;
7a0b98b5 226 case SR_CONF_VOLTAGE_TARGET:
33c40990
BV
227 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
228 break;
7a0b98b5 229 case SR_CONF_CURRENT:
33c40990
BV
230 *data = g_variant_new_double(devc->config[channel].output_current_last);
231 break;
7a0b98b5 232 case SR_CONF_CURRENT_LIMIT:
33c40990
BV
233 *data = g_variant_new_double(devc->config[channel].output_current_max);
234 break;
7a0b98b5 235 case SR_CONF_ENABLED:
33c40990
BV
236 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
237 break;
238 default:
239 return SR_ERR_NA;
240 }
fa0d6afe
BV
241 }
242
243 return ret;
244}
245
33c40990
BV
246static int find_str(const char *str, const char **strings, int array_size)
247{
248 int idx, i;
249
250 idx = -1;
251 for (i = 0; i < array_size; i++) {
252 if (!strcmp(str, strings[i])) {
253 idx = i;
254 break;
255 }
256 }
257
258 return idx;
259}
260
584560f1 261static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 262 const struct sr_channel_group *cg)
fa0d6afe 263{
33c40990 264 struct dev_context *devc;
ba7dd8bb 265 struct sr_channel *ch;
33c40990
BV
266 gdouble dval;
267 int channel, ret, ival;
268 const char *sval;
269 gboolean bval;
fa0d6afe
BV
270
271 if (sdi->status != SR_ST_ACTIVE)
272 return SR_ERR_DEV_CLOSED;
273
274 ret = SR_OK;
33c40990 275 devc = sdi->priv;
53b4680f 276 if (!cg) {
660e398f 277 /* No channel group: global options. */
33c40990 278 switch (key) {
7a0b98b5 279 case SR_CONF_CHANNEL_CONFIG:
33c40990
BV
280 sval = g_variant_get_string(data, NULL);
281 if ((ival = find_str(sval, channel_modes,
282 ARRAY_SIZE(channel_modes))) == -1) {
283 ret = SR_ERR_ARG;
284 break;
285 }
286 if (devc->model->channel_modes && (1 << ival) == 0) {
287 /* Not supported on this model. */
288 ret = SR_ERR_ARG;
289 }
290 if (ival == devc->channel_mode_set)
291 /* Nothing to do. */
292 break;
293 devc->channel_mode_set = ival;
ab988ecb 294 devc->config_dirty = TRUE;
33c40990 295 break;
a1eaa9e0 296 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
33c40990
BV
297 bval = g_variant_get_boolean(data);
298 if (bval == devc->over_current_protection_set)
299 /* Nothing to do. */
300 break;
301 devc->over_current_protection_set = bval;
ab988ecb 302 devc->config_dirty = TRUE;
33c40990
BV
303 break;
304 default:
305 return SR_ERR_NA;
306 }
307 } else {
660e398f
UH
308 /* Channel group specified: per-channel options. */
309 /* We only ever have one channel per channel group in this driver. */
ba7dd8bb
UH
310 ch = cg->channels->data;
311 channel = ch->index;
33c40990
BV
312
313 switch (key) {
7a0b98b5 314 case SR_CONF_VOLTAGE_TARGET:
33c40990
BV
315 dval = g_variant_get_double(data);
316 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
317 ret = SR_ERR_ARG;
318 devc->config[channel].output_voltage_max = dval;
ab988ecb 319 devc->config_dirty = TRUE;
33c40990 320 break;
7a0b98b5 321 case SR_CONF_CURRENT_LIMIT:
33c40990
BV
322 dval = g_variant_get_double(data);
323 if (dval < 0 || dval > devc->model->channels[channel].current[1])
324 ret = SR_ERR_ARG;
325 devc->config[channel].output_current_max = dval;
ab988ecb 326 devc->config_dirty = TRUE;
33c40990 327 break;
7a0b98b5 328 case SR_CONF_ENABLED:
33c40990
BV
329 bval = g_variant_get_boolean(data);
330 if (bval == devc->config[channel].output_enabled_set)
331 /* Nothing to do. */
332 break;
333 devc->config[channel].output_enabled_set = bval;
ab988ecb 334 devc->config_dirty = TRUE;
33c40990
BV
335 break;
336 default:
337 ret = SR_ERR_NA;
338 }
fa0d6afe
BV
339 }
340
341 return ret;
342}
343
584560f1 344static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 345 const struct sr_channel_group *cg)
fa0d6afe 346{
33c40990 347 struct dev_context *devc;
ba7dd8bb 348 struct sr_channel *ch;
33c40990
BV
349 GVariant *gvar;
350 GVariantBuilder gvb;
351 int channel, ret, i;
352
d6fa8ace 353 /* Always available. */
33c40990 354 if (key == SR_CONF_SCAN_OPTIONS) {
584560f1
BV
355 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
356 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
33c40990
BV
357 return SR_OK;
358 }
359
d6fa8ace
BV
360 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
361 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
1f889afd 362 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
d6fa8ace
BV
363 return SR_OK;
364 }
365
e22aa878
BV
366 if (!sdi)
367 return SR_ERR_ARG;
fa0d6afe 368
d6fa8ace 369 devc = sdi->priv;
fa0d6afe 370 ret = SR_OK;
53b4680f 371 if (!cg) {
660e398f 372 /* No channel group: global options. */
33c40990
BV
373 switch (key) {
374 case SR_CONF_DEVICE_OPTIONS:
584560f1 375 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
1f889afd 376 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
33c40990 377 break;
7a0b98b5 378 case SR_CONF_CHANNEL_CONFIG:
33c40990
BV
379 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
380 /* The 1-channel models. */
381 *data = g_variant_new_strv(channel_modes, 1);
382 } else {
383 /* The other models support all modes. */
384 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
385 }
386 break;
387 default:
388 return SR_ERR_NA;
389 }
390 } else {
660e398f 391 /* Channel group specified: per-channel options. */
33c40990
BV
392 if (!sdi)
393 return SR_ERR_ARG;
660e398f 394 /* We only ever have one channel per channel group in this driver. */
ba7dd8bb
UH
395 ch = cg->channels->data;
396 channel = ch->index;
33c40990
BV
397
398 switch (key) {
399 case SR_CONF_DEVICE_OPTIONS:
584560f1
BV
400 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
401 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
33c40990 402 break;
7a0b98b5 403 case SR_CONF_VOLTAGE_TARGET:
33c40990
BV
404 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
405 /* Min, max, step. */
406 for (i = 0; i < 3; i++) {
407 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
408 g_variant_builder_add_value(&gvb, gvar);
409 }
410 *data = g_variant_builder_end(&gvb);
411 break;
7a0b98b5 412 case SR_CONF_CURRENT_LIMIT:
33c40990
BV
413 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
414 /* Min, max, step. */
415 for (i = 0; i < 3; i++) {
416 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
417 g_variant_builder_add_value(&gvb, gvar);
418 }
419 *data = g_variant_builder_end(&gvb);
420 break;
421 default:
422 return SR_ERR_NA;
423 }
fa0d6afe
BV
424 }
425
426 return ret;
427}
428
ab988ecb
BV
429static int dev_close(struct sr_dev_inst *sdi)
430{
431 struct dev_context *devc;
432
433 devc = sdi->priv;
434 if (devc->config_dirty)
435 /* Some configuration changes were queued up but didn't
436 * get sent to the device, likely because we were never
437 * in acquisition mode. Send them out now. */
438 send_config(sdi);
439
440 return std_serial_dev_close(sdi);
441}
442
695dc859 443static int dev_acquisition_start(const struct sr_dev_inst *sdi)
fa0d6afe 444{
33c40990
BV
445 struct dev_context *devc;
446 struct sr_serial_dev_inst *serial;
447 uint8_t packet[PACKET_SIZE];
448
fa0d6afe
BV
449 if (sdi->status != SR_ST_ACTIVE)
450 return SR_ERR_DEV_CLOSED;
451
33c40990
BV
452 devc = sdi->priv;
453 memset(devc->packet, 0x44, PACKET_SIZE);
454 devc->packet_size = 0;
455
456 devc->acquisition_running = TRUE;
457
458 serial = sdi->conn;
102f1239
BV
459 serial_source_add(sdi->session, serial, G_IO_IN, 50,
460 atten_pps3xxx_receive_data, (void *)sdi);
695dc859 461 std_session_send_df_header(sdi, LOG_PREFIX);
33c40990 462
ba7dd8bb 463 /* Send a "channel" configuration packet now. */
33c40990
BV
464 memset(packet, 0, PACKET_SIZE);
465 packet[0] = 0xaa;
466 packet[1] = 0xaa;
467 send_packet(sdi, packet);
fa0d6afe
BV
468
469 return SR_OK;
470}
471
695dc859 472static int dev_acquisition_stop(struct sr_dev_inst *sdi)
fa0d6afe 473{
33c40990
BV
474 struct dev_context *devc;
475
fa0d6afe
BV
476 if (sdi->status != SR_ST_ACTIVE)
477 return SR_ERR_DEV_CLOSED;
478
33c40990
BV
479 devc = sdi->priv;
480 devc->acquisition_running = FALSE;
fa0d6afe
BV
481
482 return SR_OK;
483}
484
dd5c48a6 485static struct sr_dev_driver atten_pps3203_driver_info = {
33c40990
BV
486 .name = "atten-pps3203",
487 .longname = "Atten PPS3203T-3S",
fa0d6afe 488 .api_version = 1,
c2fdcc25 489 .init = std_init,
700d6b64 490 .cleanup = std_cleanup,
33c40990 491 .scan = scan_3203,
c01bf34c 492 .dev_list = std_dev_list,
a6630742 493 .dev_clear = NULL,
fa0d6afe
BV
494 .config_get = config_get,
495 .config_set = config_set,
496 .config_list = config_list,
33c40990 497 .dev_open = std_serial_dev_open,
ab988ecb 498 .dev_close = dev_close,
fa0d6afe
BV
499 .dev_acquisition_start = dev_acquisition_start,
500 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 501 .context = NULL,
fa0d6afe 502};
dd5c48a6 503SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info);