]>
Commit | Line | Data |
---|---|---|
063e7aef | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
063e7aef UH |
3 | * |
4 | * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de> | |
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 2 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 | |
2ea1fdf1 | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
063e7aef UH |
18 | */ |
19 | ||
d9251a2c UH |
20 | /** |
21 | * @file | |
22 | * | |
23 | * Standard API helper functions. | |
24 | * | |
25 | * @internal | |
26 | */ | |
04cb9157 | 27 | |
6ec6c43b | 28 | #include <config.h> |
063e7aef | 29 | #include <glib.h> |
c1aae900 | 30 | #include <libsigrok/libsigrok.h> |
063e7aef | 31 | #include "libsigrok-internal.h" |
5a1afc09 | 32 | #include "scpi.h" |
063e7aef | 33 | |
3544f848 ML |
34 | #define LOG_PREFIX "std" |
35 | ||
063e7aef UH |
36 | /** |
37 | * Standard sr_driver_init() API helper. | |
38 | * | |
6078d2c9 | 39 | * This function can be used to simplify most driver's init() API callback. |
063e7aef UH |
40 | * |
41 | * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and | |
42 | * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed. | |
43 | * | |
063e7aef | 44 | * @param di The driver instance to use. |
1f8f5bc0 | 45 | * @param sr_ctx The libsigrok context to assign. |
063e7aef | 46 | * |
91219afc | 47 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. |
063e7aef | 48 | */ |
c45c32ce | 49 | SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx) |
063e7aef UH |
50 | { |
51 | struct drv_context *drvc; | |
52 | ||
91219afc | 53 | drvc = g_malloc0(sizeof(struct drv_context)); |
063e7aef | 54 | drvc->sr_ctx = sr_ctx; |
c2523f22 | 55 | drvc->instances = NULL; |
41812aca | 56 | di->context = drvc; |
063e7aef UH |
57 | |
58 | return SR_OK; | |
59 | } | |
4afdfd46 | 60 | |
700d6b64 LPC |
61 | /** |
62 | * Standard driver cleanup() callback API helper | |
63 | * | |
64 | * @param di The driver instance to use. | |
65 | * | |
66 | * Frees all device instances by calling sr_dev_clear() and then releases any | |
67 | * resources allocated by std_init(). | |
68 | * | |
69 | * @retval SR_OK Success | |
70 | * @retval SR_ERR_ARG Invalid driver | |
71 | * | |
72 | */ | |
73 | SR_PRIV int std_cleanup(const struct sr_dev_driver *di) | |
74 | { | |
75 | int ret; | |
76 | ||
77 | ret = sr_dev_clear(di); | |
78 | g_free(di->context); | |
79 | ||
80 | return ret; | |
81 | } | |
82 | ||
4afdfd46 UH |
83 | /** |
84 | * Standard API helper for sending an SR_DF_HEADER packet. | |
85 | * | |
86 | * This function can be used to simplify most driver's | |
6078d2c9 | 87 | * dev_acquisition_start() API callback. |
4afdfd46 UH |
88 | * |
89 | * @param sdi The device instance to use. | |
4afdfd46 UH |
90 | * |
91 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
92 | * SR_ERR upon other errors. | |
93 | */ | |
bee2b016 | 94 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi) |
4afdfd46 | 95 | { |
23630316 | 96 | const char *prefix = (sdi->driver) ? sdi->driver->name : "unknown"; |
4afdfd46 UH |
97 | int ret; |
98 | struct sr_datafeed_packet packet; | |
99 | struct sr_datafeed_header header; | |
100 | ||
ac2926b3 | 101 | sr_dbg("%s: Starting acquisition.", prefix); |
4afdfd46 UH |
102 | |
103 | /* Send header packet to the session bus. */ | |
ac2926b3 | 104 | sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix); |
4afdfd46 UH |
105 | packet.type = SR_DF_HEADER; |
106 | packet.payload = (uint8_t *)&header; | |
107 | header.feed_version = 1; | |
108 | gettimeofday(&header.starttime, NULL); | |
109 | ||
110 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
ac2926b3 | 111 | sr_err("%s: Failed to send header packet: %d.", prefix, ret); |
4afdfd46 UH |
112 | return ret; |
113 | } | |
114 | ||
115 | return SR_OK; | |
116 | } | |
cd2f0fe2 | 117 | |
3be42bc2 UH |
118 | /** |
119 | * Standard API helper for sending an SR_DF_END packet. | |
120 | * | |
121 | * @param sdi The device instance to use. Must not be NULL. | |
3be42bc2 UH |
122 | * |
123 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
124 | * SR_ERR upon other errors. | |
125 | */ | |
bee2b016 | 126 | SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi) |
3be42bc2 | 127 | { |
23630316 | 128 | const char *prefix = (sdi->driver) ? sdi->driver->name : "unknown"; |
3be42bc2 UH |
129 | int ret; |
130 | struct sr_datafeed_packet packet; | |
131 | ||
bee2b016 | 132 | if (!sdi) |
3be42bc2 UH |
133 | return SR_ERR_ARG; |
134 | ||
135 | sr_dbg("%s: Sending SR_DF_END packet.", prefix); | |
136 | ||
137 | packet.type = SR_DF_END; | |
138 | packet.payload = NULL; | |
139 | ||
140 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
141 | sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret); | |
142 | return ret; | |
143 | } | |
144 | ||
145 | return SR_OK; | |
146 | } | |
147 | ||
c4f2dfd0 UH |
148 | #ifdef HAVE_LIBSERIALPORT |
149 | ||
813aab69 | 150 | /** |
23dc6661 BV |
151 | * Standard serial driver dev_open() helper. |
152 | * | |
153 | * This function can be used to implement the dev_open() driver API | |
154 | * callback in drivers that use a serial port. The port is opened | |
6c592ece | 155 | * with the SERIAL_RDWR flag. |
23dc6661 BV |
156 | * |
157 | * If the open succeeded, the status field of the given sdi is set | |
158 | * to SR_ST_ACTIVE. | |
159 | * | |
160 | * @retval SR_OK Success. | |
161 | * @retval SR_ERR Serial port open failed. | |
162 | */ | |
163 | SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi) | |
164 | { | |
165 | struct sr_serial_dev_inst *serial; | |
166 | ||
167 | serial = sdi->conn; | |
6c592ece | 168 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) |
23dc6661 BV |
169 | return SR_ERR; |
170 | ||
171 | sdi->status = SR_ST_ACTIVE; | |
172 | ||
173 | return SR_OK; | |
174 | } | |
175 | ||
813aab69 | 176 | /** |
1e7134dc BV |
177 | * Standard serial driver dev_close() helper. |
178 | * | |
179 | * This function can be used to implement the dev_close() driver API | |
180 | * callback in drivers that use a serial port. | |
181 | * | |
182 | * After closing the port, the status field of the given sdi is set | |
183 | * to SR_ST_INACTIVE. | |
184 | * | |
185 | * @retval SR_OK Success. | |
186 | */ | |
187 | SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) | |
188 | { | |
189 | struct sr_serial_dev_inst *serial; | |
190 | ||
191 | serial = sdi->conn; | |
192 | if (serial && sdi->status == SR_ST_ACTIVE) { | |
193 | serial_close(serial); | |
194 | sdi->status = SR_ST_INACTIVE; | |
195 | } | |
196 | ||
197 | return SR_OK; | |
198 | } | |
199 | ||
813aab69 | 200 | /** |
cd2f0fe2 UH |
201 | * Standard sr_session_stop() API helper. |
202 | * | |
203 | * This function can be used to simplify most (serial port based) driver's | |
6078d2c9 | 204 | * dev_acquisition_stop() API callback. |
cd2f0fe2 UH |
205 | * |
206 | * @param sdi The device instance for which acquisition should stop. | |
207 | * Must not be NULL. | |
cd2f0fe2 | 208 | * |
1477a9a6 MH |
209 | * @retval SR_OK Success. |
210 | * @retval SR_ERR_ARG Invalid arguments. | |
211 | * @retval SR_ERR_DEV_CLOSED Device is closed. | |
212 | * @retval SR_ERR Other errors. | |
cd2f0fe2 | 213 | */ |
1b38775b | 214 | SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi) |
cd2f0fe2 | 215 | { |
15f96409 | 216 | struct sr_serial_dev_inst *serial = sdi->conn; |
bee2b016 | 217 | const char *prefix = sdi->driver->name; |
cd2f0fe2 | 218 | int ret; |
cd2f0fe2 | 219 | |
102f1239 | 220 | if ((ret = serial_source_remove(sdi->session, serial)) < 0) { |
ac2926b3 | 221 | sr_err("%s: Failed to remove source: %d.", prefix, ret); |
cd2f0fe2 UH |
222 | return ret; |
223 | } | |
224 | ||
1b38775b | 225 | if ((ret = sdi->driver->dev_close(sdi)) < 0) { |
ac2926b3 | 226 | sr_err("%s: Failed to close device: %d.", prefix, ret); |
cd2f0fe2 UH |
227 | return ret; |
228 | } | |
229 | ||
bee2b016 | 230 | std_session_send_df_end(sdi); |
cd2f0fe2 UH |
231 | |
232 | return SR_OK; | |
233 | } | |
49f00e13 | 234 | |
c4f2dfd0 UH |
235 | #endif |
236 | ||
813aab69 | 237 | /** |
49f00e13 BV |
238 | * Standard driver dev_clear() helper. |
239 | * | |
813aab69 MH |
240 | * Clear driver, this means, close all instances. |
241 | * | |
49f00e13 BV |
242 | * This function can be used to implement the dev_clear() driver API |
243 | * callback. dev_close() is called before every sr_dev_inst is cleared. | |
244 | * | |
245 | * The only limitation is driver-specific device contexts (sdi->priv). | |
246 | * These are freed, but any dynamic allocation within structs stored | |
247 | * there cannot be freed. | |
248 | * | |
249 | * @param driver The driver which will have its instances released. | |
12a33563 BV |
250 | * @param clear_private If not NULL, this points to a function called |
251 | * with sdi->priv as argument. The function can then clear any device | |
252 | * instance-specific resources kept there. It must also clear the struct | |
253 | * pointed to by sdi->priv. | |
49f00e13 BV |
254 | * |
255 | * @return SR_OK on success. | |
256 | */ | |
ae5859ff | 257 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, |
144f6660 | 258 | std_dev_clear_callback clear_private) |
49f00e13 | 259 | { |
49f00e13 | 260 | struct drv_context *drvc; |
12a33563 | 261 | struct sr_dev_inst *sdi; |
7aebe22d | 262 | GSList *l; |
49f00e13 BV |
263 | int ret; |
264 | ||
41812aca | 265 | if (!(drvc = driver->context)) |
3a277f3b BV |
266 | /* Driver was never initialized, nothing to do. */ |
267 | return SR_OK; | |
268 | ||
49f00e13 BV |
269 | ret = SR_OK; |
270 | for (l = drvc->instances; l; l = l->next) { | |
49f00e13 BV |
271 | if (!(sdi = l->data)) { |
272 | ret = SR_ERR_BUG; | |
273 | continue; | |
274 | } | |
49f00e13 BV |
275 | if (driver->dev_close) |
276 | driver->dev_close(sdi); | |
277 | ||
278 | if (sdi->conn) { | |
45357ce6 | 279 | #ifdef HAVE_LIBSERIALPORT |
c4f2dfd0 | 280 | if (sdi->inst_type == SR_INST_SERIAL) |
12a33563 | 281 | sr_serial_dev_inst_free(sdi->conn); |
c4f2dfd0 | 282 | #endif |
45357ce6 | 283 | #ifdef HAVE_LIBUSB_1_0 |
c4f2dfd0 | 284 | if (sdi->inst_type == SR_INST_USB) |
49f00e13 | 285 | sr_usb_dev_inst_free(sdi->conn); |
a0c7e23a | 286 | #endif |
23f43dff ML |
287 | if (sdi->inst_type == SR_INST_SCPI) |
288 | sr_scpi_free(sdi->conn); | |
daa39012 AJ |
289 | if (sdi->inst_type == SR_INST_MODBUS) |
290 | sr_modbus_free(sdi->conn); | |
49f00e13 | 291 | } |
ae5859ff | 292 | if (clear_private) |
886413b6 BV |
293 | /* The helper function is responsible for freeing |
294 | * its own sdi->priv! */ | |
ae5859ff | 295 | clear_private(sdi->priv); |
12a33563 BV |
296 | else |
297 | g_free(sdi->priv); | |
886413b6 | 298 | |
49f00e13 BV |
299 | sr_dev_inst_free(sdi); |
300 | } | |
301 | ||
302 | g_slist_free(drvc->instances); | |
303 | drvc->instances = NULL; | |
304 | ||
305 | return ret; | |
306 | } | |
c01bf34c LPC |
307 | |
308 | /** | |
309 | * Standard implementation for the driver dev_list() callback | |
310 | * | |
311 | * This function can be used as the dev_list callback by most drivers that use | |
312 | * the standard helper functions. It returns the devices contained in the driver | |
313 | * context instances list. | |
314 | * | |
315 | * @param di The driver instance to use. | |
316 | * | |
317 | * @return The list of devices/instances of this driver, or NULL upon errors | |
318 | * or if the list is empty. | |
319 | */ | |
320 | SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di) | |
321 | { | |
322 | struct drv_context *drvc = di->context; | |
323 | ||
324 | return drvc->instances; | |
325 | } | |
15a5bfe4 LPC |
326 | |
327 | /** | |
328 | * Standard scan() callback API helper. | |
329 | * | |
330 | * This function can be used to perform common tasks required by a driver's | |
331 | * scan() callback. It will initialize the driver for each device on the list | |
332 | * and add the devices on the list to the driver's device instance list. | |
333 | * Usually it should be used as the last step in the scan() callback, right | |
334 | * before returning. | |
335 | * | |
336 | * Note: This function can only be used if std_init() has been called | |
337 | * previously by the driver. | |
338 | * | |
339 | * Example: | |
340 | * @code{c} | |
341 | * static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
342 | * { | |
343 | * struct GSList *device; | |
344 | * struct sr_dev_inst *sdi; | |
345 | * | |
346 | * sdi = g_new0(sr_dev_inst, 1); | |
347 | * sdi->vendor = ...; | |
348 | * ... | |
349 | * devices = g_slist_append(devices, sdi); | |
350 | * ... | |
351 | * return std_scan_complete(di, devices); | |
352 | * } | |
353 | * @endcode | |
354 | * | |
39fcfdc9 | 355 | * @param di The driver instance to use. Must not be NULL. |
15a5bfe4 LPC |
356 | * @param devices List of newly discovered devices (struct sr_dev_inst). |
357 | * | |
358 | * @return The @p devices list. | |
359 | */ | |
360 | SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices) | |
361 | { | |
39fcfdc9 | 362 | struct drv_context *drvc; |
15a5bfe4 LPC |
363 | GSList *l; |
364 | ||
39fcfdc9 UH |
365 | if (!di) { |
366 | sr_err("Invalid driver instance (di), cannot complete scan."); | |
367 | return NULL; | |
368 | } | |
369 | ||
370 | drvc = di->context; | |
371 | ||
15a5bfe4 LPC |
372 | for (l = devices; l; l = l->next) { |
373 | struct sr_dev_inst *sdi = l->data; | |
39fcfdc9 UH |
374 | if (!sdi) { |
375 | sr_err("Invalid driver instance, cannot complete scan."); | |
376 | return NULL; | |
377 | } | |
15a5bfe4 LPC |
378 | sdi->driver = di; |
379 | } | |
380 | ||
381 | drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices)); | |
382 | ||
383 | return devices; | |
384 | } |