]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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 | |
19 | */ | |
20 | ||
21 | /** @file | |
22 | * Standard API helper functions. | |
23 | * @internal | |
24 | */ | |
25 | ||
26 | #include <glib.h> | |
27 | #include "libsigrok.h" | |
28 | #include "libsigrok-internal.h" | |
29 | ||
30 | #define LOG_PREFIX "std" | |
31 | ||
32 | /** | |
33 | * Standard sr_driver_init() API helper. | |
34 | * | |
35 | * This function can be used to simplify most driver's init() API callback. | |
36 | * | |
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. | |
39 | * | |
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. | |
43 | * | |
44 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. | |
45 | */ | |
46 | SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, | |
47 | const char *prefix) | |
48 | { | |
49 | struct drv_context *drvc; | |
50 | ||
51 | if (!di) { | |
52 | sr_err("%s: Invalid driver, cannot initialize.", prefix); | |
53 | return SR_ERR_ARG; | |
54 | } | |
55 | ||
56 | drvc = g_malloc0(sizeof(struct drv_context)); | |
57 | drvc->sr_ctx = sr_ctx; | |
58 | drvc->instances = NULL; | |
59 | di->priv = drvc; | |
60 | ||
61 | return SR_OK; | |
62 | } | |
63 | ||
64 | /** | |
65 | * Standard API helper for sending an SR_DF_HEADER packet. | |
66 | * | |
67 | * This function can be used to simplify most driver's | |
68 | * dev_acquisition_start() API callback. | |
69 | * | |
70 | * @param sdi The device instance to use. | |
71 | * @param prefix A driver-specific prefix string used for log messages. | |
72 | * Must not be NULL. An empty string is allowed. | |
73 | * | |
74 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
75 | * SR_ERR upon other errors. | |
76 | */ | |
77 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, | |
78 | const char *prefix) | |
79 | { | |
80 | int ret; | |
81 | struct sr_datafeed_packet packet; | |
82 | struct sr_datafeed_header header; | |
83 | ||
84 | if (!prefix) { | |
85 | sr_err("Invalid prefix."); | |
86 | return SR_ERR_ARG; | |
87 | } | |
88 | ||
89 | sr_dbg("%s: Starting acquisition.", prefix); | |
90 | ||
91 | /* Send header packet to the session bus. */ | |
92 | sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix); | |
93 | packet.type = SR_DF_HEADER; | |
94 | packet.payload = (uint8_t *)&header; | |
95 | header.feed_version = 1; | |
96 | gettimeofday(&header.starttime, NULL); | |
97 | ||
98 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
99 | sr_err("%s: Failed to send header packet: %d.", prefix, ret); | |
100 | return ret; | |
101 | } | |
102 | ||
103 | return SR_OK; | |
104 | } | |
105 | ||
106 | #ifdef HAVE_LIBSERIALPORT | |
107 | ||
108 | /** | |
109 | * Standard serial driver dev_open() helper. | |
110 | * | |
111 | * This function can be used to implement the dev_open() driver API | |
112 | * callback in drivers that use a serial port. The port is opened | |
113 | * with the SERIAL_RDWR flag. | |
114 | * | |
115 | * If the open succeeded, the status field of the given sdi is set | |
116 | * to SR_ST_ACTIVE. | |
117 | * | |
118 | * @retval SR_OK Success. | |
119 | * @retval SR_ERR Serial port open failed. | |
120 | */ | |
121 | SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi) | |
122 | { | |
123 | struct sr_serial_dev_inst *serial; | |
124 | ||
125 | serial = sdi->conn; | |
126 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) | |
127 | return SR_ERR; | |
128 | ||
129 | sdi->status = SR_ST_ACTIVE; | |
130 | ||
131 | return SR_OK; | |
132 | } | |
133 | ||
134 | /** | |
135 | * Standard serial driver dev_close() helper. | |
136 | * | |
137 | * This function can be used to implement the dev_close() driver API | |
138 | * callback in drivers that use a serial port. | |
139 | * | |
140 | * After closing the port, the status field of the given sdi is set | |
141 | * to SR_ST_INACTIVE. | |
142 | * | |
143 | * @retval SR_OK Success. | |
144 | */ | |
145 | SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) | |
146 | { | |
147 | struct sr_serial_dev_inst *serial; | |
148 | ||
149 | serial = sdi->conn; | |
150 | if (serial && sdi->status == SR_ST_ACTIVE) { | |
151 | serial_close(serial); | |
152 | sdi->status = SR_ST_INACTIVE; | |
153 | } | |
154 | ||
155 | return SR_OK; | |
156 | } | |
157 | ||
158 | /** | |
159 | * Standard sr_session_stop() API helper. | |
160 | * | |
161 | * This function can be used to simplify most (serial port based) driver's | |
162 | * dev_acquisition_stop() API callback. | |
163 | * | |
164 | * @param sdi The device instance for which acquisition should stop. | |
165 | * Must not be NULL. | |
166 | * @param cb_data Opaque 'cb_data' pointer. Must not be NULL. | |
167 | * @param dev_close_fn Function pointer to the driver's dev_close(). | |
168 | * Must not be NULL. | |
169 | * @param serial The serial device instance (struct serial_dev_inst *). | |
170 | * Must not be NULL. | |
171 | * @param[in] prefix A driver-specific prefix string used for log messages. | |
172 | * Must not be NULL. An empty string is allowed. | |
173 | * | |
174 | * @retval SR_OK Success. | |
175 | * @retval SR_ERR_ARG Invalid arguments. | |
176 | * @retval SR_ERR_DEV_CLOSED Device is closed. | |
177 | * @retval SR_ERR Other errors. | |
178 | */ | |
179 | SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, | |
180 | void *cb_data, dev_close_callback dev_close_fn, | |
181 | struct sr_serial_dev_inst *serial, const char *prefix) | |
182 | { | |
183 | int ret; | |
184 | struct sr_datafeed_packet packet; | |
185 | ||
186 | if (!prefix) { | |
187 | sr_err("Invalid prefix."); | |
188 | return SR_ERR_ARG; | |
189 | } | |
190 | ||
191 | if (sdi->status != SR_ST_ACTIVE) { | |
192 | sr_err("%s: Device inactive, can't stop acquisition.", prefix); | |
193 | return SR_ERR_DEV_CLOSED; | |
194 | } | |
195 | ||
196 | sr_dbg("%s: Stopping acquisition.", prefix); | |
197 | ||
198 | if ((ret = serial_source_remove(sdi->session, serial)) < 0) { | |
199 | sr_err("%s: Failed to remove source: %d.", prefix, ret); | |
200 | return ret; | |
201 | } | |
202 | ||
203 | if ((ret = dev_close_fn(sdi)) < 0) { | |
204 | sr_err("%s: Failed to close device: %d.", prefix, ret); | |
205 | return ret; | |
206 | } | |
207 | ||
208 | /* Send SR_DF_END packet to the session bus. */ | |
209 | sr_dbg("%s: Sending SR_DF_END packet.", prefix); | |
210 | packet.type = SR_DF_END; | |
211 | packet.payload = NULL; | |
212 | if ((ret = sr_session_send(cb_data, &packet)) < 0) { | |
213 | sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret); | |
214 | return ret; | |
215 | } | |
216 | ||
217 | return SR_OK; | |
218 | } | |
219 | ||
220 | #endif | |
221 | ||
222 | /** | |
223 | * Standard driver dev_clear() helper. | |
224 | * | |
225 | * Clear driver, this means, close all instances. | |
226 | * | |
227 | * This function can be used to implement the dev_clear() driver API | |
228 | * callback. dev_close() is called before every sr_dev_inst is cleared. | |
229 | * | |
230 | * The only limitation is driver-specific device contexts (sdi->priv). | |
231 | * These are freed, but any dynamic allocation within structs stored | |
232 | * there cannot be freed. | |
233 | * | |
234 | * @param driver The driver which will have its instances released. | |
235 | * @param clear_private If not NULL, this points to a function called | |
236 | * with sdi->priv as argument. The function can then clear any device | |
237 | * instance-specific resources kept there. It must also clear the struct | |
238 | * pointed to by sdi->priv. | |
239 | * | |
240 | * @return SR_OK on success. | |
241 | */ | |
242 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, | |
243 | std_dev_clear_callback clear_private) | |
244 | { | |
245 | struct drv_context *drvc; | |
246 | struct sr_dev_inst *sdi; | |
247 | GSList *l; | |
248 | int ret; | |
249 | ||
250 | if (!(drvc = driver->priv)) | |
251 | /* Driver was never initialized, nothing to do. */ | |
252 | return SR_OK; | |
253 | ||
254 | ret = SR_OK; | |
255 | for (l = drvc->instances; l; l = l->next) { | |
256 | if (!(sdi = l->data)) { | |
257 | ret = SR_ERR_BUG; | |
258 | continue; | |
259 | } | |
260 | if (driver->dev_close) | |
261 | driver->dev_close(sdi); | |
262 | ||
263 | if (sdi->conn) { | |
264 | #ifdef HAVE_LIBSERIALPORT | |
265 | if (sdi->inst_type == SR_INST_SERIAL) | |
266 | sr_serial_dev_inst_free(sdi->conn); | |
267 | #endif | |
268 | #ifdef HAVE_LIBUSB_1_0 | |
269 | if (sdi->inst_type == SR_INST_USB) | |
270 | sr_usb_dev_inst_free(sdi->conn); | |
271 | #endif | |
272 | if (sdi->inst_type == SR_INST_SCPI) | |
273 | sr_scpi_free(sdi->conn); | |
274 | } | |
275 | if (clear_private) | |
276 | /* The helper function is responsible for freeing | |
277 | * its own sdi->priv! */ | |
278 | clear_private(sdi->priv); | |
279 | else | |
280 | g_free(sdi->priv); | |
281 | ||
282 | sr_dev_inst_free(sdi); | |
283 | } | |
284 | ||
285 | g_slist_free(drvc->instances); | |
286 | drvc->instances = NULL; | |
287 | ||
288 | return ret; | |
289 | } |