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 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;
87 const struct pps_model *model;
88 uint8_t packet[PACKET_SIZE];
91 const char *conn, *serialcomm;
94 conn = serialcomm = NULL;
95 for (l = options; l; l = l->next) {
99 conn = g_variant_get_string(src->data, NULL);
101 case SR_CONF_SERIALCOMM:
102 serialcomm = g_variant_get_string(src->data, NULL);
109 serialcomm = SERIALCOMM;
111 serial = sr_serial_dev_inst_new(conn, serialcomm);
113 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
116 serial_flush(serial);
118 /* This is how the vendor software scans for hardware. */
119 memset(packet, 0, PACKET_SIZE);
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.");
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",
136 if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
137 /* Doesn't look like an Atten PPS. */
142 for (i = 0; i < ARRAY_SIZE(models); i++) {
143 if (models[i].modelid == modelid) {
149 sr_err("Unknown modelid %d", modelid);
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;
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);
166 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
169 devc = g_malloc0(sizeof(struct dev_context));
171 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
172 devc->delay_ms = delay_ms;
175 serial_close(serial);
177 return std_scan_complete(di, g_slist_append(NULL, sdi));
180 static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
182 return scan(di, options, PPS_3203T_3S);
185 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
186 const struct sr_channel_group *cg)
188 struct dev_context *devc;
189 struct sr_channel *ch;
199 /* No channel group: global options. */
201 case SR_CONF_CHANNEL_CONFIG:
202 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
204 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
205 *data = g_variant_new_boolean(devc->over_current_protection);
211 /* We only ever have one channel per channel group in this driver. */
212 ch = cg->channels->data;
216 case SR_CONF_VOLTAGE:
217 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
219 case SR_CONF_VOLTAGE_TARGET:
220 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
222 case SR_CONF_CURRENT:
223 *data = g_variant_new_double(devc->config[channel].output_current_last);
225 case SR_CONF_CURRENT_LIMIT:
226 *data = g_variant_new_double(devc->config[channel].output_current_max);
228 case SR_CONF_ENABLED:
229 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
239 static int find_str(const char *str, const char **strings, int array_size)
244 for (i = 0; i < array_size; i++) {
245 if (!strcmp(str, strings[i])) {
254 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
255 const struct sr_channel_group *cg)
257 struct dev_context *devc;
258 struct sr_channel *ch;
260 int channel, ret, ival;
267 /* No channel group: global options. */
269 case SR_CONF_CHANNEL_CONFIG:
270 sval = g_variant_get_string(data, NULL);
271 if ((ival = find_str(sval, channel_modes,
272 ARRAY_SIZE(channel_modes))) == -1) {
276 if (devc->model->channel_modes && (1 << ival) == 0) {
277 /* Not supported on this model. */
280 if (ival == devc->channel_mode_set)
283 devc->channel_mode_set = ival;
284 devc->config_dirty = TRUE;
286 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
287 bval = g_variant_get_boolean(data);
288 if (bval == devc->over_current_protection_set)
291 devc->over_current_protection_set = bval;
292 devc->config_dirty = TRUE;
298 /* Channel group specified: per-channel options. */
299 /* We only ever have one channel per channel group in this driver. */
300 ch = cg->channels->data;
304 case SR_CONF_VOLTAGE_TARGET:
305 dval = g_variant_get_double(data);
306 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
308 devc->config[channel].output_voltage_max = dval;
309 devc->config_dirty = TRUE;
311 case SR_CONF_CURRENT_LIMIT:
312 dval = g_variant_get_double(data);
313 if (dval < 0 || dval > devc->model->channels[channel].current[1])
315 devc->config[channel].output_current_max = dval;
316 devc->config_dirty = TRUE;
318 case SR_CONF_ENABLED:
319 bval = g_variant_get_boolean(data);
320 if (bval == devc->config[channel].output_enabled_set)
323 devc->config[channel].output_enabled_set = bval;
324 devc->config_dirty = TRUE;
334 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
335 const struct sr_channel_group *cg)
337 struct dev_context *devc;
338 struct sr_channel *ch;
343 /* Always available. */
344 if (key == SR_CONF_SCAN_OPTIONS) {
345 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
346 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
350 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
351 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
352 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
362 /* No channel group: global options. */
364 case SR_CONF_DEVICE_OPTIONS:
365 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
366 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
368 case SR_CONF_CHANNEL_CONFIG:
369 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
370 /* The 1-channel models. */
371 *data = g_variant_new_strv(channel_modes, 1);
373 /* The other models support all modes. */
374 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
381 /* Channel group specified: per-channel options. */
384 /* We only ever have one channel per channel group in this driver. */
385 ch = cg->channels->data;
389 case SR_CONF_DEVICE_OPTIONS:
390 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
391 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
393 case SR_CONF_VOLTAGE_TARGET:
394 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
395 /* Min, max, step. */
396 for (i = 0; i < 3; i++) {
397 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
398 g_variant_builder_add_value(&gvb, gvar);
400 *data = g_variant_builder_end(&gvb);
402 case SR_CONF_CURRENT_LIMIT:
403 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
404 /* Min, max, step. */
405 for (i = 0; i < 3; i++) {
406 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
407 g_variant_builder_add_value(&gvb, gvar);
409 *data = g_variant_builder_end(&gvb);
419 static int dev_close(struct sr_dev_inst *sdi)
421 struct dev_context *devc;
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. */
430 return std_serial_dev_close(sdi);
433 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
435 struct dev_context *devc;
436 struct sr_serial_dev_inst *serial;
437 uint8_t packet[PACKET_SIZE];
440 memset(devc->packet, 0x44, PACKET_SIZE);
441 devc->packet_size = 0;
443 devc->acquisition_running = TRUE;
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);
450 /* Send a "channel" configuration packet now. */
451 memset(packet, 0, PACKET_SIZE);
454 send_packet(sdi, packet);
459 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
461 struct dev_context *devc;
464 devc->acquisition_running = FALSE;
469 static struct sr_dev_driver atten_pps3203_driver_info = {
470 .name = "atten-pps3203",
471 .longname = "Atten PPS3203T-3S",
474 .cleanup = std_cleanup,
476 .dev_list = std_dev_list,
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,
487 SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info);