2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Kumar Abhishek <abhishek@theembeddedkitchen.net>
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.
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.
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/>.
21 #include "beaglelogic.h"
23 SR_PRIV struct sr_dev_driver beaglelogic_driver_info;
24 static struct sr_dev_driver *di = &beaglelogic_driver_info;
27 static const uint32_t scanopts[] = {
28 SR_CONF_NUM_LOGIC_CHANNELS,
31 /* Hardware capabilities */
32 static const uint32_t devopts[] = {
33 SR_CONF_LOGIC_ANALYZER,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
38 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_GET,
41 /* Trigger matching capabilities */
42 static const int32_t soft_trigger_matches[] = {
50 /* Channels are numbered 0-13 */
51 SR_PRIV const char *beaglelogic_channel_names[NUM_CHANNELS + 1] = {
52 "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39", "P8_40",
53 "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20", NULL,
56 /* Possible sample rates : 10 Hz to 100 MHz = (100 / x) MHz */
57 static const uint64_t samplerates[] = {
63 static int init(struct sr_context *sr_ctx)
65 return std_init(sr_ctx, di, LOG_PREFIX);
68 static struct dev_context * beaglelogic_devc_alloc(void)
70 struct dev_context *devc;
72 /* Allocate zeroed structure */
73 devc = g_try_malloc0(sizeof(*devc));
75 /* Default non-zero values (if any) */
77 devc->limit_samples = (uint64_t)-1;
82 static GSList *scan(GSList *options)
84 struct drv_context *drvc;
86 struct sr_config *src;
87 struct sr_dev_inst *sdi;
88 struct dev_context *devc;
89 struct sr_channel *ch;
94 drvc->instances = NULL;
96 /* Probe for /dev/beaglelogic */
97 if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
100 sdi = sr_dev_inst_new();
101 sdi->status = SR_ST_INACTIVE;
102 sdi->model = g_strdup("BeagleLogic");
103 sdi->version = g_strdup("1.0");
106 /* Unless explicitly specified, keep max channels to 8 only */
108 for (l = options; l; l = l->next) {
110 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
111 maxch = g_variant_get_int32(src->data);
114 /* We need to test for number of channels by opening the node */
115 devc = beaglelogic_devc_alloc();
117 if (beaglelogic_open_nonblock(devc) != SR_OK) {
119 sr_dev_inst_free(sdi);
125 maxch = NUM_CHANNELS;
126 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
129 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
132 beaglelogic_set_sampleunit(devc);
133 beaglelogic_close(devc);
136 sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
138 /* Fill the channels */
139 for (i = 0; i < maxch; i++) {
140 if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
141 beaglelogic_channel_names[i])))
143 sdi->channels = g_slist_append(sdi->channels, ch);
147 drvc->instances = g_slist_append(drvc->instances, sdi);
148 devices = g_slist_append(devices, sdi);
153 static GSList *dev_list(void)
155 return ((struct drv_context *)(di->priv))->instances;
158 static int dev_clear(void)
160 return std_dev_clear(di, NULL);
163 static int dev_open(struct sr_dev_inst *sdi)
165 struct dev_context *devc = sdi->priv;
167 /* Open BeagleLogic */
168 if (beaglelogic_open_nonblock(devc))
171 /* Set fd and local attributes */
172 devc->pollfd.fd = devc->fd;
173 devc->pollfd.events = G_IO_IN;
175 /* Get the default attributes */
176 beaglelogic_get_samplerate(devc);
177 beaglelogic_get_sampleunit(devc);
178 beaglelogic_get_triggerflags(devc);
179 beaglelogic_get_buffersize(devc);
180 beaglelogic_get_bufunitsize(devc);
182 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
183 if (beaglelogic_mmap(devc) != SR_OK) {
184 sr_err("Unable to map capture buffer");
185 beaglelogic_close(devc);
189 /* We're good to go now */
190 sdi->status = SR_ST_ACTIVE;
194 static int dev_close(struct sr_dev_inst *sdi)
196 struct dev_context *devc = sdi->priv;
198 if (sdi->status == SR_ST_ACTIVE) {
199 /* Close the memory mapping and the file */
200 beaglelogic_munmap(devc);
201 beaglelogic_close(devc);
203 sdi->status = SR_ST_INACTIVE;
207 static int cleanup(void)
209 struct drv_context *drvc;
210 struct sr_dev_inst *sdi;
214 if (!(drvc = di->priv))
217 /* Clean up the instances */
218 for (l = drvc->instances; l; l = l->next) {
222 sr_dev_inst_free(sdi);
224 g_slist_free(drvc->instances);
225 drvc->instances = NULL;
232 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
233 const struct sr_channel_group *cg)
235 struct dev_context *devc = sdi->priv;
239 case SR_CONF_LIMIT_SAMPLES:
240 *data = g_variant_new_uint64(devc->limit_samples);
243 case SR_CONF_SAMPLERATE:
244 *data = g_variant_new_uint64(devc->cur_samplerate);
247 case SR_CONF_NUM_LOGIC_CHANNELS:
248 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
258 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
259 const struct sr_channel_group *cg)
261 struct dev_context *devc = sdi->priv;
265 if (sdi->status != SR_ST_ACTIVE)
266 return SR_ERR_DEV_CLOSED;
269 case SR_CONF_SAMPLERATE:
270 devc->cur_samplerate = g_variant_get_uint64(data);
271 return beaglelogic_set_samplerate(devc);
273 case SR_CONF_LIMIT_SAMPLES:
274 tmp_u64 = g_variant_get_uint64(data);
275 devc->limit_samples = tmp_u64;
276 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
278 /* Check if we have sufficient buffer size */
279 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
280 if (tmp_u64 > devc->buffersize) {
281 sr_warn("Insufficient buffer space has been allocated.");
282 sr_warn("Please use \'echo <size in bytes> > "\
283 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
284 "\' as root to increase the buffer size, this"\
285 " capture is now truncated to %d Msamples",
287 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
289 return beaglelogic_set_triggerflags(devc);
298 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
299 const struct sr_channel_group *cg)
311 case SR_CONF_SCAN_OPTIONS:
312 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
313 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
315 case SR_CONF_DEVICE_OPTIONS:
316 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
317 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
319 case SR_CONF_SAMPLERATE:
320 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
321 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
322 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
323 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
324 *data = g_variant_builder_end(&gvb);
326 case SR_CONF_TRIGGER_MATCH:
327 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
328 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
338 /* get a sane timeout for poll() */
339 #define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
340 (uint32_t)(devc->cur_samplerate)))
342 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
346 struct dev_context *devc = sdi->priv;
347 struct sr_trigger *trigger;
349 if (sdi->status != SR_ST_ACTIVE)
350 return SR_ERR_DEV_CLOSED;
352 /* Save user pointer */
353 devc->cb_data = cb_data;
355 /* Clear capture state */
356 devc->bytes_read = 0;
359 /* Configure channels */
360 devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
361 BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
362 beaglelogic_set_sampleunit(devc);
364 /* Configure triggers & send header packet */
365 if ((trigger = sr_session_trigger_get(sdi->session))) {
366 devc->stl = soft_trigger_logic_new(sdi, trigger);
367 devc->trigger_fired = FALSE;
369 devc->trigger_fired = TRUE;
370 std_session_send_df_header(cb_data, LOG_PREFIX);
372 /* Trigger and add poll on file */
373 beaglelogic_start(devc);
374 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
375 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
381 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
383 struct dev_context *devc = sdi->priv;
384 struct sr_datafeed_packet pkt;
388 if (sdi->status != SR_ST_ACTIVE)
389 return SR_ERR_DEV_CLOSED;
391 /* Execute a stop on BeagleLogic */
392 beaglelogic_stop(devc);
394 /* lseek to offset 0, flushes the cache */
395 lseek(devc->fd, 0, SEEK_SET);
397 /* Remove session source and send EOT packet */
398 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
399 pkt.type = SR_DF_END;
401 sr_session_send(sdi, &pkt);
406 SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
407 .name = "beaglelogic",
408 .longname = "BeagleLogic",
413 .dev_list = dev_list,
414 .dev_clear = dev_clear,
415 .config_get = config_get,
416 .config_set = config_set,
417 .config_list = config_list,
418 .dev_open = dev_open,
419 .dev_close = dev_close,
420 .dev_acquisition_start = dev_acquisition_start,
421 .dev_acquisition_stop = dev_acquisition_stop,