2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 * Fortune Semiconductor FS9721_LP3/FS9721B protocol parser.
24 * FS9721_LP3: 4000 counts (3 3/4 digits)
25 * FS9721B/Q100: 2400 counts (3 2/3 digits)
27 * Same for both chips:
28 * - Packages: Bare die (78 pins) or QFP-100
29 * - Communication parameters: Unidirectional, 2400/8n1
30 * - The protocol seems to be exactly the same.
38 #include <libsigrok/libsigrok.h>
39 #include "libsigrok-internal.h"
41 #define LOG_PREFIX "fs9721"
43 static int parse_digit(uint8_t b)
67 sr_dbg("Invalid digit byte: 0x%02x.", b);
72 static gboolean sync_nibbles_valid(const uint8_t *buf)
76 /* Check the synchronization nibbles, and make sure they all match. */
77 for (i = 0; i < FS9721_PACKET_SIZE; i++) {
78 if (((buf[i] >> 4) & 0x0f) != (i + 1)) {
79 sr_dbg("Sync nibble in byte %d (0x%02x) is invalid.",
88 static gboolean flags_valid(const struct fs9721_info *info)
92 /* Does the packet have more than one multiplier? */
94 count += (info->is_nano) ? 1 : 0;
95 count += (info->is_micro) ? 1 : 0;
96 count += (info->is_milli) ? 1 : 0;
97 count += (info->is_kilo) ? 1 : 0;
98 count += (info->is_mega) ? 1 : 0;
100 sr_dbg("More than one multiplier detected in packet.");
104 /* Does the packet "measure" more than one type of value? */
106 count += (info->is_hz) ? 1 : 0;
107 count += (info->is_ohm) ? 1 : 0;
108 count += (info->is_farad) ? 1 : 0;
109 count += (info->is_ampere) ? 1 : 0;
110 count += (info->is_volt) ? 1 : 0;
111 count += (info->is_percent) ? 1 : 0;
113 sr_dbg("More than one measurement type detected in packet.");
117 /* Both AC and DC set? */
118 if (info->is_ac && info->is_dc) {
119 sr_dbg("Both AC and DC flags detected in packet.");
123 /* RS232 flag not set? */
124 if (!info->is_rs232) {
125 sr_dbg("No RS232 flag detected in packet.");
132 static int parse_value(const uint8_t *buf, float *result, int *exponent)
134 int i, sign, intval = 0, digits[4];
135 uint8_t digit_bytes[4];
138 /* Byte 1: LCD SEG2 */
139 sign = ((buf[1] & (1 << 3)) != 0) ? -1 : 1;
142 * Bytes 1-8: Value (4 decimal digits, sign, decimal point)
144 * Over limit: "0L" (LCD), 0x00 0x7d 0x68 0x00 (digit bytes).
147 /* Merge the two nibbles for a digit into one byte. */
148 for (i = 0; i < 4; i++) {
149 digit_bytes[i] = ((buf[1 + (i * 2)] & 0x0f) << 4);
150 digit_bytes[i] |= (buf[1 + (i * 2) + 1] & 0x0f);
152 /* Bit 7 in the byte is not part of the digit. */
153 digit_bytes[i] &= ~(1 << 7);
156 /* Check for "OL". */
157 if (digit_bytes[0] == 0x00 && digit_bytes[1] == 0x7d &&
158 digit_bytes[2] == 0x68 && digit_bytes[3] == 0x00) {
159 sr_spew("Over limit.");
164 /* Parse the digits. */
165 for (i = 0; i < 4; i++)
166 digits[i] = parse_digit(digit_bytes[i]);
167 sr_spew("Digits: %02x %02x %02x %02x (%d%d%d%d).",
168 digit_bytes[0], digit_bytes[1], digit_bytes[2], digit_bytes[3],
169 digits[0], digits[1], digits[2], digits[3]);
171 /* Merge all digits into an integer value. */
172 for (i = 0; i < 4; i++) {
177 floatval = (float)intval;
179 /* Decimal point position. */
180 if ((buf[3] & (1 << 3)) != 0) {
182 sr_spew("Decimal point after first digit.");
183 } else if ((buf[5] & (1 << 3)) != 0) {
185 sr_spew("Decimal point after second digit.");
186 } else if ((buf[7] & (1 << 3)) != 0) {
188 sr_spew("Decimal point after third digit.");
191 sr_spew("No decimal point in the number.");
197 sr_spew("The display value is %f.", floatval);
204 static void parse_flags(const uint8_t *buf, struct fs9721_info *info)
206 /* Byte 0: LCD SEG1 */
207 info->is_ac = (buf[0] & (1 << 3)) != 0;
208 info->is_dc = (buf[0] & (1 << 2)) != 0;
209 info->is_auto = (buf[0] & (1 << 1)) != 0;
210 info->is_rs232 = (buf[0] & (1 << 0)) != 0;
212 /* Byte 1: LCD SEG2 */
213 info->is_sign = (buf[1] & (1 << 3)) != 0;
215 /* Byte 9: LCD SEG10 */
216 info->is_micro = (buf[9] & (1 << 3)) != 0;
217 info->is_nano = (buf[9] & (1 << 2)) != 0;
218 info->is_kilo = (buf[9] & (1 << 1)) != 0;
219 info->is_diode = (buf[9] & (1 << 0)) != 0;
221 /* Byte 10: LCD SEG11 */
222 info->is_milli = (buf[10] & (1 << 3)) != 0;
223 info->is_percent = (buf[10] & (1 << 2)) != 0;
224 info->is_mega = (buf[10] & (1 << 1)) != 0;
225 info->is_beep = (buf[10] & (1 << 0)) != 0;
227 /* Byte 11: LCD SEG12 */
228 info->is_farad = (buf[11] & (1 << 3)) != 0;
229 info->is_ohm = (buf[11] & (1 << 2)) != 0;
230 info->is_rel = (buf[11] & (1 << 1)) != 0;
231 info->is_hold = (buf[11] & (1 << 0)) != 0;
233 /* Byte 12: LCD SEG13 */
234 info->is_ampere = (buf[12] & (1 << 3)) != 0;
235 info->is_volt = (buf[12] & (1 << 2)) != 0;
236 info->is_hz = (buf[12] & (1 << 1)) != 0;
237 info->is_bat = (buf[12] & (1 << 0)) != 0;
239 /* Byte 13: LCD SEG14 */
240 info->is_c2c1_11 = (buf[13] & (1 << 3)) != 0;
241 info->is_c2c1_10 = (buf[13] & (1 << 2)) != 0;
242 info->is_c2c1_01 = (buf[13] & (1 << 1)) != 0;
243 info->is_c2c1_00 = (buf[13] & (1 << 0)) != 0;
246 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
247 int *exponent, const struct fs9721_info *info)
260 *floatval *= powf(10, *exponent);
262 /* Measurement modes */
264 analog->meaning->mq = SR_MQ_VOLTAGE;
265 analog->meaning->unit = SR_UNIT_VOLT;
267 if (info->is_ampere) {
268 analog->meaning->mq = SR_MQ_CURRENT;
269 analog->meaning->unit = SR_UNIT_AMPERE;
272 analog->meaning->mq = SR_MQ_RESISTANCE;
273 analog->meaning->unit = SR_UNIT_OHM;
276 analog->meaning->mq = SR_MQ_FREQUENCY;
277 analog->meaning->unit = SR_UNIT_HERTZ;
279 if (info->is_farad) {
280 analog->meaning->mq = SR_MQ_CAPACITANCE;
281 analog->meaning->unit = SR_UNIT_FARAD;
284 analog->meaning->mq = SR_MQ_CONTINUITY;
285 analog->meaning->unit = SR_UNIT_BOOLEAN;
286 *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
288 if (info->is_diode) {
289 analog->meaning->mq = SR_MQ_VOLTAGE;
290 analog->meaning->unit = SR_UNIT_VOLT;
292 if (info->is_percent) {
293 analog->meaning->mq = SR_MQ_DUTY_CYCLE;
294 analog->meaning->unit = SR_UNIT_PERCENTAGE;
297 /* Measurement related flags */
299 analog->meaning->mqflags |= SR_MQFLAG_AC;
301 analog->meaning->mqflags |= SR_MQFLAG_DC;
303 analog->meaning->mqflags |= SR_MQFLAG_AUTORANGE;
305 analog->meaning->mqflags |= SR_MQFLAG_DIODE;
307 analog->meaning->mqflags |= SR_MQFLAG_HOLD;
309 analog->meaning->mqflags |= SR_MQFLAG_RELATIVE;
313 sr_spew("RS232 enabled.");
315 sr_spew("Battery is low.");
316 if (info->is_c2c1_00)
317 sr_spew("User-defined LCD symbol 0 is active.");
318 if (info->is_c2c1_01)
319 sr_spew("User-defined LCD symbol 1 is active.");
320 if (info->is_c2c1_10)
321 sr_spew("User-defined LCD symbol 2 is active.");
322 if (info->is_c2c1_11)
323 sr_spew("User-defined LCD symbol 3 is active.");
326 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf)
328 struct fs9721_info info;
330 parse_flags(buf, &info);
332 return (sync_nibbles_valid(buf) && flags_valid(&info));
336 * Parse a protocol packet.
338 * @param buf Buffer containing the 14-byte protocol packet. Must not be NULL.
339 * @param floatval Pointer to a float variable. That variable will contain the
340 * result value upon parsing success. Must not be NULL.
341 * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
342 * filled with data according to the protocol packet.
344 * @param info Pointer to a struct fs9721_info. The struct will be filled
345 * with data according to the protocol packet. Must not be NULL.
347 * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
348 * 'analog' variable contents are undefined and should not be used.
350 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
351 struct sr_datafeed_analog *analog, void *info)
353 int ret, exponent = 0;
354 struct fs9721_info *info_local;
356 info_local = (struct fs9721_info *)info;
358 if ((ret = parse_value(buf, floatval, &exponent)) != SR_OK) {
359 sr_dbg("Error parsing value: %d.", ret);
363 parse_flags(buf, info_local);
364 handle_flags(analog, floatval, &exponent, info_local);
366 analog->encoding->digits = -exponent;
367 analog->spec->spec_digits = -exponent;
372 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info)
374 struct fs9721_info *info_local;
376 info_local = (struct fs9721_info *)info;
378 /* User-defined FS9721_LP3 flag 'c2c1_00' means temperature (C). */
379 if (info_local->is_c2c1_00) {
380 analog->meaning->mq = SR_MQ_TEMPERATURE;
381 analog->meaning->unit = SR_UNIT_CELSIUS;
385 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info)
387 struct fs9721_info *info_local;
389 info_local = (struct fs9721_info *)info;
391 /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
392 if (info_local->is_c2c1_01) {
393 analog->meaning->mq = SR_MQ_TEMPERATURE;
394 analog->meaning->unit = SR_UNIT_CELSIUS;
398 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info)
400 struct fs9721_info *info_local;
402 info_local = (struct fs9721_info *)info;
404 /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
405 if (info_local->is_c2c1_10) {
406 analog->meaning->mq = SR_MQ_TEMPERATURE;
407 analog->meaning->unit = SR_UNIT_CELSIUS;
411 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info)
413 struct fs9721_info *info_local;
415 info_local = (struct fs9721_info *)info;
417 /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (F). */
418 if (info_local->is_c2c1_01) {
419 analog->meaning->mq = SR_MQ_TEMPERATURE;
420 analog->meaning->unit = SR_UNIT_FAHRENHEIT;
423 /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
424 if (info_local->is_c2c1_10) {
425 analog->meaning->mq = SR_MQ_TEMPERATURE;
426 analog->meaning->unit = SR_UNIT_CELSIUS;
430 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info)
432 struct fs9721_info *info_local;
434 info_local = (struct fs9721_info *)info;
436 /* User-defined FS9721_LP3 flag 'c2c1_00' means MAX. */
437 if (info_local->is_c2c1_00)
438 analog->meaning->mqflags |= SR_MQFLAG_MAX;
440 /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
441 if (info_local->is_c2c1_01) {
442 analog->meaning->mq = SR_MQ_TEMPERATURE;
443 analog->meaning->unit = SR_UNIT_CELSIUS;
446 /* User-defined FS9721_LP3 flag 'c2c1_11' means MIN. */
447 if (info_local->is_c2c1_11)
448 analog->meaning->mqflags |= SR_MQFLAG_MIN;