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, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 * Fortune Semiconductor FS9721_LP3/FS9721B protocol parser.
25 * FS9721_LP3: 4000 counts (3 3/4 digits)
26 * FS9721B/Q100: 2400 counts (3 2/3 digits)
28 * Same for both chips:
29 * - Packages: Bare die (78 pins) or QFP-100
30 * - Communication parameters: Unidirectional, 2400/8n1
31 * - The protocol seems to be exactly the same.
38 #include "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)
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.");
190 sr_spew("No decimal point in the number.");
196 sr_spew("The display value is %f.", floatval);
203 static void parse_flags(const uint8_t *buf, struct fs9721_info *info)
205 /* Byte 0: LCD SEG1 */
206 info->is_ac = (buf[0] & (1 << 3)) != 0;
207 info->is_dc = (buf[0] & (1 << 2)) != 0;
208 info->is_auto = (buf[0] & (1 << 1)) != 0;
209 info->is_rs232 = (buf[0] & (1 << 0)) != 0;
211 /* Byte 1: LCD SEG2 */
212 info->is_sign = (buf[1] & (1 << 3)) != 0;
214 /* Byte 9: LCD SEG10 */
215 info->is_micro = (buf[9] & (1 << 3)) != 0;
216 info->is_nano = (buf[9] & (1 << 2)) != 0;
217 info->is_kilo = (buf[9] & (1 << 1)) != 0;
218 info->is_diode = (buf[9] & (1 << 0)) != 0;
220 /* Byte 10: LCD SEG11 */
221 info->is_milli = (buf[10] & (1 << 3)) != 0;
222 info->is_percent = (buf[10] & (1 << 2)) != 0;
223 info->is_mega = (buf[10] & (1 << 1)) != 0;
224 info->is_beep = (buf[10] & (1 << 0)) != 0;
226 /* Byte 11: LCD SEG12 */
227 info->is_farad = (buf[11] & (1 << 3)) != 0;
228 info->is_ohm = (buf[11] & (1 << 2)) != 0;
229 info->is_rel = (buf[11] & (1 << 1)) != 0;
230 info->is_hold = (buf[11] & (1 << 0)) != 0;
232 /* Byte 12: LCD SEG13 */
233 info->is_ampere = (buf[12] & (1 << 3)) != 0;
234 info->is_volt = (buf[12] & (1 << 2)) != 0;
235 info->is_hz = (buf[12] & (1 << 1)) != 0;
236 info->is_bat = (buf[12] & (1 << 0)) != 0;
238 /* Byte 13: LCD SEG14 */
239 info->is_c2c1_11 = (buf[13] & (1 << 3)) != 0;
240 info->is_c2c1_10 = (buf[13] & (1 << 2)) != 0;
241 info->is_c2c1_01 = (buf[13] & (1 << 1)) != 0;
242 info->is_c2c1_00 = (buf[13] & (1 << 0)) != 0;
245 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
246 const struct fs9721_info *info)
250 *floatval /= 1000000000;
252 *floatval /= 1000000;
258 *floatval *= 1000000;
260 /* Measurement modes */
262 analog->mq = SR_MQ_VOLTAGE;
263 analog->unit = SR_UNIT_VOLT;
265 if (info->is_ampere) {
266 analog->mq = SR_MQ_CURRENT;
267 analog->unit = SR_UNIT_AMPERE;
270 analog->mq = SR_MQ_RESISTANCE;
271 analog->unit = SR_UNIT_OHM;
274 analog->mq = SR_MQ_FREQUENCY;
275 analog->unit = SR_UNIT_HERTZ;
277 if (info->is_farad) {
278 analog->mq = SR_MQ_CAPACITANCE;
279 analog->unit = SR_UNIT_FARAD;
282 analog->mq = SR_MQ_CONTINUITY;
283 analog->unit = SR_UNIT_BOOLEAN;
284 *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
286 if (info->is_diode) {
287 analog->mq = SR_MQ_VOLTAGE;
288 analog->unit = SR_UNIT_VOLT;
290 if (info->is_percent) {
291 analog->mq = SR_MQ_DUTY_CYCLE;
292 analog->unit = SR_UNIT_PERCENTAGE;
295 /* Measurement related flags */
297 analog->mqflags |= SR_MQFLAG_AC;
299 analog->mqflags |= SR_MQFLAG_DC;
301 analog->mqflags |= SR_MQFLAG_AUTORANGE;
303 analog->mqflags |= SR_MQFLAG_DIODE;
305 analog->mqflags |= SR_MQFLAG_HOLD;
307 analog->mqflags |= SR_MQFLAG_RELATIVE;
311 sr_spew("RS232 enabled.");
313 sr_spew("Battery is low.");
314 if (info->is_c2c1_00)
315 sr_spew("User-defined LCD symbol 0 is active.");
316 if (info->is_c2c1_01)
317 sr_spew("User-defined LCD symbol 1 is active.");
318 if (info->is_c2c1_10)
319 sr_spew("User-defined LCD symbol 2 is active.");
320 if (info->is_c2c1_11)
321 sr_spew("User-defined LCD symbol 3 is active.");
324 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf)
326 struct fs9721_info info;
328 parse_flags(buf, &info);
330 return (sync_nibbles_valid(buf) && flags_valid(&info));
334 * Parse a protocol packet.
336 * @param buf Buffer containing the 14-byte protocol packet. Must not be NULL.
337 * @param floatval Pointer to a float variable. That variable will contain the
338 * result value upon parsing success. Mut not be NULL.
339 * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
340 * filled with data according to the protocol packet.
342 * @param info Pointer to a struct fs9721_info. The struct will be filled
343 * with data according to the protocol packet. Must not be NULL.
345 * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
346 * 'analog' variable contents are undefined and should not be used.
348 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
349 struct sr_datafeed_analog *analog, void *info)
352 struct fs9721_info *info_local;
354 info_local = (struct fs9721_info *)info;
356 if ((ret = parse_value(buf, floatval)) != SR_OK) {
357 sr_dbg("Error parsing value: %d.", ret);
361 parse_flags(buf, info_local);
362 handle_flags(analog, floatval, info_local);
367 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info)
369 struct fs9721_info *info_local;
371 info_local = (struct fs9721_info *)info;
373 /* User-defined FS9721_LP3 flag 'c2c1_00' means temperature (C). */
374 if (info_local->is_c2c1_00) {
375 analog->mq = SR_MQ_TEMPERATURE;
376 analog->unit = SR_UNIT_CELSIUS;
380 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info)
382 struct fs9721_info *info_local;
384 info_local = (struct fs9721_info *)info;
386 /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
387 if (info_local->is_c2c1_01) {
388 analog->mq = SR_MQ_TEMPERATURE;
389 analog->unit = SR_UNIT_CELSIUS;
393 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info)
395 struct fs9721_info *info_local;
397 info_local = (struct fs9721_info *)info;
399 /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
400 if (info_local->is_c2c1_10) {
401 analog->mq = SR_MQ_TEMPERATURE;
402 analog->unit = SR_UNIT_CELSIUS;
406 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info)
408 struct fs9721_info *info_local;
410 info_local = (struct fs9721_info *)info;
412 /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (F). */
413 if (info_local->is_c2c1_01) {
414 analog->mq = SR_MQ_TEMPERATURE;
415 analog->unit = SR_UNIT_FAHRENHEIT;
418 /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
419 if (info_local->is_c2c1_10) {
420 analog->mq = SR_MQ_TEMPERATURE;
421 analog->unit = SR_UNIT_CELSIUS;
425 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info)
427 struct fs9721_info *info_local;
429 info_local = (struct fs9721_info *)info;
431 /* User-defined FS9721_LP3 flag 'c2c1_00' means MAX. */
432 if (info_local->is_c2c1_00)
433 analog->mqflags |= SR_MQFLAG_MAX;
435 /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
436 if (info_local->is_c2c1_01) {
437 analog->mq = SR_MQ_TEMPERATURE;
438 analog->unit = SR_UNIT_CELSIUS;
441 /* User-defined FS9721_LP3 flag 'c2c1_11' means MIN. */
442 if (info_local->is_c2c1_11)
443 analog->mqflags |= SR_MQFLAG_MIN;