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