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