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