]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/arachnid-labs-re-load-pro/api.c
Add sr_dev_acquisition_start(), factor out SR_ERR_DEV_CLOSED check.
[libsigrok.git] / src / hardware / arachnid-labs-re-load-pro / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015-2016 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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
20#include <config.h>
21#include <string.h>
22#include "protocol.h"
23
24#define SERIALCOMM "115200/8n1"
25
26#define CMD_VERSION "version\r\n"
27#define CMD_MONITOR "monitor 200\r\n"
28
29static const uint32_t scanopts[] = {
30 SR_CONF_CONN,
31 SR_CONF_SERIALCOMM,
32};
33
34static const uint32_t drvopts[] = {
35 SR_CONF_ELECTRONIC_LOAD,
36};
37
38static const uint32_t devopts[] = {
39 SR_CONF_CONTINUOUS,
40 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
42};
43
44static const uint32_t devopts_cg[] = {
45 SR_CONF_ENABLED | SR_CONF_SET,
46 SR_CONF_REGULATION | SR_CONF_GET,
47 SR_CONF_VOLTAGE | SR_CONF_GET,
48 SR_CONF_CURRENT | SR_CONF_GET,
49 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
50 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET,
51 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET,
52 SR_CONF_OVER_TEMPERATURE_PROTECTION | SR_CONF_GET,
53 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE | SR_CONF_GET,
54 SR_CONF_UNDER_VOLTAGE_CONDITION | SR_CONF_GET,
55 SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE | SR_CONF_GET,
56};
57
58static GSList *scan(struct sr_dev_driver *di, GSList *options)
59{
60 struct sr_dev_inst *sdi;
61 struct dev_context *devc;
62 struct sr_config *src;
63 struct sr_serial_dev_inst *serial;
64 struct sr_channel_group *cg;
65 struct sr_channel *ch;
66 GSList *l;
67 int ret, len;
68 const char *conn, *serialcomm;
69 char buf[100];
70 char *bufptr;
71 double version;
72
73 conn = serialcomm = NULL;
74 for (l = options; l; l = l->next) {
75 src = l->data;
76 switch (src->key) {
77 case SR_CONF_CONN:
78 conn = g_variant_get_string(src->data, NULL);
79 break;
80 case SR_CONF_SERIALCOMM:
81 serialcomm = g_variant_get_string(src->data, NULL);
82 break;
83 }
84 }
85 if (!conn)
86 return NULL;
87 if (!serialcomm)
88 serialcomm = SERIALCOMM;
89
90 serial = sr_serial_dev_inst_new(conn, serialcomm);
91
92 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
93 return NULL;
94
95 serial_flush(serial);
96
97 if (serial_write_blocking(serial, CMD_VERSION,
98 strlen(CMD_VERSION), serial_timeout(serial,
99 strlen(CMD_VERSION))) < (int)strlen(CMD_VERSION)) {
100 sr_dbg("Unable to write while probing for hardware.");
101 serial_close(serial);
102 return NULL;
103 }
104
105 memset(buf, 0, sizeof(buf));
106 bufptr = buf;
107 len = sizeof(buf);
108 ret = serial_readline(serial, &bufptr, &len, 3000);
109
110 if (ret < 0 || len < 9 || strncmp((const char *)&buf, "version ", 8)) {
111 sr_dbg("Unable to probe version number.");
112 serial_close(serial);
113 return NULL;
114 }
115
116 version = g_ascii_strtod(buf + 8, NULL);
117 if (version < 1.10) {
118 sr_info("Firmware >= 1.10 required (got %1.2f).", version);
119 serial_close(serial);
120 return NULL;
121 }
122
123 sdi = g_malloc0(sizeof(struct sr_dev_inst));
124 sdi->status = SR_ST_INACTIVE;
125 sdi->vendor = g_strdup("Arachnid Labs");
126 sdi->model = g_strdup("Re:load Pro");
127 sdi->version = g_strdup(buf + 8);
128 sdi->inst_type = SR_INST_SERIAL;
129 sdi->conn = serial;
130
131 cg = g_malloc0(sizeof(struct sr_channel_group));
132 cg->name = g_strdup("1");
133 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
134
135 ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
136 cg->channels = g_slist_append(cg->channels, ch);
137
138 ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "I");
139 cg->channels = g_slist_append(cg->channels, ch);
140
141 devc = g_malloc0(sizeof(struct dev_context));
142 sr_sw_limits_init(&devc->limits);
143 sdi->priv = devc;
144
145 serial_close(serial);
146
147 return std_scan_complete(di, g_slist_append(NULL, sdi));
148}
149
150static int config_list(uint32_t key, GVariant **data,
151 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
152{
153 GVariantBuilder gvb;
154 int ret;
155
156 /* Always available. */
157 if (key == SR_CONF_SCAN_OPTIONS) {
158 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
159 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
160 return SR_OK;
161 }
162
163 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
164 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
165 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
166 return SR_OK;
167 }
168
169 if (!sdi)
170 return SR_ERR_ARG;
171
172 ret = SR_OK;
173
174 if (!cg) {
175 /* No channel group: global options. */
176 switch (key) {
177 case SR_CONF_DEVICE_OPTIONS:
178 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
179 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
180 break;
181 default:
182 return SR_ERR_NA;
183 }
184 } else {
185 switch (key) {
186 case SR_CONF_DEVICE_OPTIONS:
187 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
188 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
189 break;
190 case SR_CONF_CURRENT_LIMIT:
191 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
192 /* Min, max, step. */
193 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
194 g_variant_builder_add_value(&gvb, g_variant_new_double(6.0));
195 g_variant_builder_add_value(&gvb, g_variant_new_double(0.001)); /* 1mA steps */
196 *data = g_variant_builder_end(&gvb);
197 break;
198 default:
199 return SR_ERR_NA;
200 }
201 }
202
203 return ret;
204}
205
206static int config_get(uint32_t key, GVariant **data,
207 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
208{
209 struct dev_context *devc;
210 int ret;
211 float fvalue;
212
213 (void)cg;
214
215 devc = sdi->priv;
216
217 /*
218 * These features/keys are not supported by the hardware:
219 * - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
220 * - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
221 * - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
222 * - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
223 * - SR_CONF_ENABLED (state cannot be queried, only set)
224 */
225
226 ret = SR_OK;
227 switch (key) {
228 case SR_CONF_LIMIT_SAMPLES:
229 case SR_CONF_LIMIT_MSEC:
230 return sr_sw_limits_config_get(&devc->limits, key, data);
231 case SR_CONF_REGULATION:
232 *data = g_variant_new_string("CC"); /* Always CC mode. */
233 break;
234 case SR_CONF_VOLTAGE:
235 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
236 return SR_ERR;
237 *data = g_variant_new_double(fvalue);
238 break;
239 case SR_CONF_CURRENT:
240 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
241 return SR_ERR;
242 *data = g_variant_new_double(fvalue);
243 break;
244 case SR_CONF_CURRENT_LIMIT:
245 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
246 *data = g_variant_new_double(fvalue);
247 break;
248 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
249 *data = g_variant_new_boolean(TRUE); /* Always on. */
250 break;
251 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
252 *data = g_variant_new_boolean(TRUE); /* Always on. */
253 break;
254 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
255 *data = g_variant_new_boolean(TRUE); /* Always on. */
256 break;
257 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
258 *data = g_variant_new_boolean(devc->otp_active);
259 break;
260 case SR_CONF_UNDER_VOLTAGE_CONDITION:
261 *data = g_variant_new_boolean(TRUE); /* Always on. */
262 break;
263 case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
264 *data = g_variant_new_boolean(devc->uvc_active);
265 break;
266 default:
267 return SR_ERR_NA;
268 }
269
270 return ret;
271}
272
273static int config_set(uint32_t key, GVariant *data,
274 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
275{
276 struct dev_context *devc;
277 int ret;
278
279 (void)cg;
280
281 if (sdi->status != SR_ST_ACTIVE)
282 return SR_ERR_DEV_CLOSED;
283
284 devc = sdi->priv;
285
286 ret = SR_OK;
287 switch (key) {
288 case SR_CONF_LIMIT_SAMPLES:
289 case SR_CONF_LIMIT_MSEC:
290 return sr_sw_limits_config_set(&devc->limits, key, data);
291 case SR_CONF_ENABLED:
292 ret = reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
293 break;
294 case SR_CONF_CURRENT_LIMIT:
295 ret = reloadpro_set_current_limit(sdi,
296 g_variant_get_double(data));
297 break;
298 default:
299 ret = SR_ERR_NA;
300 }
301
302 return ret;
303}
304
305static int dev_acquisition_start(const struct sr_dev_inst *sdi)
306{
307 int ret;
308 struct dev_context *devc;
309 struct sr_serial_dev_inst *serial;
310
311 devc = sdi->priv;
312 serial = sdi->conn;
313
314 /* Send the 'monitor <ms>' command (doesn't have a reply). */
315 if ((ret = serial_write_blocking(serial, CMD_MONITOR,
316 strlen(CMD_MONITOR), serial_timeout(serial,
317 strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
318 sr_err("Unable to send 'monitor' command: %d.", ret);
319 return SR_ERR;
320 }
321
322 /* Poll every 100ms, or whenever some data comes in. */
323 serial_source_add(sdi->session, serial, G_IO_IN, 100,
324 reloadpro_receive_data, (void *)sdi);
325
326 sr_sw_limits_acquisition_start(&devc->limits);
327 std_session_send_df_header(sdi);
328
329 memset(devc->buf, 0, RELOADPRO_BUFSIZE);
330 devc->buflen = 0;
331
332 return SR_OK;
333}
334
335static struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
336 .name = "arachnid-labs-re-load-pro",
337 .longname = "Arachnid Labs Re:load Pro",
338 .api_version = 1,
339 .init = std_init,
340 .cleanup = std_cleanup,
341 .scan = scan,
342 .dev_list = std_dev_list,
343 .config_get = config_get,
344 .config_set = config_set,
345 .config_list = config_list,
346 .dev_open = std_serial_dev_open,
347 .dev_close = std_serial_dev_close,
348 .dev_acquisition_start = dev_acquisition_start,
349 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
350 .context = NULL,
351};
352SR_REGISTER_DEV_DRIVER(arachnid_labs_re_load_pro_driver_info);