scpi-pps: Add a missing "break" in config_get().
[libsigrok.git] / src / hardware / maynuo-m97 / api.c
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
20 #include <config.h>
21 #include "protocol.h"
22
23 static const uint32_t scanopts[] = {
24         SR_CONF_CONN,
25         SR_CONF_SERIALCOMM,
26         SR_CONF_MODBUSADDR,
27 };
28
29 static const uint32_t drvopts[] = {
30         SR_CONF_ELECTRONIC_LOAD,
31 };
32
33 static 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 };
38
39 static 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 /*
57  * The IDs in this list are only guessed and needs to be verified
58  * against some real hardware. If at least a few of them matches,
59  * it will probably be safe to enable the others.
60  */
61 static const struct maynuo_m97_model supported_models[] = {
62 //      {  53, "M9711"     ,   30, 150,    150 },
63 //      {  54, "M9712"     ,   30, 150,    300 },
64 //      {  55, "M9712C"    ,   60, 150,    300 },
65 //      {  56, "M9713"     ,  120, 150,    600 },
66 //      {  57, "M9712B"    ,   15, 500,    300 },
67 //      {  58, "M9713B"    ,   30, 500,    600 },
68 //      {  59, "M9714"     ,  240, 150,   1200 },
69 //      {  60, "M9714B"    ,   60, 500,   1200 },
70 //      {  61, "M9715"     ,  240, 150,   1800 },
71 //      {  62, "M9715B"    ,  120, 500,   1800 },
72 //      {  63, "M9716"     ,  240, 150,   2400 },
73 //      {  64, "M9716B"    ,  120, 500,   2400 },
74 //      {  65, "M9717C"    ,  480, 150,   3600 },
75 //      {  66, "M9717"     ,  240, 150,   3600 },
76 //      {  67, "M9717B"    ,  120, 500,   3600 },
77 //      {  68, "M9718"     ,  240, 150,   6000 },
78 //      {  69, "M9718B"    ,  120, 500,   6000 },
79 //      {  70, "M9718D"    ,  240, 500,   6000 },
80 //      {  71, "M9836"     ,  500, 150,  20000 },
81 //      {  72, "M9836B"    ,  240, 500,  20000 },
82 //      {  73, "M9838B"    ,  240, 500,  50000 },
83 //      {  74, "M9839B"    ,  240, 500, 100000 },
84 //      {  75, "M9840B"    ,  500, 500, 200000 },
85 //      {  76, "M9840"     , 1500, 150, 200000 },
86 //      {  77, "M9712B30"  ,   30, 500,    300 },
87 //      {  78, "M9718E"    ,  120, 600,   6000 },
88 //      {  79, "M9718F"    ,  480, 150,   6000 },
89 //      {  80, "M9716E"    ,  480, 150,   3000 },
90 //      {  81, "M9710"     ,   30, 150,    150 },
91 //      {  82, "M9834"     ,  500, 150,  10000 },
92 //      {  83, "M9835"     ,  500, 150,  15000 },
93 //      {  84, "M9835B"    ,  240, 500,  15000 },
94 //      {  85, "M9837"     ,  500, 150,  35000 },
95 //      {  86, "M9837B"    ,  240, 500,  35000 },
96 //      {  87, "M9838"     ,  500, 150,  50000 },
97 //      {  88, "M9839"     ,  500, 150, 100000 },
98 //      {  89, "M9835C"    , 1000, 150,  15000 }, /* ?? */
99 //      {  90, "M9836C"    , 1000, 150,  20000 }, /* ?? */
100 //      {  91, "M9718F-300",  480, 300,   6000 }, /* ?? */
101 //      {  92, "M9836F"    , 1000, 150,  20000 }, /* ?? */
102 //      {  93, "M9836E"    ,  240, 600,  20000 }, /* ?? */
103 //      {  94, "M9717D"    ,  240, 500,   3600 }, /* ?? */
104 //      {  95, "M9836B-720",  240, 720,  20000 }, /* ?? */
105 //      {  96, "M9834H"    ,  500, 150,  10000 }, /* ?? */
106 //      {  97, "M9836H"    ,  500, 150,  20000 }, /* ?? */
107 //      {  98, "M9718F-500",  480, 500,   6000 }, /* ?? */
108 //      {  99, "M9834B"    ,  240, 500,  10000 }, /* ?? */
109 //      { 100, "M9811"     ,   30, 150,    200 },
110         { 101, "M9812"     ,   30, 150,    300 },
111 //      { 102, "M9812B"    ,   15, 500,    300 },
112 };
113
114 static struct sr_dev_driver maynuo_m97_driver_info;
115
116 static struct sr_dev_inst *probe_device(struct sr_modbus_dev_inst *modbus)
117 {
118         const struct maynuo_m97_model *model = NULL;
119         struct dev_context *devc;
120         struct sr_dev_inst *sdi;
121         struct sr_channel_group *cg;
122         struct sr_channel *ch;
123         uint16_t id, version;
124         unsigned int i;
125
126         int ret = maynuo_m97_get_model_version(modbus, &id, &version);
127         if (ret != SR_OK)
128                 return NULL;
129         for (i = 0; i < ARRAY_SIZE(supported_models); i++)
130                 if (id == supported_models[i].id) {
131                         model = &supported_models[i];
132                         break;
133                 }
134         if (model == NULL) {
135                 sr_err("Unknown model: %d.", id);
136                 return NULL;
137         }
138
139         sdi = g_malloc0(sizeof(struct sr_dev_inst));
140         sdi->status = SR_ST_INACTIVE;
141         sdi->vendor = g_strdup("Maynuo");
142         sdi->model = g_strdup(model->name);
143         sdi->version = g_strdup_printf("v%d.%d", version/10, version%10);
144         sdi->conn = modbus;
145         sdi->driver = &maynuo_m97_driver_info;
146         sdi->inst_type = SR_INST_MODBUS;
147
148         cg = g_malloc0(sizeof(struct sr_channel_group));
149         cg->name = g_strdup("1");
150         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
151
152         ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V1");
153         cg->channels = g_slist_append(cg->channels, ch);
154
155         ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "I1");
156         cg->channels = g_slist_append(cg->channels, ch);
157
158         devc = g_malloc0(sizeof(struct dev_context));
159         devc->model = model;
160
161         sdi->priv = devc;
162
163         return sdi;
164 }
165
166 static int config_compare(gconstpointer a, gconstpointer b)
167 {
168         const struct sr_config *ac = a, *bc = b;
169         return ac->key != bc->key;
170 }
171
172 static GSList *scan(struct sr_dev_driver *di, GSList *options)
173 {
174         struct sr_config default_serialcomm = {
175                 .key = SR_CONF_SERIALCOMM,
176                 .data = g_variant_new_string("9600/8n1"),
177         };
178         struct sr_config default_modbusaddr = {
179                 .key = SR_CONF_MODBUSADDR,
180                 .data = g_variant_new_uint64(1),
181         };
182         GSList *opts = options, *devices;
183
184         if (!g_slist_find_custom(options, &default_serialcomm, config_compare))
185                 opts = g_slist_prepend(opts, &default_serialcomm);
186         if (!g_slist_find_custom(options, &default_modbusaddr, config_compare))
187                 opts = g_slist_prepend(opts, &default_modbusaddr);
188
189         devices = sr_modbus_scan(di->context, opts, probe_device);
190
191         while (opts != options)
192                 opts = g_slist_delete_link(opts, opts);
193         g_variant_unref(default_serialcomm.data);
194         g_variant_unref(default_modbusaddr.data);
195
196         return devices;
197 }
198
199 static int dev_open(struct sr_dev_inst *sdi)
200 {
201         struct sr_modbus_dev_inst *modbus = sdi->conn;
202
203         if (sr_modbus_open(modbus) < 0)
204                 return SR_ERR;
205
206         maynuo_m97_set_bit(modbus, PC1, 1);
207
208         return SR_OK;
209 }
210
211 static int dev_close(struct sr_dev_inst *sdi)
212 {
213         struct dev_context *devc;
214         struct sr_modbus_dev_inst *modbus;
215
216         modbus = sdi->conn;
217
218         if (!modbus)
219                 return SR_ERR_BUG;
220
221         devc = sdi->priv;
222
223         if (devc->expecting_registers) {
224                 /* Wait for the last data that was requested from the device. */
225                 uint16_t registers[devc->expecting_registers];
226                 sr_modbus_read_holding_registers(modbus, -1,
227                         devc->expecting_registers, registers);
228         }
229
230         maynuo_m97_set_bit(modbus, PC1, 0);
231
232         return sr_modbus_close(modbus);
233 }
234
235 static int config_get(uint32_t key, GVariant **data,
236         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
237 {
238         struct dev_context *devc;
239         struct sr_modbus_dev_inst *modbus;
240         enum maynuo_m97_mode mode;
241         int ret, ivalue;
242         float fvalue;
243
244         (void)cg;
245
246         modbus = sdi->conn;
247         devc = sdi->priv;
248
249         ret = SR_OK;
250         switch (key) {
251         case SR_CONF_LIMIT_SAMPLES:
252         case SR_CONF_LIMIT_MSEC:
253                 ret = sr_sw_limits_config_get(&devc->limits, key, data);
254                 break;
255         case SR_CONF_ENABLED:
256                 if ((ret = maynuo_m97_get_bit(modbus, ISTATE, &ivalue)) == SR_OK)
257                         *data = g_variant_new_boolean(ivalue);
258                 break;
259         case SR_CONF_REGULATION:
260                 if ((ret = maynuo_m97_get_bit(modbus, UNREG, &ivalue)) != SR_OK)
261                         break;
262                 if (ivalue)
263                         *data = g_variant_new_string("UR");
264                 else if ((ret = maynuo_m97_get_mode(modbus, &mode)) == SR_OK)
265                         *data = g_variant_new_string(maynuo_m97_mode_to_str(mode));
266                 break;
267         case SR_CONF_VOLTAGE:
268                 if ((ret = maynuo_m97_get_float(modbus, U, &fvalue)) == SR_OK)
269                         *data = g_variant_new_double(fvalue);
270                 break;
271         case SR_CONF_VOLTAGE_TARGET:
272                 if ((ret = maynuo_m97_get_float(modbus, UFIX, &fvalue)) == SR_OK)
273                         *data = g_variant_new_double(fvalue);
274                 break;
275         case SR_CONF_CURRENT:
276                 if ((ret = maynuo_m97_get_float(modbus, I, &fvalue)) == SR_OK)
277                         *data = g_variant_new_double(fvalue);
278                 break;
279         case SR_CONF_CURRENT_LIMIT:
280                 if ((ret = maynuo_m97_get_float(modbus, IFIX, &fvalue)) == SR_OK)
281                         *data = g_variant_new_double(fvalue);
282                 break;
283         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
284                 *data = g_variant_new_boolean(TRUE);
285                 break;
286         case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
287                 if ((ret = maynuo_m97_get_bit(modbus, UOVER, &ivalue)) == SR_OK)
288                         *data = g_variant_new_boolean(ivalue);
289                 break;
290         case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
291                 if ((ret = maynuo_m97_get_float(modbus, UMAX, &fvalue)) == SR_OK)
292                         *data = g_variant_new_double(fvalue);
293                 break;
294         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
295                 *data = g_variant_new_boolean(TRUE);
296                 break;
297         case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
298                 if ((ret = maynuo_m97_get_bit(modbus, IOVER, &ivalue)) == SR_OK)
299                         *data = g_variant_new_boolean(ivalue);
300                 break;
301         case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
302                 if ((ret = maynuo_m97_get_float(modbus, IMAX, &fvalue)) == SR_OK)
303                         *data = g_variant_new_double(fvalue);
304                 break;
305         case SR_CONF_OVER_TEMPERATURE_PROTECTION:
306                 *data = g_variant_new_boolean(TRUE);
307                 break;
308         case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
309                 if ((ret = maynuo_m97_get_bit(modbus, HEAT, &ivalue)) == SR_OK)
310                         *data = g_variant_new_boolean(ivalue);
311                 break;
312         default:
313                 return SR_ERR_NA;
314         }
315
316         return ret;
317 }
318
319 static int config_set(uint32_t key, GVariant *data,
320         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
321 {
322         struct dev_context *devc;
323         struct sr_modbus_dev_inst *modbus;
324
325         (void)cg;
326
327         modbus = sdi->conn;
328         devc = sdi->priv;
329
330         switch (key) {
331         case SR_CONF_LIMIT_SAMPLES:
332         case SR_CONF_LIMIT_MSEC:
333                 return sr_sw_limits_config_set(&devc->limits, key, data);
334         case SR_CONF_ENABLED:
335                 return maynuo_m97_set_input(modbus, g_variant_get_boolean(data));
336         case SR_CONF_VOLTAGE_TARGET:
337                 return maynuo_m97_set_float(modbus, UFIX, g_variant_get_double(data));
338         case SR_CONF_CURRENT_LIMIT:
339                 return maynuo_m97_set_float(modbus, IFIX, g_variant_get_double(data));
340         case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
341                 return maynuo_m97_set_float(modbus, UMAX, g_variant_get_double(data));
342         case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
343                 return maynuo_m97_set_float(modbus, IMAX, g_variant_get_double(data));
344         default:
345                 return SR_ERR_NA;
346         }
347
348         return SR_OK;
349 }
350
351 static int config_list(uint32_t key, GVariant **data,
352         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
353 {
354         struct dev_context *devc;
355
356         devc = (sdi) ? sdi->priv : NULL;
357
358         if (!cg) {
359                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
360         } else {
361                 switch (key) {
362                 case SR_CONF_DEVICE_OPTIONS:
363                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
364                         break;
365                 case SR_CONF_VOLTAGE_TARGET:
366                         if (!devc || !devc->model)
367                                 return SR_ERR_ARG;
368                         *data = std_gvar_min_max_step(0.0, devc->model->max_voltage, 0.001);
369                         break;
370                 case SR_CONF_CURRENT_LIMIT:
371                         if (!devc || !devc->model)
372                                 return SR_ERR_ARG;
373                         *data = std_gvar_min_max_step(0.0, devc->model->max_current, 0.0001);
374                         break;
375                 default:
376                         return SR_ERR_NA;
377                 }
378         }
379
380         return SR_OK;
381 }
382
383 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
384 {
385         struct dev_context *devc;
386         struct sr_modbus_dev_inst *modbus;
387         int ret;
388
389         modbus = sdi->conn;
390         devc = sdi->priv;
391
392         if ((ret = sr_modbus_source_add(sdi->session, modbus, G_IO_IN, 10,
393                         maynuo_m97_receive_data, (void *)sdi)) != SR_OK)
394                 return ret;
395
396         sr_sw_limits_acquisition_start(&devc->limits);
397         std_session_send_df_header(sdi);
398
399         return maynuo_m97_capture_start(sdi);
400 }
401
402 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
403 {
404         struct sr_modbus_dev_inst *modbus;
405
406         std_session_send_df_end(sdi);
407
408         modbus = sdi->conn;
409         sr_modbus_source_remove(sdi->session, modbus);
410
411         return SR_OK;
412 }
413
414 static struct sr_dev_driver maynuo_m97_driver_info = {
415         .name = "maynuo-m97",
416         .longname = "maynuo M97/M98 series",
417         .api_version = 1,
418         .init = std_init,
419         .cleanup = std_cleanup,
420         .scan = scan,
421         .dev_list = std_dev_list,
422         .dev_clear = std_dev_clear,
423         .config_get = config_get,
424         .config_set = config_set,
425         .config_list = config_list,
426         .dev_open = dev_open,
427         .dev_close = dev_close,
428         .dev_acquisition_start = dev_acquisition_start,
429         .dev_acquisition_stop = dev_acquisition_stop,
430         .context = NULL,
431 };
432 SR_REGISTER_DEV_DRIVER(maynuo_m97_driver_info);