]> sigrok.org Git - libsigrok.git/blame - src/hardware/ipdbg-logic-analyser/api.c
ipdbg-la: Remove SR_CONF_SERIALCOMM
[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);
95 ipdbg_org_la_request_id(tcp);
a4210e18 96
9d2e5483
SA
97 struct sr_dev_inst *sdi = g_malloc0(sizeof(struct sr_dev_inst));
98 if (!sdi) {
99 sr_err("no possible to allocate sr_dev_inst");
100 return NULL;
101 }
7f4c9a04 102
9d2e5483
SA
103 sdi->status = SR_ST_INACTIVE;
104 sdi->vendor = g_strdup("ipdbg.org");
105 sdi->model = g_strdup("Logic Analyzer");
106 sdi->version = g_strdup("v1.0");
107 sdi->driver = di;
a4210e18 108
9d2e5483
SA
109 struct ipdbg_org_la_dev_context *devc = ipdbg_org_la_dev_new();
110 sdi->priv = devc;
a4210e18 111
9d2e5483 112 ipdbg_org_la_get_addrwidth_and_datawidth(tcp, devc);
a4210e18 113
9d2e5483
SA
114 sr_dbg("addr_width = %d, data_width = %d\n", devc->ADDR_WIDTH,
115 devc->DATA_WIDTH);
116 sr_dbg("limit samples = %" PRIu64 "\n", devc->limit_samples_max);
7f4c9a04 117
9d2e5483
SA
118 for (uint32_t i = 0; i < devc->DATA_WIDTH; i++) {
119 const uint8_t buf_size = 16;
120 char buf[buf_size];
121 snprintf(buf, buf_size, "ch%d", i);
122 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, buf);
123 }
a4210e18 124
9d2e5483
SA
125 sdi->inst_type = SR_INST_USER;
126 sdi->conn = tcp;
a4210e18 127
9d2e5483 128 ipdbg_org_la_tcp_close(tcp);
a4210e18 129
9d2e5483 130 devices = g_slist_append(devices, sdi);
750303aa 131
9d2e5483 132 return std_scan_complete(di, devices);
a4210e18
EK
133}
134
135static int dev_clear(const struct sr_dev_driver *di)
136{
9d2e5483
SA
137 struct drv_context *drvc = di->context;
138 struct sr_dev_inst *sdi;
139 GSList *l;
140
141 if (drvc) {
142 for (l = drvc->instances; l; l = l->next) {
143 sdi = l->data;
144 struct ipdbg_org_la_tcp *tcp = sdi->conn;
145 if (tcp) {
146 ipdbg_org_la_tcp_close(tcp);
147 ipdbg_org_la_tcp_free(tcp);
148 g_free(tcp);
149 }
150 sdi->conn = NULL;
151 }
152 }
153
154 return std_dev_clear(di);
a4210e18
EK
155}
156
157static int dev_open(struct sr_dev_inst *sdi)
158{
9d2e5483 159 sdi->status = SR_ST_INACTIVE;
a4210e18 160
9d2e5483 161 struct ipdbg_org_la_tcp *tcp = sdi->conn;
a4210e18 162
9d2e5483
SA
163 if (!tcp)
164 return SR_ERR;
a4210e18 165
9d2e5483
SA
166 if (ipdbg_org_la_tcp_open(tcp) != SR_OK)
167 return SR_ERR;
a4210e18 168
9d2e5483 169 sdi->status = SR_ST_ACTIVE;
a4210e18 170
9d2e5483 171 return SR_OK;
a4210e18
EK
172}
173
174static int dev_close(struct sr_dev_inst *sdi)
175{
9d2e5483
SA
176 // Should be called before a new call to scan()
177 struct ipdbg_org_la_tcp *tcp = sdi->conn;
38e7493d 178
9d2e5483
SA
179 if (tcp)
180 ipdbg_org_la_tcp_close(tcp);
a4210e18 181
9d2e5483
SA
182 sdi->conn = NULL;
183 sdi->status = SR_ST_INACTIVE;
a4210e18 184
9d2e5483 185 return SR_OK;
a4210e18
EK
186}
187
188static int config_get(uint32_t key, GVariant **data,
9d2e5483 189 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a4210e18 190{
9d2e5483 191 int ret = SR_OK;
a4210e18 192
9d2e5483 193 (void)cg;
a4210e18 194
9d2e5483 195 struct ipdbg_org_la_dev_context *devc = sdi->priv;
a4210e18 196
9d2e5483
SA
197 switch (key) {
198 case SR_CONF_CAPTURE_RATIO:
199 *data = g_variant_new_uint64(devc->capture_ratio);
200 break;
201 case SR_CONF_LIMIT_SAMPLES:
202 *data = g_variant_new_uint64(devc->limit_samples);
203 break;
204 default:
205 ret = SR_ERR_NA;
206 }
a4210e18 207
9d2e5483 208 return ret;
a4210e18
EK
209}
210
211static int config_set(uint32_t key, GVariant *data,
9d2e5483 212 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a4210e18 213{
9d2e5483
SA
214 int ret = SR_OK;
215 uint64_t value;
216
217 (void)cg;
218
219 if (sdi->status != SR_ST_ACTIVE)
220 return SR_ERR_DEV_CLOSED;
221
222 struct ipdbg_org_la_dev_context *devc = sdi->priv;
223
224 switch (key) {
225 case SR_CONF_CAPTURE_RATIO:
226 value = g_variant_get_uint64(data);
227 if (value <= 100)
228 devc->capture_ratio = value;
229 else
230 ret = SR_ERR;
231 break;
232 case SR_CONF_LIMIT_SAMPLES:
233 value = g_variant_get_uint64(data);
234 if (value <= devc->limit_samples_max)
235 devc->limit_samples = value;
236 else
237 ret = SR_ERR;
238 break;
239 default:
240 ret = SR_ERR_NA;
241 }
242
243 return ret;
a4210e18
EK
244}
245
246static int config_list(uint32_t key, GVariant **data,
9d2e5483 247 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a4210e18 248{
9d2e5483
SA
249 (void)cg;
250
251 switch (key) {
252 case SR_CONF_SCAN_OPTIONS:
253 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
254 ipdbg_org_la_scanopts,
255 ARRAY_SIZE
256 (ipdbg_org_la_scanopts),
257 sizeof(uint32_t));
258 break;
259 case SR_CONF_DEVICE_OPTIONS:
260 if (!sdi)
261 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
262 ipdbg_org_la_drvopts,
263 ARRAY_SIZE
264 (ipdbg_org_la_drvopts),
265 sizeof(uint32_t));
266 else
267 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
268 ipdbg_org_la_devopts,
269 ARRAY_SIZE
270 (ipdbg_org_la_devopts),
271 sizeof(uint32_t));
272 break;
273 case SR_CONF_TRIGGER_MATCH:
274 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
275 ipdbg_org_la_trigger_matches,
276 ARRAY_SIZE
277 (ipdbg_org_la_trigger_matches),
278 sizeof(int32_t));
279 break;
280 default:
281 return SR_ERR_NA;
282 }
283
284 return SR_OK;
a4210e18
EK
285}
286
a4210e18
EK
287static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
288{
9d2e5483 289 return std_init(di, sr_ctx);
a4210e18
EK
290}
291
a4210e18
EK
292static GSList *dev_list(const struct sr_dev_driver *di)
293{
9d2e5483 294 return ((struct drv_context *)(di->context))->instances;
a4210e18
EK
295}
296
297static int dev_acquisition_start(const struct sr_dev_inst *sdi)
298{
9d2e5483
SA
299 if (sdi->status != SR_ST_ACTIVE)
300 return SR_ERR_DEV_CLOSED;
a4210e18 301
9d2e5483
SA
302 struct ipdbg_org_la_tcp *tcp = sdi->conn;
303 struct ipdbg_org_la_dev_context *devc = sdi->priv;
a4210e18 304
9d2e5483
SA
305 ipdbg_org_la_convert_trigger(sdi);
306 ipdbg_org_la_send_trigger(devc, tcp);
307 ipdbg_org_la_send_delay(devc, tcp);
a4210e18 308
9d2e5483
SA
309 /* If the device stops sending for longer than it takes to send a byte,
310 * that means it's finished. But wait at least 100 ms to be safe.
311 */
312 sr_session_source_add(sdi->session, tcp->socket, G_IO_IN, 100,
313 ipdbg_org_la_receive_data, (struct sr_dev_inst *)sdi);
a4210e18 314
9d2e5483 315 ipdbg_org_la_send_start(tcp);
a4210e18 316
9d2e5483 317 return SR_OK;
a4210e18
EK
318}
319
320static int dev_acquisition_stop(struct sr_dev_inst *sdi)
321{
9d2e5483
SA
322 struct ipdbg_org_la_tcp *tcp = sdi->conn;
323 struct ipdbg_org_la_dev_context *devc = sdi->priv;
a4210e18 324
9d2e5483 325 uint8_t byte;
b51288e3 326
9d2e5483
SA
327 if (devc->num_transfers > 0) {
328 while (devc->num_transfers <
329 (devc->limit_samples_max * devc->DATA_WIDTH_BYTES)) {
330 ipdbg_org_la_tcp_receive(tcp, &byte);
331 devc->num_transfers++;
332 }
333 }
a4210e18 334
9d2e5483
SA
335 ipdbg_org_la_send_reset(tcp);
336 ipdbg_org_la_abort_acquisition(sdi);
a4210e18 337
9d2e5483 338 return SR_OK;
a4210e18
EK
339}
340
341SR_PRIV struct sr_dev_driver ipdbg_la_driver_info = {
9d2e5483
SA
342 .name = "ipdbg-org-la",
343 .longname = "ipdbg.org logic analyzer",
344 .api_version = 1,
345 .init = init,
346 .cleanup = std_cleanup,
347 .scan = scan,
348 .dev_list = dev_list,
349 .dev_clear = dev_clear,
350 .config_get = config_get,
351 .config_set = config_set,
352 .config_list = config_list,
353 .dev_open = dev_open,
354 .dev_close = dev_close,
355 .dev_acquisition_start = dev_acquisition_start,
356 .dev_acquisition_stop = dev_acquisition_stop,
357 .context = NULL,
a4210e18
EK
358};
359
360SR_REGISTER_DEV_DRIVER(ipdbg_la_driver_info);