]> sigrok.org Git - libsigrok.git/blame - src/hardware/arachnid-labs-re-load-pro/api.c
conrad-digi-35-cpu: Add SR_CONF_LIST for voltage_target and current_limit. Change...
[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"
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[] = {
e91bb0a6 39 SR_CONF_CONTINUOUS,
803db07a
UH
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[] = {
8501448c 45 SR_CONF_ENABLED | SR_CONF_SET,
803db07a
UH
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,
2217be1d
UH
54 SR_CONF_UNDER_VOLTAGE_CONDITION | SR_CONF_GET,
55 SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE | SR_CONF_GET,
803db07a
UH
56};
57
6e8d31d4
UH
58static GSList *scan(struct sr_dev_driver *di, GSList *options)
59{
803db07a 60 struct sr_dev_inst *sdi;
803db07a
UH
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;
43376f33 66 GSList *l;
803db07a
UH
67 int ret, len;
68 const char *conn, *serialcomm;
69 char buf[100];
70 char *bufptr;
8084e0fa 71 double version;
6e8d31d4 72
803db07a
UH
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
8084e0fa
UH
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
803db07a 123 sdi = g_malloc0(sizeof(struct sr_dev_inst));
45884333 124 sdi->status = SR_ST_INACTIVE;
803db07a
UH
125 sdi->vendor = g_strdup("Arachnid Labs");
126 sdi->model = g_strdup("Re:load Pro");
127 sdi->version = g_strdup(buf + 8);
803db07a
UH
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));
014c7f93 142 sr_sw_limits_init(&devc->limits);
803db07a 143 sdi->priv = devc;
803db07a
UH
144
145 serial_close(serial);
803db07a 146
43376f33 147 return std_scan_complete(di, g_slist_append(NULL, sdi));
6e8d31d4
UH
148}
149
803db07a
UH
150static int config_list(uint32_t key, GVariant **data,
151 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
6e8d31d4 152{
803db07a 153 if (!cg) {
e66d1892 154 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
803db07a
UH
155 } else {
156 switch (key) {
157 case SR_CONF_DEVICE_OPTIONS:
53012da6 158 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
803db07a
UH
159 break;
160 case SR_CONF_CURRENT_LIMIT:
54d471f4 161 *data = std_gvar_min_max_step(0.0, 6.0, 0.001);
803db07a
UH
162 break;
163 default:
164 return SR_ERR_NA;
165 }
166 }
167
a9010323 168 return SR_OK;
6e8d31d4
UH
169}
170
171static int config_get(uint32_t key, GVariant **data,
172 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
173{
803db07a 174 struct dev_context *devc;
803db07a 175 float fvalue;
6e8d31d4 176
6e8d31d4
UH
177 (void)cg;
178
803db07a
UH
179 devc = sdi->priv;
180
181 /*
182 * These features/keys are not supported by the hardware:
183 * - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
184 * - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
185 * - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
186 * - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
8501448c 187 * - SR_CONF_ENABLED (state cannot be queried, only set)
803db07a
UH
188 */
189
6e8d31d4 190 switch (key) {
803db07a 191 case SR_CONF_LIMIT_SAMPLES:
803db07a 192 case SR_CONF_LIMIT_MSEC:
014c7f93 193 return sr_sw_limits_config_get(&devc->limits, key, data);
803db07a
UH
194 case SR_CONF_REGULATION:
195 *data = g_variant_new_string("CC"); /* Always CC mode. */
196 break;
197 case SR_CONF_VOLTAGE:
198 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
199 return SR_ERR;
200 *data = g_variant_new_double(fvalue);
201 break;
202 case SR_CONF_CURRENT:
203 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
204 return SR_ERR;
205 *data = g_variant_new_double(fvalue);
206 break;
207 case SR_CONF_CURRENT_LIMIT:
208 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
209 *data = g_variant_new_double(fvalue);
210 break;
211 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
212 *data = g_variant_new_boolean(TRUE); /* Always on. */
213 break;
214 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
215 *data = g_variant_new_boolean(TRUE); /* Always on. */
216 break;
217 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
218 *data = g_variant_new_boolean(TRUE); /* Always on. */
219 break;
220 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
221 *data = g_variant_new_boolean(devc->otp_active);
222 break;
2217be1d
UH
223 case SR_CONF_UNDER_VOLTAGE_CONDITION:
224 *data = g_variant_new_boolean(TRUE); /* Always on. */
225 break;
226 case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
227 *data = g_variant_new_boolean(devc->uvc_active);
228 break;
6e8d31d4
UH
229 default:
230 return SR_ERR_NA;
231 }
232
a9010323 233 return SR_OK;
6e8d31d4
UH
234}
235
236static int config_set(uint32_t key, GVariant *data,
237 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
238{
803db07a 239 struct dev_context *devc;
6e8d31d4 240
6e8d31d4
UH
241 (void)cg;
242
803db07a
UH
243 devc = sdi->priv;
244
6e8d31d4 245 switch (key) {
803db07a 246 case SR_CONF_LIMIT_SAMPLES:
cd04f641 247 case SR_CONF_LIMIT_MSEC:
014c7f93 248 return sr_sw_limits_config_set(&devc->limits, key, data);
8501448c 249 case SR_CONF_ENABLED:
758906aa 250 return reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
803db07a 251 case SR_CONF_CURRENT_LIMIT:
758906aa 252 return reloadpro_set_current_limit(sdi, g_variant_get_double(data));
6e8d31d4 253 default:
758906aa 254 return SR_ERR_NA;
6e8d31d4
UH
255 }
256
758906aa 257 return SR_OK;
6e8d31d4
UH
258}
259
695dc859 260static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6e8d31d4
UH
261{
262 int ret;
803db07a
UH
263 struct dev_context *devc;
264 struct sr_serial_dev_inst *serial;
6e8d31d4 265
803db07a 266 devc = sdi->priv;
803db07a
UH
267 serial = sdi->conn;
268
269 /* Send the 'monitor <ms>' command (doesn't have a reply). */
270 if ((ret = serial_write_blocking(serial, CMD_MONITOR,
271 strlen(CMD_MONITOR), serial_timeout(serial,
272 strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
273 sr_err("Unable to send 'monitor' command: %d.", ret);
274 return SR_ERR;
6e8d31d4
UH
275 }
276
803db07a
UH
277 serial_source_add(sdi->session, serial, G_IO_IN, 100,
278 reloadpro_receive_data, (void *)sdi);
6e8d31d4 279
014c7f93 280 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 281 std_session_send_df_header(sdi);
6e8d31d4 282
803db07a
UH
283 memset(devc->buf, 0, RELOADPRO_BUFSIZE);
284 devc->buflen = 0;
6e8d31d4
UH
285
286 return SR_OK;
287}
288
dd5c48a6 289static struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
6e8d31d4
UH
290 .name = "arachnid-labs-re-load-pro",
291 .longname = "Arachnid Labs Re:load Pro",
292 .api_version = 1,
c2fdcc25 293 .init = std_init,
700d6b64 294 .cleanup = std_cleanup,
6e8d31d4 295 .scan = scan,
c01bf34c 296 .dev_list = std_dev_list,
f778bf02 297 .dev_clear = std_dev_clear,
6e8d31d4
UH
298 .config_get = config_get,
299 .config_set = config_set,
300 .config_list = config_list,
803db07a
UH
301 .dev_open = std_serial_dev_open,
302 .dev_close = std_serial_dev_close,
6e8d31d4 303 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 304 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
6e8d31d4
UH
305 .context = NULL,
306};
dd5c48a6 307SR_REGISTER_DEV_DRIVER(arachnid_labs_re_load_pro_driver_info);