]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/uni-t-ut32x/api.c
Drop unneeded std_session_send_df_header() comments.
[libsigrok.git] / src / hardware / uni-t-ut32x / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 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
20#include <config.h>
21#include <string.h>
22#include "protocol.h"
23
24static const uint32_t devopts[] = {
25 SR_CONF_THERMOMETER,
26 SR_CONF_CONTINUOUS,
27 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
28 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
29};
30
31static const char *channel_names[] = {
32 "T1", "T2", "T1-T2",
33};
34
35static const char *data_sources[] = {
36 "Live",
37 "Memory",
38};
39
40SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
41
42static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
43{
44 return std_init(sr_ctx, di, LOG_PREFIX);
45}
46
47static GSList *scan(struct sr_dev_driver *di, GSList *options)
48{
49 struct drv_context *drvc;
50 struct dev_context *devc;
51 struct sr_dev_inst *sdi;
52 struct sr_config *src;
53 GSList *usb_devices, *devices, *l;
54 unsigned int i;
55 const char *conn;
56
57 drvc = di->context;
58 drvc->instances = NULL;
59
60 conn = NULL;
61 for (l = options; l; l = l->next) {
62 src = l->data;
63 switch (src->key) {
64 case SR_CONF_CONN:
65 conn = g_variant_get_string(src->data, NULL);
66 break;
67 }
68 }
69 if (!conn)
70 return NULL;
71
72 devices = NULL;
73 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
74 /* We have a list of sr_usb_dev_inst matching the connection
75 * string. Wrap them in sr_dev_inst and we're done. */
76 for (l = usb_devices; l; l = l->next) {
77 sdi = g_malloc0(sizeof(struct sr_dev_inst));
78 sdi->status = SR_ST_INACTIVE;
79 sdi->vendor = g_strdup(VENDOR);
80 sdi->model = g_strdup(MODEL);
81 sdi->driver = di;
82 sdi->inst_type = SR_INST_USB;
83 sdi->conn = l->data;
84 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
85 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
86 channel_names[i]);
87 devc = g_malloc0(sizeof(struct dev_context));
88 sdi->priv = devc;
89 devc->limit_samples = 0;
90 devc->data_source = DEFAULT_DATA_SOURCE;
91 drvc->instances = g_slist_append(drvc->instances, sdi);
92 devices = g_slist_append(devices, sdi);
93 }
94 g_slist_free(usb_devices);
95 } else
96 g_slist_free_full(usb_devices, g_free);
97
98 return devices;
99}
100
101static GSList *dev_list(const struct sr_dev_driver *di)
102{
103 return ((struct drv_context *)(di->context))->instances;
104}
105
106static int dev_open(struct sr_dev_inst *sdi)
107{
108 struct sr_dev_driver *di = sdi->driver;
109 struct drv_context *drvc;
110 struct sr_usb_dev_inst *usb;
111 int ret;
112
113 if (!(drvc = di->context)) {
114 sr_err("Driver was not initialized.");
115 return SR_ERR;
116 }
117
118 usb = sdi->conn;
119
120 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
121 return SR_ERR;
122
123/*
124 * The libusb 1.0.9 Darwin backend is broken: it can report a kernel
125 * driver being active, but detaching it always returns an error.
126 */
127#if !defined(__APPLE__)
128 if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
129 if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
130 sr_err("failed to detach kernel driver: %s",
131 libusb_error_name(ret));
132 return SR_ERR;
133 }
134 }
135#endif
136
137 if ((ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION))) {
138 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
139 return SR_ERR;
140 }
141
142 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
143 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
144 return SR_ERR;
145 }
146 sdi->status = SR_ST_ACTIVE;
147
148 return ret;
149}
150
151static int dev_close(struct sr_dev_inst *sdi)
152{
153 struct sr_dev_driver *di = sdi->driver;
154 struct sr_usb_dev_inst *usb;
155
156 if (!di->context) {
157 sr_err("Driver was not initialized.");
158 return SR_ERR;
159 }
160
161 usb = sdi->conn;
162 if (!usb->devhdl)
163 /* Nothing to do. */
164 return SR_OK;
165
166 libusb_release_interface(usb->devhdl, USB_INTERFACE);
167 libusb_close(usb->devhdl);
168 usb->devhdl = NULL;
169 sdi->status = SR_ST_INACTIVE;
170
171 return SR_OK;
172}
173
174static int cleanup(const struct sr_dev_driver *di)
175{
176 int ret;
177 struct drv_context *drvc;
178
179 if (!(drvc = di->context))
180 /* Can get called on an unused driver, doesn't matter. */
181 return SR_OK;
182
183 ret = std_dev_clear(di, NULL);
184 g_free(drvc);
185
186 return ret;
187}
188
189static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
190 const struct sr_channel_group *cg)
191{
192 struct dev_context *devc;
193
194 (void)cg;
195
196 devc = sdi->priv;
197 switch (key) {
198 case SR_CONF_LIMIT_SAMPLES:
199 *data = g_variant_new_uint64(devc->limit_samples);
200 break;
201 case SR_CONF_DATA_SOURCE:
202 if (devc->data_source == DATA_SOURCE_LIVE)
203 *data = g_variant_new_string("Live");
204 else
205 *data = g_variant_new_string("Memory");
206 break;
207 default:
208 return SR_ERR_NA;
209 }
210
211 return SR_OK;
212}
213
214static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
215 const struct sr_channel_group *cg)
216{
217 struct sr_dev_driver *di = sdi->driver;
218 struct dev_context *devc;
219 const char *tmp_str;
220
221 (void)cg;
222
223 if (sdi->status != SR_ST_ACTIVE)
224 return SR_ERR_DEV_CLOSED;
225
226 if (!di->context) {
227 sr_err("Driver was not initialized.");
228 return SR_ERR;
229 }
230
231 devc = sdi->priv;
232
233 switch (key) {
234 case SR_CONF_LIMIT_SAMPLES:
235 devc->limit_samples = g_variant_get_uint64(data);
236 break;
237 case SR_CONF_DATA_SOURCE:
238 tmp_str = g_variant_get_string(data, NULL);
239 if (!strcmp(tmp_str, "Live"))
240 devc->data_source = DATA_SOURCE_LIVE;
241 else if (!strcmp(tmp_str, "Memory"))
242 devc->data_source = DATA_SOURCE_MEMORY;
243 else
244 return SR_ERR;
245 break;
246 default:
247 return SR_ERR_NA;
248 }
249
250 return SR_OK;
251}
252
253static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
254 const struct sr_channel_group *cg)
255{
256 (void)sdi;
257 (void)cg;
258
259 switch (key) {
260 case SR_CONF_DEVICE_OPTIONS:
261 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
262 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
263 break;
264 case SR_CONF_DATA_SOURCE:
265 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
266 break;
267 default:
268 return SR_ERR_NA;
269 }
270
271 return SR_OK;
272}
273
274static int dev_acquisition_start(const struct sr_dev_inst *sdi,
275 void *cb_data)
276{
277 struct sr_dev_driver *di = sdi->driver;
278 struct drv_context *drvc;
279 struct dev_context *devc;
280 struct sr_usb_dev_inst *usb;
281 int len, ret;
282 unsigned char cmd[2];
283
284 if (sdi->status != SR_ST_ACTIVE)
285 return SR_ERR_DEV_CLOSED;
286
287 drvc = di->context;
288 devc = sdi->priv;
289 usb = sdi->conn;
290
291 devc->cb_data = cb_data;
292 devc->num_samples = 0;
293 devc->packet_len = 0;
294
295 /* Configure serial port parameters on USB-UART interface
296 * chip inside the device (just baudrate 2400 actually). */
297 cmd[0] = 0x09;
298 cmd[1] = 0x60;
299 ret = libusb_control_transfer(usb->devhdl, 0x21, 0x09, 0x0300, 0x00,
300 cmd, 2, 5);
301 if (ret != 2) {
302 sr_dbg("Failed to configure CH9325: %s", libusb_error_name(ret));
303 return SR_ERR;
304 }
305
306 std_session_send_df_header(cb_data, LOG_PREFIX);
307
308 if (!(devc->xfer = libusb_alloc_transfer(0)))
309 return SR_ERR;
310
311 /* Length of payload to follow. */
312 cmd[0] = 0x01;
313 if (devc->data_source == DATA_SOURCE_LIVE)
314 cmd[1] = CMD_GET_LIVE;
315 else
316 cmd[1] = CMD_GET_STORED;
317
318 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, cmd, 2, &len, 5);
319 if (ret != 0 || len != 2) {
320 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
321 libusb_free_transfer(devc->xfer);
322 return SR_ERR;
323 }
324
325 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
326 8, uni_t_ut32x_receive_transfer, (void *)sdi, 15);
327 if (libusb_submit_transfer(devc->xfer) != 0) {
328 libusb_free_transfer(devc->xfer);
329 return SR_ERR;
330 }
331
332 usb_source_add(sdi->session, drvc->sr_ctx, 10,
333 uni_t_ut32x_handle_events, (void *)sdi);
334
335 return SR_OK;
336}
337
338static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
339{
340
341 (void)cb_data;
342
343 if (sdi->status != SR_ST_ACTIVE)
344 return SR_ERR_DEV_CLOSED;
345
346 /* Signal USB transfer handler to clean up and stop. */
347 sdi->status = SR_ST_STOPPING;
348
349 return SR_OK;
350}
351
352SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info = {
353 .name = "uni-t-ut32x",
354 .longname = "UNI-T UT32x",
355 .api_version = 1,
356 .init = init,
357 .cleanup = cleanup,
358 .scan = scan,
359 .dev_list = dev_list,
360 .dev_clear = NULL,
361 .config_get = config_get,
362 .config_set = config_set,
363 .config_list = config_list,
364 .dev_open = dev_open,
365 .dev_close = dev_close,
366 .dev_acquisition_start = dev_acquisition_start,
367 .dev_acquisition_stop = dev_acquisition_stop,
368 .context = NULL,
369};