]>
Commit | Line | Data |
---|---|---|
fa0d6afe BV |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2014 Bert Vermeulen <bert@biot.com> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
6ec6c43b | 20 | #include <config.h> |
33c40990 | 21 | #include <string.h> |
fa0d6afe BV |
22 | #include "protocol.h" |
23 | ||
33c40990 BV |
24 | /* |
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. | |
28 | * | |
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. | |
31 | */ | |
32 | #define SERIALCOMM "9600/8n2" | |
33 | ||
584560f1 | 34 | static const uint32_t scanopts[] = { |
33c40990 BV |
35 | SR_CONF_CONN, |
36 | SR_CONF_SERIALCOMM, | |
37 | }; | |
38 | ||
1f889afd | 39 | static const uint32_t drvopts[] = { |
33c40990 | 40 | SR_CONF_POWER_SUPPLY, |
d6fa8ace BV |
41 | }; |
42 | ||
1f889afd | 43 | static const uint32_t devopts[] = { |
e91bb0a6 | 44 | SR_CONF_CONTINUOUS, |
7a0b98b5 | 45 | SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, |
5827f61b | 46 | SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET, |
33c40990 BV |
47 | }; |
48 | ||
584560f1 | 49 | static const uint32_t devopts_cg[] = { |
7a0b98b5 AJ |
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, | |
33c40990 BV |
55 | }; |
56 | ||
57 | static const char *channel_modes[] = { | |
58 | "Independent", | |
59 | "Series", | |
60 | "Parallel", | |
61 | }; | |
62 | ||
329733d9 | 63 | static const struct pps_model models[] = { |
33c40990 BV |
64 | { PPS_3203T_3S, "PPS3203T-3S", |
65 | CHANMODE_INDEPENDENT | CHANMODE_SERIES | CHANMODE_PARALLEL, | |
66 | 3, | |
67 | { | |
68 | /* Channel 1 */ | |
69 | { { 0, 32, 0.01 }, { 0, 3, 0.001 } }, | |
70 | /* Channel 2 */ | |
71 | { { 0, 32, 0.01 }, { 0, 3, 0.001 } }, | |
72 | /* Channel 3 */ | |
73 | { { 0, 6, 0.01 }, { 0, 3, 0.001 } }, | |
74 | }, | |
75 | }, | |
76 | }; | |
77 | ||
4f840ce9 | 78 | static GSList *scan(struct sr_dev_driver *di, GSList *options, int modelid) |
fa0d6afe | 79 | { |
33c40990 | 80 | struct sr_dev_inst *sdi; |
33c40990 BV |
81 | struct dev_context *devc; |
82 | struct sr_config *src; | |
ba7dd8bb | 83 | struct sr_channel *ch; |
40fd0264 | 84 | struct sr_channel_group *cg; |
33c40990 | 85 | struct sr_serial_dev_inst *serial; |
43376f33 | 86 | GSList *l; |
329733d9 | 87 | const struct pps_model *model; |
33c40990 BV |
88 | uint8_t packet[PACKET_SIZE]; |
89 | unsigned int i; | |
2eb1612d | 90 | int delay_ms, ret; |
33c40990 BV |
91 | const char *conn, *serialcomm; |
92 | char channel[10]; | |
fa0d6afe | 93 | |
33c40990 BV |
94 | conn = serialcomm = NULL; |
95 | for (l = options; l; l = l->next) { | |
96 | src = l->data; | |
97 | switch (src->key) { | |
98 | case SR_CONF_CONN: | |
99 | conn = g_variant_get_string(src->data, NULL); | |
100 | break; | |
101 | case SR_CONF_SERIALCOMM: | |
102 | serialcomm = g_variant_get_string(src->data, NULL); | |
103 | break; | |
104 | } | |
105 | } | |
106 | if (!conn) | |
107 | return NULL; | |
108 | if (!serialcomm) | |
109 | serialcomm = SERIALCOMM; | |
110 | ||
91219afc | 111 | serial = sr_serial_dev_inst_new(conn, serialcomm); |
33c40990 | 112 | |
5305266a | 113 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) |
33c40990 | 114 | return NULL; |
91219afc | 115 | |
33c40990 BV |
116 | serial_flush(serial); |
117 | ||
945cfd4f | 118 | /* This is how the vendor software scans for hardware. */ |
33c40990 BV |
119 | memset(packet, 0, PACKET_SIZE); |
120 | packet[0] = 0xaa; | |
121 | packet[1] = 0xaa; | |
2eb1612d BV |
122 | delay_ms = serial_timeout(serial, PACKET_SIZE); |
123 | if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) { | |
081c214e | 124 | sr_err("Unable to write while probing for hardware."); |
33c40990 BV |
125 | return NULL; |
126 | } | |
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", | |
8d522801 | 133 | sr_strerror(ret)); |
33c40990 BV |
134 | return NULL; |
135 | } | |
136 | if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) { | |
137 | /* Doesn't look like an Atten PPS. */ | |
138 | return NULL; | |
139 | } | |
140 | ||
141 | model = NULL; | |
142 | for (i = 0; i < ARRAY_SIZE(models); i++) { | |
143 | if (models[i].modelid == modelid) { | |
144 | model = &models[i]; | |
145 | break; | |
146 | } | |
147 | } | |
148 | if (!model) { | |
149 | sr_err("Unknown modelid %d", modelid); | |
150 | return NULL; | |
151 | } | |
152 | ||
aac29cc1 | 153 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); |
0af636be UH |
154 | sdi->status = SR_ST_INACTIVE; |
155 | sdi->vendor = g_strdup("Atten"); | |
156 | sdi->model = g_strdup(model->name); | |
33c40990 BV |
157 | sdi->inst_type = SR_INST_SERIAL; |
158 | sdi->conn = serial; | |
159 | for (i = 0; i < MAX_CHANNELS; i++) { | |
160 | snprintf(channel, 10, "CH%d", i + 1); | |
5e23fcab | 161 | ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel); |
40fd0264 UH |
162 | cg = g_malloc(sizeof(struct sr_channel_group)); |
163 | cg->name = g_strdup(channel); | |
ba7dd8bb | 164 | cg->channels = g_slist_append(NULL, ch); |
40fd0264 UH |
165 | cg->priv = NULL; |
166 | sdi->channel_groups = g_slist_append(sdi->channel_groups, cg); | |
33c40990 BV |
167 | } |
168 | ||
169 | devc = g_malloc0(sizeof(struct dev_context)); | |
170 | devc->model = model; | |
171 | devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels); | |
2eb1612d | 172 | devc->delay_ms = delay_ms; |
33c40990 | 173 | sdi->priv = devc; |
33c40990 BV |
174 | |
175 | serial_close(serial); | |
fa0d6afe | 176 | |
43376f33 | 177 | return std_scan_complete(di, g_slist_append(NULL, sdi)); |
fa0d6afe BV |
178 | } |
179 | ||
4f840ce9 | 180 | static GSList *scan_3203(struct sr_dev_driver *di, GSList *options) |
33c40990 | 181 | { |
4f840ce9 | 182 | return scan(di, options, PPS_3203T_3S); |
33c40990 BV |
183 | } |
184 | ||
584560f1 | 185 | static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, |
53b4680f | 186 | const struct sr_channel_group *cg) |
fa0d6afe | 187 | { |
33c40990 | 188 | struct dev_context *devc; |
ba7dd8bb | 189 | struct sr_channel *ch; |
a9010323 | 190 | int channel; |
33c40990 BV |
191 | |
192 | if (!sdi) | |
193 | return SR_ERR_ARG; | |
fa0d6afe | 194 | |
33c40990 | 195 | devc = sdi->priv; |
fa0d6afe | 196 | |
53b4680f | 197 | if (!cg) { |
33c40990 | 198 | switch (key) { |
7a0b98b5 | 199 | case SR_CONF_CHANNEL_CONFIG: |
fe997353 | 200 | *data = g_variant_new_string(channel_modes[devc->channel_mode]); |
33c40990 | 201 | break; |
a1eaa9e0 | 202 | case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED: |
33c40990 BV |
203 | *data = g_variant_new_boolean(devc->over_current_protection); |
204 | break; | |
205 | default: | |
206 | return SR_ERR_NA; | |
207 | } | |
208 | } else { | |
660e398f | 209 | /* We only ever have one channel per channel group in this driver. */ |
ba7dd8bb UH |
210 | ch = cg->channels->data; |
211 | channel = ch->index; | |
33c40990 BV |
212 | |
213 | switch (key) { | |
7a0b98b5 | 214 | case SR_CONF_VOLTAGE: |
33c40990 BV |
215 | *data = g_variant_new_double(devc->config[channel].output_voltage_last); |
216 | break; | |
7a0b98b5 | 217 | case SR_CONF_VOLTAGE_TARGET: |
33c40990 BV |
218 | *data = g_variant_new_double(devc->config[channel].output_voltage_max); |
219 | break; | |
7a0b98b5 | 220 | case SR_CONF_CURRENT: |
33c40990 BV |
221 | *data = g_variant_new_double(devc->config[channel].output_current_last); |
222 | break; | |
7a0b98b5 | 223 | case SR_CONF_CURRENT_LIMIT: |
33c40990 BV |
224 | *data = g_variant_new_double(devc->config[channel].output_current_max); |
225 | break; | |
7a0b98b5 | 226 | case SR_CONF_ENABLED: |
33c40990 BV |
227 | *data = g_variant_new_boolean(devc->config[channel].output_enabled); |
228 | break; | |
229 | default: | |
230 | return SR_ERR_NA; | |
231 | } | |
fa0d6afe BV |
232 | } |
233 | ||
a9010323 | 234 | return SR_OK; |
fa0d6afe BV |
235 | } |
236 | ||
33c40990 BV |
237 | static int find_str(const char *str, const char **strings, int array_size) |
238 | { | |
239 | int idx, i; | |
240 | ||
241 | idx = -1; | |
242 | for (i = 0; i < array_size; i++) { | |
243 | if (!strcmp(str, strings[i])) { | |
244 | idx = i; | |
245 | break; | |
246 | } | |
247 | } | |
248 | ||
249 | return idx; | |
250 | } | |
251 | ||
584560f1 | 252 | static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, |
53b4680f | 253 | const struct sr_channel_group *cg) |
fa0d6afe | 254 | { |
33c40990 | 255 | struct dev_context *devc; |
ba7dd8bb | 256 | struct sr_channel *ch; |
33c40990 BV |
257 | gdouble dval; |
258 | int channel, ret, ival; | |
259 | const char *sval; | |
260 | gboolean bval; | |
fa0d6afe | 261 | |
fa0d6afe | 262 | ret = SR_OK; |
33c40990 | 263 | devc = sdi->priv; |
53b4680f | 264 | if (!cg) { |
33c40990 | 265 | switch (key) { |
7a0b98b5 | 266 | case SR_CONF_CHANNEL_CONFIG: |
33c40990 BV |
267 | sval = g_variant_get_string(data, NULL); |
268 | if ((ival = find_str(sval, channel_modes, | |
269 | ARRAY_SIZE(channel_modes))) == -1) { | |
270 | ret = SR_ERR_ARG; | |
271 | break; | |
272 | } | |
273 | if (devc->model->channel_modes && (1 << ival) == 0) { | |
274 | /* Not supported on this model. */ | |
275 | ret = SR_ERR_ARG; | |
276 | } | |
277 | if (ival == devc->channel_mode_set) | |
278 | /* Nothing to do. */ | |
279 | break; | |
280 | devc->channel_mode_set = ival; | |
ab988ecb | 281 | devc->config_dirty = TRUE; |
33c40990 | 282 | break; |
a1eaa9e0 | 283 | case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED: |
33c40990 BV |
284 | bval = g_variant_get_boolean(data); |
285 | if (bval == devc->over_current_protection_set) | |
286 | /* Nothing to do. */ | |
287 | break; | |
288 | devc->over_current_protection_set = bval; | |
ab988ecb | 289 | devc->config_dirty = TRUE; |
33c40990 BV |
290 | break; |
291 | default: | |
292 | return SR_ERR_NA; | |
293 | } | |
294 | } else { | |
660e398f | 295 | /* We only ever have one channel per channel group in this driver. */ |
ba7dd8bb UH |
296 | ch = cg->channels->data; |
297 | channel = ch->index; | |
33c40990 BV |
298 | |
299 | switch (key) { | |
7a0b98b5 | 300 | case SR_CONF_VOLTAGE_TARGET: |
33c40990 BV |
301 | dval = g_variant_get_double(data); |
302 | if (dval < 0 || dval > devc->model->channels[channel].voltage[1]) | |
303 | ret = SR_ERR_ARG; | |
304 | devc->config[channel].output_voltage_max = dval; | |
ab988ecb | 305 | devc->config_dirty = TRUE; |
33c40990 | 306 | break; |
7a0b98b5 | 307 | case SR_CONF_CURRENT_LIMIT: |
33c40990 BV |
308 | dval = g_variant_get_double(data); |
309 | if (dval < 0 || dval > devc->model->channels[channel].current[1]) | |
310 | ret = SR_ERR_ARG; | |
311 | devc->config[channel].output_current_max = dval; | |
ab988ecb | 312 | devc->config_dirty = TRUE; |
33c40990 | 313 | break; |
7a0b98b5 | 314 | case SR_CONF_ENABLED: |
33c40990 BV |
315 | bval = g_variant_get_boolean(data); |
316 | if (bval == devc->config[channel].output_enabled_set) | |
317 | /* Nothing to do. */ | |
318 | break; | |
319 | devc->config[channel].output_enabled_set = bval; | |
ab988ecb | 320 | devc->config_dirty = TRUE; |
33c40990 BV |
321 | break; |
322 | default: | |
323 | ret = SR_ERR_NA; | |
324 | } | |
fa0d6afe BV |
325 | } |
326 | ||
327 | return ret; | |
328 | } | |
329 | ||
584560f1 | 330 | static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, |
53b4680f | 331 | const struct sr_channel_group *cg) |
fa0d6afe | 332 | { |
33c40990 | 333 | struct dev_context *devc; |
ba7dd8bb | 334 | struct sr_channel *ch; |
33c40990 BV |
335 | GVariant *gvar; |
336 | GVariantBuilder gvb; | |
a9010323 | 337 | int channel, i; |
33c40990 | 338 | |
e66d1892 | 339 | devc = (sdi) ? sdi->priv : NULL; |
a9010323 | 340 | |
53b4680f | 341 | if (!cg) { |
33c40990 | 342 | switch (key) { |
e66d1892 | 343 | case SR_CONF_SCAN_OPTIONS: |
33c40990 | 344 | case SR_CONF_DEVICE_OPTIONS: |
e66d1892 | 345 | return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); |
7a0b98b5 | 346 | case SR_CONF_CHANNEL_CONFIG: |
33c40990 BV |
347 | if (devc->model->channel_modes == CHANMODE_INDEPENDENT) { |
348 | /* The 1-channel models. */ | |
349 | *data = g_variant_new_strv(channel_modes, 1); | |
350 | } else { | |
351 | /* The other models support all modes. */ | |
352 | *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes)); | |
353 | } | |
354 | break; | |
355 | default: | |
356 | return SR_ERR_NA; | |
357 | } | |
358 | } else { | |
660e398f | 359 | /* We only ever have one channel per channel group in this driver. */ |
ba7dd8bb UH |
360 | ch = cg->channels->data; |
361 | channel = ch->index; | |
33c40990 BV |
362 | |
363 | switch (key) { | |
364 | case SR_CONF_DEVICE_OPTIONS: | |
584560f1 BV |
365 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, |
366 | devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t)); | |
33c40990 | 367 | break; |
7a0b98b5 | 368 | case SR_CONF_VOLTAGE_TARGET: |
33c40990 BV |
369 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); |
370 | /* Min, max, step. */ | |
371 | for (i = 0; i < 3; i++) { | |
372 | gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]); | |
373 | g_variant_builder_add_value(&gvb, gvar); | |
374 | } | |
375 | *data = g_variant_builder_end(&gvb); | |
376 | break; | |
7a0b98b5 | 377 | case SR_CONF_CURRENT_LIMIT: |
33c40990 BV |
378 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); |
379 | /* Min, max, step. */ | |
380 | for (i = 0; i < 3; i++) { | |
381 | gvar = g_variant_new_double(devc->model->channels[channel].current[i]); | |
382 | g_variant_builder_add_value(&gvb, gvar); | |
383 | } | |
384 | *data = g_variant_builder_end(&gvb); | |
385 | break; | |
386 | default: | |
387 | return SR_ERR_NA; | |
388 | } | |
fa0d6afe BV |
389 | } |
390 | ||
a9010323 | 391 | return SR_OK; |
fa0d6afe BV |
392 | } |
393 | ||
ab988ecb BV |
394 | static int dev_close(struct sr_dev_inst *sdi) |
395 | { | |
396 | struct dev_context *devc; | |
397 | ||
398 | devc = sdi->priv; | |
f1ba6b4b | 399 | |
ab988ecb BV |
400 | if (devc->config_dirty) |
401 | /* Some configuration changes were queued up but didn't | |
402 | * get sent to the device, likely because we were never | |
403 | * in acquisition mode. Send them out now. */ | |
404 | send_config(sdi); | |
405 | ||
406 | return std_serial_dev_close(sdi); | |
407 | } | |
408 | ||
695dc859 | 409 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
fa0d6afe | 410 | { |
33c40990 BV |
411 | struct dev_context *devc; |
412 | struct sr_serial_dev_inst *serial; | |
413 | uint8_t packet[PACKET_SIZE]; | |
414 | ||
33c40990 BV |
415 | devc = sdi->priv; |
416 | memset(devc->packet, 0x44, PACKET_SIZE); | |
417 | devc->packet_size = 0; | |
418 | ||
419 | devc->acquisition_running = TRUE; | |
420 | ||
421 | serial = sdi->conn; | |
102f1239 BV |
422 | serial_source_add(sdi->session, serial, G_IO_IN, 50, |
423 | atten_pps3xxx_receive_data, (void *)sdi); | |
bee2b016 | 424 | std_session_send_df_header(sdi); |
33c40990 | 425 | |
ba7dd8bb | 426 | /* Send a "channel" configuration packet now. */ |
33c40990 BV |
427 | memset(packet, 0, PACKET_SIZE); |
428 | packet[0] = 0xaa; | |
429 | packet[1] = 0xaa; | |
430 | send_packet(sdi, packet); | |
fa0d6afe BV |
431 | |
432 | return SR_OK; | |
433 | } | |
434 | ||
695dc859 | 435 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
fa0d6afe | 436 | { |
33c40990 BV |
437 | struct dev_context *devc; |
438 | ||
33c40990 BV |
439 | devc = sdi->priv; |
440 | devc->acquisition_running = FALSE; | |
fa0d6afe BV |
441 | |
442 | return SR_OK; | |
443 | } | |
444 | ||
dd5c48a6 | 445 | static struct sr_dev_driver atten_pps3203_driver_info = { |
33c40990 BV |
446 | .name = "atten-pps3203", |
447 | .longname = "Atten PPS3203T-3S", | |
fa0d6afe | 448 | .api_version = 1, |
c2fdcc25 | 449 | .init = std_init, |
700d6b64 | 450 | .cleanup = std_cleanup, |
33c40990 | 451 | .scan = scan_3203, |
c01bf34c | 452 | .dev_list = std_dev_list, |
f778bf02 | 453 | .dev_clear = std_dev_clear, |
fa0d6afe BV |
454 | .config_get = config_get, |
455 | .config_set = config_set, | |
456 | .config_list = config_list, | |
33c40990 | 457 | .dev_open = std_serial_dev_open, |
ab988ecb | 458 | .dev_close = dev_close, |
fa0d6afe BV |
459 | .dev_acquisition_start = dev_acquisition_start, |
460 | .dev_acquisition_stop = dev_acquisition_stop, | |
41812aca | 461 | .context = NULL, |
fa0d6afe | 462 | }; |
dd5c48a6 | 463 | SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info); |