Add support for processing units (routing and locks).

It is not tested on a real hardware.

ChangeLog

     --se-dir and --list-serial.
  * Add support for undocumented "Thunderbolt" port status/type.
  * Display the undocumented "Friendly name" device setting.
+ * Add support for processing units (routing and locks). It is not tested
+   on a real hardware.
 
 2014-11-30 : Version 0.4
  * Add videohubctrl(1) man page.

README

   - Input/Output port statuses
   - Monitoring video output port names, routing and locking
   - Serial ports names, routing, locking and directions
-
-The following features found in bigger Videohub models are currently
-not supported (I don't have the hardware):
-
-  - Configuration of video processing units
+  - Processing units
 
 Configuration of Videohub's network settings can be made using
 Blackmagic's Windows program when the device is connected via USB.
  --list-voutputs            | List device video outputs.
  --list-moutputs            | List device monitoring outputs.
  --list-serial              | List device serial ports.
+ --list-proc-units          | List device processing units.
 
 Video inputs configuration:
  --vi-name <in_X> <name>    | Set video input port X name.
  --se-dir <ser_X> <dir>     | Set serial port X direction.
                             . <dir> can be 'auto', 'in' or 'out'.
 
+Processing units configuration:
+ --pu-input <pu_X> <in_Y>   | Connect processing unit X to input Y.
+ --pu-clear <pu_X>          | Disconnect unit X from input Y.
+ --pu-lock <pu_X>           | Lock processing unit X.
+ --pu-unlock <pu_X>         | Unlock processing unit X.
+
 Misc options:
  -T --test-input <file>     | Read commands from <file>.
  -d --debug                 | Increase logging verbosity.
 ==============
 
 Here is how videohubctrl output looks like using the commands recorded
-in tests/input-00.txt file.
+in test/input-00.txt file.
 
 |----------------------------------------------------------------------|
-$ videohubctrl --test tests/input-00.txt
+$ videohubctrl --test test/input-00.txt
 Device info
   -------------------------------------------------------------------
   | Device address             | sdi-matrix                         |
   | Video inputs               | 16                                 |
   | Video outputs              | 16                                 |
   | Serial ports               | 8                                  |
+  | Video processing units     | 4                                  |
   | Video monitoring outputs   | 4                                  |
   -------------------------------------------------------------------
 
   |   8 |   |  out | Serial 8           |                    | x |
   ----------------------------------------------------------------
 
+Processing units
+  --------------------------------------------
+  | Proc Unit | x | Connected video input    |
+  --------------------------------------------
+  |         1 | L | Windows 4 HD             |
+  |         2 |   | Windows 2                |
+  |         3 | O |                          |
+  |         4 |   | Windows 3                |
+  --------------------------------------------
+
+
 |----------------------------------------------------------------------|
 
 

cmd.c

 	[CMD_SERIAL_PORT_LOCKS]      = "SERIAL PORT LOCKS",
 	[CMD_SERIAL_PORT_STATUS]     = "SERIAL PORT STATUS",
 	[CMD_SERIAL_PORT_DIRECTIONS] = "SERIAL PORT DIRECTIONS",
+	[CMD_PROCESSING_UNIT_ROUTING]= "PROCESSING UNIT ROUTING",
+	[CMD_PROCESSING_UNIT_LOCKS]  = "PROCESSING UNIT LOCKS",
 	[CMD_PING]                 = "PING",
 	[CMD_ACK]                  = "ACK",
 	[CMD_NAK]                  = "NAK",
 		.port_id1 = "serial",
 		.opt_prefix = "se",
 	},
+	[CMD_PROCESSING_UNIT_ROUTING] = { .cmd = CMD_PROCESSING_UNIT_ROUTING, .type = PARSE_ROUTE,
+		.ports1 = OFS(proc_units),
+		.ports2 = OFS(inputs),
+		.port_id1 = "proc unit",
+		.port_id2 = "input",
+		.opt_prefix = "pu",
+		.allow_disconnect = true,
+	},
+	[CMD_PROCESSING_UNIT_LOCKS] = { .cmd = CMD_PROCESSING_UNIT_LOCKS, .type = PARSE_LOCK,
+		.ports1 = OFS(proc_units),
+		.port_id1 = "proc unit",
+		.opt_prefix = "pu",
+	},
 	[CMD_PING]                 = { .cmd = CMD_PING                , .type = PARSE_NONE },
 	[CMD_ACK]                  = { .cmd = CMD_ACK                 , .type = PARSE_NONE },
 	[CMD_NAK]                  = { .cmd = CMD_NAK                 , .type = PARSE_NONE },
 			else if ((p = parse_text(line, "Video inputs: ")))
 				d->inputs.num = strtoul(p, NULL, 10);
 			else if ((p = parse_text(line, "Video processing units: ")))
-				d->device.num_video_processing_units = strtoul(p, NULL, 10);
+				d->proc_units.num = strtoul(p, NULL, 10);
 			else if ((p = parse_text(line, "Video outputs: ")))
 				d->outputs.num = strtoul(p, NULL, 10);
 			else if ((p = parse_text(line, "Video monitoring outputs: ")))

cmd.h

 
 #include <stdbool.h>
 
-#define NUM_COMMANDS 19
+#define NUM_COMMANDS 21
 
 enum vcmd {
 	CMD_PROTOCOL_PREAMBLE,
 	CMD_SERIAL_PORT_ROUTING,
 	CMD_SERIAL_PORT_STATUS,
 	CMD_SERIAL_PORT_DIRECTIONS,
+	CMD_PROCESSING_UNIT_ROUTING,
+	CMD_PROCESSING_UNIT_LOCKS,
 	CMD_PING,
 	CMD_ACK,
 	CMD_NAK = (NUM_COMMANDS - 1),

data.h

 	char			model_name[MAX_NAME_LEN];
 	char			friendly_name[MAX_NAME_LEN];
 	char			unique_id[MAX_NAME_LEN];
-	unsigned int	num_video_processing_units;
 };
 
 enum port_status {
 	struct port_set			outputs;
 	struct port_set			mon_outputs;
 	struct port_set			serial;
+	struct port_set			proc_units;
 };
 
 extern int debug;

display.c

 	printf("  | %-26s | %-34u |\n", "Video outputs", d->outputs.num);
 	if (d->serial.num)
 		printf("  | %-26s | %-34u |\n", "Serial ports", d->serial.num);
-	if (d->device.num_video_processing_units)
-		printf("  | %-26s | %-34u |\n", "Video processing units", d->device.num_video_processing_units);
+	if (d->proc_units.num)
+		printf("  | %-26s | %-34u |\n", "Video processing units", d->proc_units.num);
 	if (d->mon_outputs.num)
 		printf("  | %-26s | %-34u |\n", "Video monitoring outputs", d->mon_outputs.num);
 	printf_line(len);
 	printf("\n");
 }
 
+void print_device_processing_units(struct videohub_data *d) {
+	unsigned int i, len = 44;
+	if (!d->proc_units.num)
+		return;
+	printf("Processing units\n");
+	printf_line(len);
+	printf("  | Proc Unit | x | %-24s |\n", "Connected video input");
+	printf_line(len);
+	for(i = 0; i < d->proc_units.num; i++) {
+		printf("  | %9d | %c | %-24s |\n",
+			i + 1,
+			port_lock_symbol(d->proc_units.port[i].lock),
+			d->proc_units.port[i].routed_to == NO_PORT ? "" : d->inputs.port[d->proc_units.port[i].routed_to].name
+		);
+	}
+	printf_line(len);
+	printf("\n");
+}
+
 static void __print_opt(struct videohub_data *d, enum vcmd vcmd) {
 	unsigned int i, last = 0;
 	struct videohub_commands *v = &videohub_commands[vcmd];

display.h

 void print_device_video_outputs(struct videohub_data *d);
 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_backup(struct videohub_data *d);
 

test/input-00.txt

 Model name: Blackmagic Micro Videohub
 Unique ID: 7c2e0d021714
 Video inputs: 16
-Video processing units: 0
+Video processing units: 4
 Video outputs: 16
 Video monitoring outputs: 4
 Serial ports: 8
 6 control
 7 slave
 
+PROCESSING UNIT ROUTING:
+0 3
+1 1
+3 2
+
+PROCESSING UNIT LOCKS:
+0 L
+1 U
+2 O
+3 U
+

test/input-03.txt

 Model name: Blackmagic Micro Videohub
 Unique ID: 7c2e0d021714
 Video inputs: 16
-Video processing units: 0
+Video processing units: 4
 Video outputs: 16
 Video monitoring outputs: 4
 Serial ports: 8

test/input-17.txt

 Friendly name: SDI router on the 5th floor
 Unique ID: 465647757584
 Video inputs: 16
-Video processing units: 16
+Video processing units: 0
 Video outputs: 32
 Video monitoring outputs: 8
 Serial ports: 8
 FRAME BUFFER LOCKS:
 0 U
 
-PROCESSING UNIT ROUTING:
-0 Output 15
-
-PROCESSING UNIT LOCKS:
-0 U
-
 ALARM STATUS:
 0 Error
 

test/run

 	--se-input 6 7 \
 	--se-clear 4 \
 	--se-clear "Serial 6" \
+	--pu-clear 1 --pu-clear 3 --pu-clear 4 \
+	--pu-unlock 1 --pu-lock 1 --pu-connect 1 "Windows 4 HD" \
+	--pu-connect 4 "DPlay1" --pu-lock 4 \
 $@ &> test/test-04.out
 check test/test-04 "Test multiple configuration commands"
 

test/test-01.ok

   | Video inputs               | 16                                 |
   | Video outputs              | 16                                 |
   | Serial ports               | 8                                  |
+  | Video processing units     | 4                                  |
   | Video monitoring outputs   | 4                                  |
   -------------------------------------------------------------------
 
   |   8 |   |  out | Serial 8           |                    | x |
   ----------------------------------------------------------------
 
+Processing units
+  --------------------------------------------
+  | Proc Unit | x | Connected video input    |
+  --------------------------------------------
+  |         1 | L | Windows 4 HD             |
+  |         2 |   | Windows 2                |
+  |         3 | O |                          |
+  |         4 |   | Windows 3                |
+  --------------------------------------------
+

test/test-02.ok

   --mo-input   4   4 \
   --se-input   1   3 \
   --se-input   2   4 \
+  --pu-input   1   4 \
+  --pu-input   2   2 \
+  --pu-input   4   3 \
   --se-dir   1 in \
   --se-dir   2 auto \
   --se-dir   3 out \
   --se-unlock   6 \
   --se-unlock   7 \
   --se-unlock   8
+  --pu-unlock   1 --pu-lock   1 \
+  --pu-unlock   2 \
+  --pu-unlock   3 --pu-lock   3 \
+  --pu-unlock   4
 

test/test-03.ok

 videohub: set monitoring output 4 "Monitor 4" to read from video input 4 "Windows 4 HD"
 videohub: connect serial 1 "Serial Ctrl 1" to serial 3 "Deck 3"
 videohub: connect serial 2 "Serial Ctrl 2" to serial 4 "Deck 4"
+videohub: connect proc unit 1 "" to input 4 "Windows 4 HD"
+videohub: connect proc unit 2 "" to input 2 "Windows 2"
+videohub: connect proc unit 4 "" to input 3 "Windows 3"
 videohub: set serial 1 "Serial Ctrl 1" direction to IN (Workstation)
 videohub: set serial 2 "Serial Ctrl 2" direction to AUTO
 videohub: set serial 3 "Deck 3" direction to OUT (Deck)
 videohub: unlock serial 6 "Serial 6"
 videohub: unlock serial 7 "Serial 7"
 videohub: unlock serial 8 "Serial 8"
+videohub: unlock proc unit 1 ""
+videohub: lock proc unit 1 ""
+videohub: unlock proc unit 2 ""
+videohub: unlock proc unit 3 ""
+videohub: lock proc unit 3 ""
+videohub: unlock proc unit 4 ""
 Device info
   -------------------------------------------------------------------
   | Device address             | sdi-matrix                         |
   | Video inputs               | 16                                 |
   | Video outputs              | 16                                 |
   | Serial ports               | 8                                  |
+  | Video processing units     | 4                                  |
   | Video monitoring outputs   | 4                                  |
   -------------------------------------------------------------------
 
   |   8 |   |  out | Serial 8           |                    | x |
   ----------------------------------------------------------------
 
+Processing units
+  --------------------------------------------
+  | Proc Unit | x | Connected video input    |
+  --------------------------------------------
+  |         1 | O | Windows 4 HD             |
+  |         2 |   | Windows 2                |
+  |         3 | O |                          |
+  |         4 |   | Windows 3                |
+  --------------------------------------------
+

test/test-04.ok

 videohub: connect serial 6 "Serial 6" to serial 7 "Serial 7"
 videohub: disconnect serial 4 "Deck 4"
 videohub: disconnect serial 6 "Serial 6"
+videohub: disconnect proc unit 1 ""
+videohub: disconnect proc unit 3 ""
+videohub: disconnect proc unit 4 ""
+videohub: force unlock proc unit 1 ""
+videohub: lock proc unit 1 ""
+videohub: connect proc unit 1 "" to input 4 "Windows 4 HighDef"
+videohub: connect proc unit 4 "" to input 12 "DPlay1"
+videohub: lock proc unit 4 ""
 Device info
   -------------------------------------------------------------------
   | Device address             | sdi-matrix                         |
   | Video inputs               | 16                                 |
   | Video outputs              | 16                                 |
   | Serial ports               | 8                                  |
+  | Video processing units     | 4                                  |
   | Video monitoring outputs   | 4                                  |
   -------------------------------------------------------------------
 
   |   8 |   | auto | Serial 8           |                    | x |
   ----------------------------------------------------------------
 
+Processing units
+  --------------------------------------------
+  | Proc Unit | x | Connected video input    |
+  --------------------------------------------
+  |         1 | O | Windows 4 HighDef        |
+  |         2 |   | Windows 2                |
+  |         3 | O |                          |
+  |         4 | O | DPlay1                   |
+  --------------------------------------------
+

test/test-05.ok

   | Video inputs               | 16                                 |
   | Video outputs              | 16                                 |
   | Serial ports               | 8                                  |
+  | Video processing units     | 4                                  |
   | Video monitoring outputs   | 4                                  |
   -------------------------------------------------------------------
 
   |   8 |   |  out | Serial 8           |                    | x |
   ----------------------------------------------------------------
 
+Processing units
+  --------------------------------------------
+  | Proc Unit | x | Connected video input    |
+  --------------------------------------------
+  |         1 | O | Windows 4 HD             |
+  |         2 |   | Windows 2                |
+  |         3 | O |                          |
+  |         4 |   | Windows 3                |
+  --------------------------------------------
+

test/test-07.ok

   | Video inputs               | 16                                 |
   | Video outputs              | 16                                 |
   | Serial ports               | 8                                  |
+  | Video processing units     | 4                                  |
   | Video monitoring outputs   | 4                                  |
   -------------------------------------------------------------------
 

test/test-17.ok

          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<---------
-PROCESSING UNIT ROUTING:
-0 Output 15
----------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<---------
-PROCESSING UNIT LOCKS:
-0 U
----------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<---------
 ALARM STATUS:
 0 Error
 ---------8<-----------8<----------- cut here ---------8<------------8<---------
   | Video inputs               | 16                                 |
   | Video outputs              | 32                                 |
   | Serial ports               | 8                                  |
-  | Video processing units     | 16                                 |
   | Video monitoring outputs   | 8                                  |
   -------------------------------------------------------------------
 

videohubctrl.1

   - Input/Output port statuses
   - Monitoring video output port names, routing and locking
   - Serial ports names, routing, locking and directions
+  - Processing units
 .SH MAIN OPTIONS
 .PP
 .TP
 Display device serial ports. Port numbers, names, locking status, directions
 and how serial ports are routed. The locking statuses are the same as video
 input, output ports and monitoring ports.
+.TP
+\fB\-\-list\-proc-units\fR
+Display device procesing units. Unit numbers, locking status and connected
+video inputs.
 .SH CONFIGURATION COMMANDS
 .PP
 Everywhere where port needs to be set, you can use the port number or the
 and \fB\-\-se\-route\fR.
 .TP
 \fB\-\-se\-clear\fR <ser_X>
-Disconnect serial port X from serial port Y.
+Disconnect serial port X from the connected serial port.
 .TP
 \fB\-\-se\-lock\fR <ser_X>
 Lock serial port X.
 Unlock serial port X. If the port is locked by somebody else the
 port would be forcefully unlocked.
 .TP
-\fB\-\-se\-dir\fR <set_X> <in|out|auto>
+\fB\-\-se\-dir\fR <ser_X> <in|out|auto>
 Set serial port X direction. There are three possible settings for
 each port:
  \fBin\fR   - input/control/Workstation
  \fBout\fR  - output/slave/Deck
  \fBauto\fR - Automatic in/out
+.SH PROCESSING UNITS CONFIGURATION
+.PP
+.TP
+\fB\-\-pu\-input\fR <pu_X> <in_Y>
+Connect processing unit X to video input port Y.
+.TP
+\fB\-\-pu\-clear\fR <pu_X>
+Disconnect processing unit X from the connected input port.
+.TP
+\fB\-\-pu\-lock\fR <pu_X>
+Lock processing unit port X.
+.TP
+\fB\-\-pu\-unlock\fR <pu_X>
+Unlock processing unit port X. If the port is locked by somebody else the
+port would be forcefully unlocked.
 .SH MISC OPTIONS
 .PP
 .TP

videohubctrl.c

 	action_list_voutputs	= (1 << 2),
 	action_list_moutputs	= (1 << 3),
 	action_list_serial		= (1 << 4),
+	action_list_proc_units	= (1 << 5),
 };
 
 static const char *program_id = PROGRAM_NAME " Version: " VERSION " Git: " GIT_VER;
 	{ "se-unlock",			required_argument, NULL, 4004 },
 	{ "se-dir",				required_argument, NULL, 4005 },
 	{ "se-clear",			required_argument, NULL, 4006 },
+	{ "pu-input",			required_argument, NULL, 5001 },
+	{ "pu-connect",			required_argument, NULL, 5001 }, // Alias of --pu-input
+	{ "pu-route",			required_argument, NULL, 5001 }, // Alias of --pu-input
+	{ "pu-lock",			required_argument, NULL, 5002 },
+	{ "pu-unlock",			required_argument, NULL, 5003 },
+	{ "pu-clear",			required_argument, NULL, 5004 },
 	{ 0, 0, 0, 0 }
 };
 
 	printf(" --list-voutputs            | List device video outputs.\n");
 	printf(" --list-moutputs            | List device monitoring outputs.\n");
 	printf(" --list-serial              | List device serial ports.\n");
+	printf(" --list-proc-units          | List device processing units.\n");
 	printf("\n");
 	printf("Video inputs configuration:\n");
 	printf(" --vi-name <in_X> <name>    | Set video input port X name.\n");
 	printf(" --se-dir <ser_X> <dir>     | Set serial port X direction.\n");
 	printf("                            . <dir> can be 'auto', 'in' or 'out'.\n");
 	printf("\n");
+	printf("Processing units configuration:\n");
+	printf(" --pu-input <pu_X> <in_Y>   | Connect processing unit X to input Y.\n");
+	printf(" --pu-clear <pu_X>          | Disconnect unit X from input Y.\n");
+	printf(" --pu-lock <pu_X>           | Lock processing unit X.\n");
+	printf(" --pu-unlock <pu_X>         | Unlock processing unit X.\n");
+	printf("\n");
 	printf("Misc options:\n");
 	printf(" -T --test-input <file>     | Read commands from <file>.\n");
 	printf(" -d --debug                 | Increase logging verbosity.\n");
 			case 4004: parse_cmd1(argc, argv, CMD_SERIAL_PORT_LOCKS, false); break; // --se-unlock
 			case 4005: parse_cmd2(argc, argv, CMD_SERIAL_PORT_DIRECTIONS); break; // --se-dir
 			case 4006: parse_cmd2s(argc, argv, CMD_SERIAL_PORT_ROUTING); break; // --se-clear
+			case 5001: parse_cmd2(argc, argv, CMD_PROCESSING_UNIT_ROUTING); break; // --pu-input
+			case 5002: parse_cmd1(argc, argv, CMD_PROCESSING_UNIT_LOCKS, true); break; // --pu-lock
+			case 5003: parse_cmd1(argc, argv, CMD_PROCESSING_UNIT_LOCKS, false); break; // --pu-unlock
+			case 5004: parse_cmd2s(argc, argv, CMD_PROCESSING_UNIT_ROUTING); break; // --pu-clear
 			case 'H': // --help
 				show_help(data);
 				exit(EXIT_SUCCESS);
 	print_device_video_outputs(d);
 	print_device_monitoring_outputs(d);
 	print_device_serial_ports(d);
+	print_device_processing_units(d);
 	fflush(stdout);
 }
 
 	}
 
 	reset_routed_to(&data->serial);
+	reset_routed_to(&data->proc_units);
 	read_device_command_stream(data);
 
 	if (test_data)
 	check_number_of_ports(&data->outputs);
 	check_number_of_ports(&data->mon_outputs);
 	check_number_of_ports(&data->serial);
+	check_number_of_ports(&data->proc_units);
 
 	if (num_parsed_cmds) {
 		unsigned int i;
 		if (show_list & action_list_voutputs)	print_device_video_outputs(data);
 		if (show_list & action_list_moutputs)	print_device_monitoring_outputs(data);
 		if (show_list & action_list_serial)		print_device_serial_ports(data);
+		if (show_list & action_list_proc_units)	print_device_processing_units(data);
 		fflush(stdout);
 	} else if (show_backup) {
 		print_device_backup(data);