]> sigrok.org Git - libsigrok.git/blame - src/hardware/beaglelogic/api.c
beaglelogic: Implement TCP protocol
[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 24static const uint32_t scanopts[] = {
9b2b3ef9 25 SR_CONF_CONN,
138589b0
BV
26 SR_CONF_NUM_LOGIC_CHANNELS,
27};
28
05199c0a
UH
29static const uint32_t drvopts[] = {
30 SR_CONF_LOGIC_ANALYZER,
31};
32
f254bc4b 33static const uint32_t devopts[] = {
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
76d10d13 42static const int32_t trigger_matches[] = {
ad9dbc1c
KA
43 SR_TRIGGER_ZERO,
44 SR_TRIGGER_ONE,
45 SR_TRIGGER_RISING,
46 SR_TRIGGER_FALLING,
47 SR_TRIGGER_EDGE,
48};
49
0f34cb47
UH
50SR_PRIV const char *channel_names[] = {
51 "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39",
52 "P8_40", "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20",
ad9dbc1c
KA
53};
54
55/* Possible sample rates : 10 Hz to 100 MHz = (100 / x) MHz */
56static const uint64_t samplerates[] = {
138589b0
BV
57 SR_HZ(10),
58 SR_MHZ(100),
59 SR_HZ(1),
ad9dbc1c
KA
60};
61
f57d8ffe 62static struct dev_context *beaglelogic_devc_alloc(void)
ad9dbc1c
KA
63{
64 struct dev_context *devc;
65
f57d8ffe 66 devc = g_malloc0(sizeof(struct dev_context));
ad9dbc1c
KA
67
68 /* Default non-zero values (if any) */
69 devc->fd = -1;
70 devc->limit_samples = (uint64_t)-1;
9b2b3ef9 71 devc->tcp_buffer = 0;
ad9dbc1c
KA
72
73 return devc;
74}
75
4f840ce9 76static GSList *scan(struct sr_dev_driver *di, GSList *options)
bb993797 77{
43376f33 78 GSList *l;
ad9dbc1c
KA
79 struct sr_config *src;
80 struct sr_dev_inst *sdi;
81 struct dev_context *devc;
9b2b3ef9
KA
82 const char *conn = NULL;
83 gchar **params;
ad9dbc1c 84 int i, maxch;
bb993797 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);
9b2b3ef9
KA
91 if (src->key == SR_CONF_CONN)
92 conn = g_variant_get_string(src->data, NULL);
93 }
94
95 /* Probe for /dev/beaglelogic if not connecting via TCP */
96 if (conn == NULL) {
97 if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
98 return NULL;
99 } else {
100 params = g_strsplit(conn, "/", 0);
101 if (!params || !params[1] || !params[2]) {
102 sr_err("Invalid Parameters.");
103 g_strfreev(params);
104 return NULL;
105 }
106 if (g_ascii_strncasecmp(params[0], "tcp", 3)) {
107 sr_err("Only TCP (tcp-raw) protocol is currently supported.");
108 g_strfreev(params);
109 return NULL;
110 }
ad9dbc1c
KA
111 }
112
6eab3021 113 if (maxch > 8)
ad9dbc1c 114 maxch = NUM_CHANNELS;
6eab3021 115 else
ad9dbc1c 116 maxch = 8;
ad9dbc1c 117
6eab3021
KA
118 sdi = g_new0(struct sr_dev_inst, 1);
119 sdi->status = SR_ST_INACTIVE;
120 sdi->model = g_strdup("BeagleLogic");
121 sdi->version = g_strdup("1.0");
ad9dbc1c 122
6eab3021 123 devc = beaglelogic_devc_alloc();
ad9dbc1c 124
9b2b3ef9
KA
125 if (conn == NULL) {
126 devc->beaglelogic = &beaglelogic_native_ops;
127 sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
128 } else {
129 devc->read_timeout = 1000 * 1000;
130 devc->beaglelogic = &beaglelogic_tcp_ops;
131 devc->address = g_strdup(params[1]);
132 devc->port = g_strdup(params[2]);
133 g_strfreev(params);
134
135 if (devc->beaglelogic->open(devc) != SR_OK)
136 goto err_free;
137 if (beaglelogic_tcp_detect(devc) != SR_OK)
138 goto err_free;
139 sr_info("BeagleLogic device found at %s : %s",
140 devc->address, devc->port);
141 }
0bca2e75 142 /* Fill the channels */
5e23fcab
ML
143 for (i = 0; i < maxch; i++)
144 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
0f34cb47 145 channel_names[i]);
ad9dbc1c
KA
146
147 sdi->priv = devc;
bb993797 148
43376f33 149 return std_scan_complete(di, g_slist_append(NULL, sdi));
9b2b3ef9
KA
150err_free:
151 g_free(sdi->model);
152 g_free(sdi->version);
153 g_free(devc);
154 g_free(sdi);
155
156 return NULL;
bb993797
KA
157}
158
bb993797
KA
159static int dev_open(struct sr_dev_inst *sdi)
160{
ad9dbc1c
KA
161 struct dev_context *devc = sdi->priv;
162
163 /* Open BeagleLogic */
9b2b3ef9
KA
164 if (devc->beaglelogic == &beaglelogic_native_ops)
165 if (devc->beaglelogic->open(devc))
166 return SR_ERR;
ad9dbc1c
KA
167
168 /* Set fd and local attributes */
9b2b3ef9
KA
169 if (devc->beaglelogic == &beaglelogic_tcp_ops)
170 devc->pollfd.fd = devc->socket;
171 else
172 devc->pollfd.fd = devc->fd;
ad9dbc1c 173 devc->pollfd.events = G_IO_IN;
89efe064 174 devc->pollfd.revents = 0;
ad9dbc1c
KA
175
176 /* Get the default attributes */
0bca2e75
KA
177 devc->beaglelogic->get_samplerate(devc);
178 devc->beaglelogic->get_sampleunit(devc);
179 devc->beaglelogic->get_buffersize(devc);
180 devc->beaglelogic->get_bufunitsize(devc);
ad9dbc1c 181
713f3f84
KA
182 /* Set the triggerflags to default for continuous capture unless we
183 * explicitly limit samples using SR_CONF_LIMIT_SAMPLES */
184 devc->triggerflags = BL_TRIGGERFLAGS_CONTINUOUS;
0bca2e75 185 devc->beaglelogic->set_triggerflags(devc);
713f3f84 186
ad9dbc1c 187 /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
9b2b3ef9
KA
188 if (devc->beaglelogic == &beaglelogic_native_ops) {
189 if (devc->beaglelogic->mmap(devc) != SR_OK) {
190 sr_err("Unable to map capture buffer");
191 devc->beaglelogic->close(devc);
192 return SR_ERR;
193 }
194 } else {
195 devc->tcp_buffer = g_malloc(TCP_BUFFER_SIZE);
ad9dbc1c 196 }
bb993797 197
bb993797
KA
198 return SR_OK;
199}
200
201static int dev_close(struct sr_dev_inst *sdi)
202{
ad9dbc1c 203 struct dev_context *devc = sdi->priv;
bb993797 204
093e1cba 205 /* Close the memory mapping and the file */
9b2b3ef9
KA
206 if (devc->beaglelogic == &beaglelogic_native_ops)
207 devc->beaglelogic->munmap(devc);
0bca2e75 208 devc->beaglelogic->close(devc);
093e1cba 209
9b2b3ef9
KA
210 if (devc->tcp_buffer)
211 g_free(devc->tcp_buffer);
212
bb993797
KA
213 return SR_OK;
214}
215
dd7a72ea
UH
216static int config_get(uint32_t key, GVariant **data,
217 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
bb993797 218{
ad9dbc1c 219 struct dev_context *devc = sdi->priv;
dcd438ee 220
bb993797
KA
221 (void)cg;
222
bb993797 223 switch (key) {
ad9dbc1c
KA
224 case SR_CONF_LIMIT_SAMPLES:
225 *data = g_variant_new_uint64(devc->limit_samples);
226 break;
ad9dbc1c
KA
227 case SR_CONF_SAMPLERATE:
228 *data = g_variant_new_uint64(devc->cur_samplerate);
229 break;
e743a47d
AJ
230 case SR_CONF_CAPTURE_RATIO:
231 *data = g_variant_new_uint64(devc->capture_ratio);
232 break;
ad9dbc1c
KA
233 case SR_CONF_NUM_LOGIC_CHANNELS:
234 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
235 break;
bb993797
KA
236 default:
237 return SR_ERR_NA;
238 }
239
ad9dbc1c 240 return SR_OK;
bb993797
KA
241}
242
dd7a72ea
UH
243static int config_set(uint32_t key, GVariant *data,
244 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
bb993797 245{
ad9dbc1c
KA
246 struct dev_context *devc = sdi->priv;
247 uint64_t tmp_u64;
dcd438ee 248
bb993797
KA
249 (void)cg;
250
bb993797 251 switch (key) {
ad9dbc1c
KA
252 case SR_CONF_SAMPLERATE:
253 devc->cur_samplerate = g_variant_get_uint64(data);
0bca2e75 254 return devc->beaglelogic->set_samplerate(devc);
ad9dbc1c
KA
255 case SR_CONF_LIMIT_SAMPLES:
256 tmp_u64 = g_variant_get_uint64(data);
257 devc->limit_samples = tmp_u64;
258 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
259
260 /* Check if we have sufficient buffer size */
261 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
262 if (tmp_u64 > devc->buffersize) {
263 sr_warn("Insufficient buffer space has been allocated.");
264 sr_warn("Please use \'echo <size in bytes> > "\
265 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
55f26c42 266 "\' to increase the buffer size, this"\
ad9dbc1c
KA
267 " capture is now truncated to %d Msamples",
268 devc->buffersize /
269 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
270 }
0bca2e75 271 return devc->beaglelogic->set_triggerflags(devc);
e743a47d
AJ
272 case SR_CONF_CAPTURE_RATIO:
273 devc->capture_ratio = g_variant_get_uint64(data);
efad7ccc 274 break;
bb993797 275 default:
ad9dbc1c 276 return SR_ERR_NA;
bb993797
KA
277 }
278
ad9dbc1c 279 return SR_OK;
bb993797
KA
280}
281
dd7a72ea
UH
282static int config_list(uint32_t key, GVariant **data,
283 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
bb993797 284{
bb993797 285 switch (key) {
138589b0 286 case SR_CONF_SCAN_OPTIONS:
ad9dbc1c 287 case SR_CONF_DEVICE_OPTIONS:
05199c0a 288 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
ad9dbc1c 289 case SR_CONF_SAMPLERATE:
53012da6 290 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
ad9dbc1c
KA
291 break;
292 case SR_CONF_TRIGGER_MATCH:
76d10d13 293 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
ad9dbc1c 294 break;
bb993797
KA
295 default:
296 return SR_ERR_NA;
297 }
298
a9010323 299 return SR_OK;
bb993797
KA
300}
301
ad9dbc1c
KA
302/* get a sane timeout for poll() */
303#define BUFUNIT_TIMEOUT_MS(devc) (100 + ((devc->bufunitsize * 1000) / \
304 (uint32_t)(devc->cur_samplerate)))
305
695dc859 306static int dev_acquisition_start(const struct sr_dev_inst *sdi)
bb993797 307{
ad9dbc1c 308 struct dev_context *devc = sdi->priv;
e71062d9 309 GSList *l;
ad9dbc1c 310 struct sr_trigger *trigger;
e71062d9 311 struct sr_channel *channel;
bb993797 312
ad9dbc1c
KA
313 /* Clear capture state */
314 devc->bytes_read = 0;
315 devc->offset = 0;
316
317 /* Configure channels */
e71062d9
KA
318 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
319
320 for (l = sdi->channels; l; l = l->next) {
321 channel = l->data;
322 if (channel->index >= 8 && channel->enabled)
323 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
324 }
0bca2e75 325 devc->beaglelogic->set_sampleunit(devc);
ad9dbc1c
KA
326
327 /* Configure triggers & send header packet */
328 if ((trigger = sr_session_trigger_get(sdi->session))) {
e743a47d
AJ
329 int pre_trigger_samples = 0;
330 if (devc->limit_samples > 0)
efad7ccc 331 pre_trigger_samples = (devc->capture_ratio * devc->limit_samples) / 100;
e743a47d 332 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
98fec29e 333 if (!devc->stl)
e743a47d 334 return SR_ERR_MALLOC;
ad9dbc1c
KA
335 devc->trigger_fired = FALSE;
336 } else
337 devc->trigger_fired = TRUE;
bee2b016 338 std_session_send_df_header(sdi);
ad9dbc1c
KA
339
340 /* Trigger and add poll on file */
0bca2e75 341 devc->beaglelogic->start(devc);
9b2b3ef9
KA
342 if (devc->beaglelogic == &beaglelogic_native_ops)
343 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
344 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_native_receive_data,
345 (void *)sdi);
346 else
347 sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
348 BUFUNIT_TIMEOUT_MS(devc), beaglelogic_tcp_receive_data,
ad9dbc1c 349 (void *)sdi);
bb993797
KA
350
351 return SR_OK;
352}
353
695dc859 354static int dev_acquisition_stop(struct sr_dev_inst *sdi)
bb993797 355{
ad9dbc1c 356 struct dev_context *devc = sdi->priv;
ad9dbc1c 357
ad9dbc1c 358 /* Execute a stop on BeagleLogic */
0bca2e75 359 devc->beaglelogic->stop(devc);
ad9dbc1c
KA
360
361 /* lseek to offset 0, flushes the cache */
9b2b3ef9
KA
362 if (devc->beaglelogic == &beaglelogic_native_ops)
363 lseek(devc->fd, 0, SEEK_SET);
ad9dbc1c
KA
364
365 /* Remove session source and send EOT packet */
366 sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
bee2b016 367 std_session_send_df_end(sdi);
bb993797
KA
368
369 return SR_OK;
370}
371
dd5c48a6 372static struct sr_dev_driver beaglelogic_driver_info = {
bb993797
KA
373 .name = "beaglelogic",
374 .longname = "BeagleLogic",
375 .api_version = 1,
c2fdcc25 376 .init = std_init,
700d6b64 377 .cleanup = std_cleanup,
bb993797 378 .scan = scan,
c01bf34c 379 .dev_list = std_dev_list,
f778bf02 380 .dev_clear = std_dev_clear,
bb993797
KA
381 .config_get = config_get,
382 .config_set = config_set,
383 .config_list = config_list,
384 .dev_open = dev_open,
385 .dev_close = dev_close,
386 .dev_acquisition_start = dev_acquisition_start,
387 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 388 .context = NULL,
bb993797 389};
dd5c48a6 390SR_REGISTER_DEV_DRIVER(beaglelogic_driver_info);