]> sigrok.org Git - libsigrok.git/blob - session_driver.c
sr: rename more functions to sr_thing_action format
[libsigrok.git] / session_driver.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010-2012 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 <sys/types.h>
21 #include <sys/stat.h>
22 #include <fcntl.h>
23 #include <unistd.h>
24 #include <sys/time.h>
25 #include <zip.h>
26 #include "sigrok.h"
27 #include "sigrok-internal.h"
28
29 /* size of payloads sent across the session bus */
30 #define CHUNKSIZE (512 * 1024)
31
32 struct session_vdevice {
33         char *capturefile;
34         struct zip *archive;
35         struct zip_file *capfile;
36         int bytes_read;
37         uint64_t samplerate;
38         int unitsize;
39         int num_probes;
40 };
41
42 static char *sessionfile = NULL;
43 static GSList *device_instances = NULL;
44 static int capabilities[] = {
45         SR_HWCAP_CAPTUREFILE,
46         SR_HWCAP_CAPTURE_UNITSIZE,
47         0,
48 };
49
50 /**
51  * TODO.
52  *
53  * @param device_index TODO.
54  */
55 static struct session_vdevice *get_vdevice_by_index(int device_index)
56 {
57         struct sr_device_instance *sdi;
58         struct session_vdevice *vdevice;
59
60         /* TODO: Sanity checks on device_index. */
61
62         if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
63                 sr_err("session driver: %s: device instance with device "
64                        "index %d was not found", __func__, device_index);
65                 return NULL;
66         }
67
68         /* TODO: Is sdi->priv == NULL valid? */
69
70         vdevice = sdi->priv;
71
72         return vdevice;
73 }
74
75 /**
76  * TODO.
77  *
78  * @param fd TODO.
79  * @param revents TODO.
80  * @param session_data TODO.
81  *
82  * @return TODO.
83  */
84 static int feed_chunk(int fd, int revents, void *session_data)
85 {
86         struct sr_device_instance *sdi;
87         struct session_vdevice *vdevice;
88         struct sr_datafeed_packet packet;
89         struct sr_datafeed_logic logic;
90         GSList *l;
91         void *buf;
92         int ret, got_data;
93
94         /* Avoid compiler warnings. */
95         (void)fd;
96         (void)revents;
97
98         sr_dbg("session_driver: feed chunk");
99
100         got_data = FALSE;
101         for (l = device_instances; l; l = l->next) {
102                 sdi = l->data;
103                 vdevice = sdi->priv;
104                 if (!vdevice)
105                         /* already done with this instance */
106                         continue;
107
108                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
109                         sr_err("session: %s: buf malloc failed", __func__);
110                         return FALSE; /* TODO: SR_ERR_MALLOC */
111                 }
112
113                 ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
114                 if (ret > 0) {
115                         got_data = TRUE;
116                         packet.type = SR_DF_LOGIC;
117                         packet.payload = &logic;
118                         logic.length = ret;
119                         logic.unitsize = vdevice->unitsize;
120                         logic.data = buf;
121                         vdevice->bytes_read += ret;
122                         sr_session_bus(session_data, &packet);
123                 } else {
124                         /* done with this capture file */
125                         zip_fclose(vdevice->capfile);
126                         g_free(vdevice->capturefile);
127                         g_free(vdevice);
128                         sdi->priv = NULL;
129                 }
130         }
131
132         if (!got_data) {
133                 packet.type = SR_DF_END;
134                 sr_session_bus(session_data, &packet);
135         }
136
137         return TRUE;
138 }
139
140 /* driver callbacks */
141 static int hw_cleanup(void);
142
143 /**
144  * TODO.
145  *
146  * @param deviceinfo TODO.
147  *
148  * @return TODO.
149  */
150 static int hw_init(const char *deviceinfo)
151 {
152         sessionfile = g_strdup(deviceinfo);
153
154         return 0;
155 }
156
157 /**
158  * TODO.
159  *
160  */
161 static int hw_cleanup(void)
162 {
163         GSList *l;
164
165         /* TODO: Error handling. */
166
167         for (l = device_instances; l; l = l->next)
168                 sr_dev_inst_free(l->data);
169
170         g_slist_free(device_instances);
171         device_instances = NULL;
172
173         sr_session_source_remove(-1);
174
175         g_free(sessionfile);
176
177         return SR_OK;
178 }
179
180 static int hw_opendev(int device_index)
181 {
182         struct sr_device_instance *sdi;
183
184         sdi = sr_dev_inst_new(device_index, SR_ST_INITIALIZING,
185                 NULL, NULL, NULL);
186         if (!sdi)
187                 return SR_ERR;
188
189         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
190                 sr_err("session: %s: sdi->priv malloc failed", __func__);
191                 return SR_ERR_MALLOC;
192         }
193
194         device_instances = g_slist_append(device_instances, sdi);
195
196         return SR_OK;
197 }
198
199 static void *hw_get_device_info(int device_index, int device_info_id)
200 {
201         struct session_vdevice *vdevice;
202         void *info;
203
204         if (device_info_id != SR_DI_CUR_SAMPLERATE)
205                 return NULL;
206
207         if (!(vdevice = get_vdevice_by_index(device_index)))
208                 return NULL;
209
210         info = &vdevice->samplerate;
211
212         return info;
213 }
214
215 static int hw_get_status(int device_index)
216 {
217         /* Avoid compiler warnings. */
218         (void)device_index;
219
220         if (sr_dev_list() != NULL)
221                 return SR_OK;
222         else
223                 return SR_ERR;
224 }
225
226 /**
227  * Get the list of hardware capabilities.
228  *
229  * @return A pointer to the (hardware) capabilities of this virtual session
230  *         driver. This could be NULL, if no such capabilities exist.
231  */
232 static int *hw_get_capabilities(void)
233 {
234         return capabilities;
235 }
236
237 static int hw_set_configuration(int device_index, int capability, void *value)
238 {
239         struct session_vdevice *vdevice;
240         uint64_t *tmp_u64;
241
242         if (!(vdevice = get_vdevice_by_index(device_index)))
243                 return SR_ERR;
244
245         switch (capability) {
246         case SR_HWCAP_SAMPLERATE:
247                 tmp_u64 = value;
248                 vdevice->samplerate = *tmp_u64;
249                 sr_info("session driver: setting samplerate to %" PRIu64,
250                         vdevice->samplerate);
251                 break;
252         case SR_HWCAP_CAPTUREFILE:
253                 vdevice->capturefile = g_strdup(value);
254                 sr_info("session driver: setting capturefile to %s",
255                         vdevice->capturefile);
256                 break;
257         case SR_HWCAP_CAPTURE_UNITSIZE:
258                 tmp_u64 = value;
259                 vdevice->unitsize = *tmp_u64;
260                 break;
261         case SR_HWCAP_CAPTURE_NUM_PROBES:
262                 tmp_u64 = value;
263                 vdevice->num_probes = *tmp_u64;
264                 break;
265         default:
266                 sr_err("session driver: %s: unknown capability %d requested",
267                        __func__, capability);
268                 return SR_ERR;
269         }
270
271         return SR_OK;
272 }
273
274 static int hw_start_acquisition(int device_index, gpointer session_device_id)
275 {
276         struct zip_stat zs;
277         struct session_vdevice *vdevice;
278         struct sr_datafeed_header *header;
279         struct sr_datafeed_packet *packet;
280         int err;
281
282         /* Avoid compiler warnings. */
283         (void)session_device_id;
284
285         if (!(vdevice = get_vdevice_by_index(device_index)))
286                 return SR_ERR;
287
288         sr_info("session_driver: opening archive %s file %s", sessionfile,
289                 vdevice->capturefile);
290
291         if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
292                 sr_err("Failed to open session file '%s': zip error %d\n",
293                        sessionfile, err);
294                 return SR_ERR;
295         }
296
297         if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
298                 sr_err("Failed to check capture file '%s' in session file "
299                        "'%s'.", vdevice->capturefile, sessionfile);
300                 return SR_ERR;
301         }
302
303         if (!(vdevice->capfile = zip_fopen(vdevice->archive,
304                                            vdevice->capturefile, 0))) {
305                 sr_err("Failed to open capture file '%s' in session file '%s'.",
306                        vdevice->capturefile, sessionfile);
307                 return SR_ERR;
308         }
309
310         /* freewheeling source */
311         sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
312
313         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
314                 sr_err("session: %s: packet malloc failed", __func__);
315                 return SR_ERR_MALLOC;
316         }
317
318         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
319                 sr_err("session: %s: header malloc failed", __func__);
320                 return SR_ERR_MALLOC;
321         }
322
323         /* Send header packet to the session bus. */
324         packet->type = SR_DF_HEADER;
325         packet->payload = (unsigned char *)header;
326         header->feed_version = 1;
327         gettimeofday(&header->starttime, NULL);
328         header->samplerate = vdevice->samplerate;
329         header->num_logic_probes = vdevice->num_probes;
330         sr_session_bus(session_device_id, packet);
331         g_free(header);
332         g_free(packet);
333
334         return SR_OK;
335 }
336
337 /* Not static, it's used elsewhere (via 'extern'). */
338 struct sr_device_plugin session_driver = {
339         "session",
340         "Session-emulating driver",
341         1,
342         hw_init,
343         hw_cleanup,
344         hw_opendev,
345         NULL,
346         hw_get_device_info,
347         hw_get_status,
348         hw_get_capabilities,
349         hw_set_configuration,
350         hw_start_acquisition,
351         NULL,
352 };