]> sigrok.org Git - libsigrok.git/blame - src/hardware/arachnid-labs-re-load-pro/api.c
output/csv: use intermediate time_t var, silence compiler warning
[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
2ea1fdf1 17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
6e8d31d4
UH
18 */
19
20#include <config.h>
803db07a 21#include <string.h>
6e8d31d4
UH
22#include "protocol.h"
23
803db07a
UH
24#define SERIALCOMM "115200/8n1"
25
26#define CMD_VERSION "version\r\n"
27#define CMD_MONITOR "monitor 200\r\n"
b76a414d 28#define CMD_MONITOR_STOP "monitor 0\r\n"
803db07a
UH
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[] = {
e91bb0a6 40 SR_CONF_CONTINUOUS,
803db07a
UH
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,
70635036 47 SR_CONF_REGULATION | SR_CONF_GET | SR_CONF_LIST,
803db07a
UH
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,
3d70d777 57 SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
803db07a
UH
58};
59
70635036
FS
60static const char *regulation[] = {
61 /* CC mode only. */
62 "CC",
63};
64
6e8d31d4
UH
65static GSList *scan(struct sr_dev_driver *di, GSList *options)
66{
803db07a 67 struct sr_dev_inst *sdi;
803db07a
UH
68 struct dev_context *devc;
69 struct sr_config *src;
70 struct sr_serial_dev_inst *serial;
71 struct sr_channel_group *cg;
72 struct sr_channel *ch;
43376f33 73 GSList *l;
803db07a
UH
74 int ret, len;
75 const char *conn, *serialcomm;
76 char buf[100];
77 char *bufptr;
8084e0fa 78 double version;
6e8d31d4 79
803db07a
UH
80 conn = serialcomm = NULL;
81 for (l = options; l; l = l->next) {
82 src = l->data;
83 switch (src->key) {
84 case SR_CONF_CONN:
85 conn = g_variant_get_string(src->data, NULL);
86 break;
87 case SR_CONF_SERIALCOMM:
88 serialcomm = g_variant_get_string(src->data, NULL);
89 break;
90 }
91 }
92 if (!conn)
93 return NULL;
94 if (!serialcomm)
95 serialcomm = SERIALCOMM;
96
97 serial = sr_serial_dev_inst_new(conn, serialcomm);
98
99 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
100 return NULL;
101
b76a414d
FS
102 /*
103 * First stop potentially running monitoring and wait for 50ms before
104 * next command can be sent.
105 */
106 if (serial_write_blocking(serial, CMD_MONITOR_STOP,
107 strlen(CMD_MONITOR_STOP), serial_timeout(serial,
108 strlen(CMD_MONITOR_STOP))) < (int)strlen(CMD_MONITOR_STOP)) {
109 sr_dbg("Unable to write while probing for hardware.");
110 serial_close(serial);
111 return NULL;
112 }
113 g_usleep(50 * 1000);
114
803db07a
UH
115 if (serial_write_blocking(serial, CMD_VERSION,
116 strlen(CMD_VERSION), serial_timeout(serial,
117 strlen(CMD_VERSION))) < (int)strlen(CMD_VERSION)) {
118 sr_dbg("Unable to write while probing for hardware.");
119 serial_close(serial);
120 return NULL;
121 }
122
123 memset(buf, 0, sizeof(buf));
124 bufptr = buf;
125 len = sizeof(buf);
126 ret = serial_readline(serial, &bufptr, &len, 3000);
127
128 if (ret < 0 || len < 9 || strncmp((const char *)&buf, "version ", 8)) {
129 sr_dbg("Unable to probe version number.");
130 serial_close(serial);
131 return NULL;
132 }
133
8084e0fa
UH
134 version = g_ascii_strtod(buf + 8, NULL);
135 if (version < 1.10) {
136 sr_info("Firmware >= 1.10 required (got %1.2f).", version);
137 serial_close(serial);
138 return NULL;
139 }
140
803db07a 141 sdi = g_malloc0(sizeof(struct sr_dev_inst));
45884333 142 sdi->status = SR_ST_INACTIVE;
803db07a
UH
143 sdi->vendor = g_strdup("Arachnid Labs");
144 sdi->model = g_strdup("Re:load Pro");
145 sdi->version = g_strdup(buf + 8);
803db07a
UH
146 sdi->inst_type = SR_INST_SERIAL;
147 sdi->conn = serial;
148
d810901a 149 cg = sr_channel_group_new(sdi, "1", NULL);
803db07a
UH
150
151 ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
152 cg->channels = g_slist_append(cg->channels, ch);
153
21530939 154 ch = sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
803db07a
UH
155 cg->channels = g_slist_append(cg->channels, ch);
156
157 devc = g_malloc0(sizeof(struct dev_context));
014c7f93 158 sr_sw_limits_init(&devc->limits);
803db07a 159 sdi->priv = devc;
803db07a
UH
160
161 serial_close(serial);
803db07a 162
43376f33 163 return std_scan_complete(di, g_slist_append(NULL, sdi));
6e8d31d4
UH
164}
165
803db07a
UH
166static int config_list(uint32_t key, GVariant **data,
167 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
6e8d31d4 168{
803db07a 169 if (!cg) {
e66d1892 170 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
803db07a
UH
171 } else {
172 switch (key) {
173 case SR_CONF_DEVICE_OPTIONS:
53012da6 174 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
803db07a 175 break;
70635036
FS
176 case SR_CONF_REGULATION:
177 *data = std_gvar_array_str(ARRAY_AND_SIZE(regulation));
178 break;
803db07a 179 case SR_CONF_CURRENT_LIMIT:
54d471f4 180 *data = std_gvar_min_max_step(0.0, 6.0, 0.001);
803db07a 181 break;
3d70d777
FS
182 case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
183 *data = std_gvar_min_max_step(0.0, 60.0, 0.001);
184 break;
803db07a
UH
185 default:
186 return SR_ERR_NA;
187 }
188 }
189
a9010323 190 return SR_OK;
6e8d31d4
UH
191}
192
193static int config_get(uint32_t key, GVariant **data,
194 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
195{
803db07a 196 struct dev_context *devc;
803db07a 197 float fvalue;
6e8d31d4 198
6e8d31d4
UH
199 (void)cg;
200
803db07a
UH
201 devc = sdi->priv;
202
203 /*
204 * These features/keys are not supported by the hardware:
205 * - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
206 * - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
207 * - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
208 * - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
8501448c 209 * - SR_CONF_ENABLED (state cannot be queried, only set)
803db07a
UH
210 */
211
6e8d31d4 212 switch (key) {
803db07a 213 case SR_CONF_LIMIT_SAMPLES:
803db07a 214 case SR_CONF_LIMIT_MSEC:
014c7f93 215 return sr_sw_limits_config_get(&devc->limits, key, data);
803db07a
UH
216 case SR_CONF_REGULATION:
217 *data = g_variant_new_string("CC"); /* Always CC mode. */
218 break;
219 case SR_CONF_VOLTAGE:
220 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
221 return SR_ERR;
222 *data = g_variant_new_double(fvalue);
223 break;
224 case SR_CONF_CURRENT:
225 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
226 return SR_ERR;
227 *data = g_variant_new_double(fvalue);
228 break;
229 case SR_CONF_CURRENT_LIMIT:
230 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
231 *data = g_variant_new_double(fvalue);
232 break;
233 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
234 *data = g_variant_new_boolean(TRUE); /* Always on. */
235 break;
236 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
237 *data = g_variant_new_boolean(TRUE); /* Always on. */
238 break;
239 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
240 *data = g_variant_new_boolean(TRUE); /* Always on. */
241 break;
242 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
243 *data = g_variant_new_boolean(devc->otp_active);
244 break;
2217be1d 245 case SR_CONF_UNDER_VOLTAGE_CONDITION:
0aaaee2d
UH
246 if (reloadpro_get_under_voltage_threshold(sdi, &fvalue) == SR_OK)
247 *data = g_variant_new_boolean(fvalue != 0.0);
2217be1d
UH
248 break;
249 case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
250 *data = g_variant_new_boolean(devc->uvc_active);
251 break;
3d70d777
FS
252 case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
253 if (reloadpro_get_under_voltage_threshold(sdi, &fvalue) == SR_OK)
254 *data = g_variant_new_double(fvalue);
255 break;
6e8d31d4
UH
256 default:
257 return SR_ERR_NA;
258 }
259
a9010323 260 return SR_OK;
6e8d31d4
UH
261}
262
263static int config_set(uint32_t key, GVariant *data,
264 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
265{
803db07a 266 struct dev_context *devc;
6e8d31d4 267
6e8d31d4
UH
268 (void)cg;
269
803db07a
UH
270 devc = sdi->priv;
271
6e8d31d4 272 switch (key) {
803db07a 273 case SR_CONF_LIMIT_SAMPLES:
cd04f641 274 case SR_CONF_LIMIT_MSEC:
014c7f93 275 return sr_sw_limits_config_set(&devc->limits, key, data);
8501448c 276 case SR_CONF_ENABLED:
758906aa 277 return reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
803db07a 278 case SR_CONF_CURRENT_LIMIT:
758906aa 279 return reloadpro_set_current_limit(sdi, g_variant_get_double(data));
3d70d777
FS
280 case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
281 return reloadpro_set_under_voltage_threshold(sdi,
282 g_variant_get_double(data));
6e8d31d4 283 default:
758906aa 284 return SR_ERR_NA;
6e8d31d4
UH
285 }
286
758906aa 287 return SR_OK;
6e8d31d4
UH
288}
289
b76a414d
FS
290static int dev_close(struct sr_dev_inst *sdi)
291{
292 if (serial_write_blocking(sdi->conn, CMD_MONITOR_STOP,
293 strlen(CMD_MONITOR_STOP), serial_timeout(sdi->conn,
294 strlen(CMD_MONITOR_STOP))) < (int)strlen(CMD_MONITOR_STOP)) {
295 sr_dbg("Unable to stop monitoring.");
296 }
297
298 return std_serial_dev_close(sdi);
299}
300
695dc859 301static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6e8d31d4
UH
302{
303 int ret;
803db07a
UH
304 struct dev_context *devc;
305 struct sr_serial_dev_inst *serial;
6e8d31d4 306
803db07a 307 devc = sdi->priv;
a2172899
FS
308 devc->acquisition_running = TRUE;
309
803db07a
UH
310 serial = sdi->conn;
311
312 /* Send the 'monitor <ms>' command (doesn't have a reply). */
313 if ((ret = serial_write_blocking(serial, CMD_MONITOR,
314 strlen(CMD_MONITOR), serial_timeout(serial,
315 strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
316 sr_err("Unable to send 'monitor' command: %d.", ret);
317 return SR_ERR;
6e8d31d4
UH
318 }
319
014c7f93 320 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 321 std_session_send_df_header(sdi);
6e8d31d4 322
803db07a
UH
323 memset(devc->buf, 0, RELOADPRO_BUFSIZE);
324 devc->buflen = 0;
6e8d31d4 325
b3e715e5
FS
326 g_mutex_init(&devc->acquisition_mutex);
327
328 serial_source_add(sdi->session, serial, G_IO_IN, 100,
329 reloadpro_receive_data, (void *)sdi);
330
6e8d31d4
UH
331 return SR_OK;
332}
333
a2172899
FS
334static int dev_acquisition_stop(struct sr_dev_inst *sdi)
335{
336 struct dev_context *devc;
b3e715e5 337 int ret;
a2172899
FS
338
339 devc = sdi->priv;
340 devc->acquisition_running = FALSE;
341
b3e715e5
FS
342 ret = std_serial_dev_acquisition_stop(sdi);
343 g_mutex_clear(&devc->acquisition_mutex);
344
345 return ret;
a2172899
FS
346}
347
dd5c48a6 348static struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
6e8d31d4
UH
349 .name = "arachnid-labs-re-load-pro",
350 .longname = "Arachnid Labs Re:load Pro",
351 .api_version = 1,
c2fdcc25 352 .init = std_init,
700d6b64 353 .cleanup = std_cleanup,
6e8d31d4 354 .scan = scan,
c01bf34c 355 .dev_list = std_dev_list,
f778bf02 356 .dev_clear = std_dev_clear,
6e8d31d4
UH
357 .config_get = config_get,
358 .config_set = config_set,
359 .config_list = config_list,
803db07a 360 .dev_open = std_serial_dev_open,
b76a414d 361 .dev_close = dev_close,
6e8d31d4 362 .dev_acquisition_start = dev_acquisition_start,
a2172899 363 .dev_acquisition_stop = dev_acquisition_stop,
6e8d31d4
UH
364 .context = NULL,
365};
dd5c48a6 366SR_REGISTER_DEV_DRIVER(arachnid_labs_re_load_pro_driver_info);