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