]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/link-mso19/protocol.c
output/vcd: Use selected probes, not lowest-numbered ones
[libsigrok.git] / hardware / link-mso19 / protocol.c
... / ...
CommitLineData
1/*
2 * This file is part of the sigrok project.
3 *
4 * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
5 * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
6 * Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#include "protocol.h"
23
24/* serial protocol */
25#define mso_trans(a, v) \
26 (((v) & 0x3f) | (((v) & 0xc0) << 6) | (((a) & 0xf) << 8) | \
27 ((~(v) & 0x20) << 1) | ((~(v) & 0x80) << 7))
28
29static const char mso_head[] = { 0x40, 0x4c, 0x44, 0x53, 0x7e };
30static const char mso_foot[] = { 0x7e };
31
32extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
33static struct sr_dev_driver *di = &link_mso19_driver_info;
34
35SR_PRIV int mso_send_control_message(struct sr_serial_dev_inst *serial,
36 uint16_t payload[], int n)
37{
38 int i, w, ret, s = n * 2 + sizeof(mso_head) + sizeof(mso_foot);
39 char *p, *buf;
40
41 ret = SR_ERR;
42
43 if (serial->fd < 0)
44 goto ret;
45
46 if (!(buf = g_try_malloc(s))) {
47 sr_err("Failed to malloc message buffer.");
48 ret = SR_ERR_MALLOC;
49 goto ret;
50 }
51
52 p = buf;
53 memcpy(p, mso_head, sizeof(mso_head));
54 p += sizeof(mso_head);
55
56 for (i = 0; i < n; i++) {
57 *(uint16_t *) p = g_htons(payload[i]);
58 p += 2;
59 }
60 memcpy(p, mso_foot, sizeof(mso_foot));
61
62 w = 0;
63 while (w < s) {
64 ret = serial_write(serial, buf + w, s - w);
65 if (ret < 0) {
66 ret = SR_ERR;
67 goto free;
68 }
69 w += ret;
70 }
71 ret = SR_OK;
72free:
73 g_free(buf);
74ret:
75 return ret;
76}
77
78SR_PRIV int mso_configure_trigger(const struct sr_dev_inst *sdi)
79{
80 struct dev_context *devc = sdi->priv;
81 uint16_t threshold_value = mso_calc_raw_from_mv(devc);
82
83 threshold_value = 0x153C;
84 uint8_t trigger_config = 0;
85
86 if (devc->trigger_slope)
87 trigger_config |= 0x04; //Trigger on falling edge
88
89 switch (devc->trigger_outsrc) {
90 case 1:
91 trigger_config |= 0x00; //Trigger pulse output
92 break;
93 case 2:
94 trigger_config |= 0x08; //PWM DAC from the pattern generator buffer
95 break;
96 case 3:
97 trigger_config |= 0x18; //White noise
98 break;
99 }
100
101 switch (devc->trigger_chan) {
102 case 0:
103 trigger_config |= 0x00; //DSO level trigger //b00000000
104 break;
105 case 1:
106 trigger_config |= 0x20; //DSO level trigger & width < trigger_width
107 break;
108 case 2:
109 trigger_config |= 0x40; //DSO level trigger & width >= trigger_width
110 break;
111 case 3:
112 trigger_config |= 0x60; //LA combination trigger
113 break;
114 }
115
116 //Last bit of trigger config reg 4 needs to be 1 for trigger enable,
117 //otherwise the trigger is not enabled
118 if (devc->use_trigger)
119 trigger_config |= 0x80;
120
121 uint16_t ops[18];
122 ops[0] = mso_trans(3, threshold_value & 0xff);
123 //The trigger_config also holds the 2 MSB bits from the threshold value
124 ops[1] = mso_trans(4, trigger_config | ((threshold_value >> 8) & 0x03));
125 ops[2] = mso_trans(5, devc->la_trigger);
126 ops[3] = mso_trans(6, devc->la_trigger_mask);
127 ops[4] = mso_trans(7, devc->trigger_holdoff[0]);
128 ops[5] = mso_trans(8, devc->trigger_holdoff[1]);
129
130 ops[6] = mso_trans(11,
131 devc->dso_trigger_width /
132 SR_HZ_TO_NS(devc->cur_rate));
133
134 /* Select the SPI/I2C trigger config bank */
135 ops[7] = mso_trans(REG_CTL2, (devc->ctlbase2 | BITS_CTL2_BANK(2)));
136 /* Configure the SPI/I2C protocol trigger */
137 ops[8] = mso_trans(REG_PT_WORD(0), devc->protocol_trigger.word[0]);
138 ops[9] = mso_trans(REG_PT_WORD(1), devc->protocol_trigger.word[1]);
139 ops[10] = mso_trans(REG_PT_WORD(2), devc->protocol_trigger.word[2]);
140 ops[11] = mso_trans(REG_PT_WORD(3), devc->protocol_trigger.word[3]);
141 ops[12] = mso_trans(REG_PT_MASK(0), devc->protocol_trigger.mask[0]);
142 ops[13] = mso_trans(REG_PT_MASK(1), devc->protocol_trigger.mask[1]);
143 ops[14] = mso_trans(REG_PT_MASK(2), devc->protocol_trigger.mask[2]);
144 ops[15] = mso_trans(REG_PT_MASK(3), devc->protocol_trigger.mask[3]);
145 ops[16] = mso_trans(REG_PT_SPIMODE, devc->protocol_trigger.spimode);
146 /* Select the default config bank */
147 ops[17] = mso_trans(REG_CTL2, devc->ctlbase2);
148
149 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
150}
151
152SR_PRIV int mso_configure_threshold_level(const struct sr_dev_inst *sdi)
153{
154 struct dev_context *devc = sdi->priv;
155
156 return mso_dac_out(sdi, la_threshold_map[devc->la_threshold]);
157}
158
159SR_PRIV int mso_read_buffer(struct sr_dev_inst *sdi)
160{
161 uint16_t ops[] = { mso_trans(REG_BUFFER, 0) };
162 struct dev_context *devc = sdi->priv;
163
164 sr_dbg("Requesting buffer dump.");
165 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
166}
167
168SR_PRIV int mso_arm(const struct sr_dev_inst *sdi)
169{
170 struct dev_context *devc = sdi->priv;
171 uint16_t ops[] = {
172 mso_trans(REG_CTL1, devc->ctlbase1 | BIT_CTL1_RESETFSM),
173 mso_trans(REG_CTL1, devc->ctlbase1 | BIT_CTL1_ARM),
174 mso_trans(REG_CTL1, devc->ctlbase1),
175 };
176
177 sr_dbg("Requesting trigger arm.");
178 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
179}
180
181SR_PRIV int mso_force_capture(struct sr_dev_inst *sdi)
182{
183 struct dev_context *devc = sdi->priv;
184 uint16_t ops[] = {
185 mso_trans(REG_CTL1, devc->ctlbase1 | 8),
186 mso_trans(REG_CTL1, devc->ctlbase1),
187 };
188
189 sr_dbg("Requesting forced capture.");
190 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
191}
192
193SR_PRIV int mso_dac_out(const struct sr_dev_inst *sdi, uint16_t val)
194{
195 struct dev_context *devc = sdi->priv;
196 uint16_t ops[] = {
197 mso_trans(REG_DAC1, (val >> 8) & 0xff),
198 mso_trans(REG_DAC2, val & 0xff),
199 mso_trans(REG_CTL1, devc->ctlbase1 | BIT_CTL1_RESETADC),
200 };
201
202 sr_dbg("Setting dac word to 0x%x.", val);
203 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
204}
205
206SR_PRIV inline uint16_t mso_calc_raw_from_mv(struct dev_context * devc)
207{
208 return (uint16_t) (0x200 -
209 ((devc->dso_trigger_voltage / devc->dso_probe_attn) /
210 devc->vbit));
211}
212
213SR_PRIV int mso_parse_serial(const char *iSerial, const char *iProduct,
214 struct dev_context *devc)
215{
216 unsigned int u1, u2, u3, u4, u5, u6;
217
218 iProduct = iProduct;
219 /* FIXME: This code is in the original app, but I think its
220 * used only for the GUI */
221 /* if (strstr(iProduct, "REV_02") || strstr(iProduct, "REV_03"))
222 devc->num_sample_rates = 0x16;
223 else
224 devc->num_sample_rates = 0x10; */
225
226 /* parse iSerial */
227 if (iSerial[0] != '4' || sscanf(iSerial, "%5u%3u%3u%1u%1u%6u",
228 &u1, &u2, &u3, &u4, &u5, &u6) != 6)
229 return SR_ERR;
230 devc->hwmodel = u4;
231 devc->hwrev = u5;
232 devc->vbit = u1 / 10000;
233 if (devc->vbit == 0)
234 devc->vbit = 4.19195;
235 devc->dac_offset = u2;
236 if (devc->dac_offset == 0)
237 devc->dac_offset = 0x1ff;
238 devc->offset_range = u3;
239 if (devc->offset_range == 0)
240 devc->offset_range = 0x17d;
241
242 /*
243 * FIXME: There is more code on the original software to handle
244 * bigger iSerial strings, but as I can't test on my device
245 * I will not implement it yet
246 */
247
248 return SR_OK;
249}
250
251SR_PRIV int mso_reset_adc(struct sr_dev_inst *sdi)
252{
253 struct dev_context *devc = sdi->priv;
254 uint16_t ops[2];
255
256 ops[0] = mso_trans(REG_CTL1, (devc->ctlbase1 | BIT_CTL1_RESETADC));
257 ops[1] = mso_trans(REG_CTL1, devc->ctlbase1);
258 devc->ctlbase1 |= BIT_CTL1_ADC_UNKNOWN4;
259
260 sr_dbg("Requesting ADC reset.");
261 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
262}
263
264SR_PRIV int mso_reset_fsm(struct sr_dev_inst *sdi)
265{
266 struct dev_context *devc = sdi->priv;
267 uint16_t ops[1];
268
269 devc->ctlbase1 |= BIT_CTL1_RESETFSM;
270 ops[0] = mso_trans(REG_CTL1, devc->ctlbase1);
271
272 sr_dbg("Requesting ADC reset.");
273 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
274}
275
276SR_PRIV int mso_toggle_led(struct sr_dev_inst *sdi, int state)
277{
278 struct dev_context *devc = sdi->priv;
279 uint16_t ops[1];
280
281 devc->ctlbase1 &= ~BIT_CTL1_LED;
282 if (state)
283 devc->ctlbase1 |= BIT_CTL1_LED;
284 ops[0] = mso_trans(REG_CTL1, devc->ctlbase1);
285
286 sr_dbg("Requesting LED toggle.");
287 return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
288}
289
290SR_PRIV void stop_acquisition(const struct sr_dev_inst *sdi)
291{
292 struct sr_datafeed_packet packet;
293 struct dev_context *devc;
294
295 devc = sdi->priv;
296 sr_source_remove(devc->serial->fd);
297
298 /* Terminate session */
299 packet.type = SR_DF_END;
300 sr_session_send(sdi, &packet);
301}
302
303SR_PRIV int mso_clkrate_out(struct sr_serial_dev_inst *serial, uint16_t val)
304{
305 uint16_t ops[] = {
306 mso_trans(REG_CLKRATE1, (val >> 8) & 0xff),
307 mso_trans(REG_CLKRATE2, val & 0xff),
308 };
309
310 sr_dbg("Setting clkrate word to 0x%x.", val);
311 return mso_send_control_message(serial, ARRAY_AND_SIZE(ops));
312}
313
314SR_PRIV int mso_configure_rate(const struct sr_dev_inst *sdi, uint32_t rate)
315{
316 struct dev_context *devc = sdi->priv;
317 unsigned int i;
318 int ret = SR_ERR;
319
320 for (i = 0; i < ARRAY_SIZE(rate_map); i++) {
321 if (rate_map[i].rate == rate) {
322 devc->ctlbase2 = rate_map[i].slowmode;
323 ret = mso_clkrate_out(devc->serial, rate_map[i].val);
324 if (ret == SR_OK)
325 devc->cur_rate = rate;
326 return ret;
327 }
328 }
329
330 if (ret != SR_OK)
331 sr_err("Unsupported rate.");
332
333 return ret;
334}
335
336SR_PRIV int mso_check_trigger(struct sr_serial_dev_inst *serial, uint8_t *info)
337{
338 uint16_t ops[] = { mso_trans(REG_TRIGGER, 0) };
339 int ret;
340
341 sr_dbg("Requesting trigger state.");
342 ret = mso_send_control_message(serial, ARRAY_AND_SIZE(ops));
343 if (info == NULL || ret != SR_OK)
344 return ret;
345
346 uint8_t buf = 0;
347 if (serial_read(serial, &buf, 1) != 1) /* FIXME: Need timeout */
348 ret = SR_ERR;
349 if (!info)
350 *info = buf;
351
352 sr_dbg("Trigger state is: 0x%x.", *info);
353 return ret;
354}
355
356SR_PRIV int mso_receive_data(int fd, int revents, void *cb_data)
357{
358 struct sr_datafeed_packet packet;
359 struct sr_datafeed_logic logic;
360 struct sr_dev_inst *sdi;
361 GSList *l;
362 int i;
363
364 struct drv_context *drvc = di->priv;
365
366 /* Find this device's devc struct by its fd. */
367 struct dev_context *devc = NULL;
368 for (l = drvc->instances; l; l = l->next) {
369 sdi = l->data;
370 devc = sdi->priv;
371 if (devc->serial->fd == fd)
372 break;
373 devc = NULL;
374 }
375 if (!devc)
376 /* Shouldn't happen. */
377 return TRUE;
378
379 (void)revents;
380
381 uint8_t in[1024];
382 size_t s = serial_read(devc->serial, in, sizeof(in));
383
384 if (s <= 0)
385 return FALSE;
386
387 /* Check if we triggered, then send a command that we are ready
388 * to read the data */
389 if (devc->trigger_state != MSO_TRIGGER_DATAREADY) {
390 devc->trigger_state = in[0];
391 if (devc->trigger_state == MSO_TRIGGER_DATAREADY) {
392 mso_read_buffer(sdi);
393 devc->buffer_n = 0;
394 } else {
395 mso_check_trigger(devc->serial, NULL);
396 }
397 return TRUE;
398 }
399
400 /* the hardware always dumps 1024 samples, 24bits each */
401 if (devc->buffer_n < 3072) {
402 memcpy(devc->buffer + devc->buffer_n, in, s);
403 devc->buffer_n += s;
404 }
405 if (devc->buffer_n < 3072)
406 return TRUE;
407
408 /* do the conversion */
409 uint8_t logic_out[1024];
410 double analog_out[1024];
411 for (i = 0; i < 1024; i++) {
412 /* FIXME: Need to do conversion to mV */
413 analog_out[i] = (devc->buffer[i * 3] & 0x3f) |
414 ((devc->buffer[i * 3 + 1] & 0xf) << 6);
415 logic_out[i] = ((devc->buffer[i * 3 + 1] & 0x30) >> 4) |
416 ((devc->buffer[i * 3 + 2] & 0x3f) << 2);
417 }
418
419 packet.type = SR_DF_LOGIC;
420 packet.payload = &logic;
421 logic.length = 1024;
422 logic.unitsize = 1;
423 logic.data = logic_out;
424 sr_session_send(cb_data, &packet);
425
426 devc->num_samples += 1024;
427
428 if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
429 sr_info("Requested number of samples reached.");
430 sdi->driver->dev_acquisition_stop(sdi, cb_data);
431 }
432
433 return TRUE;
434}
435
436SR_PRIV int mso_configure_probes(const struct sr_dev_inst *sdi)
437{
438 struct dev_context *devc;
439 struct sr_probe *probe;
440 GSList *l;
441 char *tc;
442
443 devc = sdi->priv;
444
445 devc->la_trigger_mask = 0xFF; //the mask for the LA_TRIGGER (bits set to 0 matter, those set to 1 are ignored).
446 devc->la_trigger = 0x00; //The value of the LA byte that generates a trigger event (in that mode).
447 devc->dso_trigger_voltage = 3;
448 devc->dso_probe_attn = 1;
449 devc->trigger_outsrc = 0;
450 devc->trigger_chan = 3; //LA combination trigger
451 devc->use_trigger = FALSE;
452
453 for (l = sdi->probes; l; l = l->next) {
454 probe = (struct sr_probe *)l->data;
455 if (probe->enabled == FALSE)
456 continue;
457
458 int probe_bit = 1 << (probe->index);
459 if (!(probe->trigger))
460 continue;
461
462 devc->use_trigger = TRUE;
463 //Configure trigger mask and value.
464 for (tc = probe->trigger; *tc; tc++) {
465 devc->la_trigger_mask &= ~probe_bit;
466 if (*tc == '1')
467 devc->la_trigger |= probe_bit;
468 }
469 }
470
471 return SR_OK;
472}