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