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;
264 if (sdi->status != SR_ST_ACTIVE)
265 return SR_ERR_DEV_CLOSED;
270 /* No channel group: global options. */
272 case SR_CONF_CHANNEL_CONFIG:
273 sval = g_variant_get_string(data, NULL);
274 if ((ival = find_str(sval, channel_modes,
275 ARRAY_SIZE(channel_modes))) == -1) {
279 if (devc->model->channel_modes && (1 << ival) == 0) {
280 /* Not supported on this model. */
283 if (ival == devc->channel_mode_set)
286 devc->channel_mode_set = ival;
287 devc->config_dirty = TRUE;
289 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
290 bval = g_variant_get_boolean(data);
291 if (bval == devc->over_current_protection_set)
294 devc->over_current_protection_set = bval;
295 devc->config_dirty = TRUE;
301 /* Channel group specified: per-channel options. */
302 /* We only ever have one channel per channel group in this driver. */
303 ch = cg->channels->data;
307 case SR_CONF_VOLTAGE_TARGET:
308 dval = g_variant_get_double(data);
309 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
311 devc->config[channel].output_voltage_max = dval;
312 devc->config_dirty = TRUE;
314 case SR_CONF_CURRENT_LIMIT:
315 dval = g_variant_get_double(data);
316 if (dval < 0 || dval > devc->model->channels[channel].current[1])
318 devc->config[channel].output_current_max = dval;
319 devc->config_dirty = TRUE;
321 case SR_CONF_ENABLED:
322 bval = g_variant_get_boolean(data);
323 if (bval == devc->config[channel].output_enabled_set)
326 devc->config[channel].output_enabled_set = bval;
327 devc->config_dirty = TRUE;
337 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
338 const struct sr_channel_group *cg)
340 struct dev_context *devc;
341 struct sr_channel *ch;
346 /* Always available. */
347 if (key == SR_CONF_SCAN_OPTIONS) {
348 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
349 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
353 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
354 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
355 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
365 /* No channel group: global options. */
367 case SR_CONF_DEVICE_OPTIONS:
368 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
369 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
371 case SR_CONF_CHANNEL_CONFIG:
372 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
373 /* The 1-channel models. */
374 *data = g_variant_new_strv(channel_modes, 1);
376 /* The other models support all modes. */
377 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
384 /* Channel group specified: per-channel options. */
387 /* We only ever have one channel per channel group in this driver. */
388 ch = cg->channels->data;
392 case SR_CONF_DEVICE_OPTIONS:
393 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
394 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
396 case SR_CONF_VOLTAGE_TARGET:
397 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
398 /* Min, max, step. */
399 for (i = 0; i < 3; i++) {
400 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
401 g_variant_builder_add_value(&gvb, gvar);
403 *data = g_variant_builder_end(&gvb);
405 case SR_CONF_CURRENT_LIMIT:
406 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
407 /* Min, max, step. */
408 for (i = 0; i < 3; i++) {
409 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
410 g_variant_builder_add_value(&gvb, gvar);
412 *data = g_variant_builder_end(&gvb);
422 static int dev_close(struct sr_dev_inst *sdi)
424 struct dev_context *devc;
427 if (devc->config_dirty)
428 /* Some configuration changes were queued up but didn't
429 * get sent to the device, likely because we were never
430 * in acquisition mode. Send them out now. */
433 return std_serial_dev_close(sdi);
436 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
438 struct dev_context *devc;
439 struct sr_serial_dev_inst *serial;
440 uint8_t packet[PACKET_SIZE];
442 if (sdi->status != SR_ST_ACTIVE)
443 return SR_ERR_DEV_CLOSED;
446 memset(devc->packet, 0x44, PACKET_SIZE);
447 devc->packet_size = 0;
449 devc->acquisition_running = TRUE;
452 serial_source_add(sdi->session, serial, G_IO_IN, 50,
453 atten_pps3xxx_receive_data, (void *)sdi);
454 std_session_send_df_header(sdi, LOG_PREFIX);
456 /* Send a "channel" configuration packet now. */
457 memset(packet, 0, PACKET_SIZE);
460 send_packet(sdi, packet);
465 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
467 struct dev_context *devc;
469 if (sdi->status != SR_ST_ACTIVE)
470 return SR_ERR_DEV_CLOSED;
473 devc->acquisition_running = FALSE;
478 static struct sr_dev_driver atten_pps3203_driver_info = {
479 .name = "atten-pps3203",
480 .longname = "Atten PPS3203T-3S",
483 .cleanup = std_cleanup,
485 .dev_list = std_dev_list,
487 .config_get = config_get,
488 .config_set = config_set,
489 .config_list = config_list,
490 .dev_open = std_serial_dev_open,
491 .dev_close = dev_close,
492 .dev_acquisition_start = dev_acquisition_start,
493 .dev_acquisition_stop = dev_acquisition_stop,
496 SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info);