]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/manson-hcs-3xxx/api.c
scpi-pps: Add a missing "break" in config_get().
[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_3304, "HCS-3304-USB", "HCS-3304", { 1, 60, 0.1 }, { 0, 8, 0.10 } },
57 { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40, 0.10 } },
58 { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20, 0.10 } },
59 { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10, 0.10 } },
60 { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60, 0.10 } },
61 { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30, 0.10 } },
62 { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15, 0.10 } },
63 ALL_ZERO
64};
65
66static GSList *scan(struct sr_dev_driver *di, GSList *options)
67{
68 int i, model_id;
69 struct dev_context *devc;
70 struct sr_dev_inst *sdi;
71 struct sr_config *src;
72 GSList *l;
73 const char *conn, *serialcomm;
74 struct sr_serial_dev_inst *serial;
75 char reply[50], **tokens, *dummy;
76
77 conn = NULL;
78 serialcomm = NULL;
79 devc = NULL;
80
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 default:
91 sr_err("Unknown option %d, skipping.", src->key);
92 break;
93 }
94 }
95
96 if (!conn)
97 return NULL;
98 if (!serialcomm)
99 serialcomm = "9600/8n1";
100
101 serial = sr_serial_dev_inst_new(conn, serialcomm);
102
103 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
104 return NULL;
105
106 serial_flush(serial);
107
108 sr_info("Probing serial port %s.", conn);
109
110 /* Get the device model. */
111 memset(&reply, 0, sizeof(reply));
112 if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
113 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
114 return NULL;
115 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
116
117 model_id = -1;
118 for (i = 0; models[i].id != NULL; i++) {
119 if (!strcmp(models[i].id, tokens[0]))
120 model_id = i;
121 }
122 if (model_id < 0) {
123 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
124 g_strfreev(tokens);
125 return NULL;
126 }
127 g_strfreev(tokens);
128
129 sdi = g_malloc0(sizeof(struct sr_dev_inst));
130 sdi->status = SR_ST_INACTIVE;
131 sdi->vendor = g_strdup("Manson");
132 sdi->model = g_strdup(models[model_id].name);
133 sdi->inst_type = SR_INST_SERIAL;
134 sdi->conn = serial;
135
136 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
137
138 devc = g_malloc0(sizeof(struct dev_context));
139 sr_sw_limits_init(&devc->limits);
140 devc->model = &models[model_id];
141
142 sdi->priv = devc;
143
144 /* Get current voltage, current, status. */
145 if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
146 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
147 goto exit_err;
148 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
149 if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
150 g_strfreev(tokens);
151 goto exit_err;
152 }
153 g_strfreev(tokens);
154
155 /* Get max. voltage and current. */
156 if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
157 (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
158 goto exit_err;
159 tokens = g_strsplit((const gchar *)&reply, "\r", 2);
160 devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
161 tokens[0][3] = '\0';
162 devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
163 g_strfreev(tokens);
164
165 serial_close(serial);
166
167 return std_scan_complete(di, g_slist_append(NULL, sdi));
168
169exit_err:
170 sr_dev_inst_free(sdi);
171 g_free(devc);
172
173 return NULL;
174}
175
176static int config_get(uint32_t key, GVariant **data,
177 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
178{
179 struct dev_context *devc;
180
181 (void)cg;
182
183 if (!sdi)
184 return SR_ERR_ARG;
185
186 devc = sdi->priv;
187
188 switch (key) {
189 case SR_CONF_LIMIT_SAMPLES:
190 case SR_CONF_LIMIT_MSEC:
191 return sr_sw_limits_config_get(&devc->limits, key, data);
192 case SR_CONF_VOLTAGE:
193 *data = g_variant_new_double(devc->voltage);
194 break;
195 case SR_CONF_VOLTAGE_TARGET:
196 *data = g_variant_new_double(devc->voltage_max);
197 break;
198 case SR_CONF_CURRENT:
199 *data = g_variant_new_double(devc->current);
200 break;
201 case SR_CONF_CURRENT_LIMIT:
202 *data = g_variant_new_double(devc->current_max);
203 break;
204 case SR_CONF_ENABLED:
205 *data = g_variant_new_boolean(devc->output_enabled);
206 break;
207 default:
208 return SR_ERR_NA;
209 }
210
211 return SR_OK;
212}
213
214static int config_set(uint32_t key, GVariant *data,
215 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
216{
217 struct dev_context *devc;
218 gboolean bval;
219 gdouble dval;
220
221 (void)cg;
222
223 devc = sdi->priv;
224
225 switch (key) {
226 case SR_CONF_LIMIT_MSEC:
227 case SR_CONF_LIMIT_SAMPLES:
228 return sr_sw_limits_config_set(&devc->limits, key, data);
229 case SR_CONF_VOLTAGE_TARGET:
230 dval = g_variant_get_double(data);
231 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
232 return SR_ERR_ARG;
233
234 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
235 (dval / devc->model->voltage[2])) < 0) ||
236 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
237 return SR_ERR;
238 devc->voltage_max = dval;
239 break;
240 case SR_CONF_CURRENT_LIMIT:
241 dval = g_variant_get_double(data);
242 if (dval < devc->model->current[0] || dval > devc->current_max_device)
243 return SR_ERR_ARG;
244
245 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
246 (dval / devc->model->current[2])) < 0) ||
247 (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
248 return SR_ERR;
249 devc->current_max = dval;
250 break;
251 case SR_CONF_ENABLED:
252 bval = g_variant_get_boolean(data);
253
254 if (hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) {
255 sr_err("Could not send SR_CONF_ENABLED command.");
256 return SR_ERR;
257 }
258 if (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0) {
259 sr_err("Could not read SR_CONF_ENABLED reply.");
260 return SR_ERR;
261 }
262 devc->output_enabled = bval;
263 break;
264 default:
265 return SR_ERR_NA;
266 }
267
268 return SR_OK;
269}
270
271static int config_list(uint32_t key, GVariant **data,
272 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
273{
274 const double *a;
275 struct dev_context *devc;
276
277 devc = (sdi) ? sdi->priv : NULL;
278
279 switch (key) {
280 case SR_CONF_SCAN_OPTIONS:
281 case SR_CONF_DEVICE_OPTIONS:
282 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
283 case SR_CONF_VOLTAGE_TARGET:
284 if (!devc || !devc->model)
285 return SR_ERR_ARG;
286 a = devc->model->voltage;
287 *data = std_gvar_min_max_step(a[0], devc->voltage_max_device, a[2]);
288 break;
289 case SR_CONF_CURRENT_LIMIT:
290 if (!devc || !devc->model)
291 return SR_ERR_ARG;
292 a = devc->model->current;
293 *data = std_gvar_min_max_step(a[0], devc->current_max_device, a[2]);
294 break;
295 default:
296 return SR_ERR_NA;
297 }
298
299 return SR_OK;
300}
301
302static int dev_acquisition_start(const struct sr_dev_inst *sdi)
303{
304 struct dev_context *devc;
305 struct sr_serial_dev_inst *serial;
306
307 devc = sdi->priv;
308
309 sr_sw_limits_acquisition_start(&devc->limits);
310 std_session_send_df_header(sdi);
311
312 devc->reply_pending = FALSE;
313 devc->req_sent_at = 0;
314
315 serial = sdi->conn;
316 serial_source_add(sdi->session, serial, G_IO_IN, 10,
317 hcs_receive_data, (void *)sdi);
318
319 return SR_OK;
320}
321
322static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
323 .name = "manson-hcs-3xxx",
324 .longname = "Manson HCS-3xxx",
325 .api_version = 1,
326 .init = std_init,
327 .cleanup = std_cleanup,
328 .scan = scan,
329 .dev_list = std_dev_list,
330 .dev_clear = std_dev_clear,
331 .config_get = config_get,
332 .config_set = config_set,
333 .config_list = config_list,
334 .dev_open = std_serial_dev_open,
335 .dev_close = std_serial_dev_close,
336 .dev_acquisition_start = dev_acquisition_start,
337 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
338 .context = NULL,
339};
340SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);