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