]> sigrok.org Git - libsigrok.git/blame - src/hardware/maynuo-m97/api.c
manson-hcs-3xxx: Use software limit helpers
[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[] = {
e91bb0a6 34 SR_CONF_CONTINUOUS,
ffb580cf
AJ
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
e1ccfb19
AJ
202static int dev_open(struct sr_dev_inst *sdi)
203{
ffb580cf 204 struct sr_modbus_dev_inst *modbus = sdi->conn;
e1ccfb19 205
ffb580cf
AJ
206 if (sr_modbus_open(modbus) < 0)
207 return SR_ERR;
e1ccfb19
AJ
208
209 sdi->status = SR_ST_ACTIVE;
210
ffb580cf
AJ
211 maynuo_m97_set_bit(modbus, PC1, 1);
212
e1ccfb19
AJ
213 return SR_OK;
214}
215
216static int dev_close(struct sr_dev_inst *sdi)
217{
ffb580cf
AJ
218 struct dev_context *devc;
219 struct sr_modbus_dev_inst *modbus;
e1ccfb19 220
ffb580cf
AJ
221 if (sdi->status != SR_ST_ACTIVE)
222 return SR_ERR_DEV_CLOSED;
e1ccfb19 223
ffb580cf
AJ
224 modbus = sdi->conn;
225
226 if (modbus) {
227 devc = sdi->priv;
228 if (devc->expecting_registers) {
229 /* Wait for the last data that was requested from the device. */
230 uint16_t registers[devc->expecting_registers];
231 sr_modbus_read_holding_registers(modbus, -1,
232 devc->expecting_registers,
233 registers);
234 }
235
236 maynuo_m97_set_bit(modbus, PC1, 0);
237
238 if (sr_modbus_close(modbus) < 0)
239 return SR_ERR;
240 sdi->status = SR_ST_INACTIVE;
241 }
e1ccfb19
AJ
242
243 return SR_OK;
244}
245
e1ccfb19
AJ
246static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
247 const struct sr_channel_group *cg)
248{
ffb580cf
AJ
249 struct dev_context *devc;
250 struct sr_modbus_dev_inst *modbus;
251 enum maynuo_m97_mode mode;
252 int ret, ivalue;
253 float fvalue;
e1ccfb19 254
e1ccfb19
AJ
255 (void)cg;
256
ffb580cf
AJ
257 modbus = sdi->conn;
258 devc = sdi->priv;
259
e1ccfb19
AJ
260 ret = SR_OK;
261 switch (key) {
ffb580cf
AJ
262 case SR_CONF_LIMIT_SAMPLES:
263 *data = g_variant_new_uint64(devc->limit_samples);
264 break;
265 case SR_CONF_LIMIT_MSEC:
266 *data = g_variant_new_uint64(devc->limit_msec);
267 break;
268 case SR_CONF_ENABLED:
269 if ((ret = maynuo_m97_get_bit(modbus, ISTATE, &ivalue)) == SR_OK)
270 *data = g_variant_new_boolean(ivalue);
271 break;
272 case SR_CONF_REGULATION:
273 if ((ret = maynuo_m97_get_bit(modbus, UNREG, &ivalue)) != SR_OK)
274 break;
275 if (ivalue)
276 *data = g_variant_new_string("UR");
277 else if ((ret = maynuo_m97_get_mode(modbus, &mode)) == SR_OK)
278 *data = g_variant_new_string(maynuo_m97_mode_to_str(mode));
279 break;
280 case SR_CONF_VOLTAGE:
281 if ((ret = maynuo_m97_get_float(modbus, U, &fvalue)) == SR_OK)
282 *data = g_variant_new_double(fvalue);
283 break;
284 case SR_CONF_VOLTAGE_TARGET:
285 if ((ret = maynuo_m97_get_float(modbus, UFIX, &fvalue)) == SR_OK)
286 *data = g_variant_new_double(fvalue);
287 break;
288 case SR_CONF_CURRENT:
289 if ((ret = maynuo_m97_get_float(modbus, I, &fvalue)) == SR_OK)
290 *data = g_variant_new_double(fvalue);
291 break;
292 case SR_CONF_CURRENT_LIMIT:
293 if ((ret = maynuo_m97_get_float(modbus, IFIX, &fvalue)) == SR_OK)
294 *data = g_variant_new_double(fvalue);
295 break;
296 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
297 *data = g_variant_new_boolean(TRUE);
298 break;
299 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
300 if ((ret = maynuo_m97_get_bit(modbus, UOVER, &ivalue)) == SR_OK)
301 *data = g_variant_new_boolean(ivalue);
302 break;
303 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
304 if ((ret = maynuo_m97_get_float(modbus, UMAX, &fvalue)) == SR_OK)
305 *data = g_variant_new_double(fvalue);
306 break;
307 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
308 *data = g_variant_new_boolean(TRUE);
309 break;
310 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
311 if ((ret = maynuo_m97_get_bit(modbus, IOVER, &ivalue)) == SR_OK)
312 *data = g_variant_new_boolean(ivalue);
313 break;
314 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
315 if ((ret = maynuo_m97_get_float(modbus, IMAX, &fvalue)) == SR_OK)
316 *data = g_variant_new_double(fvalue);
317 break;
318 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
319 *data = g_variant_new_boolean(TRUE);
320 break;
321 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
322 if ((ret = maynuo_m97_get_bit(modbus, HEAT, &ivalue)) == SR_OK)
323 *data = g_variant_new_boolean(ivalue);
324 break;
e1ccfb19
AJ
325 default:
326 return SR_ERR_NA;
327 }
328
329 return ret;
330}
331
332static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
333 const struct sr_channel_group *cg)
334{
ffb580cf
AJ
335 struct dev_context *devc;
336 struct sr_modbus_dev_inst *modbus;
e1ccfb19
AJ
337 int ret;
338
e1ccfb19
AJ
339 (void)cg;
340
341 if (sdi->status != SR_ST_ACTIVE)
342 return SR_ERR_DEV_CLOSED;
343
ffb580cf
AJ
344 modbus = sdi->conn;
345 devc = sdi->priv;
346
e1ccfb19
AJ
347 ret = SR_OK;
348 switch (key) {
ffb580cf
AJ
349 case SR_CONF_LIMIT_SAMPLES:
350 devc->limit_samples = g_variant_get_uint64(data);
351 break;
352 case SR_CONF_LIMIT_MSEC:
353 devc->limit_msec = g_variant_get_uint64(data);
354 break;
355 case SR_CONF_ENABLED:
356 ret = maynuo_m97_set_input(modbus, g_variant_get_boolean(data));
357 break;
358 case SR_CONF_VOLTAGE_TARGET:
359 ret = maynuo_m97_set_float(modbus, UFIX, g_variant_get_double(data));
360 break;
361 case SR_CONF_CURRENT_LIMIT:
362 ret = maynuo_m97_set_float(modbus, IFIX, g_variant_get_double(data));
363 break;
364 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
365 ret = maynuo_m97_set_float(modbus, UMAX, g_variant_get_double(data));
366 break;
367 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
368 ret = maynuo_m97_set_float(modbus, IMAX, g_variant_get_double(data));
369 break;
e1ccfb19
AJ
370 default:
371 ret = SR_ERR_NA;
372 }
373
374 return ret;
375}
376
377static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
378 const struct sr_channel_group *cg)
379{
ffb580cf
AJ
380 struct dev_context *devc;
381 GVariantBuilder gvb;
e1ccfb19
AJ
382 int ret;
383
ffb580cf
AJ
384 /* Always available, even without sdi. */
385 if (key == SR_CONF_SCAN_OPTIONS) {
386 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
387 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
388 return SR_OK;
389 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
390 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
391 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
392 return SR_OK;
393 }
394
395 if (!sdi)
396 return SR_ERR_ARG;
397 devc = sdi->priv;
e1ccfb19
AJ
398
399 ret = SR_OK;
ffb580cf
AJ
400 if (!cg) {
401 /* No channel group: global options. */
402 switch (key) {
403 case SR_CONF_DEVICE_OPTIONS:
404 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
405 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
406 break;
407 default:
408 return SR_ERR_NA;
409 }
410 } else {
411 switch (key) {
412 case SR_CONF_DEVICE_OPTIONS:
413 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
414 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
415 break;
416 case SR_CONF_VOLTAGE_TARGET:
417 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
418 /* Min, max, write resolution. */
419 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
420 g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_voltage));
421 g_variant_builder_add_value(&gvb, g_variant_new_double(0.001));
422 *data = g_variant_builder_end(&gvb);
423 break;
424 case SR_CONF_CURRENT_LIMIT:
425 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
426 /* Min, max, step. */
427 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
428 g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_current));
429 g_variant_builder_add_value(&gvb, g_variant_new_double(0.0001));
430 *data = g_variant_builder_end(&gvb);
431 break;
432 default:
433 return SR_ERR_NA;
434 }
e1ccfb19
AJ
435 }
436
437 return ret;
438}
439
695dc859 440static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e1ccfb19 441{
ffb580cf
AJ
442 struct dev_context *devc;
443 struct sr_modbus_dev_inst *modbus;
444 int ret;
445
e1ccfb19
AJ
446 if (sdi->status != SR_ST_ACTIVE)
447 return SR_ERR_DEV_CLOSED;
448
ffb580cf
AJ
449 modbus = sdi->conn;
450 devc = sdi->priv;
e1ccfb19 451
ffb580cf
AJ
452 if ((ret = sr_modbus_source_add(sdi->session, modbus, G_IO_IN, 10,
453 maynuo_m97_receive_data, (void *)sdi)) != SR_OK)
454 return ret;
455
ffb580cf
AJ
456 std_session_send_df_header(sdi, LOG_PREFIX);
457
458 devc->num_samples = 0;
459 devc->starttime = g_get_monotonic_time();
460
461 return maynuo_m97_capture_start(sdi);
e1ccfb19
AJ
462}
463
695dc859 464static int dev_acquisition_stop(struct sr_dev_inst *sdi)
e1ccfb19 465{
ffb580cf 466 struct sr_modbus_dev_inst *modbus;
ffb580cf 467
e1ccfb19
AJ
468 if (sdi->status != SR_ST_ACTIVE)
469 return SR_ERR_DEV_CLOSED;
470
3be42bc2 471 std_session_send_df_end(sdi, LOG_PREFIX);
ffb580cf
AJ
472
473 modbus = sdi->conn;
474 sr_modbus_source_remove(sdi->session, modbus);
e1ccfb19
AJ
475
476 return SR_OK;
477}
478
479SR_PRIV struct sr_dev_driver maynuo_m97_driver_info = {
480 .name = "maynuo-m97",
ffb580cf 481 .longname = "maynuo M97/M98 series",
e1ccfb19
AJ
482 .api_version = 1,
483 .init = init,
700d6b64 484 .cleanup = std_cleanup,
e1ccfb19 485 .scan = scan,
c01bf34c 486 .dev_list = std_dev_list,
e1ccfb19
AJ
487 .config_get = config_get,
488 .config_set = config_set,
489 .config_list = config_list,
490 .dev_open = dev_open,
491 .dev_close = dev_close,
492 .dev_acquisition_start = dev_acquisition_start,
493 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 494 .context = NULL,
e1ccfb19 495};