2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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/>.
23 * Standard API helper functions.
30 #include <libsigrok/libsigrok.h>
31 #include "libsigrok-internal.h"
34 #define LOG_PREFIX "std"
37 * Standard sr_driver_init() API helper.
39 * This function can be used to simplify most driver's init() API callback.
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.
44 * @param di The driver instance to use.
45 * @param sr_ctx The libsigrok context to assign.
47 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
49 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
51 struct drv_context *drvc;
53 drvc = g_malloc0(sizeof(struct drv_context));
54 drvc->sr_ctx = sr_ctx;
55 drvc->instances = NULL;
62 * Standard driver cleanup() callback API helper
64 * @param di The driver instance to use.
66 * Frees all device instances by calling sr_dev_clear() and then releases any
67 * resources allocated by std_init().
69 * @retval SR_OK Success
70 * @retval SR_ERR_ARG Invalid driver
73 SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
77 ret = sr_dev_clear(di);
84 * Standard API helper for sending an SR_DF_HEADER packet.
86 * This function can be used to simplify most driver's
87 * dev_acquisition_start() API callback.
89 * @param sdi The device instance to use.
91 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
92 * SR_ERR upon other errors.
94 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
96 const char *prefix = (sdi->driver) ? sdi->driver->name : "unknown";
98 struct sr_datafeed_packet packet;
99 struct sr_datafeed_header header;
101 /* Send header packet to the session bus. */
102 sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
103 packet.type = SR_DF_HEADER;
104 packet.payload = (uint8_t *)&header;
105 header.feed_version = 1;
106 gettimeofday(&header.starttime, NULL);
108 if ((ret = sr_session_send(sdi, &packet)) < 0) {
109 sr_err("%s: Failed to send header packet: %d.", prefix, ret);
117 * Standard API helper for sending an SR_DF_END packet.
119 * @param sdi The device instance to use. Must not be NULL.
121 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
122 * SR_ERR upon other errors.
124 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
126 const char *prefix = (sdi->driver) ? sdi->driver->name : "unknown";
128 struct sr_datafeed_packet packet;
133 sr_dbg("%s: Sending SR_DF_END packet.", prefix);
135 packet.type = SR_DF_END;
136 packet.payload = NULL;
138 if ((ret = sr_session_send(sdi, &packet)) < 0) {
139 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
146 #ifdef HAVE_LIBSERIALPORT
149 * Standard serial driver dev_open() helper.
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
153 * with the SERIAL_RDWR flag.
155 * @retval SR_OK Success.
156 * @retval SR_ERR_ARG Invalid arguments.
157 * @retval SR_ERR Serial port open failed.
159 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
161 struct sr_serial_dev_inst *serial;
163 if (!sdi || !sdi->conn)
168 return serial_open(serial, SERIAL_RDWR);
172 * Standard serial driver dev_close() helper.
174 * This function can be used to implement the dev_close() driver API
175 * callback in drivers that use a serial port.
177 * @retval SR_OK Success.
178 * @retval SR_ERR_ARG Invalid arguments.
179 * @retval SR_ERR Serial port close failed.
181 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
183 struct sr_serial_dev_inst *serial;
185 if (!sdi || !sdi->conn)
190 return serial_close(serial);
194 * Standard sr_session_stop() API helper.
196 * This function can be used to simplify most (serial port based) driver's
197 * dev_acquisition_stop() API callback.
199 * @param sdi The device instance for which acquisition should stop.
202 * @retval SR_OK Success.
203 * @retval SR_ERR_ARG Invalid arguments.
204 * @retval SR_ERR_DEV_CLOSED Device is closed.
205 * @retval SR_ERR Other errors.
207 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi)
209 struct sr_serial_dev_inst *serial = sdi->conn;
210 const char *prefix = sdi->driver->name;
213 if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
214 sr_err("%s: Failed to remove source: %d.", prefix, ret);
218 if ((ret = sr_dev_close(sdi)) < 0) {
219 sr_err("%s: Failed to close device: %d.", prefix, ret);
223 std_session_send_df_end(sdi);
231 * Standard driver dev_clear() helper.
233 * Clear driver, this means, close all instances.
235 * This function can be used to implement the dev_clear() driver API
236 * callback. dev_close() is called before every sr_dev_inst is cleared.
238 * The only limitation is driver-specific device contexts (sdi->priv).
239 * These are freed, but any dynamic allocation within structs stored
240 * there cannot be freed.
242 * @param driver The driver which will have its instances released.
243 * @param clear_private If not NULL, this points to a function called
244 * with sdi->priv as argument. The function can then clear any device
245 * instance-specific resources kept there. It must also clear the struct
246 * pointed to by sdi->priv.
248 * @return SR_OK on success.
250 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
251 std_dev_clear_callback clear_private)
253 struct drv_context *drvc;
254 struct sr_dev_inst *sdi;
258 if (!(drvc = driver->context))
259 /* Driver was never initialized, nothing to do. */
263 for (l = drvc->instances; l; l = l->next) {
264 if (!(sdi = l->data)) {
268 if (driver->dev_close)
269 driver->dev_close(sdi);
272 #ifdef HAVE_LIBSERIALPORT
273 if (sdi->inst_type == SR_INST_SERIAL)
274 sr_serial_dev_inst_free(sdi->conn);
276 #ifdef HAVE_LIBUSB_1_0
277 if (sdi->inst_type == SR_INST_USB)
278 sr_usb_dev_inst_free(sdi->conn);
280 if (sdi->inst_type == SR_INST_SCPI)
281 sr_scpi_free(sdi->conn);
282 if (sdi->inst_type == SR_INST_MODBUS)
283 sr_modbus_free(sdi->conn);
286 /* The helper function is responsible for freeing
287 * its own sdi->priv! */
288 clear_private(sdi->priv);
292 sr_dev_inst_free(sdi);
295 g_slist_free(drvc->instances);
296 drvc->instances = NULL;
302 * Standard implementation for the driver dev_list() callback
304 * This function can be used as the dev_list callback by most drivers that use
305 * the standard helper functions. It returns the devices contained in the driver
306 * context instances list.
308 * @param di The driver instance to use.
310 * @return The list of devices/instances of this driver, or NULL upon errors
311 * or if the list is empty.
313 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
315 struct drv_context *drvc = di->context;
317 return drvc->instances;
321 * Standard scan() callback API helper.
323 * This function can be used to perform common tasks required by a driver's
324 * scan() callback. It will initialize the driver for each device on the list
325 * and add the devices on the list to the driver's device instance list.
326 * Usually it should be used as the last step in the scan() callback, right
329 * Note: This function can only be used if std_init() has been called
330 * previously by the driver.
334 * static GSList *scan(struct sr_dev_driver *di, GSList *options)
336 * struct GSList *device;
337 * struct sr_dev_inst *sdi;
339 * sdi = g_new0(sr_dev_inst, 1);
342 * devices = g_slist_append(devices, sdi);
344 * return std_scan_complete(di, devices);
348 * @param di The driver instance to use. Must not be NULL.
349 * @param devices List of newly discovered devices (struct sr_dev_inst).
351 * @return The @p devices list.
353 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
355 struct drv_context *drvc;
359 sr_err("Invalid driver instance (di), cannot complete scan.");
365 for (l = devices; l; l = l->next) {
366 struct sr_dev_inst *sdi = l->data;
368 sr_err("Invalid driver instance, cannot complete scan.");
374 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));