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