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