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