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;
26 static const uint32_t scanopts[] = {
27 SR_CONF_NUM_LOGIC_CHANNELS,
30 /* Hardware capabilities */
31 static const uint32_t devopts[] = {
32 SR_CONF_LOGIC_ANALYZER,
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
35 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
37 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_GET,
41 /* Trigger matching capabilities */
42 static const int32_t soft_trigger_matches[] = {
50 SR_PRIV const char *channel_names[] = {
51 "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39",
52 "P8_40", "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20",
55 /* Possible sample rates : 10 Hz to 100 MHz = (100 / x) MHz */
56 static const uint64_t samplerates[] = {
62 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
64 return std_init(sr_ctx, di, LOG_PREFIX);
67 static struct dev_context *beaglelogic_devc_alloc(void)
69 struct dev_context *devc;
71 devc = g_malloc0(sizeof(struct dev_context));
73 /* Default non-zero values (if any) */
75 devc->limit_samples = (uint64_t)-1;
80 static GSList *scan(struct sr_dev_driver *di, GSList *options)
82 struct drv_context *drvc;
84 struct sr_config *src;
85 struct sr_dev_inst *sdi;
86 struct dev_context *devc;
91 drvc->instances = NULL;
93 /* Probe for /dev/beaglelogic */
94 if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
97 sdi = g_malloc0(sizeof(struct sr_dev_inst));
98 sdi->status = SR_ST_INACTIVE;
99 sdi->model = g_strdup("BeagleLogic");
100 sdi->version = g_strdup("1.0");
103 /* Unless explicitly specified, keep max channels to 8 only */
105 for (l = options; l; l = l->next) {
107 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
108 maxch = g_variant_get_int32(src->data);
111 /* We need to test for number of channels by opening the node */
112 devc = beaglelogic_devc_alloc();
114 if (beaglelogic_open_nonblock(devc) != SR_OK) {
116 sr_dev_inst_free(sdi);
122 maxch = NUM_CHANNELS;
123 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
126 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
129 beaglelogic_set_sampleunit(devc);
130 beaglelogic_close(devc);
133 sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
135 /* Fill the channels */
136 for (i = 0; i < maxch; i++)
137 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
141 drvc->instances = g_slist_append(drvc->instances, sdi);
142 devices = g_slist_append(devices, sdi);
147 static GSList *dev_list(const struct sr_dev_driver *di)
149 return ((struct drv_context *)(di->context))->instances;
152 static int dev_clear(const struct sr_dev_driver *di)
154 return std_dev_clear(di, NULL);
157 static int dev_open(struct sr_dev_inst *sdi)
159 struct dev_context *devc = sdi->priv;
161 /* Open BeagleLogic */
162 if (beaglelogic_open_nonblock(devc))
165 /* Set fd and local attributes */
166 devc->pollfd.fd = devc->fd;
167 devc->pollfd.events = G_IO_IN;
169 /* Get the default attributes */
170 beaglelogic_get_samplerate(devc);
171 beaglelogic_get_sampleunit(devc);
172 beaglelogic_get_triggerflags(devc);
173 beaglelogic_get_buffersize(devc);
174 beaglelogic_get_bufunitsize(devc);
176 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
177 if (beaglelogic_mmap(devc) != SR_OK) {
178 sr_err("Unable to map capture buffer");
179 beaglelogic_close(devc);
183 /* We're good to go now */
184 sdi->status = SR_ST_ACTIVE;
188 static int dev_close(struct sr_dev_inst *sdi)
190 struct dev_context *devc = sdi->priv;
192 if (sdi->status == SR_ST_ACTIVE) {
193 /* Close the memory mapping and the file */
194 beaglelogic_munmap(devc);
195 beaglelogic_close(devc);
197 sdi->status = SR_ST_INACTIVE;
201 static int cleanup(const struct sr_dev_driver *di)
203 struct drv_context *drvc;
204 struct sr_dev_inst *sdi;
208 if (!(drvc = di->context))
211 /* Clean up the instances */
212 for (l = drvc->instances; l; l = l->next) {
216 sr_dev_inst_free(sdi);
218 g_slist_free(drvc->instances);
219 drvc->instances = NULL;
224 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
225 const struct sr_channel_group *cg)
227 struct dev_context *devc = sdi->priv;
232 case SR_CONF_LIMIT_SAMPLES:
233 *data = g_variant_new_uint64(devc->limit_samples);
235 case SR_CONF_SAMPLERATE:
236 *data = g_variant_new_uint64(devc->cur_samplerate);
238 case SR_CONF_CAPTURE_RATIO:
239 *data = g_variant_new_uint64(devc->capture_ratio);
241 case SR_CONF_NUM_LOGIC_CHANNELS:
242 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
251 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
252 const struct sr_channel_group *cg)
254 struct dev_context *devc = sdi->priv;
259 if (sdi->status != SR_ST_ACTIVE)
260 return SR_ERR_DEV_CLOSED;
263 case SR_CONF_SAMPLERATE:
264 devc->cur_samplerate = g_variant_get_uint64(data);
265 return beaglelogic_set_samplerate(devc);
266 case SR_CONF_LIMIT_SAMPLES:
267 tmp_u64 = g_variant_get_uint64(data);
268 devc->limit_samples = tmp_u64;
269 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
271 /* Check if we have sufficient buffer size */
272 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
273 if (tmp_u64 > devc->buffersize) {
274 sr_warn("Insufficient buffer space has been allocated.");
275 sr_warn("Please use \'echo <size in bytes> > "\
276 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
277 "\' as root to increase the buffer size, this"\
278 " capture is now truncated to %d Msamples",
280 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
282 return beaglelogic_set_triggerflags(devc);
283 case SR_CONF_CAPTURE_RATIO:
284 devc->capture_ratio = g_variant_get_uint64(data);
285 if (devc->capture_ratio > 100) {
286 devc->capture_ratio = 0;
297 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
298 const struct sr_channel_group *cg)
309 case SR_CONF_SCAN_OPTIONS:
310 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
311 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
313 case SR_CONF_DEVICE_OPTIONS:
314 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
315 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
317 case SR_CONF_SAMPLERATE:
318 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
319 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
320 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
321 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
322 *data = g_variant_builder_end(&gvb);
324 case SR_CONF_TRIGGER_MATCH:
325 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
326 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
336 /* get a sane timeout for poll() */
337 #define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
338 (uint32_t)(devc->cur_samplerate)))
340 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
344 struct dev_context *devc = sdi->priv;
345 struct sr_trigger *trigger;
347 if (sdi->status != SR_ST_ACTIVE)
348 return SR_ERR_DEV_CLOSED;
350 /* Save user pointer */
351 devc->cb_data = cb_data;
353 /* Clear capture state */
354 devc->bytes_read = 0;
357 /* Configure channels */
358 devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
359 BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
360 beaglelogic_set_sampleunit(devc);
362 /* Configure triggers & send header packet */
363 if ((trigger = sr_session_trigger_get(sdi->session))) {
364 int pre_trigger_samples = 0;
365 if (devc->limit_samples > 0)
366 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
367 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
369 return SR_ERR_MALLOC;
370 devc->trigger_fired = FALSE;
372 devc->trigger_fired = TRUE;
373 std_session_send_df_header(cb_data, LOG_PREFIX);
375 /* Trigger and add poll on file */
376 beaglelogic_start(devc);
377 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
378 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
384 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
386 struct dev_context *devc = sdi->priv;
387 struct sr_datafeed_packet pkt;
391 if (sdi->status != SR_ST_ACTIVE)
392 return SR_ERR_DEV_CLOSED;
394 /* Execute a stop on BeagleLogic */
395 beaglelogic_stop(devc);
397 /* lseek to offset 0, flushes the cache */
398 lseek(devc->fd, 0, SEEK_SET);
400 /* Remove session source and send EOT packet */
401 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
402 pkt.type = SR_DF_END;
404 sr_session_send(sdi, &pkt);
409 SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
410 .name = "beaglelogic",
411 .longname = "BeagleLogic",
416 .dev_list = dev_list,
417 .dev_clear = dev_clear,
418 .config_get = config_get,
419 .config_set = config_set,
420 .config_list = config_list,
421 .dev_open = dev_open,
422 .dev_close = dev_close,
423 .dev_acquisition_start = dev_acquisition_start,
424 .dev_acquisition_stop = dev_acquisition_stop,