2 * This file is part of the sigrok 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 hw_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_hw_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_malloc0(sizeof(struct drv_context)))) {
51 sr_err("%sDriver context malloc failed.", prefix);
55 drvc->sr_ctx = sr_ctx;
62 * Standard API helper for sending an SR_DF_HEADER packet.
64 * This function can be used to simplify most driver's
65 * hw_dev_acquisition_start() API callback.
67 * @param sdi The device instance to use.
68 * @param prefix A driver-specific prefix string used for log messages.
69 * Must not be NULL. An empty string is allowed.
71 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
72 * SR_ERR upon other errors.
74 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
78 struct sr_datafeed_packet packet;
79 struct sr_datafeed_header header;
82 sr_err("Invalid prefix.");
86 sr_dbg("%sStarting acquisition.", prefix);
88 /* Send header packet to the session bus. */
89 sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
90 packet.type = SR_DF_HEADER;
91 packet.payload = (uint8_t *)&header;
92 header.feed_version = 1;
93 gettimeofday(&header.starttime, NULL);
95 if ((ret = sr_session_send(sdi, &packet)) < 0) {
96 sr_err("%sFailed to send header packet: %d.", prefix, ret);
104 * Standard sr_session_stop() API helper.
106 * This function can be used to simplify most (serial port based) driver's
107 * hw_dev_acquisition_stop() API callback.
109 * @param sdi The device instance for which acquisition should stop.
111 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
112 * @param hw_dev_close_fn Function pointer to the driver's hw_dev_close().
114 * @param serial The serial device instance (struct serial_dev_inst *).
116 * @param prefix A driver-specific prefix string used for log messages.
117 * Must not be NULL. An empty string is allowed.
119 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
120 * SR_ERR upon other errors.
122 SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
123 void *cb_data, dev_close_t hw_dev_close_fn,
124 struct sr_serial_dev_inst *serial, const char *prefix)
127 struct sr_datafeed_packet packet;
130 sr_err("Invalid prefix.");
134 if (sdi->status != SR_ST_ACTIVE) {
135 sr_err("%sDevice inactive, can't stop acquisition.", prefix);
139 sr_dbg("%sStopping acquisition.", prefix);
141 if ((ret = sr_source_remove(serial->fd)) < 0) {
142 sr_err("%sFailed to remove source: %d.", prefix, ret);
146 if ((ret = hw_dev_close_fn(sdi)) < 0) {
147 sr_err("%sFailed to close device: %d.", prefix, ret);
151 /* Send SR_DF_END packet to the session bus. */
152 sr_dbg("%sSending SR_DF_END packet.", prefix);
153 packet.type = SR_DF_END;
154 packet.payload = NULL;
155 if ((ret = sr_session_send(cb_data, &packet)) < 0) {
156 sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
164 * Standard driver dev_clear() helper.
166 * This function can be used to implement the dev_clear() driver API
167 * callback. dev_close() is called before every sr_dev_inst is cleared.
169 * The only limitation is driver-specific device contexts (sdi->priv).
170 * These are freed, but any dynamic allocation within structs stored
171 * there cannot be freed.
173 * @param driver The driver which will have its instances released.
175 * @return SR_OK on success.
177 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
178 std_dev_clear_t clear_private)
180 struct sr_dev_inst *sdi;
181 struct drv_context *drvc;
182 struct dev_context *devc;
188 for (l = drvc->instances; l; l = l->next) {
189 /* Log errors, but continue cleaning up the rest. */
190 if (!(sdi = l->data)) {
194 if (!(devc = sdi->priv)) {
198 if (driver->dev_close)
199 driver->dev_close(sdi);
202 if (sdi->inst_type == SR_INST_USB)
203 sr_usb_dev_inst_free(sdi->conn);
204 else if (sdi->inst_type == SR_INST_SERIAL)
205 sr_serial_dev_inst_free(sdi->conn);
208 clear_private(sdi->priv);
210 sr_dev_inst_free(sdi);
213 g_slist_free(drvc->instances);
214 drvc->instances = NULL;