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 drvopts[] = {
43 static const uint32_t devopts[] = {
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,
49 static 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,
57 static const char *channel_modes[] = {
63 static const struct pps_model models[] = {
64 { PPS_3203T_3S, "PPS3203T-3S",
65 CHANMODE_INDEPENDENT | CHANMODE_SERIES | CHANMODE_PARALLEL,
69 { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
71 { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
73 { { 0, 6, 0.01 }, { 0, 3, 0.001 } },
78 static GSList *scan(struct sr_dev_driver *di, GSList *options, int modelid)
80 struct sr_dev_inst *sdi;
81 struct drv_context *drvc;
82 struct dev_context *devc;
83 struct sr_config *src;
84 struct sr_channel *ch;
85 struct sr_channel_group *cg;
86 struct sr_serial_dev_inst *serial;
88 const struct pps_model *model;
89 uint8_t packet[PACKET_SIZE];
92 const char *conn, *serialcomm;
97 drvc->instances = NULL;
99 conn = serialcomm = NULL;
100 for (l = options; l; l = l->next) {
104 conn = g_variant_get_string(src->data, NULL);
106 case SR_CONF_SERIALCOMM:
107 serialcomm = g_variant_get_string(src->data, NULL);
114 serialcomm = SERIALCOMM;
116 serial = sr_serial_dev_inst_new(conn, serialcomm);
118 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
121 serial_flush(serial);
123 /* This is how the vendor software scans for hardware. */
124 memset(packet, 0, PACKET_SIZE);
127 delay_ms = serial_timeout(serial, PACKET_SIZE);
128 if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) {
129 sr_err("Unable to write while probing for hardware.");
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",
141 if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
142 /* Doesn't look like an Atten PPS. */
147 for (i = 0; i < ARRAY_SIZE(models); i++) {
148 if (models[i].modelid == modelid) {
154 sr_err("Unknown modelid %d", modelid);
158 sdi = g_malloc0(sizeof(struct sr_dev_inst));
159 sdi->status = SR_ST_INACTIVE;
160 sdi->vendor = g_strdup("Atten");
161 sdi->model = g_strdup(model->name);
163 sdi->inst_type = SR_INST_SERIAL;
165 for (i = 0; i < MAX_CHANNELS; i++) {
166 snprintf(channel, 10, "CH%d", i + 1);
167 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
168 cg = g_malloc(sizeof(struct sr_channel_group));
169 cg->name = g_strdup(channel);
170 cg->channels = g_slist_append(NULL, ch);
172 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
175 devc = g_malloc0(sizeof(struct dev_context));
177 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
178 devc->delay_ms = delay_ms;
180 drvc->instances = g_slist_append(drvc->instances, sdi);
181 devices = g_slist_append(devices, sdi);
183 serial_close(serial);
185 sr_serial_dev_inst_free(serial);
190 static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
192 return scan(di, options, PPS_3203T_3S);
195 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
196 const struct sr_channel_group *cg)
198 struct dev_context *devc;
199 struct sr_channel *ch;
209 /* No channel group: global options. */
211 case SR_CONF_CHANNEL_CONFIG:
212 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
214 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
215 *data = g_variant_new_boolean(devc->over_current_protection);
221 /* We only ever have one channel per channel group in this driver. */
222 ch = cg->channels->data;
226 case SR_CONF_VOLTAGE:
227 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
229 case SR_CONF_VOLTAGE_TARGET:
230 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
232 case SR_CONF_CURRENT:
233 *data = g_variant_new_double(devc->config[channel].output_current_last);
235 case SR_CONF_CURRENT_LIMIT:
236 *data = g_variant_new_double(devc->config[channel].output_current_max);
238 case SR_CONF_ENABLED:
239 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
249 static int find_str(const char *str, const char **strings, int array_size)
254 for (i = 0; i < array_size; i++) {
255 if (!strcmp(str, strings[i])) {
264 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
265 const struct sr_channel_group *cg)
267 struct dev_context *devc;
268 struct sr_channel *ch;
270 int channel, ret, ival;
274 if (sdi->status != SR_ST_ACTIVE)
275 return SR_ERR_DEV_CLOSED;
280 /* No channel group: global options. */
282 case SR_CONF_CHANNEL_CONFIG:
283 sval = g_variant_get_string(data, NULL);
284 if ((ival = find_str(sval, channel_modes,
285 ARRAY_SIZE(channel_modes))) == -1) {
289 if (devc->model->channel_modes && (1 << ival) == 0) {
290 /* Not supported on this model. */
293 if (ival == devc->channel_mode_set)
296 devc->channel_mode_set = ival;
297 devc->config_dirty = TRUE;
299 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
300 bval = g_variant_get_boolean(data);
301 if (bval == devc->over_current_protection_set)
304 devc->over_current_protection_set = bval;
305 devc->config_dirty = TRUE;
311 /* Channel group specified: per-channel options. */
312 /* We only ever have one channel per channel group in this driver. */
313 ch = cg->channels->data;
317 case SR_CONF_VOLTAGE_TARGET:
318 dval = g_variant_get_double(data);
319 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
321 devc->config[channel].output_voltage_max = dval;
322 devc->config_dirty = TRUE;
324 case SR_CONF_CURRENT_LIMIT:
325 dval = g_variant_get_double(data);
326 if (dval < 0 || dval > devc->model->channels[channel].current[1])
328 devc->config[channel].output_current_max = dval;
329 devc->config_dirty = TRUE;
331 case SR_CONF_ENABLED:
332 bval = g_variant_get_boolean(data);
333 if (bval == devc->config[channel].output_enabled_set)
336 devc->config[channel].output_enabled_set = bval;
337 devc->config_dirty = TRUE;
347 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
348 const struct sr_channel_group *cg)
350 struct dev_context *devc;
351 struct sr_channel *ch;
356 /* Always available. */
357 if (key == SR_CONF_SCAN_OPTIONS) {
358 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
359 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
363 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
364 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
365 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
375 /* No channel group: global options. */
377 case SR_CONF_DEVICE_OPTIONS:
378 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
379 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
381 case SR_CONF_CHANNEL_CONFIG:
382 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
383 /* The 1-channel models. */
384 *data = g_variant_new_strv(channel_modes, 1);
386 /* The other models support all modes. */
387 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
394 /* Channel group specified: per-channel options. */
397 /* We only ever have one channel per channel group in this driver. */
398 ch = cg->channels->data;
402 case SR_CONF_DEVICE_OPTIONS:
403 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
404 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
406 case SR_CONF_VOLTAGE_TARGET:
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);
413 *data = g_variant_builder_end(&gvb);
415 case SR_CONF_CURRENT_LIMIT:
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);
422 *data = g_variant_builder_end(&gvb);
432 static int dev_close(struct sr_dev_inst *sdi)
434 struct dev_context *devc;
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. */
443 return std_serial_dev_close(sdi);
446 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
448 struct dev_context *devc;
449 struct sr_serial_dev_inst *serial;
450 uint8_t packet[PACKET_SIZE];
452 if (sdi->status != SR_ST_ACTIVE)
453 return SR_ERR_DEV_CLOSED;
456 memset(devc->packet, 0x44, PACKET_SIZE);
457 devc->packet_size = 0;
459 devc->acquisition_running = TRUE;
462 serial_source_add(sdi->session, serial, G_IO_IN, 50,
463 atten_pps3xxx_receive_data, (void *)sdi);
464 std_session_send_df_header(sdi, LOG_PREFIX);
466 /* Send a "channel" configuration packet now. */
467 memset(packet, 0, PACKET_SIZE);
470 send_packet(sdi, packet);
475 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
477 struct dev_context *devc;
479 if (sdi->status != SR_ST_ACTIVE)
480 return SR_ERR_DEV_CLOSED;
483 devc->acquisition_running = FALSE;
488 static struct sr_dev_driver atten_pps3203_driver_info = {
489 .name = "atten-pps3203",
490 .longname = "Atten PPS3203T-3S",
493 .cleanup = std_cleanup,
495 .dev_list = std_dev_list,
497 .config_get = config_get,
498 .config_set = config_set,
499 .config_list = config_list,
500 .dev_open = std_serial_dev_open,
501 .dev_close = dev_close,
502 .dev_acquisition_start = dev_acquisition_start,
503 .dev_acquisition_stop = dev_acquisition_stop,
506 SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info);