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