]> sigrok.org Git - libsigrok.git/blame - src/hardware/beaglelogic/api.c
beaglelogic: Add missing scan options, and cleanup.
[libsigrok.git] / src / hardware / beaglelogic / api.c
CommitLineData
bb993797
KA
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Kumar Abhishek <abhishek@theembeddedkitchen.net>
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 "protocol.h"
ad9dbc1c 21#include "beaglelogic.h"
bb993797
KA
22
23SR_PRIV struct sr_dev_driver beaglelogic_driver_info;
24static struct sr_dev_driver *di = &beaglelogic_driver_info;
25
138589b0
BV
26/* Scan options */
27static const uint32_t scanopts[] = {
28 SR_CONF_NUM_LOGIC_CHANNELS,
29};
30
31/* Hardware capabilities */
f254bc4b 32static const uint32_t devopts[] = {
ad9dbc1c
KA
33 SR_CONF_LOGIC_ANALYZER,
34 SR_CONF_SAMPLERATE,
35 SR_CONF_TRIGGER_MATCH,
36
37 SR_CONF_LIMIT_SAMPLES,
38 SR_CONF_CONTINUOUS,
39
40 SR_CONF_NUM_LOGIC_CHANNELS,
41};
42
43/* Trigger matching capabilities */
44static const int32_t soft_trigger_matches[] = {
45 SR_TRIGGER_ZERO,
46 SR_TRIGGER_ONE,
47 SR_TRIGGER_RISING,
48 SR_TRIGGER_FALLING,
49 SR_TRIGGER_EDGE,
50};
51
52/* Channels are numbered 0-13 */
53SR_PRIV const char *beaglelogic_channel_names[NUM_CHANNELS + 1] = {
54 "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39", "P8_40",
55 "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20", NULL,
56};
57
58/* Possible sample rates : 10 Hz to 100 MHz = (100 / x) MHz */
59static const uint64_t samplerates[] = {
138589b0
BV
60 SR_HZ(10),
61 SR_MHZ(100),
62 SR_HZ(1),
ad9dbc1c
KA
63};
64
bb993797
KA
65static int init(struct sr_context *sr_ctx)
66{
67 return std_init(sr_ctx, di, LOG_PREFIX);
68}
69
ad9dbc1c
KA
70static struct dev_context * beaglelogic_devc_alloc(void)
71{
72 struct dev_context *devc;
73
74 /* Allocate zeroed structure */
75 devc = g_try_malloc0(sizeof(*devc));
76
77 /* Default non-zero values (if any) */
78 devc->fd = -1;
79 devc->limit_samples = (uint64_t)-1;
80
81 return devc;
82}
83
bb993797
KA
84static GSList *scan(GSList *options)
85{
86 struct drv_context *drvc;
ad9dbc1c
KA
87 GSList *devices, *l;
88 struct sr_config *src;
89 struct sr_dev_inst *sdi;
90 struct dev_context *devc;
91 struct sr_channel *ch;
92 int i, maxch;
bb993797
KA
93
94 devices = NULL;
95 drvc = di->priv;
96 drvc->instances = NULL;
97
ad9dbc1c
KA
98 /* Probe for /dev/beaglelogic */
99 if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
100 return NULL;
101
102 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, NULL, "BeagleLogic", "1.0");
103 sdi->driver = di;
104
105 /* Unless explicitly specified, keep max channels to 8 only */
106 maxch = 8;
107 for (l = options; l; l = l->next) {
108 src = l->data;
109 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
110 maxch = g_variant_get_int32(src->data);
111 }
112
113 /* We need to test for number of channels by opening the node */
114 devc = beaglelogic_devc_alloc();
115
116 if (beaglelogic_open_nonblock(devc) != SR_OK) {
117 g_free(devc);
118 sr_dev_inst_free(sdi);
119
120 return NULL;
121 }
122
123 if (maxch > 8) {
124 maxch = NUM_CHANNELS;
125 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
126 } else {
127 maxch = 8;
128 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
129 }
130
131 beaglelogic_set_sampleunit(devc);
132 beaglelogic_close(devc);
133
134 /* Signal */
135 sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
136
137 /* Fill the channels */
138 for (i = 0; i < maxch; i++) {
139 if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
140 beaglelogic_channel_names[i])))
141 return NULL;
142 sdi->channels = g_slist_append(sdi->channels, ch);
143 }
144
145 sdi->priv = devc;
146 drvc->instances = g_slist_append(drvc->instances, sdi);
147 devices = g_slist_append(devices, sdi);
bb993797
KA
148
149 return devices;
150}
151
152static GSList *dev_list(void)
153{
154 return ((struct drv_context *)(di->priv))->instances;
155}
156
157static int dev_clear(void)
158{
159 return std_dev_clear(di, NULL);
160}
161
162static int dev_open(struct sr_dev_inst *sdi)
163{
ad9dbc1c
KA
164 struct dev_context *devc = sdi->priv;
165
166 /* Open BeagleLogic */
167 if (beaglelogic_open_nonblock(devc))
168 return SR_ERR;
169
170 /* Set fd and local attributes */
171 devc->pollfd.fd = devc->fd;
172 devc->pollfd.events = G_IO_IN;
173
174 /* Get the default attributes */
175 beaglelogic_get_samplerate(devc);
176 beaglelogic_get_sampleunit(devc);
177 beaglelogic_get_triggerflags(devc);
178 beaglelogic_get_buffersize(devc);
179 beaglelogic_get_bufunitsize(devc);
180
181 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
182 if (beaglelogic_mmap(devc) != SR_OK) {
183 sr_err("Unable to map capture buffer");
184 beaglelogic_close(devc);
185 return SR_ERR;
186 }
bb993797 187
ad9dbc1c 188 /* We're good to go now */
bb993797 189 sdi->status = SR_ST_ACTIVE;
bb993797
KA
190 return SR_OK;
191}
192
193static int dev_close(struct sr_dev_inst *sdi)
194{
ad9dbc1c 195 struct dev_context *devc = sdi->priv;
bb993797 196
ad9dbc1c
KA
197 if (sdi->status == SR_ST_ACTIVE) {
198 /* Close the memory mapping and the file */
199 beaglelogic_munmap(devc);
200 beaglelogic_close(devc);
201 }
bb993797 202 sdi->status = SR_ST_INACTIVE;
bb993797
KA
203 return SR_OK;
204}
205
206static int cleanup(void)
207{
ad9dbc1c
KA
208 struct drv_context *drvc;
209 struct sr_dev_inst *sdi;
210 GSList *l;
211
212 /* unused driver */
213 if (!(drvc = di->priv))
214 return SR_OK;
215
216 /* Clean up the instances */
217 for (l = drvc->instances; l; l = l->next) {
218 sdi = l->data;
219 di->dev_close(sdi);
220 g_free(sdi->priv);
221 sr_dev_inst_free(sdi);
222 }
223 g_slist_free(drvc->instances);
224 drvc->instances = NULL;
bb993797 225
ad9dbc1c 226 di->priv = NULL;
bb993797
KA
227
228 return SR_OK;
229}
230
584560f1 231static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
bb993797
KA
232 const struct sr_channel_group *cg)
233{
ad9dbc1c 234 struct dev_context *devc = sdi->priv;
bb993797
KA
235 (void)cg;
236
bb993797 237 switch (key) {
ad9dbc1c
KA
238 case SR_CONF_LIMIT_SAMPLES:
239 *data = g_variant_new_uint64(devc->limit_samples);
240 break;
241
242 case SR_CONF_SAMPLERATE:
243 *data = g_variant_new_uint64(devc->cur_samplerate);
244 break;
245
246 case SR_CONF_NUM_LOGIC_CHANNELS:
247 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
248 break;
249
bb993797
KA
250 default:
251 return SR_ERR_NA;
252 }
253
ad9dbc1c 254 return SR_OK;
bb993797
KA
255}
256
584560f1 257static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
bb993797
KA
258 const struct sr_channel_group *cg)
259{
ad9dbc1c
KA
260 struct dev_context *devc = sdi->priv;
261 uint64_t tmp_u64;
bb993797
KA
262 (void)cg;
263
264 if (sdi->status != SR_ST_ACTIVE)
265 return SR_ERR_DEV_CLOSED;
266
bb993797 267 switch (key) {
ad9dbc1c
KA
268 case SR_CONF_SAMPLERATE:
269 devc->cur_samplerate = g_variant_get_uint64(data);
270 return beaglelogic_set_samplerate(devc);
271
272 case SR_CONF_LIMIT_SAMPLES:
273 tmp_u64 = g_variant_get_uint64(data);
274 devc->limit_samples = tmp_u64;
275 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
276
277 /* Check if we have sufficient buffer size */
278 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
279 if (tmp_u64 > devc->buffersize) {
280 sr_warn("Insufficient buffer space has been allocated.");
281 sr_warn("Please use \'echo <size in bytes> > "\
282 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
283 "\' as root to increase the buffer size, this"\
284 " capture is now truncated to %d Msamples",
285 devc->buffersize /
286 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
287 }
288 return beaglelogic_set_triggerflags(devc);
289
bb993797 290 default:
ad9dbc1c 291 return SR_ERR_NA;
bb993797
KA
292 }
293
ad9dbc1c 294 return SR_OK;
bb993797
KA
295}
296
584560f1 297static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
bb993797
KA
298 const struct sr_channel_group *cg)
299{
300 int ret;
ad9dbc1c
KA
301 GVariant *gvar;
302 GVariantBuilder gvb;
bb993797
KA
303
304 (void)sdi;
305 (void)data;
306 (void)cg;
307
308 ret = SR_OK;
309 switch (key) {
138589b0
BV
310 case SR_CONF_SCAN_OPTIONS:
311 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
312 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
313 break;
ad9dbc1c 314 case SR_CONF_DEVICE_OPTIONS:
584560f1 315 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 316 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
ad9dbc1c
KA
317 break;
318 case SR_CONF_SAMPLERATE:
319 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
320 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
321 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
322 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
323 *data = g_variant_builder_end(&gvb);
324 break;
325 case SR_CONF_TRIGGER_MATCH:
584560f1 326 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
ad9dbc1c
KA
327 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
328 sizeof(int32_t));
329 break;
bb993797
KA
330 default:
331 return SR_ERR_NA;
332 }
333
334 return ret;
335}
336
ad9dbc1c
KA
337/* get a sane timeout for poll() */
338#define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
339 (uint32_t)(devc->cur_samplerate)))
340
bb993797
KA
341static int dev_acquisition_start(const struct sr_dev_inst *sdi,
342 void *cb_data)
343{
bb993797 344 (void)cb_data;
ad9dbc1c
KA
345 struct dev_context *devc = sdi->priv;
346 struct sr_trigger *trigger;
bb993797
KA
347
348 if (sdi->status != SR_ST_ACTIVE)
349 return SR_ERR_DEV_CLOSED;
350
ad9dbc1c
KA
351 /* Save user pointer */
352 devc->cb_data = cb_data;
353
354 /* Clear capture state */
355 devc->bytes_read = 0;
356 devc->offset = 0;
357
358 /* Configure channels */
359 devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
360 BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
361 beaglelogic_set_sampleunit(devc);
362
363 /* Configure triggers & send header packet */
364 if ((trigger = sr_session_trigger_get(sdi->session))) {
365 devc->stl = soft_trigger_logic_new(sdi, trigger);
366 devc->trigger_fired = FALSE;
367 } else
368 devc->trigger_fired = TRUE;
369 std_session_send_df_header(cb_data, LOG_PREFIX);
370
371 /* Trigger and add poll on file */
372 beaglelogic_start(devc);
373 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
374 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
375 (void *)sdi);
bb993797
KA
376
377 return SR_OK;
378}
379
380static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
381{
ad9dbc1c
KA
382 struct dev_context *devc = sdi->priv;
383 struct sr_datafeed_packet pkt;
384
bb993797
KA
385 (void)cb_data;
386
387 if (sdi->status != SR_ST_ACTIVE)
388 return SR_ERR_DEV_CLOSED;
389
ad9dbc1c
KA
390 /* Execute a stop on BeagleLogic */
391 beaglelogic_stop(devc);
392
393 /* lseek to offset 0, flushes the cache */
394 lseek(devc->fd, 0, SEEK_SET);
395
396 /* Remove session source and send EOT packet */
397 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
398 pkt.type = SR_DF_END;
399 pkt.payload = NULL;
400 sr_session_send(sdi, &pkt);
bb993797
KA
401
402 return SR_OK;
403}
404
405SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
406 .name = "beaglelogic",
407 .longname = "BeagleLogic",
408 .api_version = 1,
409 .init = init,
410 .cleanup = cleanup,
411 .scan = scan,
412 .dev_list = dev_list,
413 .dev_clear = dev_clear,
414 .config_get = config_get,
415 .config_set = config_set,
416 .config_list = config_list,
417 .dev_open = dev_open,
418 .dev_close = dev_close,
419 .dev_acquisition_start = dev_acquisition_start,
420 .dev_acquisition_stop = dev_acquisition_stop,
421 .priv = NULL,
422};