From 90aec91bff5d0337a42475f79d4fac1af3193c42 Mon Sep 17 00:00:00 2001 From: Stefan Wahren Date: Tue, 15 May 2012 22:57:03 +0200 Subject: [PATCH] Added frame tracing (hex format) via debug switch --- bin/mbus-serial-request-data-multi-reply.c | 6 ++ bin/mbus-serial-request-data.c | 6 ++ bin/mbus-serial-scan-secondary.c | 38 ++++++++++++- bin/mbus-serial-scan.c | 10 +++- bin/mbus-serial-select-secondary.c | 3 +- bin/mbus-tcp-request-data-multi-reply.c | 6 ++ bin/mbus-tcp-request-data.c | 6 ++ bin/mbus-tcp-scan.c | 6 ++ mbus/mbus-protocol.c | 65 +++++++++++++++++----- mbus/mbus-protocol.h | 12 ++-- 10 files changed, 137 insertions(+), 21 deletions(-) diff --git a/bin/mbus-serial-request-data-multi-reply.c b/bin/mbus-serial-request-data-multi-reply.c index 46bcbe5..eedc02a 100644 --- a/bin/mbus-serial-request-data-multi-reply.c +++ b/bin/mbus-serial-request-data-multi-reply.c @@ -66,6 +66,12 @@ main(int argc, char **argv) fprintf(stderr, " optional flag -b for selecting baudrate\n"); return 0; } + + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } if ((handle = mbus_connect_serial(device)) == NULL) { diff --git a/bin/mbus-serial-request-data.c b/bin/mbus-serial-request-data.c index 336cc35..6d0826b 100644 --- a/bin/mbus-serial-request-data.c +++ b/bin/mbus-serial-request-data.c @@ -63,6 +63,12 @@ main(int argc, char **argv) fprintf(stderr, " optional flag -b for selecting baudrate\n"); return 0; } + + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } if ((handle = mbus_connect_serial(device)) == NULL) { diff --git a/bin/mbus-serial-scan-secondary.c b/bin/mbus-serial-scan-secondary.c index 942f673..3909c49 100644 --- a/bin/mbus-serial-scan-secondary.c +++ b/bin/mbus-serial-scan-secondary.c @@ -17,6 +17,8 @@ #include #include +static int debug = 0; + //------------------------------------------------------------------------------ // Scan for devices using secondary addressing. //------------------------------------------------------------------------------ @@ -32,30 +34,64 @@ main(int argc, char **argv) device = argv[1]; addr_mask = strdup("FFFFFFFFFFFFFFFF"); } + else if (argc == 3 && strcmp(argv[1], "-d") == 0) + { + device = argv[2]; + addr_mask = strdup("FFFFFFFFFFFFFFFF"); + debug = 1; + } else if (argc == 3) { device = argv[1]; addr_mask = strdup(argv[2]); } + else if (argc == 4 && strcmp(argv[1], "-d") == 0) + { + device = argv[1]; + addr_mask = strdup(argv[2]); + debug = 1; + } else if (argc == 4 && strcmp(argv[1], "-b") == 0) { baudrate = atoi(argv[2]); device = argv[3]; addr_mask = strdup("FFFFFFFFFFFFFFFF"); } + else if (argc == 5 && strcmp(argv[1], "-d") == 0) + { + baudrate = atoi(argv[3]); + device = argv[4]; + addr_mask = strdup("FFFFFFFFFFFFFFFF"); + debug = 1; + } else if (argc == 5 && strcmp(argv[1], "-b") == 0) { baudrate = atoi(argv[2]); device = argv[3]; addr_mask = strdup(argv[4]); } + else if (argc == 6 && strcmp(argv[1], "-d") == 0) + { + baudrate = atoi(argv[3]); + device = argv[4]; + addr_mask = strdup(argv[5]); + debug = 1; + } else { - fprintf(stderr, "usage: %s [-b BAUDRATE] device [address-mask]\n", argv[0]); + fprintf(stderr, "usage: %s [-d] [-b BAUDRATE] device [address-mask]\n", argv[0]); + fprintf(stderr, "\toptional flag -d for debug printout\n"); + fprintf(stderr, "\toptional flag -b for selecting baudrate\n"); fprintf(stderr, "\trestrict the search by supplying an optional address mask on the form\n"); fprintf(stderr, "\t'FFFFFFFFFFFFFFFF' where F is a wildcard character\n"); return 0; } + + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } if (strlen(addr_mask) != 16) { diff --git a/bin/mbus-serial-scan.c b/bin/mbus-serial-scan.c index 178cbbe..f0d1776 100644 --- a/bin/mbus-serial-scan.c +++ b/bin/mbus-serial-scan.c @@ -17,6 +17,8 @@ #include #include +static int debug = 0; + //------------------------------------------------------------------------------ // Primary addressing scanning of mbus devices. //------------------------------------------------------------------------------ @@ -25,7 +27,7 @@ main(int argc, char **argv) { mbus_handle *handle; char *device; - int address, baudrate = 9600, debug = 0; + int address, baudrate = 9600; if (argc == 2) { @@ -53,6 +55,12 @@ main(int argc, char **argv) return 0; } + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } + if ((handle = mbus_connect_serial(device)) == NULL) { printf("Failed to setup connection to M-bus gateway\n"); diff --git a/bin/mbus-serial-select-secondary.c b/bin/mbus-serial-select-secondary.c index 98536ba..a5b7067 100644 --- a/bin/mbus-serial-select-secondary.c +++ b/bin/mbus-serial-select-secondary.c @@ -42,7 +42,8 @@ main(int argc, char **argv) } else { - fprintf(stderr, "usage: %s device secondary-mbus-address\n", argv[0]); + fprintf(stderr, "usage: %s [-b BAUDRATE] device secondary-mbus-address\n", argv[0]); + fprintf(stderr, " optional flag -b for selecting baudrate\n"); return 0; } diff --git a/bin/mbus-tcp-request-data-multi-reply.c b/bin/mbus-tcp-request-data-multi-reply.c index 91ea0c1..5ae94b0 100644 --- a/bin/mbus-tcp-request-data-multi-reply.c +++ b/bin/mbus-tcp-request-data-multi-reply.c @@ -56,6 +56,12 @@ main(int argc, char **argv) return 0; } + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } + if ((handle = mbus_connect_tcp(host, port)) == NULL) { fprintf(stderr, "Failed to setup connection to M-bus gateway\n"); diff --git a/bin/mbus-tcp-request-data.c b/bin/mbus-tcp-request-data.c index 274829c..0d8db18 100644 --- a/bin/mbus-tcp-request-data.c +++ b/bin/mbus-tcp-request-data.c @@ -56,6 +56,12 @@ main(int argc, char **argv) return 0; } + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } + if ((handle = mbus_connect_tcp(host, port)) == NULL) { fprintf(stderr, "Failed to setup connection to M-bus gateway\n"); diff --git a/bin/mbus-tcp-scan.c b/bin/mbus-tcp-scan.c index 7633b00..1d412c8 100644 --- a/bin/mbus-tcp-scan.c +++ b/bin/mbus-tcp-scan.c @@ -44,6 +44,12 @@ main(int argc, char **argv) printf("usage: %s [-d] host port\n", argv[0]); return 0; } + + if (debug) + { + mbus_register_send_event(&mbus_dump_send_event); + mbus_register_recv_event(&mbus_dump_recv_event); + } if ((handle = mbus_connect_tcp(host, port)) == NULL) { diff --git a/mbus/mbus-protocol.c b/mbus/mbus-protocol.c index e5296f3..2f0ffd8 100644 --- a/mbus/mbus-protocol.c +++ b/mbus/mbus-protocol.c @@ -28,8 +28,23 @@ static mbus_slave_data slave_data[MBUS_MAX_PRIMARY_SLAVES]; // // init event callback // -void (*_mbus_recv_event)(u_char src_type) = NULL; -void (*_mbus_send_event)(u_char src_type) = NULL; +void (*_mbus_recv_event)(u_char src_type, const char *buff, size_t len) = NULL; +void (*_mbus_send_event)(u_char src_type, const char *buff, size_t len) = NULL; + +// +// trace callbacks +// +void +mbus_dump_recv_event(u_char src_type, const char *buff, size_t len) +{ + mbus_hex_dump("RECV", buff, len); +} + +void +mbus_dump_send_event(u_char src_type, const char *buff, size_t len) +{ + mbus_hex_dump("SEND", buff, len); +} //------------------------------------------------------------------------------ /// Register a function for receive events. @@ -44,7 +59,7 @@ mbus_register_recv_event(void (*event)(u_char src_type)) /// Register a function for send events. //------------------------------------------------------------------------------ void -mbus_register_send_event(void (*event)(u_char src_type)) +mbus_register_send_event(void (*event)(u_char src_type, const char *buff, size_t len)) { _mbus_send_event = event; } @@ -316,11 +331,11 @@ mbus_frame_verify(mbus_frame *frame) return -1; } - if ((frame->control != MBUS_CONTROL_MASK_SND_NKE) && - (frame->control != MBUS_CONTROL_MASK_REQ_UD1) && - (frame->control != MBUS_CONTROL_MASK_REQ_UD1 | MBUS_CONTROL_MASK_FCB) && - (frame->control != MBUS_CONTROL_MASK_REQ_UD2) && - (frame->control != MBUS_CONTROL_MASK_REQ_UD2 | MBUS_CONTROL_MASK_FCB)) + if ((frame->control != MBUS_CONTROL_MASK_SND_NKE) && + (frame->control != MBUS_CONTROL_MASK_REQ_UD1) && + (frame->control != (MBUS_CONTROL_MASK_REQ_UD1 | MBUS_CONTROL_MASK_FCB)) && + (frame->control != MBUS_CONTROL_MASK_REQ_UD2) && + (frame->control != (MBUS_CONTROL_MASK_REQ_UD2 | MBUS_CONTROL_MASK_FCB))) { snprintf(error_str, sizeof(error_str), "Unknown Control Code 0x%.2x", frame->control); @@ -339,12 +354,12 @@ mbus_frame_verify(mbus_frame *frame) return -1; } - if ((frame->control != MBUS_CONTROL_MASK_SND_UD) && - (frame->control != MBUS_CONTROL_MASK_SND_UD | MBUS_CONTROL_MASK_FCB) && - (frame->control != MBUS_CONTROL_MASK_RSP_UD) && - (frame->control != MBUS_CONTROL_MASK_RSP_UD | MBUS_CONTROL_MASK_DFC) && - (frame->control != MBUS_CONTROL_MASK_RSP_UD | MBUS_CONTROL_MASK_ACD) && - (frame->control != MBUS_CONTROL_MASK_RSP_UD | MBUS_CONTROL_MASK_DFC | MBUS_CONTROL_MASK_ACD)) + if ((frame->control != MBUS_CONTROL_MASK_SND_UD) && + (frame->control != (MBUS_CONTROL_MASK_SND_UD | MBUS_CONTROL_MASK_FCB)) && + (frame->control != MBUS_CONTROL_MASK_RSP_UD) && + (frame->control != (MBUS_CONTROL_MASK_RSP_UD | MBUS_CONTROL_MASK_DFC)) && + (frame->control != (MBUS_CONTROL_MASK_RSP_UD | MBUS_CONTROL_MASK_ACD)) && + (frame->control != (MBUS_CONTROL_MASK_RSP_UD | MBUS_CONTROL_MASK_DFC | MBUS_CONTROL_MASK_ACD))) { snprintf(error_str, sizeof(error_str), "Unknown Control Code 0x%.2x", frame->control); @@ -2942,6 +2957,28 @@ mbus_data_fixed_print(mbus_data_fixed *data) return -1; } +void +mbus_hex_dump(const char *label, const char *buff, size_t len) +{ + time_t rawtime; + struct tm * timeinfo; + char timestamp[21]; + size_t i; + + time ( &rawtime ); + timeinfo = gmtime ( &rawtime ); + + strftime(timestamp,20,"%Y-%m-%d %H:%M:%S",timeinfo); + fprintf(stderr, "[%s] %s (%03d):", timestamp, label, len); + + for (i = 0; i < len; i++) + { + fprintf(stderr, " %02X", (u_char) buff[i]); + } + + fprintf(stderr, "\n"); +} + int mbus_data_error_print(int error) { diff --git a/mbus/mbus-protocol.h b/mbus/mbus-protocol.h index 2c9cc50..d21adc9 100644 --- a/mbus/mbus-protocol.h +++ b/mbus/mbus-protocol.h @@ -462,14 +462,17 @@ typedef struct _mbus_data_secondary_address { // // Event callback functions // -extern void (*_mbus_recv_event)(u_char src_type); -extern void (*_mbus_send_event)(u_char src_type); +extern void (*_mbus_recv_event)(u_char src_type, const char *buff, size_t len); +extern void (*_mbus_send_event)(u_char src_type, const char *buff, size_t len); + +void mbus_dump_recv_event(u_char src_type, const char *buff, size_t len); +void mbus_dump_send_event(u_char src_type, const char *buff, size_t len); // // Event register functions // -void mbus_register_recv_event(void (*event)(u_char src_type)); -void mbus_register_send_event(void (*event)(u_char src_type)); +void mbus_register_recv_event(void (*event)(u_char src_type, const char *buff, size_t len)); +void mbus_register_send_event(void (*event)(u_char src_type, const char *buff, size_t len)); // // variable length records @@ -554,6 +557,7 @@ void mbus_error_str_set(char *message); void mbus_error_reset(); void mbus_parse_set_debug(int debug); +void mbus_hex_dump(const char *label, const char *buff, size_t len); // // data encode/decode functions