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 sr_ctx The libsigrok context to assign.
43 * @param di The driver instance to use.
44 * @param[in] prefix A driver-specific prefix string used for log messages.
46 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
48 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
51 struct drv_context *drvc;
54 sr_err("%s: Invalid driver, cannot initialize.", prefix);
58 drvc = g_malloc0(sizeof(struct drv_context));
59 drvc->sr_ctx = sr_ctx;
60 drvc->instances = NULL;
67 * Standard API helper for sending an SR_DF_HEADER packet.
69 * This function can be used to simplify most driver's
70 * dev_acquisition_start() API callback.
72 * @param sdi The device instance to use.
73 * @param prefix A driver-specific prefix string used for log messages.
74 * Must not be NULL. An empty string is allowed.
76 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
77 * SR_ERR upon other errors.
79 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
83 struct sr_datafeed_packet packet;
84 struct sr_datafeed_header header;
87 sr_err("Invalid prefix.");
91 sr_dbg("%s: Starting acquisition.", prefix);
93 /* Send header packet to the session bus. */
94 sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
95 packet.type = SR_DF_HEADER;
96 packet.payload = (uint8_t *)&header;
97 header.feed_version = 1;
98 gettimeofday(&header.starttime, NULL);
100 if ((ret = sr_session_send(sdi, &packet)) < 0) {
101 sr_err("%s: Failed to send header packet: %d.", prefix, ret);
108 #ifdef HAVE_LIBSERIALPORT
111 * Standard serial driver dev_open() helper.
113 * This function can be used to implement the dev_open() driver API
114 * callback in drivers that use a serial port. The port is opened
115 * with the SERIAL_RDWR flag.
117 * If the open succeeded, the status field of the given sdi is set
120 * @retval SR_OK Success.
121 * @retval SR_ERR Serial port open failed.
123 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
125 struct sr_serial_dev_inst *serial;
128 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
131 sdi->status = SR_ST_ACTIVE;
137 * Standard serial driver dev_close() helper.
139 * This function can be used to implement the dev_close() driver API
140 * callback in drivers that use a serial port.
142 * After closing the port, the status field of the given sdi is set
145 * @retval SR_OK Success.
147 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
149 struct sr_serial_dev_inst *serial;
152 if (serial && sdi->status == SR_ST_ACTIVE) {
153 serial_close(serial);
154 sdi->status = SR_ST_INACTIVE;
161 * Standard sr_session_stop() API helper.
163 * This function can be used to simplify most (serial port based) driver's
164 * dev_acquisition_stop() API callback.
166 * @param sdi The device instance for which acquisition should stop.
168 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
169 * @param dev_close_fn Function pointer to the driver's dev_close().
171 * @param serial The serial device instance (struct serial_dev_inst *).
173 * @param[in] prefix A driver-specific prefix string used for log messages.
174 * Must not be NULL. An empty string is allowed.
176 * @retval SR_OK Success.
177 * @retval SR_ERR_ARG Invalid arguments.
178 * @retval SR_ERR_DEV_CLOSED Device is closed.
179 * @retval SR_ERR Other errors.
181 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
182 void *cb_data, dev_close_callback dev_close_fn,
183 struct sr_serial_dev_inst *serial, const char *prefix)
186 struct sr_datafeed_packet packet;
189 sr_err("Invalid prefix.");
193 if (sdi->status != SR_ST_ACTIVE) {
194 sr_err("%s: Device inactive, can't stop acquisition.", prefix);
195 return SR_ERR_DEV_CLOSED;
198 sr_dbg("%s: Stopping acquisition.", prefix);
200 if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
201 sr_err("%s: Failed to remove source: %d.", prefix, ret);
205 if ((ret = dev_close_fn(sdi)) < 0) {
206 sr_err("%s: Failed to close device: %d.", prefix, ret);
210 /* Send SR_DF_END packet to the session bus. */
211 sr_dbg("%s: Sending SR_DF_END packet.", prefix);
212 packet.type = SR_DF_END;
213 packet.payload = NULL;
214 if ((ret = sr_session_send(cb_data, &packet)) < 0) {
215 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
225 * Standard driver dev_clear() helper.
227 * Clear driver, this means, close all instances.
229 * This function can be used to implement the dev_clear() driver API
230 * callback. dev_close() is called before every sr_dev_inst is cleared.
232 * The only limitation is driver-specific device contexts (sdi->priv).
233 * These are freed, but any dynamic allocation within structs stored
234 * there cannot be freed.
236 * @param driver The driver which will have its instances released.
237 * @param clear_private If not NULL, this points to a function called
238 * with sdi->priv as argument. The function can then clear any device
239 * instance-specific resources kept there. It must also clear the struct
240 * pointed to by sdi->priv.
242 * @return SR_OK on success.
244 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
245 std_dev_clear_callback clear_private)
247 struct drv_context *drvc;
248 struct sr_dev_inst *sdi;
252 if (!(drvc = driver->context))
253 /* Driver was never initialized, nothing to do. */
257 for (l = drvc->instances; l; l = l->next) {
258 if (!(sdi = l->data)) {
262 if (driver->dev_close)
263 driver->dev_close(sdi);
266 #ifdef HAVE_LIBSERIALPORT
267 if (sdi->inst_type == SR_INST_SERIAL)
268 sr_serial_dev_inst_free(sdi->conn);
270 #ifdef HAVE_LIBUSB_1_0
271 if (sdi->inst_type == SR_INST_USB)
272 sr_usb_dev_inst_free(sdi->conn);
274 if (sdi->inst_type == SR_INST_SCPI)
275 sr_scpi_free(sdi->conn);
276 if (sdi->inst_type == SR_INST_MODBUS)
277 sr_modbus_free(sdi->conn);
280 /* The helper function is responsible for freeing
281 * its own sdi->priv! */
282 clear_private(sdi->priv);
286 sr_dev_inst_free(sdi);
289 g_slist_free(drvc->instances);
290 drvc->instances = NULL;