]> sigrok.org Git - libsigrok.git/blame - src/hardware/brymen-bm86x/protocol.c
brymen-bm86x: support channel selection (enable/disable channels)
[libsigrok.git] / src / hardware / brymen-bm86x / protocol.c
CommitLineData
8d9c8554
AJ
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
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
6ec6c43b 20#include <config.h>
ecaa89af
AJ
21#include <string.h>
22#include <math.h>
8d9c8554
AJ
23#include "protocol.h"
24
ecaa89af
AJ
25#define USB_TIMEOUT 500
26
329733d9 27static const char char_map[128] = {
ecaa89af
AJ
28 [0x20] = '-',
29 [0x5F] = '0',
30 [0x50] = '1',
31 [0x6D] = '2',
32 [0x7C] = '3',
33 [0x72] = '4',
34 [0x3E] = '5',
35 [0x3F] = '6',
36 [0x54] = '7',
37 [0x7F] = '8',
38 [0x7E] = '9',
39 [0x0F] = 'C',
40 [0x27] = 'F',
41 [0x0B] = 'L',
42 [0x79] = 'd',
43 [0x10] = 'i',
44 [0x39] = 'o',
45};
46
47static int brymen_bm86x_parse_digits(const unsigned char *buf, int length,
48 char *str, float *floatval,
1baf30f5 49 char *temp_unit, int *digits, int flag)
ecaa89af
AJ
50{
51 char c, *p = str;
52 int i, ret;
53
1baf30f5
AJ
54 *digits = INT_MIN;
55
ecaa89af
AJ
56 if (buf[0] & flag)
57 *p++ = '-';
58 for (i = 0; i < length; i++) {
1baf30f5 59 if (i && i < 5 && buf[i+1] & 0x01) {
ecaa89af 60 *p++ = '.';
1baf30f5
AJ
61 *digits = 0;
62 }
ecaa89af
AJ
63 c = char_map[buf[i+1] >> 1];
64 if (i == 5 && (c == 'C' || c == 'F'))
65 *temp_unit = c;
1baf30f5 66 else if (c) {
ecaa89af 67 *p++ = c;
1baf30f5
AJ
68 (*digits)++;
69 }
ecaa89af
AJ
70 }
71 *p = 0;
72
1baf30f5
AJ
73 if (*digits < 0)
74 *digits = 0;
75
ecaa89af
AJ
76 if ((ret = sr_atof_ascii(str, floatval))) {
77 sr_dbg("invalid float string: '%s'", str);
78 return ret;
79 }
80
81 return SR_OK;
82}
83
84static void brymen_bm86x_parse(unsigned char *buf, float *floatval,
a46f869b 85 struct sr_datafeed_analog *analog)
ecaa89af
AJ
86{
87 char str[16], temp_unit;
1baf30f5 88 int ret1, ret2, digits[2], over_limit;
ecaa89af
AJ
89
90 ret1 = brymen_bm86x_parse_digits(buf+2, 6, str, &floatval[0],
1baf30f5 91 &temp_unit, &digits[0], 0x80);
ecaa89af
AJ
92 over_limit = strstr(str, "0L") || strstr(str, "0.L");
93 ret2 = brymen_bm86x_parse_digits(buf+9, 4, str, &floatval[1],
1baf30f5 94 &temp_unit, &digits[1], 0x10);
ecaa89af
AJ
95
96 /* main display */
97 if (ret1 == SR_OK || over_limit) {
98 /* SI unit */
99 if (buf[8] & 0x01) {
a46f869b
UH
100 analog[0].meaning->mq = SR_MQ_VOLTAGE;
101 analog[0].meaning->unit = SR_UNIT_VOLT;
ecaa89af 102 if (!strcmp(str, "diod"))
a46f869b 103 analog[0].meaning->mqflags |= SR_MQFLAG_DIODE;
ecaa89af 104 } else if (buf[14] & 0x80) {
a46f869b
UH
105 analog[0].meaning->mq = SR_MQ_CURRENT;
106 analog[0].meaning->unit = SR_UNIT_AMPERE;
ecaa89af 107 } else if (buf[14] & 0x20) {
a46f869b
UH
108 analog[0].meaning->mq = SR_MQ_CAPACITANCE;
109 analog[0].meaning->unit = SR_UNIT_FARAD;
ecaa89af 110 } else if (buf[14] & 0x10) {
a46f869b
UH
111 analog[0].meaning->mq = SR_MQ_CONDUCTANCE;
112 analog[0].meaning->unit = SR_UNIT_SIEMENS;
ecaa89af 113 } else if (buf[15] & 0x01) {
a46f869b
UH
114 analog[0].meaning->mq = SR_MQ_FREQUENCY;
115 analog[0].meaning->unit = SR_UNIT_HERTZ;
ecaa89af 116 } else if (buf[10] & 0x01) {
a46f869b
UH
117 analog[0].meaning->mq = SR_MQ_CONTINUITY;
118 analog[0].meaning->unit = SR_UNIT_OHM;
ecaa89af 119 } else if (buf[15] & 0x10) {
a46f869b
UH
120 analog[0].meaning->mq = SR_MQ_RESISTANCE;
121 analog[0].meaning->unit = SR_UNIT_OHM;
ecaa89af 122 } else if (buf[15] & 0x02) {
a46f869b
UH
123 analog[0].meaning->mq = SR_MQ_POWER;
124 analog[0].meaning->unit = SR_UNIT_DECIBEL_MW;
ecaa89af 125 } else if (buf[15] & 0x80) {
a46f869b
UH
126 analog[0].meaning->mq = SR_MQ_DUTY_CYCLE;
127 analog[0].meaning->unit = SR_UNIT_PERCENTAGE;
ecaa89af 128 } else if (buf[ 2] & 0x0A) {
a46f869b 129 analog[0].meaning->mq = SR_MQ_TEMPERATURE;
ecaa89af 130 if (temp_unit == 'F')
a46f869b 131 analog[0].meaning->unit = SR_UNIT_FAHRENHEIT;
ecaa89af 132 else
a46f869b 133 analog[0].meaning->unit = SR_UNIT_CELSIUS;
ecaa89af
AJ
134 }
135
136 /* when MIN MAX and AVG are displayed at the same time, remove them */
137 if ((buf[1] & 0xE0) == 0xE0)
138 buf[1] &= ~0xE0;
139
140 /* AC/DC/Auto flags */
a46f869b
UH
141 if (buf[1] & 0x10) analog[0].meaning->mqflags |= SR_MQFLAG_DC;
142 if (buf[2] & 0x01) analog[0].meaning->mqflags |= SR_MQFLAG_AC;
143 if (buf[1] & 0x01) analog[0].meaning->mqflags |= SR_MQFLAG_AUTORANGE;
144 if (buf[1] & 0x08) analog[0].meaning->mqflags |= SR_MQFLAG_HOLD;
145 if (buf[1] & 0x20) analog[0].meaning->mqflags |= SR_MQFLAG_MAX;
146 if (buf[1] & 0x40) analog[0].meaning->mqflags |= SR_MQFLAG_MIN;
147 if (buf[1] & 0x80) analog[0].meaning->mqflags |= SR_MQFLAG_AVG;
148 if (buf[3] & 0x01) analog[0].meaning->mqflags |= SR_MQFLAG_RELATIVE;
ecaa89af
AJ
149
150 /* when dBm is displayed, remove the m suffix so that it is
151 not considered as the 10e-3 SI prefix */
152 if (buf[15] & 0x02)
153 buf[15] &= ~0x04;
154
155 /* SI prefix */
d9251a2c
UH
156 if (buf[14] & 0x40) { floatval[0] *= 1e-9; digits[0] += 9; } /* n */
157 if (buf[15] & 0x08) { floatval[0] *= 1e-6; digits[0] += 6; } /* µ */
158 if (buf[15] & 0x04) { floatval[0] *= 1e-3; digits[0] += 3; } /* m */
159 if (buf[15] & 0x40) { floatval[0] *= 1e3; digits[0] -= 3; } /* k */
160 if (buf[15] & 0x20) { floatval[0] *= 1e6; digits[0] -= 6; } /* M */
ecaa89af
AJ
161
162 if (over_limit) floatval[0] = INFINITY;
1baf30f5
AJ
163
164 analog[0].encoding->digits = digits[0];
165 analog[0].spec->spec_digits = digits[0];
ecaa89af
AJ
166 }
167
168 /* secondary display */
169 if (ret2 == SR_OK) {
170 /* SI unit */
171 if (buf[14] & 0x08) {
a46f869b
UH
172 analog[1].meaning->mq = SR_MQ_VOLTAGE;
173 analog[1].meaning->unit = SR_UNIT_VOLT;
ecaa89af 174 } else if (buf[9] & 0x04) {
a46f869b
UH
175 analog[1].meaning->mq = SR_MQ_CURRENT;
176 analog[1].meaning->unit = SR_UNIT_AMPERE;
af1e487e 177 } else if (buf[9] & 0x08) {
a46f869b
UH
178 analog[1].meaning->mq = SR_MQ_CURRENT;
179 analog[1].meaning->unit = SR_UNIT_PERCENTAGE;
ecaa89af 180 } else if (buf[14] & 0x04) {
a46f869b
UH
181 analog[1].meaning->mq = SR_MQ_FREQUENCY;
182 analog[1].meaning->unit = SR_UNIT_HERTZ;
ecaa89af 183 } else if (buf[9] & 0x40) {
a46f869b 184 analog[1].meaning->mq = SR_MQ_TEMPERATURE;
ecaa89af 185 if (temp_unit == 'F')
a46f869b 186 analog[1].meaning->unit = SR_UNIT_FAHRENHEIT;
ecaa89af 187 else
a46f869b 188 analog[1].meaning->unit = SR_UNIT_CELSIUS;
ecaa89af
AJ
189 }
190
191 /* AC flag */
a46f869b 192 if (buf[9] & 0x20) analog[1].meaning->mqflags |= SR_MQFLAG_AC;
ecaa89af
AJ
193
194 /* SI prefix */
d9251a2c
UH
195 if (buf[ 9] & 0x01) { floatval[1] *= 1e-6; digits[1] += 6; } /* µ */
196 if (buf[ 9] & 0x02) { floatval[1] *= 1e-3; digits[1] += 3; } /* m */
197 if (buf[14] & 0x02) { floatval[1] *= 1e3; digits[1] -= 3; } /* k */
198 if (buf[14] & 0x01) { floatval[1] *= 1e6; digits[1] -= 6; } /* M */
1baf30f5
AJ
199
200 analog[1].encoding->digits = digits[1];
201 analog[1].spec->spec_digits = digits[1];
ecaa89af
AJ
202 }
203
204 if (buf[9] & 0x80)
205 sr_spew("Battery is low.");
206}
207
208static void brymen_bm86x_handle_packet(const struct sr_dev_inst *sdi,
209 unsigned char *buf)
210{
211 struct dev_context *devc;
212 struct sr_datafeed_packet packet;
a46f869b
UH
213 struct sr_datafeed_analog analog[2];
214 struct sr_analog_encoding encoding[2];
215 struct sr_analog_meaning meaning[2];
216 struct sr_analog_spec spec[2];
5753d2e8
GS
217 struct sr_channel *channel;
218 int sent_ch1, sent_ch2;
ecaa89af
AJ
219 float floatval[2];
220
221 devc = sdi->priv;
222
869c8375 223 /* Note: digits/spec_digits will be overridden later. */
a46f869b
UH
224 sr_analog_init(&analog[0], &encoding[0], &meaning[0], &spec[0], 0);
225 sr_analog_init(&analog[1], &encoding[1], &meaning[1], &spec[1], 0);
ecaa89af 226
ecaa89af 227 brymen_bm86x_parse(buf, floatval, analog);
5753d2e8 228 sent_ch1 = sent_ch2 = 0;
ecaa89af 229
5753d2e8
GS
230 channel = sdi->channels->data;
231 if (analog[0].meaning->mq != 0 && channel->enabled) {
ecaa89af 232 /* Got a measurement. */
5753d2e8 233 sent_ch1 = 1;
ecaa89af
AJ
234 analog[0].num_samples = 1;
235 analog[0].data = &floatval[0];
5753d2e8 236 analog[0].meaning->channels = g_slist_append(NULL, channel);
a46f869b 237 packet.type = SR_DF_ANALOG;
ecaa89af 238 packet.payload = &analog[0];
102f1239 239 sr_session_send(sdi, &packet);
a46f869b 240 g_slist_free(analog[0].meaning->channels);
ecaa89af
AJ
241 }
242
5753d2e8
GS
243 channel = sdi->channels->next->data;
244 if (analog[1].meaning->mq != 0 && channel->enabled) {
ecaa89af 245 /* Got a measurement. */
5753d2e8 246 sent_ch2 = 1;
ecaa89af
AJ
247 analog[1].num_samples = 1;
248 analog[1].data = &floatval[1];
5753d2e8 249 analog[1].meaning->channels = g_slist_append(NULL, channel);
a46f869b 250 packet.type = SR_DF_ANALOG;
ecaa89af 251 packet.payload = &analog[1];
102f1239 252 sr_session_send(sdi, &packet);
a46f869b 253 g_slist_free(analog[1].meaning->channels);
ecaa89af
AJ
254 }
255
5753d2e8 256 if (sent_ch1 || sent_ch2)
ab939ebb 257 sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
ecaa89af
AJ
258}
259
260static int brymen_bm86x_send_command(const struct sr_dev_inst *sdi)
261{
262 struct sr_usb_dev_inst *usb;
263 unsigned char buf[] = { 0x00, 0x86, 0x66 };
264 int ret;
265
266 usb = sdi->conn;
267
268 sr_dbg("Sending HID set report.");
269 ret = libusb_control_transfer(usb->devhdl,
d9251a2c 270 LIBUSB_REQUEST_TYPE_CLASS |
ecaa89af
AJ
271 LIBUSB_RECIPIENT_INTERFACE |
272 LIBUSB_ENDPOINT_OUT,
273 9, /* bRequest: HID set_report */
274 0x300, /* wValue: HID feature, report num 0 */
275 0, /* wIndex: interface 0 */
276 buf, sizeof(buf), USB_TIMEOUT);
277
278 if (ret < 0) {
279 sr_err("HID feature report error: %s.", libusb_error_name(ret));
280 return SR_ERR;
281 }
282
283 if (ret != sizeof(buf)) {
0c536bcd 284 sr_err("Short packet: sent %d/%zu bytes.", ret, sizeof(buf));
ecaa89af
AJ
285 return SR_ERR;
286 }
287
288 return SR_OK;
289}
290
291static int brymen_bm86x_read_interrupt(const struct sr_dev_inst *sdi)
292{
293 struct dev_context *devc;
294 struct sr_usb_dev_inst *usb;
295 unsigned char buf[24];
296 int ret, transferred;
297
298 devc = sdi->priv;
299 usb = sdi->conn;
300
301 sr_dbg("Reading HID interrupt report.");
302 /* Get data from EP1 using an interrupt transfer. */
303 ret = libusb_interrupt_transfer(usb->devhdl,
304 LIBUSB_ENDPOINT_IN | 1, /* EP1, IN */
305 buf, sizeof(buf),
306 &transferred, USB_TIMEOUT);
307
308 if (ret == LIBUSB_ERROR_TIMEOUT) {
309 if (++devc->interrupt_pending > 3)
310 devc->interrupt_pending = 0;
311 return SR_OK;
312 }
313
314 if (ret < 0) {
315 sr_err("USB receive error: %s.", libusb_error_name(ret));
316 return SR_ERR;
317 }
318
319 if (transferred != sizeof(buf)) {
6433156c 320 sr_err("Short packet: received %d/%zu bytes.", transferred, sizeof(buf));
ecaa89af
AJ
321 return SR_ERR;
322 }
323
324 devc->interrupt_pending = 0;
325 brymen_bm86x_handle_packet(sdi, buf);
326
327 return SR_OK;
328}
329
8d9c8554
AJ
330SR_PRIV int brymen_bm86x_receive_data(int fd, int revents, void *cb_data)
331{
ecaa89af 332 struct sr_dev_inst *sdi;
8d9c8554
AJ
333 struct dev_context *devc;
334
335 (void)fd;
ecaa89af 336 (void)revents;
8d9c8554
AJ
337
338 if (!(sdi = cb_data))
339 return TRUE;
340
341 if (!(devc = sdi->priv))
342 return TRUE;
343
ecaa89af
AJ
344 if (!devc->interrupt_pending) {
345 if (brymen_bm86x_send_command(sdi))
346 return FALSE;
347 devc->interrupt_pending = 1;
348 }
349
350 if (brymen_bm86x_read_interrupt(sdi))
351 return FALSE;
352
ab939ebb 353 if (sr_sw_limits_check(&devc->sw_limits))
d2f7c417 354 sr_dev_acquisition_stop(sdi);
8d9c8554
AJ
355
356 return TRUE;
357}