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"
31 * Standard sr_driver_init() API helper.
33 * This function can be used to simplify most driver's init() API callback.
35 * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
36 * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
38 * @param sr_ctx The libsigrok context to assign.
39 * @param di The driver instance to use.
40 * @param[in] prefix A driver-specific prefix string used for log messages.
42 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
43 * SR_ERR_MALLOC upon memory allocation errors.
45 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
48 struct drv_context *drvc;
51 sr_err("%sInvalid driver, cannot initialize.", prefix);
55 if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
56 sr_err("%sDriver context malloc failed.", prefix);
60 drvc->sr_ctx = sr_ctx;
61 drvc->instances = NULL;
68 * Standard API helper for sending an SR_DF_HEADER packet.
70 * This function can be used to simplify most driver's
71 * dev_acquisition_start() API callback.
73 * @param sdi The device instance to use.
74 * @param prefix A driver-specific prefix string used for log messages.
75 * Must not be NULL. An empty string is allowed.
77 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
78 * SR_ERR upon other errors.
80 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
84 struct sr_datafeed_packet packet;
85 struct sr_datafeed_header header;
88 sr_err("Invalid prefix.");
92 sr_dbg("%sStarting acquisition.", prefix);
94 /* Send header packet to the session bus. */
95 sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
96 packet.type = SR_DF_HEADER;
97 packet.payload = (uint8_t *)&header;
98 header.feed_version = 1;
99 gettimeofday(&header.starttime, NULL);
101 if ((ret = sr_session_send(sdi, &packet)) < 0) {
102 sr_err("%sFailed to send header packet: %d.", prefix, ret);
109 #ifdef HAVE_LIBSERIALPORT
112 * Standard serial driver dev_open() helper.
114 * This function can be used to implement the dev_open() driver API
115 * callback in drivers that use a serial port. The port is opened
116 * with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
118 * If the open succeeded, the status field of the given sdi is set
121 * @retval SR_OK Success.
122 * @retval SR_ERR Serial port open failed.
124 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
126 struct sr_serial_dev_inst *serial;
129 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
132 sdi->status = SR_ST_ACTIVE;
138 * Standard serial driver dev_close() helper.
140 * This function can be used to implement the dev_close() driver API
141 * callback in drivers that use a serial port.
143 * After closing the port, the status field of the given sdi is set
146 * @retval SR_OK Success.
148 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
150 struct sr_serial_dev_inst *serial;
153 if (serial && sdi->status == SR_ST_ACTIVE) {
154 serial_close(serial);
155 sdi->status = SR_ST_INACTIVE;
162 * Standard sr_session_stop() API helper.
164 * This function can be used to simplify most (serial port based) driver's
165 * dev_acquisition_stop() API callback.
167 * @param sdi The device instance for which acquisition should stop.
169 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
170 * @param dev_close_fn Function pointer to the driver's dev_close().
172 * @param serial The serial device instance (struct serial_dev_inst *).
174 * @param prefix A driver-specific prefix string used for log messages.
175 * Must not be NULL. An empty string is allowed.
177 * @retval SR_OK Success.
178 * @retval SR_ERR_ARG Invalid arguments.
179 * @retval SR_ERR_DEV_CLOSED Device is closed.
180 * @retval SR_ERR Other errors.
182 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
183 void *cb_data, dev_close_t dev_close_fn,
184 struct sr_serial_dev_inst *serial, const char *prefix)
187 struct sr_datafeed_packet packet;
190 sr_err("Invalid prefix.");
194 if (sdi->status != SR_ST_ACTIVE) {
195 sr_err("%sDevice inactive, can't stop acquisition.", prefix);
196 return SR_ERR_DEV_CLOSED;
199 sr_dbg("%sStopping acquisition.", prefix);
201 if ((ret = serial_source_remove(serial)) < 0) {
202 sr_err("%sFailed to remove source: %d.", prefix, ret);
206 if ((ret = dev_close_fn(sdi)) < 0) {
207 sr_err("%sFailed to close device: %d.", prefix, ret);
211 /* Send SR_DF_END packet to the session bus. */
212 sr_dbg("%sSending SR_DF_END packet.", prefix);
213 packet.type = SR_DF_END;
214 packet.payload = NULL;
215 if ((ret = sr_session_send(cb_data, &packet)) < 0) {
216 sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
226 * Standard driver dev_clear() helper.
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_t clear_private)
246 struct drv_context *drvc;
247 struct sr_dev_inst *sdi;
251 if (!(drvc = driver->priv))
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 #if HAVE_LIBSERIALPORT
266 if (sdi->inst_type == SR_INST_SERIAL)
267 sr_serial_dev_inst_free(sdi->conn);
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);
277 clear_private(sdi->priv);
280 sr_dev_inst_free(sdi);
283 g_slist_free(drvc->instances);
284 drvc->instances = NULL;