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