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 /* 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_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,
139 beaglelogic_channel_names[i]);
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->priv))->instances;
153 static int dev_clear(const struct sr_dev_driver *di)
155 return std_dev_clear(di, NULL);
158 static int dev_open(struct sr_dev_inst *sdi)
160 struct dev_context *devc = sdi->priv;
162 /* Open BeagleLogic */
163 if (beaglelogic_open_nonblock(devc))
166 /* Set fd and local attributes */
167 devc->pollfd.fd = devc->fd;
168 devc->pollfd.events = G_IO_IN;
170 /* Get the default attributes */
171 beaglelogic_get_samplerate(devc);
172 beaglelogic_get_sampleunit(devc);
173 beaglelogic_get_triggerflags(devc);
174 beaglelogic_get_buffersize(devc);
175 beaglelogic_get_bufunitsize(devc);
177 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
178 if (beaglelogic_mmap(devc) != SR_OK) {
179 sr_err("Unable to map capture buffer");
180 beaglelogic_close(devc);
184 /* We're good to go now */
185 sdi->status = SR_ST_ACTIVE;
189 static int dev_close(struct sr_dev_inst *sdi)
191 struct dev_context *devc = sdi->priv;
193 if (sdi->status == SR_ST_ACTIVE) {
194 /* Close the memory mapping and the file */
195 beaglelogic_munmap(devc);
196 beaglelogic_close(devc);
198 sdi->status = SR_ST_INACTIVE;
202 static int cleanup(const struct sr_dev_driver *di)
204 struct drv_context *drvc;
205 struct sr_dev_inst *sdi;
209 if (!(drvc = di->priv))
212 /* Clean up the instances */
213 for (l = drvc->instances; l; l = l->next) {
217 sr_dev_inst_free(sdi);
219 g_slist_free(drvc->instances);
220 drvc->instances = NULL;
225 static int config_get(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;
232 case SR_CONF_LIMIT_SAMPLES:
233 *data = g_variant_new_uint64(devc->limit_samples);
236 case SR_CONF_SAMPLERATE:
237 *data = g_variant_new_uint64(devc->cur_samplerate);
240 case SR_CONF_CAPTURE_RATIO:
241 *data = g_variant_new_uint64(devc->capture_ratio);
244 case SR_CONF_NUM_LOGIC_CHANNELS:
245 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
255 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
256 const struct sr_channel_group *cg)
258 struct dev_context *devc = sdi->priv;
262 if (sdi->status != SR_ST_ACTIVE)
263 return SR_ERR_DEV_CLOSED;
266 case SR_CONF_SAMPLERATE:
267 devc->cur_samplerate = g_variant_get_uint64(data);
268 return beaglelogic_set_samplerate(devc);
270 case SR_CONF_LIMIT_SAMPLES:
271 tmp_u64 = g_variant_get_uint64(data);
272 devc->limit_samples = tmp_u64;
273 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
275 /* Check if we have sufficient buffer size */
276 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
277 if (tmp_u64 > devc->buffersize) {
278 sr_warn("Insufficient buffer space has been allocated.");
279 sr_warn("Please use \'echo <size in bytes> > "\
280 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
281 "\' as root to increase the buffer size, this"\
282 " capture is now truncated to %d Msamples",
284 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
286 return beaglelogic_set_triggerflags(devc);
288 case SR_CONF_CAPTURE_RATIO:
289 devc->capture_ratio = g_variant_get_uint64(data);
290 if (devc->capture_ratio > 100) {
291 devc->capture_ratio = 0;
303 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
304 const struct sr_channel_group *cg)
316 case SR_CONF_SCAN_OPTIONS:
317 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
318 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
320 case SR_CONF_DEVICE_OPTIONS:
321 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
322 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
324 case SR_CONF_SAMPLERATE:
325 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
326 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
327 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
328 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
329 *data = g_variant_builder_end(&gvb);
331 case SR_CONF_TRIGGER_MATCH:
332 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
333 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
343 /* get a sane timeout for poll() */
344 #define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
345 (uint32_t)(devc->cur_samplerate)))
347 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
351 struct dev_context *devc = sdi->priv;
352 struct sr_trigger *trigger;
354 if (sdi->status != SR_ST_ACTIVE)
355 return SR_ERR_DEV_CLOSED;
357 /* Save user pointer */
358 devc->cb_data = cb_data;
360 /* Clear capture state */
361 devc->bytes_read = 0;
364 /* Configure channels */
365 devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
366 BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
367 beaglelogic_set_sampleunit(devc);
369 /* Configure triggers & send header packet */
370 if ((trigger = sr_session_trigger_get(sdi->session))) {
371 int pre_trigger_samples = 0;
372 if (devc->limit_samples > 0)
373 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
374 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
375 if (devc->stl == NULL)
376 return SR_ERR_MALLOC;
377 devc->trigger_fired = FALSE;
379 devc->trigger_fired = TRUE;
380 std_session_send_df_header(cb_data, LOG_PREFIX);
382 /* Trigger and add poll on file */
383 beaglelogic_start(devc);
384 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
385 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
391 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
393 struct dev_context *devc = sdi->priv;
394 struct sr_datafeed_packet pkt;
398 if (sdi->status != SR_ST_ACTIVE)
399 return SR_ERR_DEV_CLOSED;
401 /* Execute a stop on BeagleLogic */
402 beaglelogic_stop(devc);
404 /* lseek to offset 0, flushes the cache */
405 lseek(devc->fd, 0, SEEK_SET);
407 /* Remove session source and send EOT packet */
408 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
409 pkt.type = SR_DF_END;
411 sr_session_send(sdi, &pkt);
416 SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
417 .name = "beaglelogic",
418 .longname = "BeagleLogic",
423 .dev_list = dev_list,
424 .dev_clear = dev_clear,
425 .config_get = config_get,
426 .config_set = config_set,
427 .config_list = config_list,
428 .dev_open = dev_open,
429 .dev_close = dev_close,
430 .dev_acquisition_start = dev_acquisition_start,
431 .dev_acquisition_stop = dev_acquisition_stop,