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 /* Message logging helpers with driver-specific prefix string. */
42 #define DRIVER_LOG_DOMAIN "fs9721: "
43 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
44 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
45 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
46 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
47 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
48 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
50 static int parse_digit(uint8_t b)
74 sr_err("Invalid digit byte: 0x%02x.", b);
79 static gboolean sync_nibbles_valid(const uint8_t *buf)
83 /* Check the synchronization nibbles, and make sure they all match. */
84 for (i = 0; i < FS9721_PACKET_SIZE; i++) {
85 if (((buf[i] >> 4) & 0x0f) != (i + 1)) {
86 sr_err("Sync nibble in byte %d (0x%02x) is invalid.",
95 static gboolean flags_valid(const struct fs9721_info *info)
99 /* Does the packet have more than one multiplier? */
101 count += (info->is_nano) ? 1 : 0;
102 count += (info->is_micro) ? 1 : 0;
103 count += (info->is_milli) ? 1 : 0;
104 count += (info->is_kilo) ? 1 : 0;
105 count += (info->is_mega) ? 1 : 0;
107 sr_err("More than one multiplier detected in packet.");
111 /* Does the packet "measure" more than one type of value? */
113 count += (info->is_hz) ? 1 : 0;
114 count += (info->is_ohm) ? 1 : 0;
115 count += (info->is_farad) ? 1 : 0;
116 count += (info->is_ampere) ? 1 : 0;
117 count += (info->is_volt) ? 1 : 0;
118 count += (info->is_percent) ? 1 : 0;
120 sr_err("More than one measurement type detected in packet.");
124 /* Both AC and DC set? */
125 if (info->is_ac && info->is_dc) {
126 sr_err("Both AC and DC flags detected in packet.");
130 /* RS232 flag not set? */
131 if (!info->is_rs232) {
132 sr_err("No RS232 flag detected in packet.");
139 static int parse_value(const uint8_t *buf, float *result)
141 int i, sign, intval = 0, digits[4];
142 uint8_t digit_bytes[4];
145 /* Byte 1: LCD SEG2 */
146 sign = ((buf[1] & (1 << 3)) != 0) ? -1 : 1;
149 * Bytes 1-8: Value (4 decimal digits, sign, decimal point)
151 * Over limit: "0L" (LCD), 0x00 0x7d 0x68 0x00 (digit bytes).
154 /* Merge the two nibbles for a digit into one byte. */
155 for (i = 0; i < 4; i++) {
156 digit_bytes[i] = ((buf[1 + (i * 2)] & 0x0f) << 4);
157 digit_bytes[i] |= (buf[1 + (i * 2) + 1] & 0x0f);
159 /* Bit 7 in the byte is not part of the digit. */
160 digit_bytes[i] &= ~(1 << 7);
163 /* Check for "OL". */
164 if (digit_bytes[0] == 0x00 && digit_bytes[1] == 0x7d &&
165 digit_bytes[2] == 0x68 && digit_bytes[3] == 0x00) {
166 sr_spew("Over limit.");
171 /* Parse the digits. */
172 for (i = 0; i < 4; i++)
173 digits[i] = parse_digit(digit_bytes[i]);
174 sr_spew("Digits: %02x %02x %02x %02x (%d%d%d%d).",
175 digit_bytes[0], digit_bytes[1], digit_bytes[2], digit_bytes[3],
176 digits[0], digits[1], digits[2], digits[3]);
178 /* Merge all digits into an integer value. */
179 for (i = 0; i < 4; i++) {
184 floatval = (float)intval;
186 /* Decimal point position. */
187 if ((buf[3] & (1 << 3)) != 0) {
189 sr_spew("Decimal point after first digit.");
190 } else if ((buf[5] & (1 << 3)) != 0) {
192 sr_spew("Decimal point after second digit.");
193 } else if ((buf[7] & (1 << 3)) != 0) {
195 sr_spew("Decimal point after third digit.");
197 sr_spew("No decimal point in the number.");
203 sr_spew("The display value is %f.", floatval);
210 static void parse_flags(const uint8_t *buf, struct fs9721_info *info)
212 /* Byte 0: LCD SEG1 */
213 info->is_ac = (buf[0] & (1 << 3)) != 0;
214 info->is_dc = (buf[0] & (1 << 2)) != 0;
215 info->is_auto = (buf[0] & (1 << 1)) != 0;
216 info->is_rs232 = (buf[0] & (1 << 0)) != 0;
218 /* Byte 1: LCD SEG2 */
219 info->is_sign = (buf[1] & (1 << 3)) != 0;
221 /* Byte 9: LCD SEG10 */
222 info->is_micro = (buf[9] & (1 << 3)) != 0;
223 info->is_nano = (buf[9] & (1 << 2)) != 0;
224 info->is_kilo = (buf[9] & (1 << 1)) != 0;
225 info->is_diode = (buf[9] & (1 << 0)) != 0;
227 /* Byte 10: LCD SEG11 */
228 info->is_milli = (buf[10] & (1 << 3)) != 0;
229 info->is_percent = (buf[10] & (1 << 2)) != 0;
230 info->is_mega = (buf[10] & (1 << 1)) != 0;
231 info->is_beep = (buf[10] & (1 << 0)) != 0;
233 /* Byte 11: LCD SEG12 */
234 info->is_farad = (buf[11] & (1 << 3)) != 0;
235 info->is_ohm = (buf[11] & (1 << 2)) != 0;
236 info->is_rel = (buf[11] & (1 << 1)) != 0;
237 info->is_hold = (buf[11] & (1 << 0)) != 0;
239 /* Byte 12: LCD SEG13 */
240 info->is_ampere = (buf[12] & (1 << 3)) != 0;
241 info->is_volt = (buf[12] & (1 << 2)) != 0;
242 info->is_hz = (buf[12] & (1 << 1)) != 0;
243 info->is_bat = (buf[12] & (1 << 0)) != 0;
245 /* Byte 13: LCD SEG14 */
246 info->is_c2c1_11 = (buf[13] & (1 << 3)) != 0;
247 info->is_c2c1_10 = (buf[13] & (1 << 2)) != 0;
248 info->is_c2c1_01 = (buf[13] & (1 << 1)) != 0;
249 info->is_c2c1_00 = (buf[13] & (1 << 0)) != 0;
252 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
253 const struct fs9721_info *info)
257 *floatval /= 1000000000;
259 *floatval /= 1000000;
265 *floatval *= 1000000;
267 /* Measurement modes */
269 analog->mq = SR_MQ_VOLTAGE;
270 analog->unit = SR_UNIT_VOLT;
272 if (info->is_ampere) {
273 analog->mq = SR_MQ_CURRENT;
274 analog->unit = SR_UNIT_AMPERE;
277 analog->mq = SR_MQ_RESISTANCE;
278 analog->unit = SR_UNIT_OHM;
281 analog->mq = SR_MQ_FREQUENCY;
282 analog->unit = SR_UNIT_HERTZ;
284 if (info->is_farad) {
285 analog->mq = SR_MQ_CAPACITANCE;
286 analog->unit = SR_UNIT_FARAD;
289 analog->mq = SR_MQ_CONTINUITY;
290 analog->unit = SR_UNIT_BOOLEAN;
291 *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
293 if (info->is_diode) {
294 analog->mq = SR_MQ_VOLTAGE;
295 analog->unit = SR_UNIT_VOLT;
297 if (info->is_percent) {
298 analog->mq = SR_MQ_DUTY_CYCLE;
299 analog->unit = SR_UNIT_PERCENTAGE;
302 /* Measurement related flags */
304 analog->mqflags |= SR_MQFLAG_AC;
306 analog->mqflags |= SR_MQFLAG_DC;
308 analog->mqflags |= SR_MQFLAG_AUTORANGE;
310 analog->mqflags |= SR_MQFLAG_HOLD;
312 analog->mqflags |= SR_MQFLAG_RELATIVE;
316 sr_spew("RS232 enabled.");
318 sr_spew("Battery is low.");
319 if (info->is_c2c1_00)
320 sr_spew("User-defined LCD symbol 0 is active.");
321 if (info->is_c2c1_01)
322 sr_spew("User-defined LCD symbol 1 is active.");
323 if (info->is_c2c1_10)
324 sr_spew("User-defined LCD symbol 2 is active.");
325 if (info->is_c2c1_11)
326 sr_spew("User-defined LCD symbol 3 is active.");
329 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf)
331 struct fs9721_info info;
333 parse_flags(buf, &info);
335 return (sync_nibbles_valid(buf) && flags_valid(&info));
339 * Parse a protocol packet.
341 * @param buf Buffer containing the 14-byte protocol packet. Must not be NULL.
342 * @param floatval Pointer to a float variable. That variable will contain the
343 * result value upon parsing success. Mut not be NULL.
344 * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
345 * filled with data according to the protocol packet.
347 * @param info Pointer to a struct fs9721_info. The struct will be filled
348 * with data according to the protocol packet. Must not be NULL.
350 * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
351 * 'analog' variable contents are undefined and should not be used.
353 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
354 struct sr_datafeed_analog *analog, void *info)
357 struct fs9721_info *info_local;
359 info_local = (struct fs9721_info *)info;
361 if ((ret = parse_value(buf, floatval)) != SR_OK) {
362 sr_err("Error parsing value: %d.", ret);
366 parse_flags(buf, info_local);
367 handle_flags(analog, floatval, info_local);
372 SR_PRIV void sr_fs9721_details_c2c1_00_temp_celsius(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->mq = SR_MQ_TEMPERATURE;
381 analog->unit = SR_UNIT_CELSIUS;