]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com> | |
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 3 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, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <config.h> | |
21 | #include "protocol.h" | |
22 | #include <time.h> | |
23 | #include <sys/timerfd.h> | |
24 | ||
25 | SR_PRIV struct sr_dev_driver baylibre_acme_driver_info; | |
26 | ||
27 | static const uint32_t devopts[] = { | |
28 | SR_CONF_CONTINUOUS | SR_CONF_SET, | |
29 | SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, | |
30 | SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET, | |
31 | SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
32 | }; | |
33 | ||
34 | /* | |
35 | * Currently there are two channel-group/probe options for ACME: | |
36 | * - SR_CONF_PROBE_FACTOR - allows to modify current shunt resistance | |
37 | * calibration | |
38 | * - SR_CONF_POWER_OFF - allows to remotely cut-off/restore power to | |
39 | * measured devices | |
40 | * | |
41 | * They are not static - we have to check each probe's capabilities in | |
42 | * config_list(). | |
43 | */ | |
44 | #define MAX_DEVOPTS_CG 2 | |
45 | #define HAS_PROBE_FACTOR (SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET) | |
46 | #define HAS_POWER_OFF (SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET) | |
47 | ||
48 | #define MAX_SAMPLE_RATE 500 /* In Hz */ | |
49 | ||
50 | static const uint64_t samplerates[] = { | |
51 | SR_HZ(1), | |
52 | SR_HZ(MAX_SAMPLE_RATE), | |
53 | SR_HZ(1), | |
54 | }; | |
55 | ||
56 | static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx) | |
57 | { | |
58 | return std_init(sr_ctx, di, LOG_PREFIX); | |
59 | } | |
60 | ||
61 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
62 | { | |
63 | struct drv_context *drvc; | |
64 | struct dev_context *devc; | |
65 | struct sr_dev_inst *sdi; | |
66 | GSList *devices; | |
67 | gboolean status; | |
68 | int i; | |
69 | ||
70 | (void)options; | |
71 | ||
72 | drvc = di->context; | |
73 | devices = NULL; | |
74 | ||
75 | devc = g_malloc0(sizeof(struct dev_context)); | |
76 | devc->samplerate = SR_HZ(10); | |
77 | ||
78 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
79 | sdi->status = SR_ST_INACTIVE; | |
80 | sdi->vendor = g_strdup("BayLibre"); | |
81 | sdi->model = g_strdup("ACME"); | |
82 | sdi->driver = di; | |
83 | sdi->priv = devc; | |
84 | ||
85 | status = bl_acme_is_sane(); | |
86 | if (!status) | |
87 | goto err_out; | |
88 | ||
89 | /* | |
90 | * Iterate over all ACME connectors and check if any probes | |
91 | * are present. | |
92 | */ | |
93 | for (i = 0; i < MAX_PROBES; i++) { | |
94 | /* | |
95 | * First check if there's an energy probe on this connector. If | |
96 | * not, and we're already at the fifth probe - see if we can | |
97 | * detect a temperature probe. | |
98 | */ | |
99 | status = bl_acme_detect_probe(bl_acme_get_enrg_addr(i), | |
100 | PROBE_NUM(i), ENRG_PROBE_NAME); | |
101 | if (status) { | |
102 | /* Energy probe detected. */ | |
103 | status = bl_acme_register_probe(sdi, PROBE_ENRG, | |
104 | bl_acme_get_enrg_addr(i), PROBE_NUM(i)); | |
105 | if (!status) { | |
106 | sr_err("Error registering power probe %d", | |
107 | PROBE_NUM(i)); | |
108 | continue; | |
109 | } | |
110 | } else if (i >= TEMP_PRB_START_INDEX) { | |
111 | status = bl_acme_detect_probe(bl_acme_get_temp_addr(i), | |
112 | PROBE_NUM(i), TEMP_PROBE_NAME); | |
113 | if (status) { | |
114 | /* Temperature probe detected. */ | |
115 | status = bl_acme_register_probe(sdi,PROBE_TEMP, | |
116 | bl_acme_get_temp_addr(i), PROBE_NUM(i)); | |
117 | if (!status) { | |
118 | sr_err("Error registering temp " | |
119 | "probe %d", PROBE_NUM(i)); | |
120 | continue; | |
121 | } | |
122 | } | |
123 | } | |
124 | } | |
125 | ||
126 | /* | |
127 | * Let's assume there's no ACME device present if no probe | |
128 | * has been registered. | |
129 | */ | |
130 | if (!sdi->channel_groups) | |
131 | goto err_out; | |
132 | ||
133 | devices = g_slist_append(devices, sdi); | |
134 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
135 | ||
136 | return devices; | |
137 | ||
138 | err_out: | |
139 | g_free(devc); | |
140 | sr_dev_inst_free(sdi); | |
141 | ||
142 | return NULL; | |
143 | } | |
144 | ||
145 | static GSList *dev_list(const struct sr_dev_driver *di) | |
146 | { | |
147 | return ((struct drv_context *)(di->context))->instances; | |
148 | } | |
149 | ||
150 | static int dev_open(struct sr_dev_inst *sdi) | |
151 | { | |
152 | (void)sdi; | |
153 | ||
154 | sdi->status = SR_ST_ACTIVE; | |
155 | ||
156 | return SR_OK; | |
157 | } | |
158 | ||
159 | static int dev_close(struct sr_dev_inst *sdi) | |
160 | { | |
161 | (void)sdi; | |
162 | ||
163 | sdi->status = SR_ST_INACTIVE; | |
164 | ||
165 | return SR_OK; | |
166 | } | |
167 | ||
168 | static int config_get(uint32_t key, GVariant **data, | |
169 | const struct sr_dev_inst *sdi, | |
170 | const struct sr_channel_group *cg) | |
171 | { | |
172 | struct dev_context *devc; | |
173 | int ret; | |
174 | uint64_t shunt; | |
175 | gboolean power_off; | |
176 | ||
177 | devc = sdi->priv; | |
178 | ||
179 | ret = SR_OK; | |
180 | switch (key) { | |
181 | case SR_CONF_LIMIT_SAMPLES: | |
182 | *data = g_variant_new_uint64(devc->limit_samples); | |
183 | break; | |
184 | case SR_CONF_LIMIT_MSEC: | |
185 | *data = g_variant_new_uint64(devc->limit_msec); | |
186 | break; | |
187 | case SR_CONF_SAMPLERATE: | |
188 | *data = g_variant_new_uint64(devc->samplerate); | |
189 | break; | |
190 | case SR_CONF_PROBE_FACTOR: | |
191 | if (!cg) | |
192 | return SR_ERR_CHANNEL_GROUP; | |
193 | ret = bl_acme_get_shunt(cg, &shunt); | |
194 | if (ret == SR_OK) | |
195 | *data = g_variant_new_uint64(shunt); | |
196 | break; | |
197 | case SR_CONF_POWER_OFF: | |
198 | if (!cg) | |
199 | return SR_ERR_CHANNEL_GROUP; | |
200 | ret = bl_acme_read_power_state(cg, &power_off); | |
201 | if (ret == SR_OK) | |
202 | *data = g_variant_new_boolean(power_off); | |
203 | break; | |
204 | default: | |
205 | return SR_ERR_NA; | |
206 | } | |
207 | ||
208 | return ret; | |
209 | } | |
210 | ||
211 | static int config_set(uint32_t key, GVariant *data, | |
212 | const struct sr_dev_inst *sdi, | |
213 | const struct sr_channel_group *cg) | |
214 | { | |
215 | struct dev_context *devc; | |
216 | uint64_t samplerate; | |
217 | int ret; | |
218 | ||
219 | if (sdi->status != SR_ST_ACTIVE) | |
220 | return SR_ERR_DEV_CLOSED; | |
221 | ||
222 | devc = sdi->priv; | |
223 | ||
224 | ret = SR_OK; | |
225 | switch (key) { | |
226 | case SR_CONF_LIMIT_SAMPLES: | |
227 | devc->limit_samples = g_variant_get_uint64(data); | |
228 | devc->limit_msec = 0; | |
229 | break; | |
230 | case SR_CONF_LIMIT_MSEC: | |
231 | devc->limit_msec = g_variant_get_uint64(data) * 1000; | |
232 | devc->limit_samples = 0; | |
233 | break; | |
234 | case SR_CONF_SAMPLERATE: | |
235 | samplerate = g_variant_get_uint64(data); | |
236 | if (samplerate > MAX_SAMPLE_RATE) { | |
237 | sr_err("Maximum sample rate is %d", MAX_SAMPLE_RATE); | |
238 | ret = SR_ERR_SAMPLERATE; | |
239 | break; | |
240 | } | |
241 | devc->samplerate = samplerate; | |
242 | bl_acme_maybe_set_update_interval(sdi, samplerate); | |
243 | break; | |
244 | case SR_CONF_PROBE_FACTOR: | |
245 | if (!cg) | |
246 | return SR_ERR_CHANNEL_GROUP; | |
247 | ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data)); | |
248 | break; | |
249 | case SR_CONF_POWER_OFF: | |
250 | if (!cg) | |
251 | return SR_ERR_CHANNEL_GROUP; | |
252 | ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data)); | |
253 | break; | |
254 | default: | |
255 | ret = SR_ERR_NA; | |
256 | } | |
257 | ||
258 | return ret; | |
259 | } | |
260 | ||
261 | static int config_list(uint32_t key, GVariant **data, | |
262 | const struct sr_dev_inst *sdi, | |
263 | const struct sr_channel_group *cg) | |
264 | { | |
265 | uint32_t devopts_cg[MAX_DEVOPTS_CG]; | |
266 | GVariant *gvar; | |
267 | GVariantBuilder gvb; | |
268 | int ret, num_devopts_cg = 0; | |
269 | ||
270 | (void)sdi; | |
271 | (void)cg; | |
272 | ||
273 | ret = SR_OK; | |
274 | if (!cg) { | |
275 | switch (key) { | |
276 | case SR_CONF_DEVICE_OPTIONS: | |
277 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
278 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); | |
279 | break; | |
280 | case SR_CONF_SAMPLERATE: | |
281 | g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}")); | |
282 | gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), | |
283 | samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t)); | |
284 | g_variant_builder_add(&gvb, "{sv}", | |
285 | "samplerate-steps", gvar); | |
286 | *data = g_variant_builder_end(&gvb); | |
287 | break; | |
288 | default: | |
289 | return SR_ERR_NA; | |
290 | } | |
291 | } else { | |
292 | switch (key) { | |
293 | case SR_CONF_DEVICE_OPTIONS: | |
294 | if (bl_acme_get_probe_type(cg) == PROBE_ENRG) | |
295 | devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR; | |
296 | if (bl_acme_probe_has_pws(cg)) | |
297 | devopts_cg[num_devopts_cg++] = HAS_POWER_OFF; | |
298 | ||
299 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
300 | devopts_cg, num_devopts_cg, sizeof(uint32_t)); | |
301 | break; | |
302 | default: | |
303 | return SR_ERR_NA; | |
304 | } | |
305 | } | |
306 | ||
307 | return ret; | |
308 | } | |
309 | ||
310 | static void dev_acquisition_close(const struct sr_dev_inst *sdi) | |
311 | { | |
312 | GSList *chl; | |
313 | struct sr_channel *ch; | |
314 | ||
315 | for (chl = sdi->channels; chl; chl = chl->next) { | |
316 | ch = chl->data; | |
317 | bl_acme_close_channel(ch); | |
318 | } | |
319 | } | |
320 | ||
321 | static int dev_acquisition_open(const struct sr_dev_inst *sdi) | |
322 | { | |
323 | GSList *chl; | |
324 | struct sr_channel *ch; | |
325 | ||
326 | for (chl = sdi->channels; chl; chl = chl->next) { | |
327 | ch = chl->data; | |
328 | if (bl_acme_open_channel(ch)) { | |
329 | sr_err("Error opening channel %s", ch->name); | |
330 | dev_acquisition_close(sdi); | |
331 | return SR_ERR; | |
332 | } | |
333 | } | |
334 | ||
335 | return 0; | |
336 | } | |
337 | ||
338 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
339 | { | |
340 | struct dev_context *devc; | |
341 | struct itimerspec tspec = { | |
342 | .it_interval = { 0, 0 }, | |
343 | .it_value = { 0, 0 } | |
344 | }; | |
345 | ||
346 | if (sdi->status != SR_ST_ACTIVE) | |
347 | return SR_ERR_DEV_CLOSED; | |
348 | ||
349 | if (dev_acquisition_open(sdi)) | |
350 | return SR_ERR; | |
351 | ||
352 | devc = sdi->priv; | |
353 | devc->samples_read = 0; | |
354 | devc->samples_missed = 0; | |
355 | devc->timer_fd = timerfd_create(CLOCK_MONOTONIC, 0); | |
356 | if (devc->timer_fd < 0) { | |
357 | sr_err("Error creating timer fd"); | |
358 | return SR_ERR; | |
359 | } | |
360 | ||
361 | tspec.it_interval.tv_sec = 0; | |
362 | tspec.it_interval.tv_nsec = SR_HZ_TO_NS(devc->samplerate); | |
363 | tspec.it_value = tspec.it_interval; | |
364 | ||
365 | if (timerfd_settime(devc->timer_fd, 0, &tspec, NULL)) { | |
366 | sr_err("Failed to set timer"); | |
367 | close(devc->timer_fd); | |
368 | return SR_ERR; | |
369 | } | |
370 | ||
371 | devc->channel = g_io_channel_unix_new(devc->timer_fd); | |
372 | g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL); | |
373 | g_io_channel_set_encoding(devc->channel, NULL, NULL); | |
374 | g_io_channel_set_buffered(devc->channel, FALSE); | |
375 | ||
376 | sr_session_source_add_channel(sdi->session, devc->channel, | |
377 | G_IO_IN | G_IO_ERR, 1000, bl_acme_receive_data, (void *)sdi); | |
378 | ||
379 | std_session_send_df_header(sdi, LOG_PREFIX); | |
380 | devc->start_time = g_get_monotonic_time(); | |
381 | ||
382 | return SR_OK; | |
383 | } | |
384 | ||
385 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) | |
386 | { | |
387 | struct dev_context *devc; | |
388 | ||
389 | devc = sdi->priv; | |
390 | ||
391 | if (sdi->status != SR_ST_ACTIVE) | |
392 | return SR_ERR_DEV_CLOSED; | |
393 | ||
394 | dev_acquisition_close(sdi); | |
395 | sr_session_source_remove_channel(sdi->session, devc->channel); | |
396 | g_io_channel_shutdown(devc->channel, FALSE, NULL); | |
397 | g_io_channel_unref(devc->channel); | |
398 | devc->channel = NULL; | |
399 | ||
400 | std_session_send_df_end(sdi, LOG_PREFIX); | |
401 | ||
402 | if (devc->samples_missed > 0) | |
403 | sr_warn("%" PRIu64 " samples missed", devc->samples_missed); | |
404 | ||
405 | return SR_OK; | |
406 | } | |
407 | ||
408 | SR_PRIV struct sr_dev_driver baylibre_acme_driver_info = { | |
409 | .name = "baylibre-acme", | |
410 | .longname = "BayLibre ACME (Another Cute Measurement Equipment)", | |
411 | .api_version = 1, | |
412 | .init = init, | |
413 | .cleanup = std_cleanup, | |
414 | .scan = scan, | |
415 | .dev_list = dev_list, | |
416 | .config_get = config_get, | |
417 | .config_set = config_set, | |
418 | .config_list = config_list, | |
419 | .dev_open = dev_open, | |
420 | .dev_close = dev_close, | |
421 | .dev_acquisition_start = dev_acquisition_start, | |
422 | .dev_acquisition_stop = dev_acquisition_stop, | |
423 | .context = NULL, | |
424 | }; |