[PATCH v2] firewire: core: use long bus reset on gap count error

[Adam G. <ad...@po...>]

From: Adam Goldman <ad...@po...>

When resetting the bus after a gap count error, use a long rather than 
short bus reset.

IEEE 1394-1995 uses only long bus resets. IEEE 1394a adds the option of 
short bus resets. When video or audio transmission is in progress and a 
device is hot-plugged elsewhere on the bus, the resulting bus reset can 
cause video frame drops or audio dropouts. Short bus resets reduce or 
eliminate this problem. Accordingly, short bus resets are almost always 
preferred.

However, on a mixed 1394/1394a bus, a short bus reset can trigger an 
immediate additional bus reset. This double bus reset can be interpreted 
differently by different nodes on the bus, resulting in an inconsistent gap 
count after the bus reset. An inconsistent gap count will cause another bus 
reset, leading to a neverending bus reset loop. This only happens for some 
bus topologies, not for all mixed 1394/1394a buses.

By instead sending a long bus reset after a gap count inconsistency, we 
avoid the doubled bus reset, restoring the bus to normal operation.

Signed-off-by: Adam Goldman <ad...@po...>
Link: https://sourceforge.net/p/linux1394/mailman/message/58741624/
---

--- linux-6.8-rc1.orig/drivers/firewire/core-card.c	2024-01-21 14:11:32.000000000 -0800
+++ linux-6.8-rc1/drivers/firewire/core-card.c	2024-02-28 02:23:48.000000000 -0800
@@ -484,7 +484,19 @@
 		fw_notice(card, "phy config: new root=%x, gap_count=%d\n",
 			  new_root_id, gap_count);
 		fw_send_phy_config(card, new_root_id, generation, gap_count);
-		reset_bus(card, true);
+		/*
+		 * Where possible, use a short bus reset to minimize
+		 * disruption to isochronous transfers. But in the event
+		 * of a gap count inconsistency, use a long bus reset.
+		 *
+		 * As noted in 1394a 8.4.6.2, nodes on a mixed 1394/1394a bus
+		 * may set different gap counts after a bus reset. On a mixed
+		 * 1394/1394a bus, a short bus reset can get doubled. Some
+		 * nodes may treat the double reset as one bus reset and others
+		 * may treat it as two, causing a gap count inconsistency
+		 * again. Using a long bus reset prevents this.
+		 */
+		reset_bus(card, card->gap_count != 0);
 		/* Will allocate broadcast channel after the reset. */
 		goto out;
 	}