]> sigrok.org Git - libsigrok.git/blame - src/hardware/beaglelogic/api.c
beaglelogic: Re-organize to prepare for TCP support
[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
24static const uint32_t scanopts[] = {
25 SR_CONF_NUM_LOGIC_CHANNELS,
26};
27
05199c0a
UH
28static const uint32_t drvopts[] = {
29 SR_CONF_LOGIC_ANALYZER,
30};
31
f254bc4b 32static const uint32_t devopts[] = {
ad9dbc1c 33 SR_CONF_CONTINUOUS,
5827f61b
BV
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
35 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
e743a47d 37 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
5827f61b 38 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_GET,
ad9dbc1c
KA
39};
40
76d10d13 41static const int32_t trigger_matches[] = {
ad9dbc1c
KA
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
6eab3021 86 maxch = NUM_CHANNELS;
ad9dbc1c
KA
87 for (l = options; l; l = l->next) {
88 src = l->data;
89 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
90 maxch = g_variant_get_int32(src->data);
91 }
92
6eab3021 93 if (maxch > 8)
ad9dbc1c 94 maxch = NUM_CHANNELS;
6eab3021 95 else
ad9dbc1c 96 maxch = 8;
ad9dbc1c 97
6eab3021
KA
98 sdi = g_new0(struct sr_dev_inst, 1);
99 sdi->status = SR_ST_INACTIVE;
100 sdi->model = g_strdup("BeagleLogic");
101 sdi->version = g_strdup("1.0");
ad9dbc1c 102
6eab3021 103 devc = beaglelogic_devc_alloc();
ad9dbc1c 104
0bca2e75
KA
105 devc->beaglelogic = &beaglelogic_native_ops;
106
107 /* Fill the channels */
5e23fcab
ML
108 for (i = 0; i < maxch; i++)
109 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
0f34cb47 110 channel_names[i]);
ad9dbc1c
KA
111
112 sdi->priv = devc;
bb993797 113
6eab3021
KA
114 /* Signal */
115 sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
116
43376f33 117 return std_scan_complete(di, g_slist_append(NULL, sdi));
bb993797
KA
118}
119
bb993797
KA
120static int dev_open(struct sr_dev_inst *sdi)
121{
ad9dbc1c
KA
122 struct dev_context *devc = sdi->priv;
123
124 /* Open BeagleLogic */
0bca2e75 125 if (devc->beaglelogic->open(devc))
ad9dbc1c
KA
126 return SR_ERR;
127
128 /* Set fd and local attributes */
129 devc->pollfd.fd = devc->fd;
130 devc->pollfd.events = G_IO_IN;
89efe064 131 devc->pollfd.revents = 0;
ad9dbc1c
KA
132
133 /* Get the default attributes */
0bca2e75
KA
134 devc->beaglelogic->get_samplerate(devc);
135 devc->beaglelogic->get_sampleunit(devc);
136 devc->beaglelogic->get_buffersize(devc);
137 devc->beaglelogic->get_bufunitsize(devc);
ad9dbc1c 138
713f3f84
KA
139 /* Set the triggerflags to default for continuous capture unless we
140 * explicitly limit samples using SR_CONF_LIMIT_SAMPLES */
141 devc->triggerflags = BL_TRIGGERFLAGS_CONTINUOUS;
0bca2e75 142 devc->beaglelogic->set_triggerflags(devc);
713f3f84 143
ad9dbc1c 144 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
0bca2e75 145 if (devc->beaglelogic->mmap(devc) != SR_OK) {
ad9dbc1c 146 sr_err("Unable to map capture buffer");
0bca2e75 147 devc->beaglelogic->close(devc);
ad9dbc1c
KA
148 return SR_ERR;
149 }
bb993797 150
bb993797
KA
151 return SR_OK;
152}
153
154static int dev_close(struct sr_dev_inst *sdi)
155{
ad9dbc1c 156 struct dev_context *devc = sdi->priv;
bb993797 157
093e1cba 158 /* Close the memory mapping and the file */
0bca2e75
KA
159 devc->beaglelogic->munmap(devc);
160 devc->beaglelogic->close(devc);
093e1cba 161
bb993797
KA
162 return SR_OK;
163}
164
dd7a72ea
UH
165static int config_get(uint32_t key, GVariant **data,
166 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
bb993797 167{
ad9dbc1c 168 struct dev_context *devc = sdi->priv;
dcd438ee 169
bb993797
KA
170 (void)cg;
171
bb993797 172 switch (key) {
ad9dbc1c
KA
173 case SR_CONF_LIMIT_SAMPLES:
174 *data = g_variant_new_uint64(devc->limit_samples);
175 break;
ad9dbc1c
KA
176 case SR_CONF_SAMPLERATE:
177 *data = g_variant_new_uint64(devc->cur_samplerate);
178 break;
e743a47d
AJ
179 case SR_CONF_CAPTURE_RATIO:
180 *data = g_variant_new_uint64(devc->capture_ratio);
181 break;
ad9dbc1c
KA
182 case SR_CONF_NUM_LOGIC_CHANNELS:
183 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
184 break;
bb993797
KA
185 default:
186 return SR_ERR_NA;
187 }
188
ad9dbc1c 189 return SR_OK;
bb993797
KA
190}
191
dd7a72ea
UH
192static int config_set(uint32_t key, GVariant *data,
193 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
bb993797 194{
ad9dbc1c
KA
195 struct dev_context *devc = sdi->priv;
196 uint64_t tmp_u64;
dcd438ee 197
bb993797
KA
198 (void)cg;
199
bb993797 200 switch (key) {
ad9dbc1c
KA
201 case SR_CONF_SAMPLERATE:
202 devc->cur_samplerate = g_variant_get_uint64(data);
0bca2e75 203 return devc->beaglelogic->set_samplerate(devc);
ad9dbc1c
KA
204 case SR_CONF_LIMIT_SAMPLES:
205 tmp_u64 = g_variant_get_uint64(data);
206 devc->limit_samples = tmp_u64;
207 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
208
209 /* Check if we have sufficient buffer size */
210 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
211 if (tmp_u64 > devc->buffersize) {
212 sr_warn("Insufficient buffer space has been allocated.");
213 sr_warn("Please use \'echo <size in bytes> > "\
214 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
55f26c42 215 "\' to increase the buffer size, this"\
ad9dbc1c
KA
216 " capture is now truncated to %d Msamples",
217 devc->buffersize /
218 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
219 }
0bca2e75 220 return devc->beaglelogic->set_triggerflags(devc);
e743a47d
AJ
221 case SR_CONF_CAPTURE_RATIO:
222 devc->capture_ratio = g_variant_get_uint64(data);
efad7ccc 223 break;
bb993797 224 default:
ad9dbc1c 225 return SR_ERR_NA;
bb993797
KA
226 }
227
ad9dbc1c 228 return SR_OK;
bb993797
KA
229}
230
dd7a72ea
UH
231static int config_list(uint32_t key, GVariant **data,
232 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
bb993797 233{
bb993797 234 switch (key) {
138589b0 235 case SR_CONF_SCAN_OPTIONS:
ad9dbc1c 236 case SR_CONF_DEVICE_OPTIONS:
05199c0a 237 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
ad9dbc1c 238 case SR_CONF_SAMPLERATE:
53012da6 239 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
ad9dbc1c
KA
240 break;
241 case SR_CONF_TRIGGER_MATCH:
76d10d13 242 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
ad9dbc1c 243 break;
bb993797
KA
244 default:
245 return SR_ERR_NA;
246 }
247
a9010323 248 return SR_OK;
bb993797
KA
249}
250
ad9dbc1c
KA
251/* get a sane timeout for poll() */
252#define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
253 (uint32_t)(devc->cur_samplerate)))
254
695dc859 255static int dev_acquisition_start(const struct sr_dev_inst *sdi)
bb993797 256{
ad9dbc1c 257 struct dev_context *devc = sdi->priv;
e71062d9 258 GSList *l;
ad9dbc1c 259 struct sr_trigger *trigger;
e71062d9 260 struct sr_channel *channel;
bb993797 261
ad9dbc1c
KA
262 /* Clear capture state */
263 devc->bytes_read = 0;
264 devc->offset = 0;
265
266 /* Configure channels */
e71062d9
KA
267 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
268
269 for (l = sdi->channels; l; l = l->next) {
270 channel = l->data;
271 if (channel->index >= 8 && channel->enabled)
272 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
273 }
0bca2e75 274 devc->beaglelogic->set_sampleunit(devc);
ad9dbc1c
KA
275
276 /* Configure triggers & send header packet */
277 if ((trigger = sr_session_trigger_get(sdi->session))) {
e743a47d
AJ
278 int pre_trigger_samples = 0;
279 if (devc->limit_samples > 0)
efad7ccc 280 pre_trigger_samples = (devc->capture_ratio * devc->limit_samples) / 100;
e743a47d 281 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
98fec29e 282 if (!devc->stl)
e743a47d 283 return SR_ERR_MALLOC;
ad9dbc1c
KA
284 devc->trigger_fired = FALSE;
285 } else
286 devc->trigger_fired = TRUE;
bee2b016 287 std_session_send_df_header(sdi);
ad9dbc1c
KA
288
289 /* Trigger and add poll on file */
0bca2e75 290 devc->beaglelogic->start(devc);
ad9dbc1c
KA
291 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
292 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
293 (void *)sdi);
bb993797
KA
294
295 return SR_OK;
296}
297
695dc859 298static int dev_acquisition_stop(struct sr_dev_inst *sdi)
bb993797 299{
ad9dbc1c 300 struct dev_context *devc = sdi->priv;
ad9dbc1c 301
ad9dbc1c 302 /* Execute a stop on BeagleLogic */
0bca2e75 303 devc->beaglelogic->stop(devc);
ad9dbc1c
KA
304
305 /* lseek to offset 0, flushes the cache */
306 lseek(devc->fd, 0, SEEK_SET);
307
308 /* Remove session source and send EOT packet */
309 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
bee2b016 310 std_session_send_df_end(sdi);
bb993797
KA
311
312 return SR_OK;
313}
314
dd5c48a6 315static struct sr_dev_driver beaglelogic_driver_info = {
bb993797
KA
316 .name = "beaglelogic",
317 .longname = "BeagleLogic",
318 .api_version = 1,
c2fdcc25 319 .init = std_init,
700d6b64 320 .cleanup = std_cleanup,
bb993797 321 .scan = scan,
c01bf34c 322 .dev_list = std_dev_list,
f778bf02 323 .dev_clear = std_dev_clear,
bb993797
KA
324 .config_get = config_get,
325 .config_set = config_set,
326 .config_list = config_list,
327 .dev_open = dev_open,
328 .dev_close = dev_close,
329 .dev_acquisition_start = dev_acquisition_start,
330 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 331 .context = NULL,
bb993797 332};
dd5c48a6 333SR_REGISTER_DEV_DRIVER(beaglelogic_driver_info);