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