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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Standard API helper functions.
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
32 #define LOG_PREFIX "std"
35 * Standard sr_driver_init() API helper.
37 * This function can be used to simplify most driver's init() API callback.
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.
42 * @param di The driver instance to use.
43 * @param sr_ctx The libsigrok context to assign.
45 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
47 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
49 struct drv_context *drvc;
51 drvc = g_malloc0(sizeof(struct drv_context));
52 drvc->sr_ctx = sr_ctx;
53 drvc->instances = NULL;
60 * Standard driver cleanup() callback API helper
62 * @param di The driver instance to use.
64 * Frees all device instances by calling sr_dev_clear() and then releases any
65 * resources allocated by std_init().
67 * @retval SR_OK Success
68 * @retval SR_ERR_ARG Invalid driver
71 SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
75 ret = sr_dev_clear(di);
82 * Standard API helper for sending an SR_DF_HEADER packet.
84 * This function can be used to simplify most driver's
85 * dev_acquisition_start() API callback.
87 * @param sdi The device instance to use.
89 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
90 * SR_ERR upon other errors.
92 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
94 const char *prefix = sdi->driver->name;
96 struct sr_datafeed_packet packet;
97 struct sr_datafeed_header header;
99 sr_dbg("%s: Starting acquisition.", prefix);
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->name;
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 * If the open succeeded, the status field of the given sdi is set
158 * @retval SR_OK Success.
159 * @retval SR_ERR Serial port open failed.
161 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
163 struct sr_serial_dev_inst *serial;
166 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
169 sdi->status = SR_ST_ACTIVE;
175 * Standard serial driver dev_close() helper.
177 * This function can be used to implement the dev_close() driver API
178 * callback in drivers that use a serial port.
180 * After closing the port, the status field of the given sdi is set
183 * @retval SR_OK Success.
185 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
187 struct sr_serial_dev_inst *serial;
190 if (serial && sdi->status == SR_ST_ACTIVE) {
191 serial_close(serial);
192 sdi->status = SR_ST_INACTIVE;
199 * Standard sr_session_stop() API helper.
201 * This function can be used to simplify most (serial port based) driver's
202 * dev_acquisition_stop() API callback.
204 * @param sdi The device instance for which acquisition should stop.
207 * @retval SR_OK Success.
208 * @retval SR_ERR_ARG Invalid arguments.
209 * @retval SR_ERR_DEV_CLOSED Device is closed.
210 * @retval SR_ERR Other errors.
212 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi)
214 struct sr_serial_dev_inst *serial = sdi->conn;
215 const char *prefix = sdi->driver->name;
218 if (sdi->status != SR_ST_ACTIVE) {
219 sr_err("%s: Device inactive, can't stop acquisition.", prefix);
220 return SR_ERR_DEV_CLOSED;
223 sr_dbg("%s: Stopping acquisition.", prefix);
225 if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
226 sr_err("%s: Failed to remove source: %d.", prefix, ret);
230 if ((ret = sdi->driver->dev_close(sdi)) < 0) {
231 sr_err("%s: Failed to close device: %d.", prefix, ret);
235 std_session_send_df_end(sdi);
243 * Standard driver dev_clear() helper.
245 * Clear driver, this means, close all instances.
247 * This function can be used to implement the dev_clear() driver API
248 * callback. dev_close() is called before every sr_dev_inst is cleared.
250 * The only limitation is driver-specific device contexts (sdi->priv).
251 * These are freed, but any dynamic allocation within structs stored
252 * there cannot be freed.
254 * @param driver The driver which will have its instances released.
255 * @param clear_private If not NULL, this points to a function called
256 * with sdi->priv as argument. The function can then clear any device
257 * instance-specific resources kept there. It must also clear the struct
258 * pointed to by sdi->priv.
260 * @return SR_OK on success.
262 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
263 std_dev_clear_callback clear_private)
265 struct drv_context *drvc;
266 struct sr_dev_inst *sdi;
270 if (!(drvc = driver->context))
271 /* Driver was never initialized, nothing to do. */
275 for (l = drvc->instances; l; l = l->next) {
276 if (!(sdi = l->data)) {
280 if (driver->dev_close)
281 driver->dev_close(sdi);
284 #ifdef HAVE_LIBSERIALPORT
285 if (sdi->inst_type == SR_INST_SERIAL)
286 sr_serial_dev_inst_free(sdi->conn);
288 #ifdef HAVE_LIBUSB_1_0
289 if (sdi->inst_type == SR_INST_USB)
290 sr_usb_dev_inst_free(sdi->conn);
292 if (sdi->inst_type == SR_INST_SCPI)
293 sr_scpi_free(sdi->conn);
294 if (sdi->inst_type == SR_INST_MODBUS)
295 sr_modbus_free(sdi->conn);
298 /* The helper function is responsible for freeing
299 * its own sdi->priv! */
300 clear_private(sdi->priv);
304 sr_dev_inst_free(sdi);
307 g_slist_free(drvc->instances);
308 drvc->instances = NULL;
314 * Standard implementation for the driver dev_list() callback
316 * This function can be used as the dev_list callback by most drivers that use
317 * the standard helper functions. It returns the devices contained in the driver
318 * context instances list.
320 * @param di The driver instance to use.
322 * @return The list of devices/instances of this driver, or NULL upon errors
323 * or if the list is empty.
325 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
327 struct drv_context *drvc = di->context;
329 return drvc->instances;
333 * Standard scan() callback API helper.
335 * This function can be used to perform common tasks required by a driver's
336 * scan() callback. It will initialize the driver for each device on the list
337 * and add the devices on the list to the driver's device instance list.
338 * Usually it should be used as the last step in the scan() callback, right
341 * Note: This function can only be used if std_init() has been called
342 * previously by the driver.
346 * static GSList *scan(struct sr_dev_driver *di, GSList *options)
348 * struct GSList *device;
349 * struct sr_dev_inst *sdi;
351 * sdi = g_new0(sr_dev_inst, 1);
354 * devices = g_slist_append(devices, sdi);
356 * return std_scan_complete(di, devices);
360 * @param di The driver instance to use. Must not be NULL.
361 * @param devices List of newly discovered devices (struct sr_dev_inst).
363 * @return The @p devices list.
365 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
367 struct drv_context *drvc;
371 sr_err("Invalid driver instance (di), cannot complete scan.");
377 for (l = devices; l; l = l->next) {
378 struct sr_dev_inst *sdi = l->data;
380 sr_err("Invalid driver instance, cannot complete scan.");
386 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));