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