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 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
80 static GSList *scan(struct sr_dev_driver *di, GSList *options, int modelid)
82 struct sr_dev_inst *sdi;
83 struct drv_context *drvc;
84 struct dev_context *devc;
85 struct sr_config *src;
86 struct sr_channel *ch;
87 struct sr_channel_group *cg;
88 struct sr_serial_dev_inst *serial;
90 const struct pps_model *model;
91 uint8_t packet[PACKET_SIZE];
94 const char *conn, *serialcomm;
99 drvc->instances = NULL;
101 conn = serialcomm = NULL;
102 for (l = options; l; l = l->next) {
106 conn = g_variant_get_string(src->data, NULL);
108 case SR_CONF_SERIALCOMM:
109 serialcomm = g_variant_get_string(src->data, NULL);
116 serialcomm = SERIALCOMM;
118 serial = sr_serial_dev_inst_new(conn, serialcomm);
120 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
123 serial_flush(serial);
125 /* This is how the vendor software scans for hardware. */
126 memset(packet, 0, PACKET_SIZE);
129 delay_ms = serial_timeout(serial, PACKET_SIZE);
130 if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) {
131 sr_err("Unable to write while probing for hardware.");
134 /* The device responds with a 24-byte packet when it receives a packet.
135 * At 9600 baud, 300ms is long enough for it to have arrived. */
136 g_usleep(300 * 1000);
137 memset(packet, 0, PACKET_SIZE);
138 if ((ret = serial_read_nonblocking(serial, packet, PACKET_SIZE)) < 0) {
139 sr_err("Unable to read while probing for hardware: %s",
143 if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
144 /* Doesn't look like an Atten PPS. */
149 for (i = 0; i < ARRAY_SIZE(models); i++) {
150 if (models[i].modelid == modelid) {
156 sr_err("Unknown modelid %d", modelid);
160 sdi = g_malloc0(sizeof(struct sr_dev_inst));
161 sdi->status = SR_ST_INACTIVE;
162 sdi->vendor = g_strdup("Atten");
163 sdi->model = g_strdup(model->name);
165 sdi->inst_type = SR_INST_SERIAL;
167 for (i = 0; i < MAX_CHANNELS; i++) {
168 snprintf(channel, 10, "CH%d", i + 1);
169 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
170 cg = g_malloc(sizeof(struct sr_channel_group));
171 cg->name = g_strdup(channel);
172 cg->channels = g_slist_append(NULL, ch);
174 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
177 devc = g_malloc0(sizeof(struct dev_context));
179 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
180 devc->delay_ms = delay_ms;
182 drvc->instances = g_slist_append(drvc->instances, sdi);
183 devices = g_slist_append(devices, sdi);
185 serial_close(serial);
187 sr_serial_dev_inst_free(serial);
192 static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
194 return scan(di, options, PPS_3203T_3S);
197 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
198 const struct sr_channel_group *cg)
200 struct dev_context *devc;
201 struct sr_channel *ch;
211 /* No channel group: global options. */
213 case SR_CONF_CHANNEL_CONFIG:
214 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
216 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
217 *data = g_variant_new_boolean(devc->over_current_protection);
223 /* We only ever have one channel per channel group in this driver. */
224 ch = cg->channels->data;
228 case SR_CONF_VOLTAGE:
229 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
231 case SR_CONF_VOLTAGE_TARGET:
232 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
234 case SR_CONF_CURRENT:
235 *data = g_variant_new_double(devc->config[channel].output_current_last);
237 case SR_CONF_CURRENT_LIMIT:
238 *data = g_variant_new_double(devc->config[channel].output_current_max);
240 case SR_CONF_ENABLED:
241 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
251 static int find_str(const char *str, const char **strings, int array_size)
256 for (i = 0; i < array_size; i++) {
257 if (!strcmp(str, strings[i])) {
266 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
267 const struct sr_channel_group *cg)
269 struct dev_context *devc;
270 struct sr_channel *ch;
272 int channel, ret, ival;
276 if (sdi->status != SR_ST_ACTIVE)
277 return SR_ERR_DEV_CLOSED;
282 /* No channel group: global options. */
284 case SR_CONF_CHANNEL_CONFIG:
285 sval = g_variant_get_string(data, NULL);
286 if ((ival = find_str(sval, channel_modes,
287 ARRAY_SIZE(channel_modes))) == -1) {
291 if (devc->model->channel_modes && (1 << ival) == 0) {
292 /* Not supported on this model. */
295 if (ival == devc->channel_mode_set)
298 devc->channel_mode_set = ival;
299 devc->config_dirty = TRUE;
301 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
302 bval = g_variant_get_boolean(data);
303 if (bval == devc->over_current_protection_set)
306 devc->over_current_protection_set = bval;
307 devc->config_dirty = TRUE;
313 /* Channel group specified: per-channel options. */
314 /* We only ever have one channel per channel group in this driver. */
315 ch = cg->channels->data;
319 case SR_CONF_VOLTAGE_TARGET:
320 dval = g_variant_get_double(data);
321 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
323 devc->config[channel].output_voltage_max = dval;
324 devc->config_dirty = TRUE;
326 case SR_CONF_CURRENT_LIMIT:
327 dval = g_variant_get_double(data);
328 if (dval < 0 || dval > devc->model->channels[channel].current[1])
330 devc->config[channel].output_current_max = dval;
331 devc->config_dirty = TRUE;
333 case SR_CONF_ENABLED:
334 bval = g_variant_get_boolean(data);
335 if (bval == devc->config[channel].output_enabled_set)
338 devc->config[channel].output_enabled_set = bval;
339 devc->config_dirty = TRUE;
349 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
350 const struct sr_channel_group *cg)
352 struct dev_context *devc;
353 struct sr_channel *ch;
358 /* Always available. */
359 if (key == SR_CONF_SCAN_OPTIONS) {
360 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
361 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
365 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
366 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
367 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
377 /* No channel group: global options. */
379 case SR_CONF_DEVICE_OPTIONS:
380 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
381 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
383 case SR_CONF_CHANNEL_CONFIG:
384 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
385 /* The 1-channel models. */
386 *data = g_variant_new_strv(channel_modes, 1);
388 /* The other models support all modes. */
389 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
396 /* Channel group specified: per-channel options. */
399 /* We only ever have one channel per channel group in this driver. */
400 ch = cg->channels->data;
404 case SR_CONF_DEVICE_OPTIONS:
405 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
406 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
408 case SR_CONF_VOLTAGE_TARGET:
409 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
410 /* Min, max, step. */
411 for (i = 0; i < 3; i++) {
412 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
413 g_variant_builder_add_value(&gvb, gvar);
415 *data = g_variant_builder_end(&gvb);
417 case SR_CONF_CURRENT_LIMIT:
418 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
419 /* Min, max, step. */
420 for (i = 0; i < 3; i++) {
421 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
422 g_variant_builder_add_value(&gvb, gvar);
424 *data = g_variant_builder_end(&gvb);
434 static int dev_close(struct sr_dev_inst *sdi)
436 struct dev_context *devc;
439 if (devc->config_dirty)
440 /* Some configuration changes were queued up but didn't
441 * get sent to the device, likely because we were never
442 * in acquisition mode. Send them out now. */
445 return std_serial_dev_close(sdi);
448 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
450 struct dev_context *devc;
451 struct sr_serial_dev_inst *serial;
452 uint8_t packet[PACKET_SIZE];
454 if (sdi->status != SR_ST_ACTIVE)
455 return SR_ERR_DEV_CLOSED;
458 memset(devc->packet, 0x44, PACKET_SIZE);
459 devc->packet_size = 0;
461 devc->acquisition_running = TRUE;
464 serial_source_add(sdi->session, serial, G_IO_IN, 50,
465 atten_pps3xxx_receive_data, (void *)sdi);
466 std_session_send_df_header(sdi, LOG_PREFIX);
468 /* Send a "channel" configuration packet now. */
469 memset(packet, 0, PACKET_SIZE);
472 send_packet(sdi, packet);
477 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
479 struct dev_context *devc;
481 if (sdi->status != SR_ST_ACTIVE)
482 return SR_ERR_DEV_CLOSED;
485 devc->acquisition_running = FALSE;
490 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = {
491 .name = "atten-pps3203",
492 .longname = "Atten PPS3203T-3S",
495 .cleanup = std_cleanup,
497 .dev_list = std_dev_list,
499 .config_get = config_get,
500 .config_set = config_set,
501 .config_list = config_list,
502 .dev_open = std_serial_dev_open,
503 .dev_close = dev_close,
504 .dev_acquisition_start = dev_acquisition_start,
505 .dev_acquisition_stop = dev_acquisition_stop,