]> sigrok.org Git - libsigrok.git/blame - src/hardware/atten-pps3xxx/api.c
drivers: Factor out std_*_idx*().
[libsigrok.git] / src / hardware / atten-pps3xxx / api.c
CommitLineData
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 34static const uint32_t scanopts[] = {
33c40990
BV
35 SR_CONF_CONN,
36 SR_CONF_SERIALCOMM,
37};
38
1f889afd 39static const uint32_t drvopts[] = {
33c40990 40 SR_CONF_POWER_SUPPLY,
d6fa8ace
BV
41};
42
1f889afd 43static 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 49static 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
57static const char *channel_modes[] = {
58 "Independent",
59 "Series",
60 "Parallel",
61};
62
329733d9 63static 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 78static 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 180static 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
dd7a72ea
UH
185static int config_get(uint32_t key, GVariant **data,
186 const struct sr_dev_inst *sdi, 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
dd7a72ea
UH
237static int config_set(uint32_t key, GVariant *data,
238 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
fa0d6afe 239{
33c40990 240 struct dev_context *devc;
ba7dd8bb 241 struct sr_channel *ch;
33c40990
BV
242 gdouble dval;
243 int channel, ret, ival;
33c40990 244 gboolean bval;
fa0d6afe 245
fa0d6afe 246 ret = SR_OK;
33c40990 247 devc = sdi->priv;
53b4680f 248 if (!cg) {
33c40990 249 switch (key) {
7a0b98b5 250 case SR_CONF_CHANNEL_CONFIG:
697fb6dd
UH
251 if ((ival = std_str_idx(data, ARRAY_AND_SIZE(channel_modes))) < 0)
252 return SR_ERR_ARG;
33c40990
BV
253 if (devc->model->channel_modes && (1 << ival) == 0) {
254 /* Not supported on this model. */
255 ret = SR_ERR_ARG;
256 }
257 if (ival == devc->channel_mode_set)
258 /* Nothing to do. */
259 break;
260 devc->channel_mode_set = ival;
ab988ecb 261 devc->config_dirty = TRUE;
33c40990 262 break;
a1eaa9e0 263 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
33c40990
BV
264 bval = g_variant_get_boolean(data);
265 if (bval == devc->over_current_protection_set)
266 /* Nothing to do. */
267 break;
268 devc->over_current_protection_set = bval;
ab988ecb 269 devc->config_dirty = TRUE;
33c40990
BV
270 break;
271 default:
272 return SR_ERR_NA;
273 }
274 } else {
660e398f 275 /* We only ever have one channel per channel group in this driver. */
ba7dd8bb
UH
276 ch = cg->channels->data;
277 channel = ch->index;
33c40990
BV
278
279 switch (key) {
7a0b98b5 280 case SR_CONF_VOLTAGE_TARGET:
33c40990
BV
281 dval = g_variant_get_double(data);
282 if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
283 ret = SR_ERR_ARG;
284 devc->config[channel].output_voltage_max = dval;
ab988ecb 285 devc->config_dirty = TRUE;
33c40990 286 break;
7a0b98b5 287 case SR_CONF_CURRENT_LIMIT:
33c40990
BV
288 dval = g_variant_get_double(data);
289 if (dval < 0 || dval > devc->model->channels[channel].current[1])
290 ret = SR_ERR_ARG;
291 devc->config[channel].output_current_max = dval;
ab988ecb 292 devc->config_dirty = TRUE;
33c40990 293 break;
7a0b98b5 294 case SR_CONF_ENABLED:
33c40990
BV
295 bval = g_variant_get_boolean(data);
296 if (bval == devc->config[channel].output_enabled_set)
297 /* Nothing to do. */
298 break;
299 devc->config[channel].output_enabled_set = bval;
ab988ecb 300 devc->config_dirty = TRUE;
33c40990
BV
301 break;
302 default:
303 ret = SR_ERR_NA;
304 }
fa0d6afe
BV
305 }
306
307 return ret;
308}
309
dd7a72ea
UH
310static int config_list(uint32_t key, GVariant **data,
311 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
fa0d6afe 312{
33c40990 313 struct dev_context *devc;
ba7dd8bb 314 struct sr_channel *ch;
54d471f4 315 int channel;
33c40990 316
e66d1892 317 devc = (sdi) ? sdi->priv : NULL;
a9010323 318
53b4680f 319 if (!cg) {
33c40990 320 switch (key) {
e66d1892 321 case SR_CONF_SCAN_OPTIONS:
33c40990 322 case SR_CONF_DEVICE_OPTIONS:
e66d1892 323 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
7a0b98b5 324 case SR_CONF_CHANNEL_CONFIG:
33c40990
BV
325 if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
326 /* The 1-channel models. */
327 *data = g_variant_new_strv(channel_modes, 1);
328 } else {
329 /* The other models support all modes. */
53012da6 330 *data = g_variant_new_strv(ARRAY_AND_SIZE(channel_modes));
33c40990
BV
331 }
332 break;
333 default:
334 return SR_ERR_NA;
335 }
336 } else {
660e398f 337 /* We only ever have one channel per channel group in this driver. */
ba7dd8bb
UH
338 ch = cg->channels->data;
339 channel = ch->index;
33c40990
BV
340
341 switch (key) {
342 case SR_CONF_DEVICE_OPTIONS:
53012da6 343 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
33c40990 344 break;
7a0b98b5 345 case SR_CONF_VOLTAGE_TARGET:
54d471f4 346 *data = std_gvar_min_max_step_array(devc->model->channels[channel].voltage);
33c40990 347 break;
7a0b98b5 348 case SR_CONF_CURRENT_LIMIT:
54d471f4 349 *data = std_gvar_min_max_step_array(devc->model->channels[channel].current);
33c40990
BV
350 break;
351 default:
352 return SR_ERR_NA;
353 }
fa0d6afe
BV
354 }
355
a9010323 356 return SR_OK;
fa0d6afe
BV
357}
358
ab988ecb
BV
359static int dev_close(struct sr_dev_inst *sdi)
360{
361 struct dev_context *devc;
362
363 devc = sdi->priv;
f1ba6b4b 364
ab988ecb
BV
365 if (devc->config_dirty)
366 /* Some configuration changes were queued up but didn't
367 * get sent to the device, likely because we were never
368 * in acquisition mode. Send them out now. */
369 send_config(sdi);
370
371 return std_serial_dev_close(sdi);
372}
373
695dc859 374static int dev_acquisition_start(const struct sr_dev_inst *sdi)
fa0d6afe 375{
33c40990
BV
376 struct dev_context *devc;
377 struct sr_serial_dev_inst *serial;
378 uint8_t packet[PACKET_SIZE];
379
33c40990
BV
380 devc = sdi->priv;
381 memset(devc->packet, 0x44, PACKET_SIZE);
382 devc->packet_size = 0;
383
384 devc->acquisition_running = TRUE;
385
386 serial = sdi->conn;
102f1239
BV
387 serial_source_add(sdi->session, serial, G_IO_IN, 50,
388 atten_pps3xxx_receive_data, (void *)sdi);
bee2b016 389 std_session_send_df_header(sdi);
33c40990 390
ba7dd8bb 391 /* Send a "channel" configuration packet now. */
33c40990
BV
392 memset(packet, 0, PACKET_SIZE);
393 packet[0] = 0xaa;
394 packet[1] = 0xaa;
395 send_packet(sdi, packet);
fa0d6afe
BV
396
397 return SR_OK;
398}
399
695dc859 400static int dev_acquisition_stop(struct sr_dev_inst *sdi)
fa0d6afe 401{
33c40990
BV
402 struct dev_context *devc;
403
33c40990
BV
404 devc = sdi->priv;
405 devc->acquisition_running = FALSE;
fa0d6afe
BV
406
407 return SR_OK;
408}
409
dd5c48a6 410static struct sr_dev_driver atten_pps3203_driver_info = {
33c40990
BV
411 .name = "atten-pps3203",
412 .longname = "Atten PPS3203T-3S",
fa0d6afe 413 .api_version = 1,
c2fdcc25 414 .init = std_init,
700d6b64 415 .cleanup = std_cleanup,
33c40990 416 .scan = scan_3203,
c01bf34c 417 .dev_list = std_dev_list,
f778bf02 418 .dev_clear = std_dev_clear,
fa0d6afe
BV
419 .config_get = config_get,
420 .config_set = config_set,
421 .config_list = config_list,
33c40990 422 .dev_open = std_serial_dev_open,
ab988ecb 423 .dev_close = dev_close,
fa0d6afe
BV
424 .dev_acquisition_start = dev_acquisition_start,
425 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 426 .context = NULL,
fa0d6afe 427};
dd5c48a6 428SR_REGISTER_DEV_DRIVER(atten_pps3203_driver_info);