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.
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "std"
34 * Standard sr_driver_init() API helper.
36 * This function can be used to simplify most driver's init() API callback.
38 * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
39 * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
41 * @param sr_ctx The libsigrok context to assign.
42 * @param di The driver instance to use.
43 * @param[in] prefix A driver-specific prefix string used for log messages.
45 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
47 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
50 struct drv_context *drvc;
53 sr_err("%s: Invalid driver, cannot initialize.", prefix);
57 drvc = g_malloc0(sizeof(struct drv_context));
58 drvc->sr_ctx = sr_ctx;
59 drvc->instances = NULL;
66 * Standard API helper for sending an SR_DF_HEADER packet.
68 * This function can be used to simplify most driver's
69 * dev_acquisition_start() API callback.
71 * @param sdi The device instance to use.
72 * @param prefix A driver-specific prefix string used for log messages.
73 * Must not be NULL. An empty string is allowed.
75 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
76 * SR_ERR upon other errors.
78 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
82 struct sr_datafeed_packet packet;
83 struct sr_datafeed_header header;
86 sr_err("Invalid prefix.");
90 sr_dbg("%s: Starting acquisition.", prefix);
92 /* Send header packet to the session bus. */
93 sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
94 packet.type = SR_DF_HEADER;
95 packet.payload = (uint8_t *)&header;
96 header.feed_version = 1;
97 gettimeofday(&header.starttime, NULL);
99 if ((ret = sr_session_send(sdi, &packet)) < 0) {
100 sr_err("%s: Failed to send header packet: %d.", prefix, ret);
107 #ifdef HAVE_LIBSERIALPORT
110 * Standard serial driver dev_open() helper.
112 * This function can be used to implement the dev_open() driver API
113 * callback in drivers that use a serial port. The port is opened
114 * with the SERIAL_RDWR flag.
116 * If the open succeeded, the status field of the given sdi is set
119 * @retval SR_OK Success.
120 * @retval SR_ERR Serial port open failed.
122 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
124 struct sr_serial_dev_inst *serial;
127 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
130 sdi->status = SR_ST_ACTIVE;
136 * Standard serial driver dev_close() helper.
138 * This function can be used to implement the dev_close() driver API
139 * callback in drivers that use a serial port.
141 * After closing the port, the status field of the given sdi is set
144 * @retval SR_OK Success.
146 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
148 struct sr_serial_dev_inst *serial;
151 if (serial && sdi->status == SR_ST_ACTIVE) {
152 serial_close(serial);
153 sdi->status = SR_ST_INACTIVE;
160 * Standard sr_session_stop() API helper.
162 * This function can be used to simplify most (serial port based) driver's
163 * dev_acquisition_stop() API callback.
165 * @param sdi The device instance for which acquisition should stop.
167 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
168 * @param dev_close_fn Function pointer to the driver's dev_close().
170 * @param serial The serial device instance (struct serial_dev_inst *).
172 * @param[in] prefix A driver-specific prefix string used for log messages.
173 * Must not be NULL. An empty string is allowed.
175 * @retval SR_OK Success.
176 * @retval SR_ERR_ARG Invalid arguments.
177 * @retval SR_ERR_DEV_CLOSED Device is closed.
178 * @retval SR_ERR Other errors.
180 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
181 void *cb_data, dev_close_callback dev_close_fn,
182 struct sr_serial_dev_inst *serial, const char *prefix)
185 struct sr_datafeed_packet packet;
188 sr_err("Invalid prefix.");
192 if (sdi->status != SR_ST_ACTIVE) {
193 sr_err("%s: Device inactive, can't stop acquisition.", prefix);
194 return SR_ERR_DEV_CLOSED;
197 sr_dbg("%s: Stopping acquisition.", prefix);
199 if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
200 sr_err("%s: Failed to remove source: %d.", prefix, ret);
204 if ((ret = dev_close_fn(sdi)) < 0) {
205 sr_err("%s: Failed to close device: %d.", prefix, ret);
209 /* Send SR_DF_END packet to the session bus. */
210 sr_dbg("%s: Sending SR_DF_END packet.", prefix);
211 packet.type = SR_DF_END;
212 packet.payload = NULL;
213 if ((ret = sr_session_send(cb_data, &packet)) < 0) {
214 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
224 * Standard driver dev_clear() helper.
226 * Clear driver, this means, close all instances.
228 * This function can be used to implement the dev_clear() driver API
229 * callback. dev_close() is called before every sr_dev_inst is cleared.
231 * The only limitation is driver-specific device contexts (sdi->priv).
232 * These are freed, but any dynamic allocation within structs stored
233 * there cannot be freed.
235 * @param driver The driver which will have its instances released.
236 * @param clear_private If not NULL, this points to a function called
237 * with sdi->priv as argument. The function can then clear any device
238 * instance-specific resources kept there. It must also clear the struct
239 * pointed to by sdi->priv.
241 * @return SR_OK on success.
243 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
244 std_dev_clear_callback clear_private)
246 struct drv_context *drvc;
247 struct sr_dev_inst *sdi;
251 if (!(drvc = driver->context))
252 /* Driver was never initialized, nothing to do. */
256 for (l = drvc->instances; l; l = l->next) {
257 if (!(sdi = l->data)) {
261 if (driver->dev_close)
262 driver->dev_close(sdi);
265 #ifdef HAVE_LIBSERIALPORT
266 if (sdi->inst_type == SR_INST_SERIAL)
267 sr_serial_dev_inst_free(sdi->conn);
269 #ifdef HAVE_LIBUSB_1_0
270 if (sdi->inst_type == SR_INST_USB)
271 sr_usb_dev_inst_free(sdi->conn);
273 if (sdi->inst_type == SR_INST_SCPI)
274 sr_scpi_free(sdi->conn);
275 if (sdi->inst_type == SR_INST_MODBUS)
276 sr_modbus_free(sdi->conn);
279 /* The helper function is responsible for freeing
280 * its own sdi->priv! */
281 clear_private(sdi->priv);
285 sr_dev_inst_free(sdi);
288 g_slist_free(drvc->instances);
289 drvc->instances = NULL;