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 /* This is how the vendor software scans for hardware. */
117 memset(packet, 0, PACKET_SIZE);
120 delay_ms = serial_timeout(serial, PACKET_SIZE);
121 if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) {
122 sr_err("Unable to write while probing for hardware.");
125 /* The device responds with a 24-byte packet when it receives a packet.
126 * At 9600 baud, 300ms is long enough for it to have arrived. */
127 g_usleep(300 * 1000);
128 memset(packet, 0, PACKET_SIZE);
129 if ((ret = serial_read_nonblocking(serial, packet, PACKET_SIZE)) < 0) {
130 sr_err("Unable to read while probing for hardware: %s",
134 if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
135 /* Doesn't look like an Atten PPS. */
140 for (i = 0; i < ARRAY_SIZE(models); i++) {
141 if (models[i].modelid == modelid) {
147 sr_err("Unknown modelid %d", modelid);
151 sdi = g_malloc0(sizeof(struct sr_dev_inst));
152 sdi->status = SR_ST_INACTIVE;
153 sdi->vendor = g_strdup("Atten");
154 sdi->model = g_strdup(model->name);
155 sdi->inst_type = SR_INST_SERIAL;
157 for (i = 0; i < MAX_CHANNELS; i++) {
158 snprintf(channel, 10, "CH%d", i + 1);
159 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
160 cg = g_malloc(sizeof(struct sr_channel_group));
161 cg->name = g_strdup(channel);
162 cg->channels = g_slist_append(NULL, ch);
164 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
167 devc = g_malloc0(sizeof(struct dev_context));
169 devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
170 devc->delay_ms = delay_ms;
173 serial_close(serial);
175 return std_scan_complete(di, g_slist_append(NULL, sdi));
178 static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
180 return scan(di, options, PPS_3203T_3S);
183 static int config_get(uint32_t key, GVariant **data,
184 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
186 struct dev_context *devc;
187 struct sr_channel *ch;
197 case SR_CONF_CHANNEL_CONFIG:
198 *data = g_variant_new_string(channel_modes[devc->channel_mode]);
200 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
201 *data = g_variant_new_boolean(devc->over_current_protection);
207 /* We only ever have one channel per channel group in this driver. */
208 ch = cg->channels->data;
212 case SR_CONF_VOLTAGE:
213 *data = g_variant_new_double(devc->config[channel].output_voltage_last);
215 case SR_CONF_VOLTAGE_TARGET:
216 *data = g_variant_new_double(devc->config[channel].output_voltage_max);
218 case SR_CONF_CURRENT:
219 *data = g_variant_new_double(devc->config[channel].output_current_last);
221 case SR_CONF_CURRENT_LIMIT:
222 *data = g_variant_new_double(devc->config[channel].output_current_max);
224 case SR_CONF_ENABLED:
225 *data = g_variant_new_boolean(devc->config[channel].output_enabled);
235 static int config_set(uint32_t key, GVariant *data,
236 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
238 struct dev_context *devc;
239 struct sr_channel *ch;
248 case SR_CONF_CHANNEL_CONFIG:
249 if ((ival = std_str_idx(data, ARRAY_AND_SIZE(channel_modes))) < 0)
251 if (devc->model->channel_modes && (1 << ival) == 0)
252 return SR_ERR_ARG; /* Not supported on this model. */
253 if (ival == devc->channel_mode_set)
254 break; /* Nothing to do. */
255 devc->channel_mode_set = ival;
256 devc->config_dirty = TRUE;
258 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
259 bval = g_variant_get_boolean(data);
260 if (bval == devc->over_current_protection_set)
261 break; /* Nothing to do. */
262 devc->over_current_protection_set = bval;
263 devc->config_dirty = TRUE;
269 /* We only ever have one channel per channel group in this driver. */
270 ch = cg->channels->data;
274 case SR_CONF_VOLTAGE_TARGET:
275 dval = g_variant_get_double(data);
276 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
278 devc->config[channel].output_voltage_max = dval;
279 devc->config_dirty = TRUE;
281 case SR_CONF_CURRENT_LIMIT:
282 dval = g_variant_get_double(data);
283 if (dval < 0 || dval > devc->model->channels[channel].current[1])
285 devc->config[channel].output_current_max = dval;
286 devc->config_dirty = TRUE;
288 case SR_CONF_ENABLED:
289 bval = g_variant_get_boolean(data);
290 if (bval == devc->config[channel].output_enabled_set)
291 break; /* Nothing to do. */
292 devc->config[channel].output_enabled_set = bval;
293 devc->config_dirty = TRUE;
303 static int config_list(uint32_t key, GVariant **data,
304 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
306 struct dev_context *devc;
307 struct sr_channel *ch;
310 devc = (sdi) ? sdi->priv : NULL;
314 case SR_CONF_SCAN_OPTIONS:
315 case SR_CONF_DEVICE_OPTIONS:
316 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
317 case SR_CONF_CHANNEL_CONFIG:
318 if (!devc || !devc->model)
320 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
321 /* The 1-channel models. */
322 *data = g_variant_new_strv(channel_modes, 1);
324 /* The other models support all modes. */
325 *data = g_variant_new_strv(ARRAY_AND_SIZE(channel_modes));
332 /* We only ever have one channel per channel group in this driver. */
333 ch = cg->channels->data;
337 case SR_CONF_DEVICE_OPTIONS:
338 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
340 case SR_CONF_VOLTAGE_TARGET:
341 if (!devc || !devc->model)
343 *data = std_gvar_min_max_step_array(devc->model->channels[channel].voltage);
345 case SR_CONF_CURRENT_LIMIT:
346 if (!devc || !devc->model)
348 *data = std_gvar_min_max_step_array(devc->model->channels[channel].current);
358 static int dev_close(struct sr_dev_inst *sdi)
360 struct dev_context *devc;
364 if (devc->config_dirty)
365 /* Some configuration changes were queued up but didn't
366 * get sent to the device, likely because we were never
367 * in acquisition mode. Send them out now. */
370 return std_serial_dev_close(sdi);
373 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
375 struct dev_context *devc;
376 struct sr_serial_dev_inst *serial;
377 uint8_t packet[PACKET_SIZE];
380 memset(devc->packet, 0x44, PACKET_SIZE);
381 devc->packet_size = 0;
383 devc->acquisition_running = TRUE;
386 serial_source_add(sdi->session, serial, G_IO_IN, 50,
387 atten_pps3xxx_receive_data, (void *)sdi);
388 std_session_send_df_header(sdi);
390 /* Send a "channel" configuration packet now. */
391 memset(packet, 0, PACKET_SIZE);
394 send_packet(sdi, packet);
399 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
401 struct dev_context *devc;
404 devc->acquisition_running = FALSE;
409 static struct sr_dev_driver atten_pps3203_driver_info = {
410 .name = "atten-pps3203",
411 .longname = "Atten PPS3203T-3S",
414 .cleanup = std_cleanup,
416 .dev_list = std_dev_list,
417 .dev_clear = std_dev_clear,
418 .config_get = config_get,
419 .config_set = config_set,
420 .config_list = config_list,
421 .dev_open = std_serial_dev_open,
422 .dev_close = dev_close,
423 .dev_acquisition_start = dev_acquisition_start,
424 .dev_acquisition_stop = dev_acquisition_stop,
427 SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info);