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