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/>.
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.
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.
32 #define SERIALCOMM "9600/8n2"
34 static const uint32_t scanopts[] = {
39 static const uint32_t devopts[] = {
42 SR_CONF_OUTPUT_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
46 static const uint32_t devopts_cg[] = {
47 SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET,
48 SR_CONF_OUTPUT_VOLTAGE_MAX | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49 SR_CONF_OUTPUT_CURRENT | SR_CONF_GET,
50 SR_CONF_OUTPUT_CURRENT_MAX | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
51 SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET,
54 static const char *channel_modes[] = {
60 static struct pps_model models[] = {
61 { PPS_3203T_3S, "PPS3203T-3S",
62 CHANMODE_INDEPENDENT | CHANMODE_SERIES | CHANMODE_PARALLEL,
66 { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
68 { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
70 { { 0, 6, 0.01 }, { 0, 3, 0.001 } },
76 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
77 static struct sr_dev_driver *di = &atten_pps3203_driver_info;
79 static int init(struct sr_context *sr_ctx)
81 return std_init(sr_ctx, di, LOG_PREFIX);
84 static GSList *scan(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 struct pps_model *model;
96 uint8_t packet[PACKET_SIZE];
99 const char *conn, *serialcomm;
104 drvc->instances = NULL;
106 conn = serialcomm = NULL;
107 for (l = options; l; l = l->next) {
111 conn = g_variant_get_string(src->data, NULL);
113 case SR_CONF_SERIALCOMM:
114 serialcomm = g_variant_get_string(src->data, NULL);
121 serialcomm = SERIALCOMM;
123 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
126 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
128 serial_flush(serial);
130 /* How long it takes for a byte to transfer over the serial port. */
131 if (sp_get_port_transport(serial->data) == SP_TRANSPORT_NATIVE)
132 /* 11 bits at 9600 bps. */
133 byte_delay_ms = 1.15;
135 /* Emulated serial over USB or bluetooth is just enqueueing. */
138 /* This is how the vendor software scans for hardware. */
139 memset(packet, 0, PACKET_SIZE);
142 if (serial_write_blocking(serial, packet, PACKET_SIZE,
143 byte_delay_ms * PACKET_SIZE + 1) < PACKET_SIZE) {
144 sr_err("Unable to write while probing for hardware.");
147 /* The device responds with a 24-byte packet when it receives a packet.
148 * At 9600 baud, 300ms is long enough for it to have arrived. */
149 g_usleep(300 * 1000);
150 memset(packet, 0, PACKET_SIZE);
151 if ((ret = serial_read_nonblocking(serial, packet, PACKET_SIZE)) < 0) {
152 sr_err("Unable to read while probing for hardware: %s",
156 if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
157 /* Doesn't look like an Atten PPS. */
162 for (i = 0; i < ARRAY_SIZE(models); i++) {
163 if (models[i].modelid == modelid) {
169 sr_err("Unknown modelid %d", modelid);
173 sdi = sr_dev_inst_new(SR_ST_INACTIVE, "Atten", model->name, NULL);
175 sdi->inst_type = SR_INST_SERIAL;
177 for (i = 0; i < MAX_CHANNELS; i++) {
178 snprintf(channel, 10, "CH%d", i + 1);
179 ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE, channel);
180 sdi->channels = g_slist_append(sdi->channels, ch);
181 cg = g_malloc(sizeof(struct sr_channel_group));
182 cg->name = g_strdup(channel);
183 cg->channels = g_slist_append(NULL, ch);
185 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
188 devc = g_malloc0(sizeof(struct dev_context));
190 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
191 devc->byte_delay_ms = byte_delay_ms;
193 drvc->instances = g_slist_append(drvc->instances, sdi);
194 devices = g_slist_append(devices, sdi);
196 serial_close(serial);
198 sr_serial_dev_inst_free(serial);
203 static GSList *scan_3203(GSList *options)
205 return scan(options, PPS_3203T_3S);
208 static GSList *dev_list(void)
210 return ((struct drv_context *)(di->priv))->instances;
213 static int cleanup(void)
215 return std_dev_clear(di, NULL);
218 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
219 const struct sr_channel_group *cg)
221 struct dev_context *devc;
222 struct sr_channel *ch;
232 /* No channel group: global options. */
234 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
235 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
237 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
238 *data = g_variant_new_boolean(devc->over_current_protection);
244 /* We only ever have one channel per channel group in this driver. */
245 ch = cg->channels->data;
249 case SR_CONF_OUTPUT_VOLTAGE:
250 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
252 case SR_CONF_OUTPUT_VOLTAGE_MAX:
253 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
255 case SR_CONF_OUTPUT_CURRENT:
256 *data = g_variant_new_double(devc->config[channel].output_current_last);
258 case SR_CONF_OUTPUT_CURRENT_MAX:
259 *data = g_variant_new_double(devc->config[channel].output_current_max);
261 case SR_CONF_OUTPUT_ENABLED:
262 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
272 static int find_str(const char *str, const char **strings, int array_size)
277 for (i = 0; i < array_size; i++) {
278 if (!strcmp(str, strings[i])) {
287 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
288 const struct sr_channel_group *cg)
290 struct dev_context *devc;
291 struct sr_channel *ch;
293 int channel, ret, ival;
297 if (sdi->status != SR_ST_ACTIVE)
298 return SR_ERR_DEV_CLOSED;
303 /* No channel group: global options. */
305 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
306 sval = g_variant_get_string(data, NULL);
307 if ((ival = find_str(sval, channel_modes,
308 ARRAY_SIZE(channel_modes))) == -1) {
312 if (devc->model->channel_modes && (1 << ival) == 0) {
313 /* Not supported on this model. */
316 if (ival == devc->channel_mode_set)
319 devc->channel_mode_set = ival;
320 devc->config_dirty = TRUE;
322 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
323 bval = g_variant_get_boolean(data);
324 if (bval == devc->over_current_protection_set)
327 devc->over_current_protection_set = bval;
328 devc->config_dirty = TRUE;
334 /* Channel group specified: per-channel options. */
335 /* We only ever have one channel per channel group in this driver. */
336 ch = cg->channels->data;
340 case SR_CONF_OUTPUT_VOLTAGE_MAX:
341 dval = g_variant_get_double(data);
342 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
344 devc->config[channel].output_voltage_max = dval;
345 devc->config_dirty = TRUE;
347 case SR_CONF_OUTPUT_CURRENT_MAX:
348 dval = g_variant_get_double(data);
349 if (dval < 0 || dval > devc->model->channels[channel].current[1])
351 devc->config[channel].output_current_max = dval;
352 devc->config_dirty = TRUE;
354 case SR_CONF_OUTPUT_ENABLED:
355 bval = g_variant_get_boolean(data);
356 if (bval == devc->config[channel].output_enabled_set)
359 devc->config[channel].output_enabled_set = bval;
360 devc->config_dirty = TRUE;
371 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
372 const struct sr_channel_group *cg)
374 struct dev_context *devc;
375 struct sr_channel *ch;
380 /* Always available, even without sdi. */
381 if (key == SR_CONF_SCAN_OPTIONS) {
382 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
383 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
393 /* No channel group: global options. */
395 case SR_CONF_DEVICE_OPTIONS:
396 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
397 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
399 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
400 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
401 /* The 1-channel models. */
402 *data = g_variant_new_strv(channel_modes, 1);
404 /* The other models support all modes. */
405 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
412 /* Channel group specified: per-channel options. */
415 /* We only ever have one channel per channel group in this driver. */
416 ch = cg->channels->data;
420 case SR_CONF_DEVICE_OPTIONS:
421 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
422 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
424 case SR_CONF_OUTPUT_VOLTAGE_MAX:
425 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
426 /* Min, max, step. */
427 for (i = 0; i < 3; i++) {
428 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
429 g_variant_builder_add_value(&gvb, gvar);
431 *data = g_variant_builder_end(&gvb);
433 case SR_CONF_OUTPUT_CURRENT_MAX:
434 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
435 /* Min, max, step. */
436 for (i = 0; i < 3; i++) {
437 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
438 g_variant_builder_add_value(&gvb, gvar);
440 *data = g_variant_builder_end(&gvb);
450 static int dev_close(struct sr_dev_inst *sdi)
452 struct dev_context *devc;
455 if (devc->config_dirty)
456 /* Some configuration changes were queued up but didn't
457 * get sent to the device, likely because we were never
458 * in acquisition mode. Send them out now. */
461 return std_serial_dev_close(sdi);
464 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
467 struct dev_context *devc;
468 struct sr_serial_dev_inst *serial;
469 uint8_t packet[PACKET_SIZE];
473 if (sdi->status != SR_ST_ACTIVE)
474 return SR_ERR_DEV_CLOSED;
477 memset(devc->packet, 0x44, PACKET_SIZE);
478 devc->packet_size = 0;
480 devc->acquisition_running = TRUE;
483 serial_source_add(sdi->session, serial, G_IO_IN, 50,
484 atten_pps3xxx_receive_data, (void *)sdi);
485 std_session_send_df_header(cb_data, LOG_PREFIX);
487 /* Send a "channel" configuration packet now. */
488 memset(packet, 0, PACKET_SIZE);
491 send_packet(sdi, packet);
496 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
498 struct dev_context *devc;
502 if (sdi->status != SR_ST_ACTIVE)
503 return SR_ERR_DEV_CLOSED;
506 devc->acquisition_running = FALSE;
511 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = {
512 .name = "atten-pps3203",
513 .longname = "Atten PPS3203T-3S",
518 .dev_list = dev_list,
520 .config_get = config_get,
521 .config_set = config_set,
522 .config_list = config_list,
523 .dev_open = std_serial_dev_open,
524 .dev_close = dev_close,
525 .dev_acquisition_start = dev_acquisition_start,
526 .dev_acquisition_stop = dev_acquisition_stop,