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