-
Notifications
You must be signed in to change notification settings - Fork 0
/
std.c
291 lines (254 loc) · 7.76 KB
/
std.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/*
* This file is part of the libsigrok project.
*
* Copyright (C) 2013 Uwe Hermann <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/** @file
* Standard API helper functions.
* @internal
*/
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#define LOG_PREFIX "std"
/**
* Standard sr_driver_init() API helper.
*
* This function can be used to simplify most driver's init() API callback.
*
* It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
* then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
*
* @param sr_ctx The libsigrok context to assign.
* @param di The driver instance to use.
* @param[in] prefix A driver-specific prefix string used for log messages.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
* SR_ERR_MALLOC upon memory allocation errors.
*/
SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
const char *prefix)
{
struct drv_context *drvc;
if (!di) {
sr_err("%s: Invalid driver, cannot initialize.", prefix);
return SR_ERR_ARG;
}
if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
sr_err("%s: Driver context malloc failed.", prefix);
return SR_ERR_MALLOC;
}
drvc->sr_ctx = sr_ctx;
drvc->instances = NULL;
di->priv = drvc;
return SR_OK;
}
/**
* Standard API helper for sending an SR_DF_HEADER packet.
*
* This function can be used to simplify most driver's
* dev_acquisition_start() API callback.
*
* @param sdi The device instance to use.
* @param prefix A driver-specific prefix string used for log messages.
* Must not be NULL. An empty string is allowed.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
* SR_ERR upon other errors.
*/
SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
const char *prefix)
{
int ret;
struct sr_datafeed_packet packet;
struct sr_datafeed_header header;
if (!prefix) {
sr_err("Invalid prefix.");
return SR_ERR_ARG;
}
sr_dbg("%s: Starting acquisition.", prefix);
/* Send header packet to the session bus. */
sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
packet.type = SR_DF_HEADER;
packet.payload = (uint8_t *)&header;
header.feed_version = 1;
gettimeofday(&header.starttime, NULL);
if ((ret = sr_session_send(sdi, &packet)) < 0) {
sr_err("%s: Failed to send header packet: %d.", prefix, ret);
return ret;
}
return SR_OK;
}
#ifdef HAVE_LIBSERIALPORT
/**
* Standard serial driver dev_open() helper.
*
* This function can be used to implement the dev_open() driver API
* callback in drivers that use a serial port. The port is opened
* with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
*
* If the open succeeded, the status field of the given sdi is set
* to SR_ST_ACTIVE.
*
* @retval SR_OK Success.
* @retval SR_ERR Serial port open failed.
*/
SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
{
struct sr_serial_dev_inst *serial;
serial = sdi->conn;
if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
return SR_ERR;
sdi->status = SR_ST_ACTIVE;
return SR_OK;
}
/**
* Standard serial driver dev_close() helper.
*
* This function can be used to implement the dev_close() driver API
* callback in drivers that use a serial port.
*
* After closing the port, the status field of the given sdi is set
* to SR_ST_INACTIVE.
*
* @retval SR_OK Success.
*/
SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
{
struct sr_serial_dev_inst *serial;
serial = sdi->conn;
if (serial && sdi->status == SR_ST_ACTIVE) {
serial_close(serial);
sdi->status = SR_ST_INACTIVE;
}
return SR_OK;
}
/**
* Standard sr_session_stop() API helper.
*
* This function can be used to simplify most (serial port based) driver's
* dev_acquisition_stop() API callback.
*
* @param sdi The device instance for which acquisition should stop.
* Must not be NULL.
* @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
* @param dev_close_fn Function pointer to the driver's dev_close().
* Must not be NULL.
* @param serial The serial device instance (struct serial_dev_inst *).
* Must not be NULL.
* @param[in] prefix A driver-specific prefix string used for log messages.
* Must not be NULL. An empty string is allowed.
*
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid arguments.
* @retval SR_ERR_DEV_CLOSED Device is closed.
* @retval SR_ERR Other errors.
*/
SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
void *cb_data, dev_close_callback dev_close_fn,
struct sr_serial_dev_inst *serial, const char *prefix)
{
int ret;
struct sr_datafeed_packet packet;
if (!prefix) {
sr_err("Invalid prefix.");
return SR_ERR_ARG;
}
if (sdi->status != SR_ST_ACTIVE) {
sr_err("%s: Device inactive, can't stop acquisition.", prefix);
return SR_ERR_DEV_CLOSED;
}
sr_dbg("%s: Stopping acquisition.", prefix);
if ((ret = serial_source_remove(serial)) < 0) {
sr_err("%s: Failed to remove source: %d.", prefix, ret);
return ret;
}
if ((ret = dev_close_fn(sdi)) < 0) {
sr_err("%s: Failed to close device: %d.", prefix, ret);
return ret;
}
/* Send SR_DF_END packet to the session bus. */
sr_dbg("%s: Sending SR_DF_END packet.", prefix);
packet.type = SR_DF_END;
packet.payload = NULL;
if ((ret = sr_session_send(cb_data, &packet)) < 0) {
sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
return ret;
}
return SR_OK;
}
#endif
/**
* Standard driver dev_clear() helper.
*
* Clear driver, this means, close all instances.
*
* This function can be used to implement the dev_clear() driver API
* callback. dev_close() is called before every sr_dev_inst is cleared.
*
* The only limitation is driver-specific device contexts (sdi->priv).
* These are freed, but any dynamic allocation within structs stored
* there cannot be freed.
*
* @param driver The driver which will have its instances released.
* @param clear_private If not NULL, this points to a function called
* with sdi->priv as argument. The function can then clear any device
* instance-specific resources kept there. It must also clear the struct
* pointed to by sdi->priv.
*
* @return SR_OK on success.
*/
SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
std_dev_clear_callback clear_private)
{
struct drv_context *drvc;
struct sr_dev_inst *sdi;
GSList *l;
int ret;
if (!(drvc = driver->priv))
/* Driver was never initialized, nothing to do. */
return SR_OK;
ret = SR_OK;
for (l = drvc->instances; l; l = l->next) {
if (!(sdi = l->data)) {
ret = SR_ERR_BUG;
continue;
}
if (driver->dev_close)
driver->dev_close(sdi);
if (sdi->conn) {
#ifdef HAVE_LIBSERIALPORT
if (sdi->inst_type == SR_INST_SERIAL)
sr_serial_dev_inst_free(sdi->conn);
#endif
#ifdef HAVE_LIBUSB_1_0
if (sdi->inst_type == SR_INST_USB)
sr_usb_dev_inst_free(sdi->conn);
#endif
if (sdi->inst_type == SR_INST_SCPI)
sr_scpi_free(sdi->conn);
}
if (clear_private)
clear_private(sdi->priv);
else
g_free(sdi->priv);
sr_dev_inst_free(sdi);
}
g_slist_free(drvc->instances);
drvc->instances = NULL;
return ret;
}