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