]> sigrok.org Git - libsigrok.git/blob - hardware/link-mso19/api.c
Drivers: Explicitly list sr_samplerates fields.
[libsigrok.git] / hardware / link-mso19 / api.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
5  * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
6  * Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include "protocol.h"
23
24 static const int hwcaps[] = {
25         SR_CONF_LOGIC_ANALYZER,
26         SR_CONF_SAMPLERATE,
27         SR_CONF_TRIGGER_SLOPE,
28         SR_CONF_HORIZ_TRIGGERPOS,
29 //      SR_CONF_CAPTURE_RATIO,
30         SR_CONF_LIMIT_SAMPLES,
31 //      SR_CONF_RLE,
32         0,
33 };
34
35 /*
36  * Probes are numbered 0 to 7.
37  *
38  * See also: http://www.linkinstruments.com/images/mso19_1113.gif
39  */
40 SR_PRIV const char *mso19_probe_names[NUM_PROBES + 1] = {
41         "0", "1", "2", "3", "4", "5", "6", "7", NULL
42 };
43
44 static const struct sr_samplerates samplerates = {
45         .low  = SR_HZ(100),
46         .high = SR_MHZ(200),
47         .step = SR_HZ(100),
48         .list = NULL,
49 };
50
51 SR_PRIV struct sr_dev_driver link_mso19_driver_info;
52 static struct sr_dev_driver *di = &link_mso19_driver_info;
53
54 static int hw_init(struct sr_context *sr_ctx)
55 {
56         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
57 }
58
59 static GSList *hw_scan(GSList *options)
60 {
61         int i;
62         GSList *devices = NULL;
63         const char *conn = NULL;
64         const char *serialcomm = NULL;
65         GSList *l;
66         struct sr_config *src;
67         struct udev *udev;
68
69         (void)options;
70
71         for (l = options; l; l = l->next) {
72                 src = l->data;
73                 switch (src->key) {
74                 case SR_CONF_CONN:
75                         conn = src->value;
76                         break;
77                 case SR_CONF_SERIALCOMM:
78                         serialcomm = src->value;
79                         break;
80                 }
81         }
82         if (!conn)
83                 conn = SERIALCONN;
84         if (serialcomm == NULL)
85                 serialcomm = SERIALCOMM;
86
87         udev = udev_new();
88         if (!udev) {
89                 sr_err("Failed to initialize udev.");
90         }
91
92         struct udev_enumerate *enumerate = udev_enumerate_new(udev);
93         udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
94         udev_enumerate_scan_devices(enumerate);
95         struct udev_list_entry *devs = udev_enumerate_get_list_entry(enumerate);
96         struct udev_list_entry *dev_list_entry;
97         for (dev_list_entry = devs;
98              dev_list_entry != NULL;
99              dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
100                 const char *syspath = udev_list_entry_get_name(dev_list_entry);
101                 struct udev_device *dev =
102                     udev_device_new_from_syspath(udev, syspath);
103                 const char *sysname = udev_device_get_sysname(dev);
104                 struct udev_device *parent =
105                     udev_device_get_parent_with_subsystem_devtype(dev, "usb",
106                                                                   "usb_device");
107
108                 if (!parent) {
109                         sr_err("Unable to find parent usb device for %s",
110                                sysname);
111                         continue;
112                 }
113
114                 const char *idVendor =
115                     udev_device_get_sysattr_value(parent, "idVendor");
116                 const char *idProduct =
117                     udev_device_get_sysattr_value(parent, "idProduct");
118                 if (strcmp(USB_VENDOR, idVendor)
119                     || strcmp(USB_PRODUCT, idProduct))
120                         continue;
121
122                 const char *iSerial =
123                     udev_device_get_sysattr_value(parent, "serial");
124                 const char *iProduct =
125                     udev_device_get_sysattr_value(parent, "product");
126
127                 char path[32];
128                 snprintf(path, sizeof(path), "/dev/%s", sysname);
129                 conn = path;
130
131                 size_t s = strcspn(iProduct, " ");
132                 char product[32];
133                 char manufacturer[32];
134                 if (s > sizeof(product) ||
135                     strlen(iProduct) - s > sizeof(manufacturer)) {
136                         sr_err("Could not parse iProduct: %s.", iProduct);
137                         continue;
138                 }
139                 strncpy(product, iProduct, s);
140                 product[s] = 0;
141                 strcpy(manufacturer, iProduct + s + 1);
142
143                 //Create the device context and set its params
144                 struct dev_context *devc;
145                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
146                         sr_err("Device context malloc failed.");
147                         return devices;
148                 }
149
150                 if (mso_parse_serial(iSerial, iProduct, devc) != SR_OK) {
151                         sr_err("Invalid iSerial: %s.", iSerial);
152                         g_free(devc);
153                         return devices;
154                 }
155
156                 char hwrev[32];
157                 sprintf(hwrev, "r%d", devc->hwrev);
158                 devc->ctlbase1 = 0;
159                 devc->protocol_trigger.spimode = 0;
160                 for (i = 0; i < 4; i++) {
161                         devc->protocol_trigger.word[i] = 0;
162                         devc->protocol_trigger.mask[i] = 0xff;
163                 }
164
165                 if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm))) {
166                         g_free(devc);
167                         return devices;
168                 }
169
170                 struct sr_dev_inst *sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
171                                                 manufacturer, product, hwrev);
172
173                 if (!sdi) {
174                         sr_err("Unable to create device instance for %s",
175                                sysname);
176                         sr_dev_inst_free(sdi);
177                         g_free(devc);
178                         return devices;
179                 }
180
181                 sdi->driver = di;
182                 sdi->priv = devc;
183
184                 for (i = 0; i < NUM_PROBES; i++) {
185                         struct sr_probe *probe;
186                         if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
187                                                    mso19_probe_names[i])))
188                                 return 0;
189                         sdi->probes = g_slist_append(sdi->probes, probe);
190                 }
191
192                 //Add the driver
193                 struct drv_context *drvc = di->priv;
194                 drvc->instances = g_slist_append(drvc->instances, sdi);
195                 devices = g_slist_append(devices, sdi);
196         }
197
198         return devices;
199 }
200
201 static GSList *hw_dev_list(void)
202 {
203         struct drv_context *drvc;
204
205         drvc = di->priv;
206
207         return drvc->instances;
208 }
209
210 static int hw_dev_open(struct sr_dev_inst *sdi)
211 {
212         int ret;
213         struct dev_context *devc;
214
215         devc = sdi->priv;
216
217         if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
218                 return SR_ERR;
219
220         sdi->status = SR_ST_ACTIVE;
221
222         /* FIXME: discard serial buffer */
223         mso_check_trigger(devc->serial, &devc->trigger_state);
224         sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
225
226         ret = mso_reset_adc(sdi);
227         if (ret != SR_OK)
228                 return ret;
229
230         mso_check_trigger(devc->serial, &devc->trigger_state);
231         sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
232
233         //    ret = mso_reset_fsm(sdi);
234         //    if (ret != SR_OK)
235         //            return ret;
236         //    return SR_ERR;
237
238         return SR_OK;
239 }
240
241 static int hw_dev_close(struct sr_dev_inst *sdi)
242 {
243         struct dev_context *devc;
244
245         devc = sdi->priv;
246
247         if (devc->serial && devc->serial->fd != -1) {
248                 serial_close(devc->serial);
249                 sdi->status = SR_ST_INACTIVE;
250         }
251
252         return SR_OK;
253 }
254
255 static int hw_cleanup(void)
256 {
257         GSList *l;
258         struct sr_dev_inst *sdi;
259         struct drv_context *drvc;
260         struct dev_context *devc;
261         int ret = SR_OK;
262
263         if (!(drvc = di->priv))
264                 return SR_OK;
265
266         /* Properly close and free all devices. */
267         for (l = drvc->instances; l; l = l->next) {
268                 if (!(sdi = l->data)) {
269                         /* Log error, but continue cleaning up the rest. */
270                         sr_err("%s: sdi was NULL, continuing", __func__);
271                         ret = SR_ERR_BUG;
272                         continue;
273                 }
274                 if (!(devc = sdi->priv)) {
275                         /* Log error, but continue cleaning up the rest. */
276                         sr_err("%s: sdi->priv was NULL, continuing", __func__);
277                         ret = SR_ERR_BUG;
278                         continue;
279                 }
280                 hw_dev_close(sdi);
281                 sr_serial_dev_inst_free(devc->serial);
282                 sr_dev_inst_free(sdi);
283         }
284         g_slist_free(drvc->instances);
285         drvc->instances = NULL;
286
287         return ret;
288 }
289
290 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
291 {
292         struct dev_context *devc;
293
294         switch (id) {
295         case SR_CONF_SAMPLERATE:
296                 if (sdi) {
297                         devc = sdi->priv;
298                         *data = &devc->cur_rate;
299                 } else
300                         return SR_ERR;
301                 break;
302         default:
303                 return SR_ERR_ARG;
304         }
305
306         return SR_OK;
307 }
308
309 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
310 {
311         int ret;
312         struct dev_context *devc;
313         uint64_t num_samples, slope;
314         int trigger_pos;
315         float pos;
316
317         devc = sdi->priv;
318
319         if (sdi->status != SR_ST_ACTIVE)
320                 return SR_ERR;
321
322         switch (id) {
323         case SR_CONF_SAMPLERATE:
324                 // FIXME
325                 return mso_configure_rate(sdi, *(const uint64_t *)value);
326                 ret = SR_OK;
327                 break;
328         case SR_CONF_LIMIT_SAMPLES:
329                 num_samples = *(uint64_t *)value;
330                 if (num_samples < 1024) {
331                         sr_err("minimum of 1024 samples required");
332                         ret = SR_ERR_ARG;
333                 } else {
334                         devc->limit_samples = num_samples;
335                         sr_dbg("setting limit_samples to %i\n",
336                                num_samples);
337                         ret = SR_OK;
338                 }
339                 break;
340         case SR_CONF_CAPTURE_RATIO:
341                 ret = SR_OK;
342                 break;
343         case SR_CONF_TRIGGER_SLOPE:
344                 slope = *(uint64_t *)value;
345                 if (slope != SLOPE_NEGATIVE && slope != SLOPE_POSITIVE) {
346                         sr_err("Invalid trigger slope");
347                         ret = SR_ERR_ARG;
348                 } else {
349                         devc->trigger_slope = slope;
350                         ret = SR_OK;
351                 }
352                 break;
353         case SR_CONF_HORIZ_TRIGGERPOS:
354                 pos = *(float *)value;
355                 if (pos < 0 || pos > 255) {
356                         sr_err("Trigger position (%f) should be between 0 and 255.", pos);
357                         ret = SR_ERR_ARG;
358                 } else {
359                         trigger_pos = (int)pos;
360                         devc->trigger_holdoff[0] = trigger_pos & 0xff;
361                         ret = SR_OK;
362                 }
363                 break;
364         case SR_CONF_RLE:
365                 ret = SR_OK;
366                 break;
367         default:
368                 ret = SR_ERR;
369                 break;
370         }
371
372         return ret;
373 }
374
375 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
376 {
377
378         (void)sdi;
379
380         switch (key) {
381         case SR_CONF_DEVICE_OPTIONS:
382                 *data = hwcaps;
383                 break;
384         case SR_CONF_SAMPLERATE:
385                 *data = &samplerates;
386                 break;
387         case SR_CONF_TRIGGER_TYPE:
388                 *data = (char *)TRIGGER_TYPE;
389                 break;
390         default:
391                 return SR_ERR_ARG;
392         }
393
394         return SR_OK;
395 }
396
397 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
398                                     void *cb_data)
399 {
400         struct sr_datafeed_packet *packet;
401         struct sr_datafeed_header *header;
402         struct dev_context *devc;
403         int ret = SR_ERR;
404
405         devc = sdi->priv;
406
407         if (sdi->status != SR_ST_ACTIVE)
408                 return SR_ERR;
409
410         if (mso_configure_probes(sdi) != SR_OK) {
411                 sr_err("Failed to configure probes.");
412                 return SR_ERR;
413         }
414
415         /* FIXME: No need to do full reconfigure every time */
416 //      ret = mso_reset_fsm(sdi);
417 //      if (ret != SR_OK)
418 //              return ret;
419
420         /* FIXME: ACDC Mode */
421         devc->ctlbase1 &= 0x7f;
422 //      devc->ctlbase1 |= devc->acdcmode;
423
424         ret = mso_configure_rate(sdi, devc->cur_rate);
425         if (ret != SR_OK)
426                 return ret;
427
428         /* set dac offset */
429         ret = mso_dac_out(sdi, devc->dac_offset);
430         if (ret != SR_OK)
431                 return ret;
432
433         ret = mso_configure_threshold_level(sdi);
434         if (ret != SR_OK)
435                 return ret;
436
437         ret = mso_configure_trigger(sdi);
438         if (ret != SR_OK)
439                 return ret;
440
441         /* END of config hardware part */
442         ret = mso_arm(sdi);
443         if (ret != SR_OK)
444                 return ret;
445
446         /* Start acquisition on the device. */
447         mso_check_trigger(devc->serial, &devc->trigger_state);
448         ret = mso_check_trigger(devc->serial, NULL);
449         if (ret != SR_OK)
450                 return ret;
451
452         sr_source_add(devc->serial->fd, G_IO_IN, -1, mso_receive_data, cb_data);
453
454         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
455                 sr_err("Datafeed packet malloc failed.");
456                 return SR_ERR_MALLOC;
457         }
458
459         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
460                 sr_err("Datafeed header malloc failed.");
461                 g_free(packet);
462                 return SR_ERR_MALLOC;
463         }
464
465         packet->type = SR_DF_HEADER;
466         packet->payload = (unsigned char *)header;
467         header->feed_version = 1;
468         gettimeofday(&header->starttime, NULL);
469         sr_session_send(cb_data, packet);
470
471         g_free(header);
472         g_free(packet);
473
474         return SR_OK;
475 }
476
477 /* This stops acquisition on ALL devices, ignoring dev_index. */
478 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
479 {
480         (void)cb_data;
481
482         stop_acquisition(sdi);
483
484         return SR_OK;
485 }
486
487 SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
488         .name = "link-mso19",
489         .longname = "Link Instruments MSO-19",
490         .api_version = 1,
491         .init = hw_init,
492         .cleanup = hw_cleanup,
493         .scan = hw_scan,
494         .dev_list = hw_dev_list,
495         .dev_clear = hw_cleanup,
496         .config_get = config_get,
497         .config_set = config_set,
498         .config_list = config_list,
499         .dev_open = hw_dev_open,
500         .dev_close = hw_dev_close,
501         .dev_acquisition_start = hw_dev_acquisition_start,
502         .dev_acquisition_stop = hw_dev_acquisition_stop,
503         .priv = NULL,
504 };