]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/manson-hcs-3xxx/api.c
std_gvar_tuple_array(): Change to allow for more ARRAY_AND_SIZE usage.
[libsigrok.git] / src / hardware / manson-hcs-3xxx / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <config.h>
22#include "protocol.h"
23
24static const uint32_t scanopts[] = {
25 SR_CONF_CONN,
26 SR_CONF_SERIALCOMM,
27};
28
29static const uint32_t drvopts[] = {
30 SR_CONF_POWER_SUPPLY,
31};
32
33static const uint32_t devopts[] = {
34 SR_CONF_CONTINUOUS,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_VOLTAGE | SR_CONF_GET,
38 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_CURRENT | SR_CONF_GET,
40 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
42};
43
44/* Note: All models have one power supply output only. */
45static const struct hcs_model models[] = {
46 { MANSON_HCS_3100, "HCS-3100", "3100", { 1, 18, 0.1 }, { 0, 10, 0.10 } },
47 { MANSON_HCS_3102, "HCS-3102", "3102", { 1, 36, 0.1 }, { 0, 5, 0.01 } },
48 { MANSON_HCS_3104, "HCS-3104", "3104", { 1, 60, 0.1 }, { 0, 2.5, 0.01 } },
49 { MANSON_HCS_3150, "HCS-3150", "3150", { 1, 18, 0.1 }, { 0, 15, 0.10 } },
50 { MANSON_HCS_3200, "HCS-3200", "3200", { 1, 18, 0.1 }, { 0, 20, 0.10 } },
51 { MANSON_HCS_3202, "HCS-3202", "3202", { 1, 36, 0.1 }, { 0, 10, 0.10 } },
52 { MANSON_HCS_3204, "HCS-3204", "3204", { 1, 60, 0.1 }, { 0, 5, 0.01 } },
53 { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30, 0.10 } },
54 { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15, 0.10 } },
55 { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0, 8, 0.10 } },
56 { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40, 0.10 } },
57 { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20, 0.10 } },
58 { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10, 0.10 } },
59 { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60, 0.10 } },
60 { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30, 0.10 } },
61 { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15, 0.10 } },
62 ALL_ZERO
63};
64
65static GSList *scan(struct sr_dev_driver *di, GSList *options)
66{
67 int i, model_id;
68 struct dev_context *devc;
69 struct sr_dev_inst *sdi;
70 struct sr_config *src;
71 GSList *l;
72 const char *conn, *serialcomm;
73 struct sr_serial_dev_inst *serial;
74 char reply[50], **tokens, *dummy;
75
76 conn = NULL;
77 serialcomm = NULL;
78 devc = NULL;
79
80 for (l = options; l; l = l->next) {
81 src = l->data;
82 switch (src->key) {
83 case SR_CONF_CONN:
84 conn = g_variant_get_string(src->data, NULL);
85 break;
86 case SR_CONF_SERIALCOMM:
87 serialcomm = g_variant_get_string(src->data, NULL);
88 break;
89 default:
90 sr_err("Unknown option %d, skipping.", src->key);
91 break;
92 }
93 }
94
95 if (!conn)
96 return NULL;
97 if (!serialcomm)
98 serialcomm = "9600/8n1";
99
100 serial = sr_serial_dev_inst_new(conn, serialcomm);
101
102 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
103 return NULL;
104
105 serial_flush(serial);
106
107 sr_info("Probing serial port %s.", conn);
108
109 /* Get the device model. */
110 memset(&reply, 0, sizeof(reply));
111 if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
112 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
113 return NULL;
114 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
115
116 model_id = -1;
117 for (i = 0; models[i].id != NULL; i++) {
118 if (!strcmp(models[i].id, tokens[0]))
119 model_id = i;
120 }
121 if (model_id < 0) {
122 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
123 g_strfreev(tokens);
124 return NULL;
125 }
126 g_strfreev(tokens);
127
128 sdi = g_malloc0(sizeof(struct sr_dev_inst));
129 sdi->status = SR_ST_INACTIVE;
130 sdi->vendor = g_strdup("Manson");
131 sdi->model = g_strdup(models[model_id].name);
132 sdi->inst_type = SR_INST_SERIAL;
133 sdi->conn = serial;
134
135 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
136
137 devc = g_malloc0(sizeof(struct dev_context));
138 sr_sw_limits_init(&devc->limits);
139 devc->model = &models[model_id];
140
141 sdi->priv = devc;
142
143 /* Get current voltage, current, status. */
144 if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
145 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
146 goto exit_err;
147 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
148 if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
149 g_strfreev(tokens);
150 goto exit_err;
151 }
152 g_strfreev(tokens);
153
154 /* Get max. voltage and current. */
155 if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
156 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
157 goto exit_err;
158 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
159 devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
160 tokens[0][3] = '\0';
161 devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
162 g_strfreev(tokens);
163
164 serial_close(serial);
165
166 return std_scan_complete(di, g_slist_append(NULL, sdi));
167
168exit_err:
169 sr_dev_inst_free(sdi);
170 g_free(devc);
171
172 return NULL;
173}
174
175static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
176 const struct sr_channel_group *cg)
177{
178 struct dev_context *devc;
179
180 (void)cg;
181
182 if (!sdi)
183 return SR_ERR_ARG;
184
185 devc = sdi->priv;
186
187 switch (key) {
188 case SR_CONF_LIMIT_SAMPLES:
189 case SR_CONF_LIMIT_MSEC:
190 return sr_sw_limits_config_get(&devc->limits, key, data);
191 case SR_CONF_VOLTAGE:
192 *data = g_variant_new_double(devc->voltage);
193 break;
194 case SR_CONF_VOLTAGE_TARGET:
195 *data = g_variant_new_double(devc->voltage_max);
196 break;
197 case SR_CONF_CURRENT:
198 *data = g_variant_new_double(devc->current);
199 break;
200 case SR_CONF_CURRENT_LIMIT:
201 *data = g_variant_new_double(devc->current_max);
202 break;
203 case SR_CONF_ENABLED:
204 *data = g_variant_new_boolean(devc->output_enabled);
205 break;
206 default:
207 return SR_ERR_NA;
208 }
209
210 return SR_OK;
211}
212
213static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
214 const struct sr_channel_group *cg)
215{
216 struct dev_context *devc;
217 gboolean bval;
218 gdouble dval;
219
220 (void)cg;
221
222 devc = sdi->priv;
223
224 switch (key) {
225 case SR_CONF_LIMIT_MSEC:
226 case SR_CONF_LIMIT_SAMPLES:
227 return sr_sw_limits_config_set(&devc->limits, key, data);
228 case SR_CONF_VOLTAGE_TARGET:
229 dval = g_variant_get_double(data);
230 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
231 return SR_ERR_ARG;
232
233 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
234 (dval / devc->model->voltage[2])) < 0) ||
235 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
236 return SR_ERR;
237 devc->voltage_max = dval;
238 break;
239 case SR_CONF_CURRENT_LIMIT:
240 dval = g_variant_get_double(data);
241 if (dval < devc->model->current[0] || dval > devc->current_max_device)
242 return SR_ERR_ARG;
243
244 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
245 (dval / devc->model->current[2])) < 0) ||
246 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
247 return SR_ERR;
248 devc->current_max = dval;
249 break;
250 case SR_CONF_ENABLED:
251 bval = g_variant_get_boolean(data);
252 if (bval == devc->output_enabled) /* Nothing to do. */
253 break;
254 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
255 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
256 return SR_ERR;
257 devc->output_enabled = bval;
258 break;
259 default:
260 return SR_ERR_NA;
261 }
262
263 return SR_OK;
264}
265
266static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
267 const struct sr_channel_group *cg)
268{
269 const double *a;
270 struct dev_context *devc;
271
272 devc = (sdi) ? sdi->priv : NULL;
273
274 switch (key) {
275 case SR_CONF_SCAN_OPTIONS:
276 case SR_CONF_DEVICE_OPTIONS:
277 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
278 case SR_CONF_VOLTAGE_TARGET:
279 a = devc->model->voltage;
280 *data = std_gvar_min_max_step(a[0], devc->voltage_max_device, a[2]);
281 break;
282 case SR_CONF_CURRENT_LIMIT:
283 a = devc->model->current;
284 *data = std_gvar_min_max_step(a[0], devc->current_max_device, a[2]);
285 break;
286 default:
287 return SR_ERR_NA;
288 }
289
290 return SR_OK;
291}
292
293static int dev_acquisition_start(const struct sr_dev_inst *sdi)
294{
295 struct dev_context *devc;
296 struct sr_serial_dev_inst *serial;
297
298 devc = sdi->priv;
299
300 sr_sw_limits_acquisition_start(&devc->limits);
301 std_session_send_df_header(sdi);
302
303 devc->reply_pending = FALSE;
304 devc->req_sent_at = 0;
305
306 serial = sdi->conn;
307 serial_source_add(sdi->session, serial, G_IO_IN, 10,
308 hcs_receive_data, (void *)sdi);
309
310 return SR_OK;
311}
312
313static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
314 .name = "manson-hcs-3xxx",
315 .longname = "Manson HCS-3xxx",
316 .api_version = 1,
317 .init = std_init,
318 .cleanup = std_cleanup,
319 .scan = scan,
320 .dev_list = std_dev_list,
321 .dev_clear = std_dev_clear,
322 .config_get = config_get,
323 .config_set = config_set,
324 .config_list = config_list,
325 .dev_open = std_serial_dev_open,
326 .dev_close = std_serial_dev_close,
327 .dev_acquisition_start = dev_acquisition_start,
328 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
329 .context = NULL,
330};
331SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);