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 #include "libsigrok.h"
23 #include "libsigrok-internal.h"
26 * Standard sr_driver_init() API helper.
28 * This function can be used to simplify most driver's init() API callback.
30 * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
31 * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
33 * @param sr_ctx The libsigrok context to assign.
34 * @param di The driver instance to use.
35 * @param prefix A driver-specific prefix string used for log messages.
37 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
38 * SR_ERR_MALLOC upon memory allocation errors.
40 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
43 struct drv_context *drvc;
46 sr_err("%sInvalid driver, cannot initialize.", prefix);
50 if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
51 sr_err("%sDriver context malloc failed.", prefix);
55 drvc->sr_ctx = sr_ctx;
56 drvc->instances = NULL;
63 * Standard API helper for sending an SR_DF_HEADER packet.
65 * This function can be used to simplify most driver's
66 * dev_acquisition_start() API callback.
68 * @param sdi The device instance to use.
69 * @param prefix A driver-specific prefix string used for log messages.
70 * Must not be NULL. An empty string is allowed.
72 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
73 * SR_ERR upon other errors.
75 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
79 struct sr_datafeed_packet packet;
80 struct sr_datafeed_header header;
83 sr_err("Invalid prefix.");
87 sr_dbg("%sStarting acquisition.", prefix);
89 /* Send header packet to the session bus. */
90 sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
91 packet.type = SR_DF_HEADER;
92 packet.payload = (uint8_t *)&header;
93 header.feed_version = 1;
94 gettimeofday(&header.starttime, NULL);
96 if ((ret = sr_session_send(sdi, &packet)) < 0) {
97 sr_err("%sFailed to send header packet: %d.", prefix, ret);
104 #ifdef HAVE_LIBSERIALPORT
107 * Standard serial driver dev_open() helper.
109 * This function can be used to implement the dev_open() driver API
110 * callback in drivers that use a serial port. The port is opened
111 * with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
113 * If the open succeeded, the status field of the given sdi is set
116 * @retval SR_OK Success.
117 * @retval SR_ERR Serial port open failed.
119 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
121 struct sr_serial_dev_inst *serial;
124 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
127 sdi->status = SR_ST_ACTIVE;
133 * Standard sr_session_stop() API helper.
135 * This function can be used to simplify most (serial port based) driver's
136 * dev_acquisition_stop() API callback.
138 * @param sdi The device instance for which acquisition should stop.
140 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
141 * @param dev_close_fn Function pointer to the driver's dev_close().
143 * @param serial The serial device instance (struct serial_dev_inst *).
145 * @param prefix A driver-specific prefix string used for log messages.
146 * Must not be NULL. An empty string is allowed.
148 * @retval SR_OK Success.
149 * @retval SR_ERR_ARG Invalid arguments.
150 * @retval SR_ERR_DEV_CLOSED Device is closed.
151 * @retval SR_ERR Other errors.
153 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
154 void *cb_data, dev_close_t dev_close_fn,
155 struct sr_serial_dev_inst *serial, const char *prefix)
158 struct sr_datafeed_packet packet;
161 sr_err("Invalid prefix.");
165 if (sdi->status != SR_ST_ACTIVE) {
166 sr_err("%sDevice inactive, can't stop acquisition.", prefix);
167 return SR_ERR_DEV_CLOSED;
170 sr_dbg("%sStopping acquisition.", prefix);
172 if ((ret = serial_source_remove(serial)) < 0) {
173 sr_err("%sFailed to remove source: %d.", prefix, ret);
177 if ((ret = dev_close_fn(sdi)) < 0) {
178 sr_err("%sFailed to close device: %d.", prefix, ret);
182 /* Send SR_DF_END packet to the session bus. */
183 sr_dbg("%sSending SR_DF_END packet.", prefix);
184 packet.type = SR_DF_END;
185 packet.payload = NULL;
186 if ((ret = sr_session_send(cb_data, &packet)) < 0) {
187 sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
197 * Standard driver dev_clear() helper.
199 * This function can be used to implement the dev_clear() driver API
200 * callback. dev_close() is called before every sr_dev_inst is cleared.
202 * The only limitation is driver-specific device contexts (sdi->priv).
203 * These are freed, but any dynamic allocation within structs stored
204 * there cannot be freed.
206 * @param driver The driver which will have its instances released.
207 * @param clear_private If not NULL, this points to a function called
208 * with sdi->priv as argument. The function can then clear any device
209 * instance-specific resources kept there. It must also clear the struct
210 * pointed to by sdi->priv.
212 * @return SR_OK on success.
214 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
215 std_dev_clear_t clear_private)
217 struct drv_context *drvc;
218 struct sr_dev_inst *sdi;
222 if (!(drvc = driver->priv))
223 /* Driver was never initialized, nothing to do. */
227 for (l = drvc->instances; l; l = l->next) {
228 if (!(sdi = l->data)) {
232 if (driver->dev_close)
233 driver->dev_close(sdi);
236 #if HAVE_LIBSERIALPORT
237 if (sdi->inst_type == SR_INST_SERIAL)
238 sr_serial_dev_inst_free(sdi->conn);
241 if (sdi->inst_type == SR_INST_USB)
242 sr_usb_dev_inst_free(sdi->conn);
244 if (sdi->inst_type == SR_INST_SCPI)
245 sr_scpi_free(sdi->conn);
248 clear_private(sdi->priv);
251 sr_dev_inst_free(sdi);
254 g_slist_free(drvc->instances);
255 drvc->instances = NULL;
260 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
262 struct sr_serial_dev_inst *serial;
265 if (serial && sdi->status == SR_ST_ACTIVE) {
266 serial_close(serial);
267 sdi->status = SR_ST_INACTIVE;