]> sigrok.org Git - libsigrok.git/blame - src/hardware/maynuo-m97/api.c
Introduce standard cleanup helper
[libsigrok.git] / src / hardware / maynuo-m97 / api.c
CommitLineData
e1ccfb19
AJ
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Aurelien Jacobs <aurel@gnuage.org>
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 3 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
6ec6c43b 20#include <config.h>
e1ccfb19
AJ
21#include "protocol.h"
22
ffb580cf
AJ
23static const uint32_t scanopts[] = {
24 SR_CONF_CONN,
25 SR_CONF_SERIALCOMM,
26 SR_CONF_MODBUSADDR
27};
28
29static const uint32_t drvopts[] = {
30 SR_CONF_ELECTRONIC_LOAD,
31};
32
33static const uint32_t devopts[] = {
34 SR_CONF_CONTINUOUS | SR_CONF_SET,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
37};
38
39static const uint32_t devopts_cg[] = {
40 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_REGULATION | SR_CONF_GET,
42 SR_CONF_VOLTAGE | SR_CONF_GET,
43 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 SR_CONF_CURRENT | SR_CONF_GET,
45 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
46 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET,
47 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE | SR_CONF_GET,
48 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
49 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET,
50 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE | SR_CONF_GET,
51 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
52 SR_CONF_OVER_TEMPERATURE_PROTECTION | SR_CONF_GET,
53 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE | SR_CONF_GET,
54};
55
56/* The IDs in this list are only guessed and needs to be verified
57 against some real hardware. If at least a few of them matches,
58 it will probably be safe to enable the others. */
59static const struct maynuo_m97_model supported_models[] = {
60// { 53, "M9711" , 30, 150, 150 },
61// { 54, "M9712" , 30, 150, 300 },
62// { 55, "M9712C" , 60, 150, 300 },
63// { 56, "M9713" , 120, 150, 600 },
64// { 57, "M9712B" , 15, 500, 300 },
65// { 58, "M9713B" , 30, 500, 600 },
66// { 59, "M9714" , 240, 150, 1200 },
67// { 60, "M9714B" , 60, 500, 1200 },
68// { 61, "M9715" , 240, 150, 1800 },
69// { 62, "M9715B" , 120, 500, 1800 },
70// { 63, "M9716" , 240, 150, 2400 },
71// { 64, "M9716B" , 120, 500, 2400 },
72// { 65, "M9717C" , 480, 150, 3600 },
73// { 66, "M9717" , 240, 150, 3600 },
74// { 67, "M9717B" , 120, 500, 3600 },
75// { 68, "M9718" , 240, 150, 6000 },
76// { 69, "M9718B" , 120, 500, 6000 },
77// { 70, "M9718D" , 240, 500, 6000 },
78// { 71, "M9836" , 500, 150, 20000 },
79// { 72, "M9836B" , 240, 500, 20000 },
80// { 73, "M9838B" , 240, 500, 50000 },
81// { 74, "M9839B" , 240, 500, 100000 },
82// { 75, "M9840B" , 500, 500, 200000 },
83// { 76, "M9840" , 1500, 150, 200000 },
84// { 77, "M9712B30" , 30, 500, 300 },
85// { 78, "M9718E" , 120, 600, 6000 },
86// { 79, "M9718F" , 480, 150, 6000 },
87// { 80, "M9716E" , 480, 150, 3000 },
88// { 81, "M9710" , 30, 150, 150 },
89// { 82, "M9834" , 500, 150, 10000 },
90// { 83, "M9835" , 500, 150, 15000 },
91// { 84, "M9835B" , 240, 500, 15000 },
92// { 85, "M9837" , 500, 150, 35000 },
93// { 86, "M9837B" , 240, 500, 35000 },
94// { 87, "M9838" , 500, 150, 50000 },
95// { 88, "M9839" , 500, 150, 100000 },
96// { 89, "M9835C" , 1000, 150, 15000 }, /* ?? */
97// { 90, "M9836C" , 1000, 150, 20000 }, /* ?? */
98// { 91, "M9718F-300", 480, 300, 6000 }, /* ?? */
99// { 92, "M9836F" , 1000, 150, 20000 }, /* ?? */
100// { 93, "M9836E" , 240, 600, 20000 }, /* ?? */
101// { 94, "M9717D" , 240, 500, 3600 }, /* ?? */
102// { 95, "M9836B-720", 240, 720, 20000 }, /* ?? */
103// { 96, "M9834H" , 500, 150, 10000 }, /* ?? */
104// { 97, "M9836H" , 500, 150, 20000 }, /* ?? */
105// { 98, "M9718F-500", 480, 500, 6000 }, /* ?? */
106// { 99, "M9834B" , 240, 500, 10000 }, /* ?? */
107// { 100, "M9811" , 30, 150, 200 },
108 { 101, "M9812" , 30, 150, 300 },
109// { 102, "M9812B" , 15, 500, 300 },
110};
111
e1ccfb19
AJ
112SR_PRIV struct sr_dev_driver maynuo_m97_driver_info;
113
114static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
115{
116 return std_init(sr_ctx, di, LOG_PREFIX);
117}
118
ffb580cf 119static struct sr_dev_inst *probe_device(struct sr_modbus_dev_inst *modbus)
e1ccfb19 120{
ffb580cf
AJ
121 const struct maynuo_m97_model *model = NULL;
122 struct dev_context *devc;
123 struct sr_dev_inst *sdi;
124 struct sr_channel_group *cg;
125 struct sr_channel *ch;
126 uint16_t id, version;
127 unsigned int i;
128
129 int ret = maynuo_m97_get_model_version(modbus, &id, &version);
130 if (ret != SR_OK)
131 return NULL;
c442ffda 132 for (i = 0; i < ARRAY_SIZE(supported_models); i++)
ffb580cf
AJ
133 if (id == supported_models[i].id) {
134 model = &supported_models[i];
135 break;
136 }
137 if (model == NULL) {
5af975b5 138 sr_err("Unknown model: %d.", id);
ffb580cf
AJ
139 return NULL;
140 }
141
142 sdi = g_malloc0(sizeof(struct sr_dev_inst));
143 sdi->status = SR_ST_ACTIVE;
144 sdi->vendor = g_strdup("Maynuo");
145 sdi->model = g_strdup(model->name);
146 sdi->version = g_strdup_printf("v%d.%d", version/10, version%10);
147 sdi->conn = modbus;
148 sdi->driver = &maynuo_m97_driver_info;
149 sdi->inst_type = SR_INST_MODBUS;
e1ccfb19 150
ffb580cf
AJ
151 cg = g_malloc0(sizeof(struct sr_channel_group));
152 cg->name = g_strdup("1");
153 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
e1ccfb19 154
ffb580cf
AJ
155 ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V1");
156 cg->channels = g_slist_append(cg->channels, ch);
e1ccfb19 157
ffb580cf
AJ
158 ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "I1");
159 cg->channels = g_slist_append(cg->channels, ch);
160
161 devc = g_malloc0(sizeof(struct dev_context));
162 devc->model = model;
163
164 sdi->priv = devc;
165
166 return sdi;
167}
168
169static int config_compare(gconstpointer a, gconstpointer b)
170{
171 const struct sr_config *ac = a, *bc = b;
172 return ac->key != bc->key;
173}
174
175static GSList *scan(struct sr_dev_driver *di, GSList *options)
176{
177 struct sr_config default_serialcomm = {
178 .key = SR_CONF_SERIALCOMM,
179 .data = g_variant_new_string("9600/8n1"),
180 };
181 struct sr_config default_modbusaddr = {
182 .key = SR_CONF_MODBUSADDR,
183 .data = g_variant_new_uint64(1),
184 };
185 GSList *opts = options, *devices;
186
187 if (!g_slist_find_custom(options, &default_serialcomm, config_compare))
188 opts = g_slist_prepend(opts, &default_serialcomm);
189 if (!g_slist_find_custom(options, &default_modbusaddr, config_compare))
190 opts = g_slist_prepend(opts, &default_modbusaddr);
191
41812aca 192 devices = sr_modbus_scan(di->context, opts, probe_device);
ffb580cf
AJ
193
194 while (opts != options)
195 opts = g_slist_delete_link(opts, opts);
196 g_variant_unref(default_serialcomm.data);
197 g_variant_unref(default_modbusaddr.data);
e1ccfb19
AJ
198
199 return devices;
200}
201
202static GSList *dev_list(const struct sr_dev_driver *di)
203{
41812aca 204 return ((struct drv_context *)(di->context))->instances;
e1ccfb19
AJ
205}
206
207static int dev_clear(const struct sr_dev_driver *di)
208{
ffb580cf 209 return std_dev_clear(di, g_free);
e1ccfb19
AJ
210}
211
212static int dev_open(struct sr_dev_inst *sdi)
213{
ffb580cf 214 struct sr_modbus_dev_inst *modbus = sdi->conn;
e1ccfb19 215
ffb580cf
AJ
216 if (sr_modbus_open(modbus) < 0)
217 return SR_ERR;
e1ccfb19
AJ
218
219 sdi->status = SR_ST_ACTIVE;
220
ffb580cf
AJ
221 maynuo_m97_set_bit(modbus, PC1, 1);
222
e1ccfb19
AJ
223 return SR_OK;
224}
225
226static int dev_close(struct sr_dev_inst *sdi)
227{
ffb580cf
AJ
228 struct dev_context *devc;
229 struct sr_modbus_dev_inst *modbus;
e1ccfb19 230
ffb580cf
AJ
231 if (sdi->status != SR_ST_ACTIVE)
232 return SR_ERR_DEV_CLOSED;
e1ccfb19 233
ffb580cf
AJ
234 modbus = sdi->conn;
235
236 if (modbus) {
237 devc = sdi->priv;
238 if (devc->expecting_registers) {
239 /* Wait for the last data that was requested from the device. */
240 uint16_t registers[devc->expecting_registers];
241 sr_modbus_read_holding_registers(modbus, -1,
242 devc->expecting_registers,
243 registers);
244 }
245
246 maynuo_m97_set_bit(modbus, PC1, 0);
247
248 if (sr_modbus_close(modbus) < 0)
249 return SR_ERR;
250 sdi->status = SR_ST_INACTIVE;
251 }
e1ccfb19
AJ
252
253 return SR_OK;
254}
255
e1ccfb19
AJ
256static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
257 const struct sr_channel_group *cg)
258{
ffb580cf
AJ
259 struct dev_context *devc;
260 struct sr_modbus_dev_inst *modbus;
261 enum maynuo_m97_mode mode;
262 int ret, ivalue;
263 float fvalue;
e1ccfb19 264
e1ccfb19
AJ
265 (void)cg;
266
ffb580cf
AJ
267 modbus = sdi->conn;
268 devc = sdi->priv;
269
e1ccfb19
AJ
270 ret = SR_OK;
271 switch (key) {
ffb580cf
AJ
272 case SR_CONF_LIMIT_SAMPLES:
273 *data = g_variant_new_uint64(devc->limit_samples);
274 break;
275 case SR_CONF_LIMIT_MSEC:
276 *data = g_variant_new_uint64(devc->limit_msec);
277 break;
278 case SR_CONF_ENABLED:
279 if ((ret = maynuo_m97_get_bit(modbus, ISTATE, &ivalue)) == SR_OK)
280 *data = g_variant_new_boolean(ivalue);
281 break;
282 case SR_CONF_REGULATION:
283 if ((ret = maynuo_m97_get_bit(modbus, UNREG, &ivalue)) != SR_OK)
284 break;
285 if (ivalue)
286 *data = g_variant_new_string("UR");
287 else if ((ret = maynuo_m97_get_mode(modbus, &mode)) == SR_OK)
288 *data = g_variant_new_string(maynuo_m97_mode_to_str(mode));
289 break;
290 case SR_CONF_VOLTAGE:
291 if ((ret = maynuo_m97_get_float(modbus, U, &fvalue)) == SR_OK)
292 *data = g_variant_new_double(fvalue);
293 break;
294 case SR_CONF_VOLTAGE_TARGET:
295 if ((ret = maynuo_m97_get_float(modbus, UFIX, &fvalue)) == SR_OK)
296 *data = g_variant_new_double(fvalue);
297 break;
298 case SR_CONF_CURRENT:
299 if ((ret = maynuo_m97_get_float(modbus, I, &fvalue)) == SR_OK)
300 *data = g_variant_new_double(fvalue);
301 break;
302 case SR_CONF_CURRENT_LIMIT:
303 if ((ret = maynuo_m97_get_float(modbus, IFIX, &fvalue)) == SR_OK)
304 *data = g_variant_new_double(fvalue);
305 break;
306 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
307 *data = g_variant_new_boolean(TRUE);
308 break;
309 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
310 if ((ret = maynuo_m97_get_bit(modbus, UOVER, &ivalue)) == SR_OK)
311 *data = g_variant_new_boolean(ivalue);
312 break;
313 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
314 if ((ret = maynuo_m97_get_float(modbus, UMAX, &fvalue)) == SR_OK)
315 *data = g_variant_new_double(fvalue);
316 break;
317 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
318 *data = g_variant_new_boolean(TRUE);
319 break;
320 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
321 if ((ret = maynuo_m97_get_bit(modbus, IOVER, &ivalue)) == SR_OK)
322 *data = g_variant_new_boolean(ivalue);
323 break;
324 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
325 if ((ret = maynuo_m97_get_float(modbus, IMAX, &fvalue)) == SR_OK)
326 *data = g_variant_new_double(fvalue);
327 break;
328 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
329 *data = g_variant_new_boolean(TRUE);
330 break;
331 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
332 if ((ret = maynuo_m97_get_bit(modbus, HEAT, &ivalue)) == SR_OK)
333 *data = g_variant_new_boolean(ivalue);
334 break;
e1ccfb19
AJ
335 default:
336 return SR_ERR_NA;
337 }
338
339 return ret;
340}
341
342static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
343 const struct sr_channel_group *cg)
344{
ffb580cf
AJ
345 struct dev_context *devc;
346 struct sr_modbus_dev_inst *modbus;
e1ccfb19
AJ
347 int ret;
348
e1ccfb19
AJ
349 (void)cg;
350
351 if (sdi->status != SR_ST_ACTIVE)
352 return SR_ERR_DEV_CLOSED;
353
ffb580cf
AJ
354 modbus = sdi->conn;
355 devc = sdi->priv;
356
e1ccfb19
AJ
357 ret = SR_OK;
358 switch (key) {
ffb580cf
AJ
359 case SR_CONF_LIMIT_SAMPLES:
360 devc->limit_samples = g_variant_get_uint64(data);
361 break;
362 case SR_CONF_LIMIT_MSEC:
363 devc->limit_msec = g_variant_get_uint64(data);
364 break;
365 case SR_CONF_ENABLED:
366 ret = maynuo_m97_set_input(modbus, g_variant_get_boolean(data));
367 break;
368 case SR_CONF_VOLTAGE_TARGET:
369 ret = maynuo_m97_set_float(modbus, UFIX, g_variant_get_double(data));
370 break;
371 case SR_CONF_CURRENT_LIMIT:
372 ret = maynuo_m97_set_float(modbus, IFIX, g_variant_get_double(data));
373 break;
374 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
375 ret = maynuo_m97_set_float(modbus, UMAX, g_variant_get_double(data));
376 break;
377 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
378 ret = maynuo_m97_set_float(modbus, IMAX, g_variant_get_double(data));
379 break;
e1ccfb19
AJ
380 default:
381 ret = SR_ERR_NA;
382 }
383
384 return ret;
385}
386
387static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
388 const struct sr_channel_group *cg)
389{
ffb580cf
AJ
390 struct dev_context *devc;
391 GVariantBuilder gvb;
e1ccfb19
AJ
392 int ret;
393
ffb580cf
AJ
394 /* Always available, even without sdi. */
395 if (key == SR_CONF_SCAN_OPTIONS) {
396 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
397 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
398 return SR_OK;
399 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
400 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
401 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
402 return SR_OK;
403 }
404
405 if (!sdi)
406 return SR_ERR_ARG;
407 devc = sdi->priv;
e1ccfb19
AJ
408
409 ret = SR_OK;
ffb580cf
AJ
410 if (!cg) {
411 /* No channel group: global options. */
412 switch (key) {
413 case SR_CONF_DEVICE_OPTIONS:
414 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
415 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
416 break;
417 default:
418 return SR_ERR_NA;
419 }
420 } else {
421 switch (key) {
422 case SR_CONF_DEVICE_OPTIONS:
423 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
424 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
425 break;
426 case SR_CONF_VOLTAGE_TARGET:
427 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
428 /* Min, max, write resolution. */
429 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
430 g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_voltage));
431 g_variant_builder_add_value(&gvb, g_variant_new_double(0.001));
432 *data = g_variant_builder_end(&gvb);
433 break;
434 case SR_CONF_CURRENT_LIMIT:
435 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
436 /* Min, max, step. */
437 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
438 g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_current));
439 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0001));
440 *data = g_variant_builder_end(&gvb);
441 break;
442 default:
443 return SR_ERR_NA;
444 }
e1ccfb19
AJ
445 }
446
447 return ret;
448}
449
695dc859 450static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e1ccfb19 451{
ffb580cf
AJ
452 struct dev_context *devc;
453 struct sr_modbus_dev_inst *modbus;
454 int ret;
455
e1ccfb19
AJ
456 if (sdi->status != SR_ST_ACTIVE)
457 return SR_ERR_DEV_CLOSED;
458
ffb580cf
AJ
459 modbus = sdi->conn;
460 devc = sdi->priv;
e1ccfb19 461
ffb580cf
AJ
462 if ((ret = sr_modbus_source_add(sdi->session, modbus, G_IO_IN, 10,
463 maynuo_m97_receive_data, (void *)sdi)) != SR_OK)
464 return ret;
465
ffb580cf
AJ
466 std_session_send_df_header(sdi, LOG_PREFIX);
467
468 devc->num_samples = 0;
469 devc->starttime = g_get_monotonic_time();
470
471 return maynuo_m97_capture_start(sdi);
e1ccfb19
AJ
472}
473
695dc859 474static int dev_acquisition_stop(struct sr_dev_inst *sdi)
e1ccfb19 475{
ffb580cf 476 struct sr_modbus_dev_inst *modbus;
ffb580cf 477
e1ccfb19
AJ
478 if (sdi->status != SR_ST_ACTIVE)
479 return SR_ERR_DEV_CLOSED;
480
3be42bc2 481 std_session_send_df_end(sdi, LOG_PREFIX);
ffb580cf
AJ
482
483 modbus = sdi->conn;
484 sr_modbus_source_remove(sdi->session, modbus);
e1ccfb19
AJ
485
486 return SR_OK;
487}
488
489SR_PRIV struct sr_dev_driver maynuo_m97_driver_info = {
490 .name = "maynuo-m97",
ffb580cf 491 .longname = "maynuo M97/M98 series",
e1ccfb19
AJ
492 .api_version = 1,
493 .init = init,
700d6b64 494 .cleanup = std_cleanup,
e1ccfb19
AJ
495 .scan = scan,
496 .dev_list = dev_list,
497 .dev_clear = dev_clear,
498 .config_get = config_get,
499 .config_set = config_set,
500 .config_list = config_list,
501 .dev_open = dev_open,
502 .dev_close = dev_close,
503 .dev_acquisition_start = dev_acquisition_start,
504 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 505 .context = NULL,
e1ccfb19 506};