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