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.h"
28 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "std"
33 * Standard sr_driver_init() API helper.
35 * This function can be used to simplify most driver's init() API callback.
37 * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
38 * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
40 * @param sr_ctx The libsigrok context to assign.
41 * @param di The driver instance to use.
42 * @param[in] prefix A driver-specific prefix string used for log messages.
44 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
45 * SR_ERR_MALLOC upon memory allocation errors.
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 if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
58 sr_err("%s: Driver context malloc failed.", prefix);
62 drvc->sr_ctx = sr_ctx;
63 drvc->instances = NULL;
70 * Standard API helper for sending an SR_DF_HEADER packet.
72 * This function can be used to simplify most driver's
73 * dev_acquisition_start() API callback.
75 * @param sdi The device instance to use.
76 * @param prefix A driver-specific prefix string used for log messages.
77 * Must not be NULL. An empty string is allowed.
79 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
80 * SR_ERR upon other errors.
82 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
86 struct sr_datafeed_packet packet;
87 struct sr_datafeed_header header;
90 sr_err("Invalid prefix.");
94 sr_dbg("%s: Starting acquisition.", prefix);
96 /* Send header packet to the session bus. */
97 sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
98 packet.type = SR_DF_HEADER;
99 packet.payload = (uint8_t *)&header;
100 header.feed_version = 1;
101 gettimeofday(&header.starttime, NULL);
103 if ((ret = sr_session_send(sdi, &packet)) < 0) {
104 sr_err("%s: Failed to send header packet: %d.", prefix, ret);
111 #ifdef HAVE_LIBSERIALPORT
114 * Standard serial driver dev_open() helper.
116 * This function can be used to implement the dev_open() driver API
117 * callback in drivers that use a serial port. The port is opened
118 * with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
120 * If the open succeeded, the status field of the given sdi is set
123 * @retval SR_OK Success.
124 * @retval SR_ERR Serial port open failed.
126 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
128 struct sr_serial_dev_inst *serial;
131 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
134 sdi->status = SR_ST_ACTIVE;
140 * Standard serial driver dev_close() helper.
142 * This function can be used to implement the dev_close() driver API
143 * callback in drivers that use a serial port.
145 * After closing the port, the status field of the given sdi is set
148 * @retval SR_OK Success.
150 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
152 struct sr_serial_dev_inst *serial;
155 if (serial && sdi->status == SR_ST_ACTIVE) {
156 serial_close(serial);
157 sdi->status = SR_ST_INACTIVE;
164 * Standard sr_session_stop() API helper.
166 * This function can be used to simplify most (serial port based) driver's
167 * dev_acquisition_stop() API callback.
169 * @param sdi The device instance for which acquisition should stop.
171 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
172 * @param dev_close_fn Function pointer to the driver's dev_close().
174 * @param serial The serial device instance (struct serial_dev_inst *).
176 * @param[in] prefix A driver-specific prefix string used for log messages.
177 * Must not be NULL. An empty string is allowed.
179 * @retval SR_OK Success.
180 * @retval SR_ERR_ARG Invalid arguments.
181 * @retval SR_ERR_DEV_CLOSED Device is closed.
182 * @retval SR_ERR Other errors.
184 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
185 void *cb_data, dev_close_t dev_close_fn,
186 struct sr_serial_dev_inst *serial, const char *prefix)
189 struct sr_datafeed_packet packet;
192 sr_err("Invalid prefix.");
196 if (sdi->status != SR_ST_ACTIVE) {
197 sr_err("%s: Device inactive, can't stop acquisition.", prefix);
198 return SR_ERR_DEV_CLOSED;
201 sr_dbg("%s: Stopping acquisition.", prefix);
203 if ((ret = serial_source_remove(serial)) < 0) {
204 sr_err("%s: Failed to remove source: %d.", prefix, ret);
208 if ((ret = dev_close_fn(sdi)) < 0) {
209 sr_err("%s: Failed to close device: %d.", prefix, ret);
213 /* Send SR_DF_END packet to the session bus. */
214 sr_dbg("%s: Sending SR_DF_END packet.", prefix);
215 packet.type = SR_DF_END;
216 packet.payload = NULL;
217 if ((ret = sr_session_send(cb_data, &packet)) < 0) {
218 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
228 * Standard driver dev_clear() helper.
230 * Clear driver, this means, close all instances.
232 * This function can be used to implement the dev_clear() driver API
233 * callback. dev_close() is called before every sr_dev_inst is cleared.
235 * The only limitation is driver-specific device contexts (sdi->priv).
236 * These are freed, but any dynamic allocation within structs stored
237 * there cannot be freed.
239 * @param driver The driver which will have its instances released.
240 * @param clear_private If not NULL, this points to a function called
241 * with sdi->priv as argument. The function can then clear any device
242 * instance-specific resources kept there. It must also clear the struct
243 * pointed to by sdi->priv.
245 * @return SR_OK on success.
247 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
248 std_dev_clear_t clear_private)
250 struct drv_context *drvc;
251 struct sr_dev_inst *sdi;
255 if (!(drvc = driver->priv))
256 /* Driver was never initialized, nothing to do. */
260 for (l = drvc->instances; l; l = l->next) {
261 if (!(sdi = l->data)) {
265 if (driver->dev_close)
266 driver->dev_close(sdi);
269 #ifdef HAVE_LIBSERIALPORT
270 if (sdi->inst_type == SR_INST_SERIAL)
271 sr_serial_dev_inst_free(sdi->conn);
273 #ifdef HAVE_LIBUSB_1_0
274 if (sdi->inst_type == SR_INST_USB)
275 sr_usb_dev_inst_free(sdi->conn);
277 if (sdi->inst_type == SR_INST_SCPI)
278 sr_scpi_free(sdi->conn);
281 clear_private(sdi->priv);
284 sr_dev_inst_free(sdi);
287 g_slist_free(drvc->instances);
288 drvc->instances = NULL;