]> sigrok.org Git - libsigrok.git/blame - src/hardware/testo/api.c
drivers: Add and use STD_CONFIG_LIST().
[libsigrok.git] / src / hardware / testo / api.c
CommitLineData
0acdd793
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
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>
6dcb9723 21#include <string.h>
0acdd793
BV
22#include "protocol.h"
23
6dcb9723 24#define SERIALCOMM "115200/8n1"
6dcb9723 25
584560f1 26static const uint32_t scanopts[] = {
6dcb9723
BV
27 SR_CONF_CONN,
28};
29
584560f1 30static const uint32_t devopts[] = {
6dcb9723 31 SR_CONF_MULTIMETER,
6dcb9723 32 SR_CONF_CONTINUOUS,
91b77e6b
LPC
33 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET,
34 SR_CONF_LIMIT_MSEC | SR_CONF_SET | SR_CONF_GET,
6dcb9723
BV
35};
36
329733d9
UH
37static const uint8_t TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
38
39static const struct testo_model models[] = {
6dcb9723
BV
40 { "435", 9, TESTO_x35_REQUEST },
41};
0acdd793 42
4f840ce9 43static GSList *scan(struct sr_dev_driver *di, GSList *options)
0acdd793
BV
44{
45 struct drv_context *drvc;
6dcb9723
BV
46 struct dev_context *devc;
47 struct sr_config *src;
48 struct sr_dev_inst *sdi;
49 struct sr_usb_dev_inst *usb;
50 struct libusb_device_descriptor des;
51 libusb_device **devlist;
52 struct libusb_device_handle *hdl;
53 GSList *conn_devices, *devices, *l;
bde9fbd1 54 int ret, i;
6dcb9723 55 const char *str;
bde9fbd1 56 char manufacturer[64], product[64], connection_id[64];
0acdd793
BV
57
58 devices = NULL;
41812aca 59 drvc = di->context;
0acdd793 60
6dcb9723
BV
61 conn_devices = NULL;
62 for (l = options; l; l = l->next) {
63 src = l->data;
64 if (src->key != SR_CONF_CONN)
65 continue;
66 str = g_variant_get_string(src->data, NULL);
67 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, str);
68 }
69
70 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
71 for (i = 0; devlist[i]; i++) {
72 if (conn_devices) {
73 usb = NULL;
74 for (l = conn_devices; l; l = l->next) {
75 usb = l->data;
76 if (usb->bus == libusb_get_bus_number(devlist[i])
77 && usb->address == libusb_get_device_address(devlist[i]))
78 break;
79 }
80 if (!l)
81 /* This device matched none of the ones that
82 * matched the conn specification. */
83 continue;
84 }
85
2a8f2d41 86 libusb_get_device_descriptor(devlist[i], &des);
6dcb9723
BV
87
88 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
89 continue;
90
91 manufacturer[0] = product[0] = '\0';
92 if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
93 hdl, des.iManufacturer, (unsigned char *) manufacturer,
94 sizeof(manufacturer))) < 0) {
95 sr_warn("Failed to get manufacturer string descriptor: %s.",
96 libusb_error_name(ret));
97 }
98 if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
99 hdl, des.iProduct, (unsigned char *) product,
100 sizeof(product))) < 0) {
101 sr_warn("Failed to get product string descriptor: %s.",
102 libusb_error_name(ret));
103 }
104 libusb_close(hdl);
105
106 if (strncmp(manufacturer, "testo", 5))
107 continue;
108
bde9fbd1
SA
109 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
110
6dcb9723
BV
111 /* Hardcode the 435 for now.*/
112 if (strcmp(product, "testo 435/635/735"))
113 continue;
114
aac29cc1 115 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
116 sdi->status = SR_ST_INACTIVE;
117 sdi->vendor = g_strdup("Testo");
118 sdi->model = g_strdup("435/635/735");
6dcb9723
BV
119 sdi->driver = di;
120 sdi->inst_type = SR_INST_USB;
121 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
122 libusb_get_device_address(devlist[i]), NULL);
bde9fbd1 123 sdi->connection_id = g_strdup(connection_id);
6dcb9723
BV
124 devc = g_malloc(sizeof(struct dev_context));
125 devc->model = &models[0];
91b77e6b 126 sr_sw_limits_init(&devc->sw_limits);
6dcb9723
BV
127 sdi->priv = devc;
128 if (testo_probe_channels(sdi) != SR_OK)
129 continue;
6dcb9723
BV
130 devices = g_slist_append(devices, sdi);
131 }
132 libusb_free_device_list(devlist, 1);
133 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
0acdd793 134
15a5bfe4 135 return std_scan_complete(di, devices);
0acdd793
BV
136}
137
0acdd793
BV
138static int dev_open(struct sr_dev_inst *sdi)
139{
4f840ce9 140 struct sr_dev_driver *di = sdi->driver;
41812aca 141 struct drv_context *drvc = di->context;
6dcb9723 142 struct sr_usb_dev_inst *usb;
b75dc14a 143 int ret;
6dcb9723 144
6dcb9723 145 usb = sdi->conn;
b75dc14a
LPC
146
147 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
148 if (ret != SR_OK)
149 return ret;
0acdd793 150
88b1d4e5
BV
151 if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
152 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
153 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
154 sr_err("Failed to detach kernel driver: %s.",
155 libusb_error_name(ret));
156 return SR_ERR;
157 }
158 }
159 }
160
6dcb9723
BV
161 if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
162 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
163 return SR_ERR;
164 }
0acdd793
BV
165
166 return SR_OK;
167}
168
169static int dev_close(struct sr_dev_inst *sdi)
170{
6dcb9723
BV
171 struct sr_usb_dev_inst *usb;
172
6dcb9723 173 usb = sdi->conn;
f1ba6b4b 174
6dcb9723 175 if (!usb->devhdl)
f1ba6b4b 176 return SR_ERR_BUG;
0acdd793 177
6dcb9723
BV
178 libusb_release_interface(usb->devhdl, 0);
179 libusb_close(usb->devhdl);
180 usb->devhdl = NULL;
0acdd793
BV
181
182 return SR_OK;
183}
184
584560f1 185static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
186 const struct sr_channel_group *cg)
187{
91b77e6b 188 struct dev_context *devc = sdi->priv;
6dcb9723
BV
189 struct sr_usb_dev_inst *usb;
190 char str[128];
0acdd793 191
0acdd793
BV
192 (void)cg;
193
0acdd793 194 switch (key) {
6dcb9723
BV
195 case SR_CONF_CONN:
196 if (!sdi || !sdi->conn)
197 return SR_ERR_ARG;
198 usb = sdi->conn;
199 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
200 *data = g_variant_new_string(str);
201 break;
91b77e6b
LPC
202 case SR_CONF_LIMIT_MSEC:
203 case SR_CONF_LIMIT_SAMPLES:
204 return sr_sw_limits_config_get(&devc->sw_limits, key, data);
0acdd793
BV
205 default:
206 return SR_ERR_NA;
207 }
208
6dcb9723 209 return SR_OK;
0acdd793
BV
210}
211
584560f1 212static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
0acdd793
BV
213 const struct sr_channel_group *cg)
214{
91b77e6b 215 struct dev_context *devc = sdi->priv;
0acdd793 216
0acdd793
BV
217 (void)cg;
218
91b77e6b 219 return sr_sw_limits_config_set(&devc->sw_limits, key, data);
0acdd793
BV
220}
221
584560f1 222static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
223 const struct sr_channel_group *cg)
224{
e66d1892 225 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, devopts);
0acdd793
BV
226}
227
6dcb9723 228static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
0acdd793 229{
6dcb9723
BV
230 struct dev_context *devc;
231 int packet_size;
87895640 232 uint16_t crc;
6dcb9723
BV
233
234 devc = sdi->priv;
235
236 if (devc->reply_size + len > MAX_REPLY_SIZE) {
237 /* Something went very wrong. */
238 sr_dbg("Receive buffer overrun.");
239 devc->reply_size = 0;
240 return;
241 }
242
243 memcpy(devc->reply + devc->reply_size, data, len);
244 devc->reply_size += len;
245 /* Sixth byte contains the length of the packet. */
87895640
BV
246 if (devc->reply_size < 7)
247 return;
248
249 packet_size = 7 + devc->reply[6] * 7 + 2;
250 if (devc->reply_size < packet_size)
251 return;
252
253 if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
254 return;
255
256 crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
88b1d4e5 257 if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
87895640 258 testo_receive_packet(sdi);
91b77e6b 259 sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
87895640
BV
260 } else {
261 sr_dbg("Packet has invalid CRC.");
6dcb9723
BV
262 }
263
87895640 264 devc->reply_size = 0;
91b77e6b 265 if (sr_sw_limits_check(&devc->sw_limits))
d2f7c417 266 sr_dev_acquisition_stop(sdi);
87895640
BV
267 else
268 testo_request_packet(sdi);
269
6dcb9723
BV
270}
271
55462b8b 272SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
6dcb9723
BV
273{
274 struct dev_context *devc;
275 struct sr_dev_inst *sdi;
276 int ret;
277
278 sdi = transfer->user_data;
279 devc = sdi->priv;
280 if (transfer == devc->out_transfer)
281 /* Just the command acknowledgement. */
282 return;
283
284 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
285 /* USB device was unplugged. */
d2f7c417 286 sr_dev_acquisition_stop(sdi);
6dcb9723
BV
287 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
288 /* First two bytes in any transfer are FTDI status bytes. */
289 if (transfer->actual_length > 2)
290 receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
291 }
292 /* Anything else is either an error or a timeout, which is fine:
293 * we were just going to send another transfer request anyway. */
294
295 if (sdi->status == SR_ST_ACTIVE) {
296 if ((ret = libusb_submit_transfer(transfer) != 0)) {
297 sr_err("Unable to resubmit transfer: %s.",
298 libusb_error_name(ret));
299 g_free(transfer->buffer);
300 libusb_free_transfer(transfer);
d2f7c417 301 sr_dev_acquisition_stop(sdi);
6dcb9723
BV
302 }
303 } else {
304 /* This was the last transfer we're going to receive, so
305 * clean up now. */
306 g_free(transfer->buffer);
307 libusb_free_transfer(transfer);
308 }
309}
310
311static int handle_events(int fd, int revents, void *cb_data)
312{
4f840ce9 313 struct sr_dev_driver *di;
6dcb9723 314 struct dev_context *devc;
4f840ce9 315 struct drv_context *drvc;
6dcb9723
BV
316 struct sr_dev_inst *sdi;
317 struct timeval tv;
6dcb9723
BV
318
319 (void)fd;
320 (void)revents;
321
322 sdi = cb_data;
323 devc = sdi->priv;
4f840ce9 324 di = sdi->driver;
41812aca 325 drvc = di->context;
6dcb9723 326
91b77e6b 327 if (sr_sw_limits_check(&devc->sw_limits))
d2f7c417 328 sr_dev_acquisition_stop(sdi);
6dcb9723
BV
329
330 if (sdi->status == SR_ST_STOPPING) {
102f1239 331 usb_source_remove(sdi->session, drvc->sr_ctx);
6dcb9723 332 dev_close(sdi);
bee2b016 333 std_session_send_df_end(sdi);
6dcb9723
BV
334 }
335
336 memset(&tv, 0, sizeof(struct timeval));
337 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
338 NULL);
339
340 return TRUE;
341}
342
695dc859 343static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6dcb9723 344{
4f840ce9 345 struct sr_dev_driver *di = sdi->driver;
6dcb9723
BV
346 struct drv_context *drvc;
347 struct dev_context *devc;
348 struct sr_usb_dev_inst *usb;
349 struct libusb_transfer *transfer;
350 int ret;
351 unsigned char *buf;
0acdd793 352
41812aca 353 drvc = di->context;
6dcb9723
BV
354 devc = sdi->priv;
355 usb = sdi->conn;
6dcb9723
BV
356 devc->reply_size = 0;
357
bee2b016 358 std_session_send_df_header(sdi);
6dcb9723 359
102f1239
BV
360 usb_source_add(sdi->session, drvc->sr_ctx, 100,
361 handle_events, (void *)sdi);
6dcb9723
BV
362
363 if (testo_set_serial_params(usb) != SR_OK)
364 return SR_ERR;
365
366 devc->out_transfer = libusb_alloc_transfer(0);
367 if (testo_request_packet(sdi) != SR_OK)
368 return SR_ERR;
369
a95f142e 370 buf = g_malloc(MAX_REPLY_SIZE);
6dcb9723
BV
371 transfer = libusb_alloc_transfer(0);
372 libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
373 MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
374 if ((ret = libusb_submit_transfer(transfer) != 0)) {
375 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
376 libusb_free_transfer(transfer);
377 g_free(buf);
378 return SR_ERR;
379 }
380 devc->reply_size = 0;
0acdd793 381
91b77e6b
LPC
382 sr_sw_limits_acquisition_start(&devc->sw_limits);
383
0acdd793
BV
384 return SR_OK;
385}
386
695dc859 387static int dev_acquisition_stop(struct sr_dev_inst *sdi)
0acdd793 388{
6dcb9723 389 sdi->status = SR_ST_STOPPING;
0acdd793
BV
390
391 return SR_OK;
392}
393
dd5c48a6 394static struct sr_dev_driver testo_driver_info = {
0acdd793
BV
395 .name = "testo",
396 .longname = "Testo",
397 .api_version = 1,
c2fdcc25 398 .init = std_init,
700d6b64 399 .cleanup = std_cleanup,
0acdd793 400 .scan = scan,
c01bf34c 401 .dev_list = std_dev_list,
f778bf02 402 .dev_clear = std_dev_clear,
0acdd793
BV
403 .config_get = config_get,
404 .config_set = config_set,
405 .config_list = config_list,
406 .dev_open = dev_open,
407 .dev_close = dev_close,
408 .dev_acquisition_start = dev_acquisition_start,
409 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 410 .context = NULL,
0acdd793 411};
dd5c48a6 412SR_REGISTER_DEV_DRIVER(testo_driver_info);