]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/arachnid-labs-re-load-pro/api.c
arachnid-labs-re-load-pro: Setting correct current limit.
[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#define CMD_MONITOR_STOP "monitor 0\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,
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[] = {
46 SR_CONF_ENABLED | SR_CONF_SET,
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,
55 SR_CONF_UNDER_VOLTAGE_CONDITION | SR_CONF_GET,
56 SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE | SR_CONF_GET,
57};
58
59static GSList *scan(struct sr_dev_driver *di, GSList *options)
60{
61 struct sr_dev_inst *sdi;
62 struct dev_context *devc;
63 struct sr_config *src;
64 struct sr_serial_dev_inst *serial;
65 struct sr_channel_group *cg;
66 struct sr_channel *ch;
67 GSList *l;
68 int ret, len;
69 const char *conn, *serialcomm;
70 char buf[100];
71 char *bufptr;
72 double version;
73
74 conn = serialcomm = NULL;
75 for (l = options; l; l = l->next) {
76 src = l->data;
77 switch (src->key) {
78 case SR_CONF_CONN:
79 conn = g_variant_get_string(src->data, NULL);
80 break;
81 case SR_CONF_SERIALCOMM:
82 serialcomm = g_variant_get_string(src->data, NULL);
83 break;
84 }
85 }
86 if (!conn)
87 return NULL;
88 if (!serialcomm)
89 serialcomm = SERIALCOMM;
90
91 serial = sr_serial_dev_inst_new(conn, serialcomm);
92
93 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
94 return NULL;
95
96 serial_flush(serial);
97
98 /*
99 * First stop potentially running monitoring and wait for 50ms before
100 * next command can be sent.
101 */
102 if (serial_write_blocking(serial, CMD_MONITOR_STOP,
103 strlen(CMD_MONITOR_STOP), serial_timeout(serial,
104 strlen(CMD_MONITOR_STOP))) < (int)strlen(CMD_MONITOR_STOP)) {
105 sr_dbg("Unable to write while probing for hardware.");
106 serial_close(serial);
107 return NULL;
108 }
109 g_usleep(50 * 1000);
110
111 if (serial_write_blocking(serial, CMD_VERSION,
112 strlen(CMD_VERSION), serial_timeout(serial,
113 strlen(CMD_VERSION))) < (int)strlen(CMD_VERSION)) {
114 sr_dbg("Unable to write while probing for hardware.");
115 serial_close(serial);
116 return NULL;
117 }
118
119 memset(buf, 0, sizeof(buf));
120 bufptr = buf;
121 len = sizeof(buf);
122 ret = serial_readline(serial, &bufptr, &len, 3000);
123
124 if (ret < 0 || len < 9 || strncmp((const char *)&buf, "version ", 8)) {
125 sr_dbg("Unable to probe version number.");
126 serial_close(serial);
127 return NULL;
128 }
129
130 version = g_ascii_strtod(buf + 8, NULL);
131 if (version < 1.10) {
132 sr_info("Firmware >= 1.10 required (got %1.2f).", version);
133 serial_close(serial);
134 return NULL;
135 }
136
137 sdi = g_malloc0(sizeof(struct sr_dev_inst));
138 sdi->status = SR_ST_INACTIVE;
139 sdi->vendor = g_strdup("Arachnid Labs");
140 sdi->model = g_strdup("Re:load Pro");
141 sdi->version = g_strdup(buf + 8);
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 sr_sw_limits_init(&devc->limits);
157 sdi->priv = devc;
158
159 serial_close(serial);
160
161 return std_scan_complete(di, g_slist_append(NULL, sdi));
162}
163
164static int config_list(uint32_t key, GVariant **data,
165 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
166{
167 if (!cg) {
168 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
169 } else {
170 switch (key) {
171 case SR_CONF_DEVICE_OPTIONS:
172 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
173 break;
174 case SR_CONF_CURRENT_LIMIT:
175 *data = std_gvar_min_max_step(0.0, 6.0, 0.001);
176 break;
177 default:
178 return SR_ERR_NA;
179 }
180 }
181
182 return SR_OK;
183}
184
185static int config_get(uint32_t key, GVariant **data,
186 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
187{
188 struct dev_context *devc;
189 float fvalue;
190
191 (void)cg;
192
193 devc = sdi->priv;
194
195 /*
196 * These features/keys are not supported by the hardware:
197 * - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
198 * - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
199 * - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
200 * - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
201 * - SR_CONF_ENABLED (state cannot be queried, only set)
202 */
203
204 switch (key) {
205 case SR_CONF_LIMIT_SAMPLES:
206 case SR_CONF_LIMIT_MSEC:
207 return sr_sw_limits_config_get(&devc->limits, key, data);
208 case SR_CONF_REGULATION:
209 *data = g_variant_new_string("CC"); /* Always CC mode. */
210 break;
211 case SR_CONF_VOLTAGE:
212 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
213 return SR_ERR;
214 *data = g_variant_new_double(fvalue);
215 break;
216 case SR_CONF_CURRENT:
217 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
218 return SR_ERR;
219 *data = g_variant_new_double(fvalue);
220 break;
221 case SR_CONF_CURRENT_LIMIT:
222 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
223 *data = g_variant_new_double(fvalue);
224 break;
225 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
226 *data = g_variant_new_boolean(TRUE); /* Always on. */
227 break;
228 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
229 *data = g_variant_new_boolean(TRUE); /* Always on. */
230 break;
231 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
232 *data = g_variant_new_boolean(TRUE); /* Always on. */
233 break;
234 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
235 *data = g_variant_new_boolean(devc->otp_active);
236 break;
237 case SR_CONF_UNDER_VOLTAGE_CONDITION:
238 *data = g_variant_new_boolean(TRUE); /* Always on. */
239 break;
240 case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
241 *data = g_variant_new_boolean(devc->uvc_active);
242 break;
243 default:
244 return SR_ERR_NA;
245 }
246
247 return SR_OK;
248}
249
250static int config_set(uint32_t key, GVariant *data,
251 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
252{
253 struct dev_context *devc;
254
255 (void)cg;
256
257 devc = sdi->priv;
258
259 switch (key) {
260 case SR_CONF_LIMIT_SAMPLES:
261 case SR_CONF_LIMIT_MSEC:
262 return sr_sw_limits_config_set(&devc->limits, key, data);
263 case SR_CONF_ENABLED:
264 return reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
265 case SR_CONF_CURRENT_LIMIT:
266 return reloadpro_set_current_limit(sdi, g_variant_get_double(data));
267 default:
268 return SR_ERR_NA;
269 }
270
271 return SR_OK;
272}
273
274static int dev_close(struct sr_dev_inst *sdi)
275{
276 if (serial_write_blocking(sdi->conn, CMD_MONITOR_STOP,
277 strlen(CMD_MONITOR_STOP), serial_timeout(sdi->conn,
278 strlen(CMD_MONITOR_STOP))) < (int)strlen(CMD_MONITOR_STOP)) {
279 sr_dbg("Unable to stop monitoring.");
280 }
281
282 return std_serial_dev_close(sdi);
283}
284
285static int dev_acquisition_start(const struct sr_dev_inst *sdi)
286{
287 int ret;
288 struct dev_context *devc;
289 struct sr_serial_dev_inst *serial;
290
291 devc = sdi->priv;
292 devc->acquisition_running = TRUE;
293
294 serial = sdi->conn;
295
296 /* Send the 'monitor <ms>' command (doesn't have a reply). */
297 if ((ret = serial_write_blocking(serial, CMD_MONITOR,
298 strlen(CMD_MONITOR), serial_timeout(serial,
299 strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
300 sr_err("Unable to send 'monitor' command: %d.", ret);
301 return SR_ERR;
302 }
303
304 serial_source_add(sdi->session, serial, G_IO_IN, 100,
305 reloadpro_receive_data, (void *)sdi);
306
307 sr_sw_limits_acquisition_start(&devc->limits);
308 std_session_send_df_header(sdi);
309
310 memset(devc->buf, 0, RELOADPRO_BUFSIZE);
311 devc->buflen = 0;
312
313 return SR_OK;
314}
315
316static int dev_acquisition_stop(struct sr_dev_inst *sdi)
317{
318 struct dev_context *devc;
319
320 devc = sdi->priv;
321 devc->acquisition_running = FALSE;
322
323 return std_serial_dev_acquisition_stop(sdi);
324}
325
326static struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
327 .name = "arachnid-labs-re-load-pro",
328 .longname = "Arachnid Labs Re:load Pro",
329 .api_version = 1,
330 .init = std_init,
331 .cleanup = std_cleanup,
332 .scan = scan,
333 .dev_list = std_dev_list,
334 .dev_clear = std_dev_clear,
335 .config_get = config_get,
336 .config_set = config_set,
337 .config_list = config_list,
338 .dev_open = std_serial_dev_open,
339 .dev_close = dev_close,
340 .dev_acquisition_start = dev_acquisition_start,
341 .dev_acquisition_stop = dev_acquisition_stop,
342 .context = NULL,
343};
344SR_REGISTER_DEV_DRIVER(arachnid_labs_re_load_pro_driver_info);