Add support for ALARM STATUS command

README

@@ -15,6 +15,7 @@ videohubctrl currently displays and can configure:
   - Serial ports names, routing, locking and directions
   - Processing units
   - Frames
+  - Alarms status
 
 Configuration of Videohub's network settings can be made using
 Blackmagic's Windows program when the device is connected via USB.
@@ -59,6 +60,7 @@ Commands:
  --list-serial              | List device serial ports.
  --list-proc-units          | List device processing units.
  --list-frames              | List device frame buffers.
+ --list-alarms              | List device alarms.
 
  --set-name <name>          | Set the device "friendly name".
 
@@ -412,7 +414,6 @@ TODO list
 Help is very much welcome for these tasks:
 
  - Find out what these undocumented commands do:
-    ALARM STATUS:
     END PRELUDE:
     ENGINEERING:
 

cmd.c

@@ -43,6 +43,7 @@ const char *videohub_commands_text[NUM_COMMANDS] = {
 	[CMD_FRAME_LABELS]           = "FRAME LABELS",
 	[CMD_FRAME_BUFFER_ROUTING]   = "FRAME BUFFER ROUTING",
 	[CMD_FRAME_BUFFER_LOCKS]     = "FRAME BUFFER LOCKS",
+	[CMD_ALARM_STATUS]         = "ALARM STATUS",
 	[CMD_PING]                 = "PING",
 	[CMD_ACK]                  = "ACK",
 	[CMD_NAK]                  = "NAK",
@@ -162,6 +163,7 @@ struct videohub_commands videohub_commands[NUM_COMMANDS] = {
 		.port_id1 = "frame",
 		.opt_prefix = "fr",
 	},
+	[CMD_ALARM_STATUS]         = { .cmd = CMD_ALARM_STATUS        , .type = PARSE_CUSTOM },
 	[CMD_END_PRELUDE]          = { .cmd = CMD_END_PRELUDE         , .type = PARSE_NONE },
 	[CMD_PING]                 = { .cmd = CMD_PING                , .type = PARSE_NONE },
 	[CMD_ACK]                  = { .cmd = CMD_ACK                 , .type = PARSE_NONE },
@@ -332,6 +334,22 @@ bool parse_command(struct videohub_data *d, char *cmd) {
 			if ((p = parse_text(line, "Take Mode: "))) {
 				d->device.conf_take_mode = streq(p, "true");
 			}
+			break;
+		case CMD_ALARM_STATUS:
+			p = strchr(line, ':');
+			if (p) {
+				char *alarm_name = line; // Use start of the line
+				*p = '\0'; // Terminate the alarm name at :
+				char *alarm_status = p + 2; // Set alarm value to point after ': '
+				if (d->alarms.num + 1 < MAX_ALARMS) {
+					snprintf(d->alarms.alarm[ d->alarms.num ].name  , MAX_NAME_LEN, "%s", alarm_name);
+					snprintf(d->alarms.alarm[ d->alarms.num ].status, MAX_ALARM_STATUS_LEN, "%s", alarm_status);
+					d->alarms.num++;
+				} else {
+					q("WARNING: Too many alarms (> %d) increase MAX_ALARMS and recompile. Alarm '%s' value '%s' ignorred\n", d->alarms.num + 1, alarm_name, alarm_status);
+				}
+		}
+			break;
 		case CMD_NAK:
 			ret = false;
 			break;

cmd.h

@@ -15,7 +15,7 @@
 
 #include <stdbool.h>
 
-#define NUM_COMMANDS 26
+#define NUM_COMMANDS 27
 
 enum vcmd {
 	CMD_PROTOCOL_PREAMBLE,
@@ -41,6 +41,7 @@ enum vcmd {
 	CMD_FRAME_LABELS,
 	CMD_FRAME_BUFFER_ROUTING,
 	CMD_FRAME_BUFFER_LOCKS,
+	CMD_ALARM_STATUS,
 	CMD_PING,
 	CMD_ACK,
 	CMD_NAK = (NUM_COMMANDS - 1),

data.h

@@ -16,9 +16,11 @@
 #include <stdbool.h>
 
 #define MAX_PORTS 288
-#define MAX_NAME_LEN 32
+#define MAX_NAME_LEN 48
 #define MAX_RUN_CMDS (288 * 5)
 #define NO_PORT ((unsigned int) -1)
+#define MAX_ALARMS 32
+#define MAX_ALARM_STATUS_LEN 256
 
 struct device_desc {
 	bool			dev_present;
@@ -73,6 +75,16 @@ struct port_set {
 	struct port		port[MAX_PORTS];
 };
 
+struct alarm {
+	char			name[MAX_NAME_LEN];
+	char			status[MAX_ALARM_STATUS_LEN];
+};
+
+struct alarm_status {
+	unsigned int	num;
+	struct alarm	alarm[MAX_ALARMS];
+};
+
 struct videohub_data {
 	char					*dev_host;
 	char					*dev_port;
@@ -84,6 +96,7 @@ struct videohub_data {
 	struct port_set			serial;
 	struct port_set			proc_units;
 	struct port_set			frames;
+	struct alarm_status		alarms;
 };
 
 extern int debug;

display.c

@@ -224,6 +224,24 @@ void print_device_frame_buffers(struct videohub_data *d) {
 	printf("\n");
 }
 
+void print_device_alarm_status(struct videohub_data *d) {
+	unsigned int i, len = 70;
+	if (!d->alarms.num)
+		return;
+	printf("Alarm status\n");
+	printf_line(len);
+	printf("  | %-32s | %-31s |\n", "Alarm name", "Status");
+	printf_line(len);
+	for(i = 0; i < d->alarms.num; i++) {
+		printf("  | %-32s | %-31s |\n",
+			d->alarms.alarm[i].name,
+			d->alarms.alarm[i].status
+		);
+	}
+	printf_line(len);
+	printf("\n");
+}
+
 
 static void __print_opt(struct videohub_data *d, enum vcmd vcmd) {
 	unsigned int i, last = 0;

display.h

@@ -20,6 +20,7 @@ void print_device_monitoring_outputs(struct videohub_data *d);
 void print_device_serial_ports(struct videohub_data *d);
 void print_device_processing_units(struct videohub_data *d);
 void print_device_frame_buffers(struct videohub_data *d);
+void print_device_alarm_status(struct videohub_data *d);
 
 void print_device_backup(struct videohub_data *d);
 

test/input-17.txt

@@ -37,7 +37,9 @@ INPUT LABELS:
 15 Loopback
 
 ALARM STATUS:
+Fan 1: ok
 0 Error
+Fan 2: Something very bad is happening
 
 END PRELUDE:
 

test/input-288-alarms.txt

@@ -0,0 +1,51 @@
+PROTOCOL PREAMBLE:
+Version: 2.3
+
+VIDEOHUB DEVICE:
+Device present: true
+Model name: Blackmagic Universal Videohub
+Video inputs: 288
+Video processing units: 0
+Video outputs: 288
+Video monitoring outputs: 0
+Serial ports: 288
+
+ALARM STATUS:
+Fan 0: ok
+Fan 1: zok
+Fan 2: ok
+Power Supply Slot 0: ok
+Power Supply Slot 1: ok
+Power Sufficient for Load: ok
+Network Slot 0: ok
+Network Slot 1: ok
+Card Bus: ok
+Card Firmware Version: ok
+Logic Slot 0: ok
+Logic Slot 1: ok
+Logic Firmware Version Slot 0: ok
+Logic Firmware Version Slot 1: ok
+ProcessorLink: ok
+Processor Firmware Version: ok
+Crosspoint Slot 0: ok
+Crosspoint Slot 1: ok
+Bus Host Slot 0: ok
+Bus Host Slot 1: ok
+Bus Host Firmware Version Slot 0: ok
+Bus Host Firmware Version Slot 1: ok
+test 01: ok
+test 02: ok
+test 03: ok
+test 04: ok
+test 05: ok
+test 06: ok
+test 07: ok
+test 08: ok
+test 09: ok
+test 10: ok
+test 11: ok
+test 12: ok
+test 13: ok
+test 14: ok
+test 15: ok
+test 16: ok

test/run

@@ -163,3 +163,9 @@ check test/test-r "Test input with windows line endings"
 
 videohubctrl --test-input test/input-r2.txt $@ &> test/test-r2.out
 check test/test-r2 "Test input with leading whitespace and windows line endings"
+
+videohubctrl --test-input test/input-288.txt $@ &> test/test-288.out
+check test/test-288 "Test videohub 288 config parsing"
+
+videohubctrl --list-alarms --test-input test/input-288-alarms.txt $@ &> test/test-288-alarms.out
+check test/test-288-alarms "Test alarm overflow"

test/test-17.ok

@@ -8,13 +8,6 @@ WARNING: Videohub sent unknown command!
          Please report this command to author's email: georgi@unixsol.org
          You may use -q or --quiet to suppress the message.
 ---------8<-----------8<----------- cut here ---------8<------------8<---------
-ALARM STATUS:
-0 Error
----------8<-----------8<----------- cut here ---------8<------------8<---------
-WARNING: Videohub sent unknown command!
-         Please report this command to author's email: georgi@unixsol.org
-         You may use -q or --quiet to suppress the message.
----------8<-----------8<----------- cut here ---------8<------------8<---------
 ENGINEERING:
 0 Hack
 1 Hack
@@ -23,13 +16,6 @@ WARNING: Videohub sent unknown command!
          Please report this command to author's email: georgi@unixsol.org
          You may use -q or --quiet to suppress the message.
 ---------8<-----------8<----------- cut here ---------8<------------8<---------
-ALARM STATUS:
-0 Error
----------8<-----------8<----------- cut here ---------8<------------8<---------
-WARNING: Videohub sent unknown command!
-         Please report this command to author's email: georgi@unixsol.org
-         You may use -q or --quiet to suppress the message.
----------8<-----------8<----------- cut here ---------8<------------8<---------
 ENGINEERING:
 0 Debug
 ---------8<-----------8<----------- cut here ---------8<------------8<---------
@@ -47,6 +33,14 @@ Device info
   | Video monitoring outputs   | 8                                  |
   -------------------------------------------------------------------
 
+Alarm status
+  ----------------------------------------------------------------------
+  | Alarm name                       | Status                          |
+  ----------------------------------------------------------------------
+  | Fan 1                            | ok                              |
+  | Fan 2                            | Something very bad is happening |
+  ----------------------------------------------------------------------
+
 Video inputs
   ----------------------------------------------------------------------
   | ### | Video input name         | nn | Routed to output         | s |

test/test-288-alarms.ok

@@ -0,0 +1,44 @@
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 10' value 'ok' ignorred
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 11' value 'ok' ignorred
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 12' value 'ok' ignorred
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 13' value 'ok' ignorred
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 14' value 'ok' ignorred
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 15' value 'ok' ignorred
+WARNING: Too many alarms (> 32) increase MAX_ALARMS and recompile. Alarm 'test 16' value 'ok' ignorred
+Alarm status
+  ----------------------------------------------------------------------
+  | Alarm name                       | Status                          |
+  ----------------------------------------------------------------------
+  | Fan 0                            | ok                              |
+  | Fan 1                            | zok                             |
+  | Fan 2                            | ok                              |
+  | Power Supply Slot 0              | ok                              |
+  | Power Supply Slot 1              | ok                              |
+  | Power Sufficient for Load        | ok                              |
+  | Network Slot 0                   | ok                              |
+  | Network Slot 1                   | ok                              |
+  | Card Bus                         | ok                              |
+  | Card Firmware Version            | ok                              |
+  | Logic Slot 0                     | ok                              |
+  | Logic Slot 1                     | ok                              |
+  | Logic Firmware Version Slot 0    | ok                              |
+  | Logic Firmware Version Slot 1    | ok                              |
+  | ProcessorLink                    | ok                              |
+  | Processor Firmware Version       | ok                              |
+  | Crosspoint Slot 0                | ok                              |
+  | Crosspoint Slot 1                | ok                              |
+  | Bus Host Slot 0                  | ok                              |
+  | Bus Host Slot 1                  | ok                              |
+  | Bus Host Firmware Version Slot 0 | ok                              |
+  | Bus Host Firmware Version Slot 1 | ok                              |
+  | test 01                          | ok                              |
+  | test 02                          | ok                              |
+  | test 03                          | ok                              |
+  | test 04                          | ok                              |
+  | test 05                          | ok                              |
+  | test 06                          | ok                              |
+  | test 07                          | ok                              |
+  | test 08                          | ok                              |
+  | test 09                          | ok                              |
+  ----------------------------------------------------------------------
+

test/test-r2.ok

@@ -2,7 +2,7 @@ Device info
   -------------------------------------------------------------------
   | Device address             | sdi-matrix                         |
   | Device port                | 9990                               |
-  | Model name                 | Blackmagic Smart Videohub 20 x     |
+  | Model name                 | Blackmagic Smart Videohub 20 x 20  |
   | Friendly name              |      (2)            @              |
   | Unique ID                  | XXXXXXXXXXXX                       |
   | Protocol                   | 2.7                                |

videohubctrl.1

@@ -1,4 +1,4 @@
-.TH VIDEOHUBCTRL "1" "December 2014" "videohubctrl 3.0" "User Commands"
+.TH VIDEOHUBCTRL "1" "October 2020" "videohubctrl 3.1" "User Commands"
 .SH NAME
 videohubctrl - Blackmagic Design Videohub SDI router control
 .SH SYNOPSIS
@@ -17,6 +17,7 @@ videohubctrl currently displays and can configure:
   - Serial ports names, routing, locking and directions
   - Processing units
   - Frames
+  - Alarms status
 .SH MAIN OPTIONS
 .PP
 .TP
@@ -97,6 +98,9 @@ video inputs.
 \fB\-\-list\-frames\fR
 Display stored frame buffers.
 .TP
+\fB\-\-list\-alarms\fR
+Display current alarms status.
+.TP
 \fB\-\-set\-name\fR <name>
 Set the device "friendly name". This name can be used as a device identifier.
 Only some Videohub models support this functionality.

videohubctrl.c

@@ -46,6 +46,7 @@ enum list_actions {
 	action_list_serial		= (1 << 4),
 	action_list_proc_units	= (1 << 5),
 	action_list_frames		= (1 << 6),
+	action_list_alarms		= (1 << 7),
 };
 
 static const char *program_id = PROGRAM_NAME " Version: " VERSION " Git: " GIT_VER;
@@ -75,6 +76,7 @@ static const struct option long_options[] = {
 	{ "list-serial",		no_argument,       NULL, 905 },
 	{ "list-proc-units",	no_argument,       NULL, 906 },
 	{ "list-frames",		no_argument,       NULL, 907 },
+	{ "list-alarms",		no_argument,       NULL, 908 },
 
 	{ "set-name",			required_argument, NULL, 950 },
 
@@ -167,6 +169,7 @@ static void show_help(struct videohub_data *data) {
 	printf(" --list-serial              | List device serial ports.\n");
 	printf(" --list-proc-units          | List device processing units.\n");
 	printf(" --list-frames              | List device frame buffers.\n");
+	printf(" --list-alarms              | List device alarms.\n");
 	printf("\n");
 	printf(" --set-name <name>          | Set the device \"friendly name\".\n");
 	printf("\n");
@@ -344,6 +347,7 @@ static void parse_options(struct videohub_data *data, int argc, char **argv) {
 			case 905: show_list |= action_list_serial; break; // --list-serial
 			case 906: show_list |= action_list_proc_units; break; // --list-proc-units
 			case 907: show_list |= action_list_frames; break; // --list-frames
+			case 908: show_list |= action_list_alarms; break; // --list-alarms
 			case 950: set_device_option("Friendly name", optarg); break; // --set-name
 			case 1001: parse_cmd2(argc, argv, CMD_INPUT_LABELS); break; // --in-name
 			case 1002: parse_cmd2(argc, argv, CMD_VIDEO_OUTPUT_ROUTING); switch_cmd_args(); break; // --in-output
@@ -409,6 +413,7 @@ static void reset_routed_to(struct port_set *p) {
 
 static void print_device_full(struct videohub_data *d) {
 	print_device_info(d);
+	print_device_alarm_status(d);
 	print_device_video_inputs(d);
 	print_device_video_outputs(d);
 	print_device_monitoring_outputs(d);
@@ -528,6 +533,7 @@ int main(int argc, char **argv) {
 		}
 	} else if (show_list) {
 		if (show_list & action_list_device)		print_device_info(data);
+		if (show_list & action_list_alarms)		print_device_alarm_status(data);
 		if (show_list & action_list_vinputs)	print_device_video_inputs(data);
 		if (show_list & action_list_voutputs)	print_device_video_outputs(data);
 		if (show_list & action_list_moutputs)	print_device_monitoring_outputs(data);