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;
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 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
125 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
127 serial_flush(serial);
129 /* This is how the vendor software channels for hardware. */
130 memset(packet, 0, PACKET_SIZE);
133 if (serial_write_blocking(serial, packet, PACKET_SIZE) == -1) {
134 sr_err("Unable to write while probing for hardware: %s",
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 = sr_dev_inst_new(SR_ST_INACTIVE, "Atten", model->name, NULL);
166 sdi->inst_type = SR_INST_SERIAL;
168 for (i = 0; i < MAX_CHANNELS; i++) {
169 snprintf(channel, 10, "CH%d", i + 1);
170 ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE, channel);
171 sdi->channels = g_slist_append(sdi->channels, ch);
172 cg = g_malloc(sizeof(struct sr_channel_group));
173 cg->name = g_strdup(channel);
174 cg->channels = g_slist_append(NULL, ch);
176 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
179 devc = g_malloc0(sizeof(struct dev_context));
181 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
183 drvc->instances = g_slist_append(drvc->instances, sdi);
184 devices = g_slist_append(devices, sdi);
186 serial_close(serial);
188 sr_serial_dev_inst_free(serial);
193 static GSList *scan_3203(GSList *options)
195 return scan(options, PPS_3203T_3S);
198 static GSList *dev_list(void)
200 return ((struct drv_context *)(di->priv))->instances;
203 static int cleanup(void)
205 return std_dev_clear(di, NULL);
208 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
209 const struct sr_channel_group *cg)
211 struct dev_context *devc;
212 struct sr_channel *ch;
222 /* No channel group: global options. */
224 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
225 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
227 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
228 *data = g_variant_new_boolean(devc->over_current_protection);
234 /* We only ever have one channel per channel group in this driver. */
235 ch = cg->channels->data;
239 case SR_CONF_OUTPUT_VOLTAGE:
240 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
242 case SR_CONF_OUTPUT_VOLTAGE_MAX:
243 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
245 case SR_CONF_OUTPUT_CURRENT:
246 *data = g_variant_new_double(devc->config[channel].output_current_last);
248 case SR_CONF_OUTPUT_CURRENT_MAX:
249 *data = g_variant_new_double(devc->config[channel].output_current_max);
251 case SR_CONF_OUTPUT_ENABLED:
252 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
262 static int find_str(const char *str, const char **strings, int array_size)
267 for (i = 0; i < array_size; i++) {
268 if (!strcmp(str, strings[i])) {
277 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
278 const struct sr_channel_group *cg)
280 struct dev_context *devc;
281 struct sr_channel *ch;
283 int channel, ret, ival;
287 if (sdi->status != SR_ST_ACTIVE)
288 return SR_ERR_DEV_CLOSED;
293 /* No channel group: global options. */
295 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
296 sval = g_variant_get_string(data, NULL);
297 if ((ival = find_str(sval, channel_modes,
298 ARRAY_SIZE(channel_modes))) == -1) {
302 if (devc->model->channel_modes && (1 << ival) == 0) {
303 /* Not supported on this model. */
306 if (ival == devc->channel_mode_set)
309 devc->channel_mode_set = ival;
310 devc->config_dirty = TRUE;
312 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
313 bval = g_variant_get_boolean(data);
314 if (bval == devc->over_current_protection_set)
317 devc->over_current_protection_set = bval;
318 devc->config_dirty = TRUE;
324 /* Channel group specified: per-channel options. */
325 /* We only ever have one channel per channel group in this driver. */
326 ch = cg->channels->data;
330 case SR_CONF_OUTPUT_VOLTAGE_MAX:
331 dval = g_variant_get_double(data);
332 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
334 devc->config[channel].output_voltage_max = dval;
335 devc->config_dirty = TRUE;
337 case SR_CONF_OUTPUT_CURRENT_MAX:
338 dval = g_variant_get_double(data);
339 if (dval < 0 || dval > devc->model->channels[channel].current[1])
341 devc->config[channel].output_current_max = dval;
342 devc->config_dirty = TRUE;
344 case SR_CONF_OUTPUT_ENABLED:
345 bval = g_variant_get_boolean(data);
346 if (bval == devc->config[channel].output_enabled_set)
349 devc->config[channel].output_enabled_set = bval;
350 devc->config_dirty = TRUE;
361 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
362 const struct sr_channel_group *cg)
364 struct dev_context *devc;
365 struct sr_channel *ch;
370 /* Always available, even without sdi. */
371 if (key == SR_CONF_SCAN_OPTIONS) {
372 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
373 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
383 /* No channel group: global options. */
385 case SR_CONF_DEVICE_OPTIONS:
386 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
387 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
389 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
390 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
391 /* The 1-channel models. */
392 *data = g_variant_new_strv(channel_modes, 1);
394 /* The other models support all modes. */
395 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
402 /* Channel group specified: per-channel options. */
405 /* We only ever have one channel per channel group in this driver. */
406 ch = cg->channels->data;
410 case SR_CONF_DEVICE_OPTIONS:
411 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
412 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
414 case SR_CONF_OUTPUT_VOLTAGE_MAX:
415 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
416 /* Min, max, step. */
417 for (i = 0; i < 3; i++) {
418 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
419 g_variant_builder_add_value(&gvb, gvar);
421 *data = g_variant_builder_end(&gvb);
423 case SR_CONF_OUTPUT_CURRENT_MAX:
424 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
425 /* Min, max, step. */
426 for (i = 0; i < 3; i++) {
427 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
428 g_variant_builder_add_value(&gvb, gvar);
430 *data = g_variant_builder_end(&gvb);
440 static int dev_close(struct sr_dev_inst *sdi)
442 struct dev_context *devc;
445 if (devc->config_dirty)
446 /* Some configuration changes were queued up but didn't
447 * get sent to the device, likely because we were never
448 * in acquisition mode. Send them out now. */
451 return std_serial_dev_close(sdi);
454 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
457 struct dev_context *devc;
458 struct sr_serial_dev_inst *serial;
459 uint8_t packet[PACKET_SIZE];
463 if (sdi->status != SR_ST_ACTIVE)
464 return SR_ERR_DEV_CLOSED;
467 memset(devc->packet, 0x44, PACKET_SIZE);
468 devc->packet_size = 0;
470 devc->acquisition_running = TRUE;
473 serial_source_add(sdi->session, serial, G_IO_IN, 50,
474 atten_pps3xxx_receive_data, (void *)sdi);
475 std_session_send_df_header(cb_data, LOG_PREFIX);
477 /* Send a "channel" configuration packet now. */
478 memset(packet, 0, PACKET_SIZE);
481 send_packet(sdi, packet);
486 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
488 struct dev_context *devc;
492 if (sdi->status != SR_ST_ACTIVE)
493 return SR_ERR_DEV_CLOSED;
496 devc->acquisition_running = FALSE;
501 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = {
502 .name = "atten-pps3203",
503 .longname = "Atten PPS3203T-3S",
508 .dev_list = dev_list,
510 .config_get = config_get,
511 .config_set = config_set,
512 .config_list = config_list,
513 .dev_open = std_serial_dev_open,
514 .dev_close = dev_close,
515 .dev_acquisition_start = dev_acquisition_start,
516 .dev_acquisition_stop = dev_acquisition_stop,