]> sigrok.org Git - libsigrok.git/blame - src/hardware/ipdbg-logic-analyser/api.c
ipdbg-la: Allow rx to time out and handle invalid data properly
[libsigrok.git] / src / hardware / ipdbg-logic-analyser / api.c
CommitLineData
a4210e18
EK
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2016 danselmi <da@da>
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
20#include <config.h>
21#include "protocol.h"
22
23static const uint32_t ipdbg_org_la_drvopts[] = {
9d2e5483 24 SR_CONF_LOGIC_ANALYZER,
a4210e18
EK
25};
26
27static const uint32_t ipdbg_org_la_scanopts[] = {
9d2e5483 28 SR_CONF_CONN,
a4210e18
EK
29};
30
31static const uint32_t ipdbg_org_la_devopts[] = {
9d2e5483
SA
32 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST | SR_CONF_SET,
33 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
87712225 34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET,
a4210e18
EK
35};
36
37static const int32_t ipdbg_org_la_trigger_matches[] = {
9d2e5483
SA
38 SR_TRIGGER_ZERO,
39 SR_TRIGGER_ONE,
40 SR_TRIGGER_RISING,
41 SR_TRIGGER_FALLING,
42 SR_TRIGGER_EDGE,
a4210e18
EK
43};
44
45SR_PRIV struct sr_dev_driver ipdbg_la_driver_info;
46
9d2e5483
SA
47static void ipdbg_org_la_split_addr_port(const char *conn, char **addr,
48 char **port)
a4210e18 49{
9d2e5483 50 char **strs = g_strsplit(conn, "/", 3);
a4210e18 51
9d2e5483
SA
52 *addr = g_strdup(strs[1]);
53 *port = g_strdup(strs[2]);
a4210e18 54
9d2e5483 55 g_strfreev(strs);
a4210e18
EK
56}
57
58static GSList *scan(struct sr_dev_driver *di, GSList *options)
59{
9d2e5483
SA
60 struct drv_context *drvc;
61 GSList *devices;
a4210e18 62
9d2e5483
SA
63 devices = NULL;
64 drvc = di->context;
65 drvc->instances = NULL;
66 const char *conn;
67 struct sr_config *src;
68 GSList *l;
a4210e18 69
9d2e5483
SA
70 conn = NULL;
71 for (l = options; l; l = l->next) {
72 src = l->data;
73 switch (src->key) {
74 case SR_CONF_CONN:
75 conn = g_variant_get_string(src->data, NULL);
76 break;
77 }
78 }
a4210e18 79
9d2e5483
SA
80 if (!conn)
81 return NULL;
a4210e18 82
9d2e5483 83 struct ipdbg_org_la_tcp *tcp = ipdbg_org_la_tcp_new();
a4210e18 84
9d2e5483 85 ipdbg_org_la_split_addr_port(conn, &tcp->address, &tcp->port);
a4210e18 86
9d2e5483
SA
87 if (!tcp->address)
88 return NULL;
a4210e18 89
9d2e5483
SA
90 if (ipdbg_org_la_tcp_open(tcp) != SR_OK)
91 return NULL;
a4210e18 92
9d2e5483
SA
93 ipdbg_org_la_send_reset(tcp);
94 ipdbg_org_la_send_reset(tcp);
ed186484
SA
95
96 if (ipdbg_org_la_request_id(tcp) != SR_OK)
97 return NULL;
a4210e18 98
9d2e5483
SA
99 struct sr_dev_inst *sdi = g_malloc0(sizeof(struct sr_dev_inst));
100 if (!sdi) {
101 sr_err("no possible to allocate sr_dev_inst");
102 return NULL;
103 }
7f4c9a04 104
9d2e5483
SA
105 sdi->status = SR_ST_INACTIVE;
106 sdi->vendor = g_strdup("ipdbg.org");
107 sdi->model = g_strdup("Logic Analyzer");
108 sdi->version = g_strdup("v1.0");
109 sdi->driver = di;
a4210e18 110
9d2e5483
SA
111 struct ipdbg_org_la_dev_context *devc = ipdbg_org_la_dev_new();
112 sdi->priv = devc;
a4210e18 113
9d2e5483 114 ipdbg_org_la_get_addrwidth_and_datawidth(tcp, devc);
a4210e18 115
9d2e5483
SA
116 sr_dbg("addr_width = %d, data_width = %d\n", devc->ADDR_WIDTH,
117 devc->DATA_WIDTH);
118 sr_dbg("limit samples = %" PRIu64 "\n", devc->limit_samples_max);
7f4c9a04 119
9d2e5483
SA
120 for (uint32_t i = 0; i < devc->DATA_WIDTH; i++) {
121 const uint8_t buf_size = 16;
122 char buf[buf_size];
123 snprintf(buf, buf_size, "ch%d", i);
124 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, buf);
125 }
a4210e18 126
9d2e5483
SA
127 sdi->inst_type = SR_INST_USER;
128 sdi->conn = tcp;
a4210e18 129
9d2e5483 130 ipdbg_org_la_tcp_close(tcp);
a4210e18 131
9d2e5483 132 devices = g_slist_append(devices, sdi);
750303aa 133
9d2e5483 134 return std_scan_complete(di, devices);
a4210e18
EK
135}
136
137static int dev_clear(const struct sr_dev_driver *di)
138{
9d2e5483
SA
139 struct drv_context *drvc = di->context;
140 struct sr_dev_inst *sdi;
141 GSList *l;
142
143 if (drvc) {
144 for (l = drvc->instances; l; l = l->next) {
145 sdi = l->data;
146 struct ipdbg_org_la_tcp *tcp = sdi->conn;
147 if (tcp) {
148 ipdbg_org_la_tcp_close(tcp);
149 ipdbg_org_la_tcp_free(tcp);
150 g_free(tcp);
151 }
152 sdi->conn = NULL;
153 }
154 }
155
156 return std_dev_clear(di);
a4210e18
EK
157}
158
159static int dev_open(struct sr_dev_inst *sdi)
160{
9d2e5483 161 sdi->status = SR_ST_INACTIVE;
a4210e18 162
9d2e5483 163 struct ipdbg_org_la_tcp *tcp = sdi->conn;
a4210e18 164
9d2e5483
SA
165 if (!tcp)
166 return SR_ERR;
a4210e18 167
9d2e5483
SA
168 if (ipdbg_org_la_tcp_open(tcp) != SR_OK)
169 return SR_ERR;
a4210e18 170
9d2e5483 171 sdi->status = SR_ST_ACTIVE;
a4210e18 172
9d2e5483 173 return SR_OK;
a4210e18
EK
174}
175
176static int dev_close(struct sr_dev_inst *sdi)
177{
9d2e5483
SA
178 // Should be called before a new call to scan()
179 struct ipdbg_org_la_tcp *tcp = sdi->conn;
38e7493d 180
9d2e5483
SA
181 if (tcp)
182 ipdbg_org_la_tcp_close(tcp);
a4210e18 183
9d2e5483
SA
184 sdi->conn = NULL;
185 sdi->status = SR_ST_INACTIVE;
a4210e18 186
9d2e5483 187 return SR_OK;
a4210e18
EK
188}
189
190static int config_get(uint32_t key, GVariant **data,
9d2e5483 191 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a4210e18 192{
9d2e5483 193 int ret = SR_OK;
a4210e18 194
9d2e5483 195 (void)cg;
a4210e18 196
9d2e5483 197 struct ipdbg_org_la_dev_context *devc = sdi->priv;
a4210e18 198
9d2e5483
SA
199 switch (key) {
200 case SR_CONF_CAPTURE_RATIO:
201 *data = g_variant_new_uint64(devc->capture_ratio);
202 break;
203 case SR_CONF_LIMIT_SAMPLES:
204 *data = g_variant_new_uint64(devc->limit_samples);
205 break;
206 default:
207 ret = SR_ERR_NA;
208 }
a4210e18 209
9d2e5483 210 return ret;
a4210e18
EK
211}
212
213static int config_set(uint32_t key, GVariant *data,
9d2e5483 214 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a4210e18 215{
9d2e5483
SA
216 int ret = SR_OK;
217 uint64_t value;
218
219 (void)cg;
220
221 if (sdi->status != SR_ST_ACTIVE)
222 return SR_ERR_DEV_CLOSED;
223
224 struct ipdbg_org_la_dev_context *devc = sdi->priv;
225
226 switch (key) {
227 case SR_CONF_CAPTURE_RATIO:
228 value = g_variant_get_uint64(data);
229 if (value <= 100)
230 devc->capture_ratio = value;
231 else
232 ret = SR_ERR;
233 break;
234 case SR_CONF_LIMIT_SAMPLES:
235 value = g_variant_get_uint64(data);
236 if (value <= devc->limit_samples_max)
237 devc->limit_samples = value;
238 else
239 ret = SR_ERR;
240 break;
241 default:
242 ret = SR_ERR_NA;
243 }
244
245 return ret;
a4210e18
EK
246}
247
248static int config_list(uint32_t key, GVariant **data,
9d2e5483 249 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a4210e18 250{
9d2e5483
SA
251 (void)cg;
252
253 switch (key) {
254 case SR_CONF_SCAN_OPTIONS:
255 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
256 ipdbg_org_la_scanopts,
257 ARRAY_SIZE
258 (ipdbg_org_la_scanopts),
259 sizeof(uint32_t));
260 break;
261 case SR_CONF_DEVICE_OPTIONS:
262 if (!sdi)
263 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
264 ipdbg_org_la_drvopts,
265 ARRAY_SIZE
266 (ipdbg_org_la_drvopts),
267 sizeof(uint32_t));
268 else
269 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
270 ipdbg_org_la_devopts,
271 ARRAY_SIZE
272 (ipdbg_org_la_devopts),
273 sizeof(uint32_t));
274 break;
275 case SR_CONF_TRIGGER_MATCH:
276 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
277 ipdbg_org_la_trigger_matches,
278 ARRAY_SIZE
279 (ipdbg_org_la_trigger_matches),
280 sizeof(int32_t));
281 break;
282 default:
283 return SR_ERR_NA;
284 }
285
286 return SR_OK;
a4210e18
EK
287}
288
a4210e18
EK
289static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
290{
9d2e5483 291 return std_init(di, sr_ctx);
a4210e18
EK
292}
293
a4210e18
EK
294static GSList *dev_list(const struct sr_dev_driver *di)
295{
9d2e5483 296 return ((struct drv_context *)(di->context))->instances;
a4210e18
EK
297}
298
299static int dev_acquisition_start(const struct sr_dev_inst *sdi)
300{
9d2e5483
SA
301 if (sdi->status != SR_ST_ACTIVE)
302 return SR_ERR_DEV_CLOSED;
a4210e18 303
9d2e5483
SA
304 struct ipdbg_org_la_tcp *tcp = sdi->conn;
305 struct ipdbg_org_la_dev_context *devc = sdi->priv;
a4210e18 306
9d2e5483
SA
307 ipdbg_org_la_convert_trigger(sdi);
308 ipdbg_org_la_send_trigger(devc, tcp);
309 ipdbg_org_la_send_delay(devc, tcp);
a4210e18 310
9d2e5483
SA
311 /* If the device stops sending for longer than it takes to send a byte,
312 * that means it's finished. But wait at least 100 ms to be safe.
313 */
314 sr_session_source_add(sdi->session, tcp->socket, G_IO_IN, 100,
315 ipdbg_org_la_receive_data, (struct sr_dev_inst *)sdi);
a4210e18 316
9d2e5483 317 ipdbg_org_la_send_start(tcp);
a4210e18 318
9d2e5483 319 return SR_OK;
a4210e18
EK
320}
321
322static int dev_acquisition_stop(struct sr_dev_inst *sdi)
323{
9d2e5483
SA
324 struct ipdbg_org_la_tcp *tcp = sdi->conn;
325 struct ipdbg_org_la_dev_context *devc = sdi->priv;
a4210e18 326
9d2e5483 327 uint8_t byte;
b51288e3 328
9d2e5483
SA
329 if (devc->num_transfers > 0) {
330 while (devc->num_transfers <
331 (devc->limit_samples_max * devc->DATA_WIDTH_BYTES)) {
332 ipdbg_org_la_tcp_receive(tcp, &byte);
333 devc->num_transfers++;
334 }
335 }
a4210e18 336
9d2e5483
SA
337 ipdbg_org_la_send_reset(tcp);
338 ipdbg_org_la_abort_acquisition(sdi);
a4210e18 339
9d2e5483 340 return SR_OK;
a4210e18
EK
341}
342
343SR_PRIV struct sr_dev_driver ipdbg_la_driver_info = {
9d2e5483
SA
344 .name = "ipdbg-org-la",
345 .longname = "ipdbg.org logic analyzer",
346 .api_version = 1,
347 .init = init,
348 .cleanup = std_cleanup,
349 .scan = scan,
350 .dev_list = dev_list,
351 .dev_clear = dev_clear,
352 .config_get = config_get,
353 .config_set = config_set,
354 .config_list = config_list,
355 .dev_open = dev_open,
356 .dev_close = dev_close,
357 .dev_acquisition_start = dev_acquisition_start,
358 .dev_acquisition_stop = dev_acquisition_stop,
359 .context = NULL,
a4210e18
EK
360};
361
362SR_REGISTER_DEV_DRIVER(ipdbg_la_driver_info);