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/>.
22 #include "beaglelogic.h"
24 SR_PRIV struct sr_dev_driver 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_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_GET,
42 /* Trigger matching capabilities */
43 static const int32_t soft_trigger_matches[] = {
51 SR_PRIV const char *channel_names[] = {
52 "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39",
53 "P8_40", "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20",
56 /* Possible sample rates : 10 Hz to 100 MHz = (100 / x) MHz */
57 static const uint64_t samplerates[] = {
63 static int init(struct sr_dev_driver *di, 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 devc = g_malloc0(sizeof(struct dev_context));
74 /* Default non-zero values (if any) */
76 devc->limit_samples = (uint64_t)-1;
81 static GSList *scan(struct sr_dev_driver *di, GSList *options)
83 struct drv_context *drvc;
85 struct sr_config *src;
86 struct sr_dev_inst *sdi;
87 struct dev_context *devc;
92 drvc->instances = NULL;
94 /* Probe for /dev/beaglelogic */
95 if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
98 sdi = g_malloc0(sizeof(struct sr_dev_inst));
99 sdi->status = SR_ST_INACTIVE;
100 sdi->model = g_strdup("BeagleLogic");
101 sdi->version = g_strdup("1.0");
104 /* Unless explicitly specified, keep max channels to 8 only */
106 for (l = options; l; l = l->next) {
108 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
109 maxch = g_variant_get_int32(src->data);
112 /* We need to test for number of channels by opening the node */
113 devc = beaglelogic_devc_alloc();
115 if (beaglelogic_open_nonblock(devc) != SR_OK) {
117 sr_dev_inst_free(sdi);
123 maxch = NUM_CHANNELS;
124 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
127 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
130 beaglelogic_set_sampleunit(devc);
131 beaglelogic_close(devc);
134 sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
136 /* Fill the channels */
137 for (i = 0; i < maxch; i++)
138 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
142 drvc->instances = g_slist_append(drvc->instances, sdi);
143 devices = g_slist_append(devices, sdi);
148 static GSList *dev_list(const struct sr_dev_driver *di)
150 return ((struct drv_context *)(di->context))->instances;
153 static int dev_open(struct sr_dev_inst *sdi)
155 struct dev_context *devc = sdi->priv;
157 /* Open BeagleLogic */
158 if (beaglelogic_open_nonblock(devc))
161 /* Set fd and local attributes */
162 devc->pollfd.fd = devc->fd;
163 devc->pollfd.events = G_IO_IN;
164 devc->pollfd.revents = 0;
166 /* Get the default attributes */
167 beaglelogic_get_samplerate(devc);
168 beaglelogic_get_sampleunit(devc);
169 beaglelogic_get_triggerflags(devc);
170 beaglelogic_get_buffersize(devc);
171 beaglelogic_get_bufunitsize(devc);
173 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
174 if (beaglelogic_mmap(devc) != SR_OK) {
175 sr_err("Unable to map capture buffer");
176 beaglelogic_close(devc);
180 /* We're good to go now */
181 sdi->status = SR_ST_ACTIVE;
185 static int dev_close(struct sr_dev_inst *sdi)
187 struct dev_context *devc = sdi->priv;
189 if (sdi->status == SR_ST_ACTIVE) {
190 /* Close the memory mapping and the file */
191 beaglelogic_munmap(devc);
192 beaglelogic_close(devc);
194 sdi->status = SR_ST_INACTIVE;
198 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
199 const struct sr_channel_group *cg)
201 struct dev_context *devc = sdi->priv;
206 case SR_CONF_LIMIT_SAMPLES:
207 *data = g_variant_new_uint64(devc->limit_samples);
209 case SR_CONF_SAMPLERATE:
210 *data = g_variant_new_uint64(devc->cur_samplerate);
212 case SR_CONF_CAPTURE_RATIO:
213 *data = g_variant_new_uint64(devc->capture_ratio);
215 case SR_CONF_NUM_LOGIC_CHANNELS:
216 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
225 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
226 const struct sr_channel_group *cg)
228 struct dev_context *devc = sdi->priv;
233 if (sdi->status != SR_ST_ACTIVE)
234 return SR_ERR_DEV_CLOSED;
237 case SR_CONF_SAMPLERATE:
238 devc->cur_samplerate = g_variant_get_uint64(data);
239 return beaglelogic_set_samplerate(devc);
240 case SR_CONF_LIMIT_SAMPLES:
241 tmp_u64 = g_variant_get_uint64(data);
242 devc->limit_samples = tmp_u64;
243 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
245 /* Check if we have sufficient buffer size */
246 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
247 if (tmp_u64 > devc->buffersize) {
248 sr_warn("Insufficient buffer space has been allocated.");
249 sr_warn("Please use \'echo <size in bytes> > "\
250 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
251 "\' as root to increase the buffer size, this"\
252 " capture is now truncated to %d Msamples",
254 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
256 return beaglelogic_set_triggerflags(devc);
257 case SR_CONF_CAPTURE_RATIO:
258 devc->capture_ratio = g_variant_get_uint64(data);
259 if (devc->capture_ratio > 100)
269 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
270 const struct sr_channel_group *cg)
281 case SR_CONF_SCAN_OPTIONS:
282 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
283 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
285 case SR_CONF_DEVICE_OPTIONS:
286 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
287 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
289 case SR_CONF_SAMPLERATE:
290 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
291 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
292 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
293 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
294 *data = g_variant_builder_end(&gvb);
296 case SR_CONF_TRIGGER_MATCH:
297 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
298 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
308 /* get a sane timeout for poll() */
309 #define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
310 (uint32_t)(devc->cur_samplerate)))
312 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
314 struct dev_context *devc = sdi->priv;
315 struct sr_trigger *trigger;
317 if (sdi->status != SR_ST_ACTIVE)
318 return SR_ERR_DEV_CLOSED;
320 /* Clear capture state */
321 devc->bytes_read = 0;
324 /* Configure channels */
325 devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
326 BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
327 beaglelogic_set_sampleunit(devc);
329 /* Configure triggers & send header packet */
330 if ((trigger = sr_session_trigger_get(sdi->session))) {
331 int pre_trigger_samples = 0;
332 if (devc->limit_samples > 0)
333 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
334 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
336 return SR_ERR_MALLOC;
337 devc->trigger_fired = FALSE;
339 devc->trigger_fired = TRUE;
340 std_session_send_df_header(sdi, LOG_PREFIX);
342 /* Trigger and add poll on file */
343 beaglelogic_start(devc);
344 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
345 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
351 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
353 struct dev_context *devc = sdi->priv;
355 if (sdi->status != SR_ST_ACTIVE)
356 return SR_ERR_DEV_CLOSED;
358 /* Execute a stop on BeagleLogic */
359 beaglelogic_stop(devc);
361 /* lseek to offset 0, flushes the cache */
362 lseek(devc->fd, 0, SEEK_SET);
364 /* Remove session source and send EOT packet */
365 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
366 std_session_send_df_end(sdi, LOG_PREFIX);
371 SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
372 .name = "beaglelogic",
373 .longname = "BeagleLogic",
376 .cleanup = std_cleanup,
378 .dev_list = dev_list,
379 .config_get = config_get,
380 .config_set = config_set,
381 .config_list = config_list,
382 .dev_open = dev_open,
383 .dev_close = dev_close,
384 .dev_acquisition_start = dev_acquisition_start,
385 .dev_acquisition_stop = dev_acquisition_stop,