2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 * The default serial communication settings on the device are 9600
25 * baud, 9 data bits. The 9th bit isn't actually used, and the vendor
26 * software uses Mark parity to absorb the extra bit.
28 * Since 9 data bits is not a standard available in POSIX, we use two
29 * stop bits to skip over the extra bit instead.
31 #define SERIALCOMM "9600/8n2"
33 static const uint32_t scanopts[] = {
38 static const uint32_t drvopts[] = {
42 static const uint32_t devopts[] = {
43 SR_CONF_CONTINUOUS | SR_CONF_SET,
44 SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
45 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
48 static const uint32_t devopts_cg[] = {
49 SR_CONF_VOLTAGE | SR_CONF_GET,
50 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
51 SR_CONF_CURRENT | SR_CONF_GET,
52 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
53 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
56 static const char *channel_modes[] = {
62 static const struct pps_model models[] = {
63 { PPS_3203T_3S, "PPS3203T-3S",
64 CHANMODE_INDEPENDENT | CHANMODE_SERIES | CHANMODE_PARALLEL,
68 { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
70 { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
72 { { 0, 6, 0.01 }, { 0, 3, 0.001 } },
77 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
79 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
81 return std_init(sr_ctx, di, LOG_PREFIX);
84 static GSList *scan(struct sr_dev_driver *di, GSList *options, int modelid)
86 struct sr_dev_inst *sdi;
87 struct drv_context *drvc;
88 struct dev_context *devc;
89 struct sr_config *src;
90 struct sr_channel *ch;
91 struct sr_channel_group *cg;
92 struct sr_serial_dev_inst *serial;
94 const struct pps_model *model;
95 uint8_t packet[PACKET_SIZE];
98 const char *conn, *serialcomm;
103 drvc->instances = NULL;
105 conn = serialcomm = NULL;
106 for (l = options; l; l = l->next) {
110 conn = g_variant_get_string(src->data, NULL);
112 case SR_CONF_SERIALCOMM:
113 serialcomm = g_variant_get_string(src->data, NULL);
120 serialcomm = SERIALCOMM;
122 serial = sr_serial_dev_inst_new(conn, serialcomm);
124 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
127 serial_flush(serial);
129 /* This is how the vendor software scans for hardware. */
130 memset(packet, 0, PACKET_SIZE);
133 delay_ms = serial_timeout(serial, PACKET_SIZE);
134 if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) {
135 sr_err("Unable to write while probing for hardware.");
138 /* The device responds with a 24-byte packet when it receives a packet.
139 * At 9600 baud, 300ms is long enough for it to have arrived. */
140 g_usleep(300 * 1000);
141 memset(packet, 0, PACKET_SIZE);
142 if ((ret = serial_read_nonblocking(serial, packet, PACKET_SIZE)) < 0) {
143 sr_err("Unable to read while probing for hardware: %s",
147 if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
148 /* Doesn't look like an Atten PPS. */
153 for (i = 0; i < ARRAY_SIZE(models); i++) {
154 if (models[i].modelid == modelid) {
160 sr_err("Unknown modelid %d", modelid);
164 sdi = g_malloc0(sizeof(struct sr_dev_inst));
165 sdi->status = SR_ST_INACTIVE;
166 sdi->vendor = g_strdup("Atten");
167 sdi->model = g_strdup(model->name);
169 sdi->inst_type = SR_INST_SERIAL;
171 for (i = 0; i < MAX_CHANNELS; i++) {
172 snprintf(channel, 10, "CH%d", i + 1);
173 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
174 cg = g_malloc(sizeof(struct sr_channel_group));
175 cg->name = g_strdup(channel);
176 cg->channels = g_slist_append(NULL, ch);
178 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
181 devc = g_malloc0(sizeof(struct dev_context));
183 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
184 devc->delay_ms = delay_ms;
186 drvc->instances = g_slist_append(drvc->instances, sdi);
187 devices = g_slist_append(devices, sdi);
189 serial_close(serial);
191 sr_serial_dev_inst_free(serial);
196 static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
198 return scan(di, options, PPS_3203T_3S);
201 static GSList *dev_list(const struct sr_dev_driver *di)
203 return ((struct drv_context *)(di->context))->instances;
206 static int cleanup(const struct sr_dev_driver *di)
208 return std_dev_clear(di, NULL);
211 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
212 const struct sr_channel_group *cg)
214 struct dev_context *devc;
215 struct sr_channel *ch;
225 /* No channel group: global options. */
227 case SR_CONF_CHANNEL_CONFIG:
228 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
230 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
231 *data = g_variant_new_boolean(devc->over_current_protection);
237 /* We only ever have one channel per channel group in this driver. */
238 ch = cg->channels->data;
242 case SR_CONF_VOLTAGE:
243 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
245 case SR_CONF_VOLTAGE_TARGET:
246 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
248 case SR_CONF_CURRENT:
249 *data = g_variant_new_double(devc->config[channel].output_current_last);
251 case SR_CONF_CURRENT_LIMIT:
252 *data = g_variant_new_double(devc->config[channel].output_current_max);
254 case SR_CONF_ENABLED:
255 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
265 static int find_str(const char *str, const char **strings, int array_size)
270 for (i = 0; i < array_size; i++) {
271 if (!strcmp(str, strings[i])) {
280 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
281 const struct sr_channel_group *cg)
283 struct dev_context *devc;
284 struct sr_channel *ch;
286 int channel, ret, ival;
290 if (sdi->status != SR_ST_ACTIVE)
291 return SR_ERR_DEV_CLOSED;
296 /* No channel group: global options. */
298 case SR_CONF_CHANNEL_CONFIG:
299 sval = g_variant_get_string(data, NULL);
300 if ((ival = find_str(sval, channel_modes,
301 ARRAY_SIZE(channel_modes))) == -1) {
305 if (devc->model->channel_modes && (1 << ival) == 0) {
306 /* Not supported on this model. */
309 if (ival == devc->channel_mode_set)
312 devc->channel_mode_set = ival;
313 devc->config_dirty = TRUE;
315 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
316 bval = g_variant_get_boolean(data);
317 if (bval == devc->over_current_protection_set)
320 devc->over_current_protection_set = bval;
321 devc->config_dirty = TRUE;
327 /* Channel group specified: per-channel options. */
328 /* We only ever have one channel per channel group in this driver. */
329 ch = cg->channels->data;
333 case SR_CONF_VOLTAGE_TARGET:
334 dval = g_variant_get_double(data);
335 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
337 devc->config[channel].output_voltage_max = dval;
338 devc->config_dirty = TRUE;
340 case SR_CONF_CURRENT_LIMIT:
341 dval = g_variant_get_double(data);
342 if (dval < 0 || dval > devc->model->channels[channel].current[1])
344 devc->config[channel].output_current_max = dval;
345 devc->config_dirty = TRUE;
347 case SR_CONF_ENABLED:
348 bval = g_variant_get_boolean(data);
349 if (bval == devc->config[channel].output_enabled_set)
352 devc->config[channel].output_enabled_set = bval;
353 devc->config_dirty = TRUE;
363 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
364 const struct sr_channel_group *cg)
366 struct dev_context *devc;
367 struct sr_channel *ch;
372 /* Always available. */
373 if (key == SR_CONF_SCAN_OPTIONS) {
374 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
375 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
379 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
380 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
381 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
391 /* No channel group: global options. */
393 case SR_CONF_DEVICE_OPTIONS:
394 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
395 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
397 case SR_CONF_CHANNEL_CONFIG:
398 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
399 /* The 1-channel models. */
400 *data = g_variant_new_strv(channel_modes, 1);
402 /* The other models support all modes. */
403 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
410 /* Channel group specified: per-channel options. */
413 /* We only ever have one channel per channel group in this driver. */
414 ch = cg->channels->data;
418 case SR_CONF_DEVICE_OPTIONS:
419 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
420 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
422 case SR_CONF_VOLTAGE_TARGET:
423 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
424 /* Min, max, step. */
425 for (i = 0; i < 3; i++) {
426 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
427 g_variant_builder_add_value(&gvb, gvar);
429 *data = g_variant_builder_end(&gvb);
431 case SR_CONF_CURRENT_LIMIT:
432 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
433 /* Min, max, step. */
434 for (i = 0; i < 3; i++) {
435 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
436 g_variant_builder_add_value(&gvb, gvar);
438 *data = g_variant_builder_end(&gvb);
448 static int dev_close(struct sr_dev_inst *sdi)
450 struct dev_context *devc;
453 if (devc->config_dirty)
454 /* Some configuration changes were queued up but didn't
455 * get sent to the device, likely because we were never
456 * in acquisition mode. Send them out now. */
459 return std_serial_dev_close(sdi);
462 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
465 struct dev_context *devc;
466 struct sr_serial_dev_inst *serial;
467 uint8_t packet[PACKET_SIZE];
471 if (sdi->status != SR_ST_ACTIVE)
472 return SR_ERR_DEV_CLOSED;
475 memset(devc->packet, 0x44, PACKET_SIZE);
476 devc->packet_size = 0;
478 devc->acquisition_running = TRUE;
481 serial_source_add(sdi->session, serial, G_IO_IN, 50,
482 atten_pps3xxx_receive_data, (void *)sdi);
483 std_session_send_df_header(cb_data, LOG_PREFIX);
485 /* Send a "channel" configuration packet now. */
486 memset(packet, 0, PACKET_SIZE);
489 send_packet(sdi, packet);
494 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
496 struct dev_context *devc;
500 if (sdi->status != SR_ST_ACTIVE)
501 return SR_ERR_DEV_CLOSED;
504 devc->acquisition_running = FALSE;
509 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = {
510 .name = "atten-pps3203",
511 .longname = "Atten PPS3203T-3S",
516 .dev_list = dev_list,
518 .config_get = config_get,
519 .config_set = config_set,
520 .config_list = config_list,
521 .dev_open = std_serial_dev_open,
522 .dev_close = dev_close,
523 .dev_acquisition_start = dev_acquisition_start,
524 .dev_acquisition_stop = dev_acquisition_stop,