]> sigrok.org Git - libsigrok.git/blame - src/hardware/arachnid-labs-re-load-pro/api.c
drivers: Drop unneeded or duplicate comments.
[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 GVariantBuilder gvb;
6e8d31d4 154
803db07a 155 if (!cg) {
e66d1892 156 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
803db07a
UH
157 } else {
158 switch (key) {
159 case SR_CONF_DEVICE_OPTIONS:
160 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
161 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
162 break;
163 case SR_CONF_CURRENT_LIMIT:
164 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
165 /* Min, max, step. */
166 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
167 g_variant_builder_add_value(&gvb, g_variant_new_double(6.0));
168 g_variant_builder_add_value(&gvb, g_variant_new_double(0.001)); /* 1mA steps */
169 *data = g_variant_builder_end(&gvb);
170 break;
171 default:
172 return SR_ERR_NA;
173 }
174 }
175
a9010323 176 return SR_OK;
6e8d31d4
UH
177}
178
179static int config_get(uint32_t key, GVariant **data,
180 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
181{
803db07a 182 struct dev_context *devc;
803db07a 183 float fvalue;
6e8d31d4 184
6e8d31d4
UH
185 (void)cg;
186
803db07a
UH
187 devc = sdi->priv;
188
189 /*
190 * These features/keys are not supported by the hardware:
191 * - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
192 * - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
193 * - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
194 * - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
8501448c 195 * - SR_CONF_ENABLED (state cannot be queried, only set)
803db07a
UH
196 */
197
6e8d31d4 198 switch (key) {
803db07a 199 case SR_CONF_LIMIT_SAMPLES:
803db07a 200 case SR_CONF_LIMIT_MSEC:
014c7f93 201 return sr_sw_limits_config_get(&devc->limits, key, data);
803db07a
UH
202 case SR_CONF_REGULATION:
203 *data = g_variant_new_string("CC"); /* Always CC mode. */
204 break;
205 case SR_CONF_VOLTAGE:
206 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
207 return SR_ERR;
208 *data = g_variant_new_double(fvalue);
209 break;
210 case SR_CONF_CURRENT:
211 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
212 return SR_ERR;
213 *data = g_variant_new_double(fvalue);
214 break;
215 case SR_CONF_CURRENT_LIMIT:
216 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
217 *data = g_variant_new_double(fvalue);
218 break;
219 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
220 *data = g_variant_new_boolean(TRUE); /* Always on. */
221 break;
222 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
223 *data = g_variant_new_boolean(TRUE); /* Always on. */
224 break;
225 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
226 *data = g_variant_new_boolean(TRUE); /* Always on. */
227 break;
228 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
229 *data = g_variant_new_boolean(devc->otp_active);
230 break;
2217be1d
UH
231 case SR_CONF_UNDER_VOLTAGE_CONDITION:
232 *data = g_variant_new_boolean(TRUE); /* Always on. */
233 break;
234 case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
235 *data = g_variant_new_boolean(devc->uvc_active);
236 break;
6e8d31d4
UH
237 default:
238 return SR_ERR_NA;
239 }
240
a9010323 241 return SR_OK;
6e8d31d4
UH
242}
243
244static int config_set(uint32_t key, GVariant *data,
245 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
246{
803db07a 247 struct dev_context *devc;
6e8d31d4
UH
248 int ret;
249
6e8d31d4
UH
250 (void)cg;
251
803db07a
UH
252 devc = sdi->priv;
253
6e8d31d4
UH
254 ret = SR_OK;
255 switch (key) {
803db07a 256 case SR_CONF_LIMIT_SAMPLES:
cd04f641 257 case SR_CONF_LIMIT_MSEC:
014c7f93 258 return sr_sw_limits_config_set(&devc->limits, key, data);
8501448c
UH
259 case SR_CONF_ENABLED:
260 ret = reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
261 break;
803db07a
UH
262 case SR_CONF_CURRENT_LIMIT:
263 ret = reloadpro_set_current_limit(sdi,
264 g_variant_get_double(data));
265 break;
6e8d31d4
UH
266 default:
267 ret = SR_ERR_NA;
268 }
269
270 return ret;
271}
272
695dc859 273static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6e8d31d4
UH
274{
275 int ret;
803db07a
UH
276 struct dev_context *devc;
277 struct sr_serial_dev_inst *serial;
6e8d31d4 278
803db07a 279 devc = sdi->priv;
803db07a
UH
280 serial = sdi->conn;
281
282 /* Send the 'monitor <ms>' command (doesn't have a reply). */
283 if ((ret = serial_write_blocking(serial, CMD_MONITOR,
284 strlen(CMD_MONITOR), serial_timeout(serial,
285 strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
286 sr_err("Unable to send 'monitor' command: %d.", ret);
287 return SR_ERR;
6e8d31d4
UH
288 }
289
803db07a
UH
290 serial_source_add(sdi->session, serial, G_IO_IN, 100,
291 reloadpro_receive_data, (void *)sdi);
6e8d31d4 292
014c7f93 293 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 294 std_session_send_df_header(sdi);
6e8d31d4 295
803db07a
UH
296 memset(devc->buf, 0, RELOADPRO_BUFSIZE);
297 devc->buflen = 0;
6e8d31d4
UH
298
299 return SR_OK;
300}
301
dd5c48a6 302static struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
6e8d31d4
UH
303 .name = "arachnid-labs-re-load-pro",
304 .longname = "Arachnid Labs Re:load Pro",
305 .api_version = 1,
c2fdcc25 306 .init = std_init,
700d6b64 307 .cleanup = std_cleanup,
6e8d31d4 308 .scan = scan,
c01bf34c 309 .dev_list = std_dev_list,
f778bf02 310 .dev_clear = std_dev_clear,
6e8d31d4
UH
311 .config_get = config_get,
312 .config_set = config_set,
313 .config_list = config_list,
803db07a
UH
314 .dev_open = std_serial_dev_open,
315 .dev_close = std_serial_dev_close,
6e8d31d4 316 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 317 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
6e8d31d4
UH
318 .context = NULL,
319};
dd5c48a6 320SR_REGISTER_DEV_DRIVER(arachnid_labs_re_load_pro_driver_info);