test: add some basic ptp tests

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>

Author: troglobit

doc/testing.md

@@ -359,6 +359,51 @@ $ make test-spec
 ...
 ```
 
+### Node and Link Capabilities
+
+Logical topology files (`topology.dot`) declare what each node and link
+*requires*; physical topology files declare what each node and link
+*provides*.  When mapping a logical topology to physical hardware, infamy
+only assigns a physical node to a logical node when the physical node's
+`provides` set is a superset of the logical node's `requires` set.  Tests
+are skipped if no matching physical topology can be found.
+
+#### Declaring requirements (logical topology)
+
+```dot
+dut [
+    requires="infix ptp-hwts",
+];
+
+host:data -- dut:data [requires="ieee-mc"]
+```
+
+#### Declaring capabilities (physical topology)
+
+```dot
+switch1 [
+    provides="infix ptp-hwts",
+];
+```
+
+#### Node capabilities
+
+| Capability        | Meaning                                                                 |
+|-------------------|-------------------------------------------------------------------------|
+| `controller`      | Reserved for the host/controller node; never assigned to a DUT          |
+| `infix`           | Node runs Infix OS — required by virtually all DUT nodes                |
+| `infix gps`       | Node has a GPS receiver available as a time reference                   |
+| `infix watchdog`  | Node has a hardware watchdog device                                     |
+| `infix ptp-hwts`  | Node has PTP Hardware Clock (PHC) support on its network interfaces, enabling hardware timestamping and sub-microsecond PTP convergence |
+
+#### Link capabilities
+
+| Capability        | Meaning                                                                 |
+|-------------------|-------------------------------------------------------------------------|
+| `mgmt`            | Link is a management path (typically coloured grey in diagrams)         |
+| `ieee-mc`         | Link carries IEEE multicast traffic (required by LAG and some L2 tests) |
+| `link-ctrl copper`| Link supports copper speed/duplex control                               |
+
 ### Test Development
 
 For adding a new test to the automated regression test suite, it's best

src/confd/src/ptp.c

@@ -39,7 +39,7 @@ static const char *instance_type_to_clock_type(const char *type)
  *   gmCapable, follow_up_info, assume_two_step, path_trace_enabled,
  *   and the tighter neighborPropDelayThresh.
  */
-static bool emit_profile_globals(FILE *fp, const char *profile)
+static bool emit_profile_globals(FILE *fp, const char *profile, bool hw_ts)
 {
 	bool dot1as = profile && !strcmp(profile, "ieee802-dot1as");
 
@@ -53,7 +53,16 @@ static bool emit_profile_globals(FILE *fp, const char *profile)
 		fprintf(fp, "follow_up_info          1\n");
 		fprintf(fp, "assume_two_step         1\n");
 		fprintf(fp, "path_trace_enabled      1\n");
-		fprintf(fp, "neighborPropDelayThresh 800\n");
+		/*
+		 * 802.1AS P2P gate: if meanLinkDelay exceeds this threshold the
+		 * port stays asCapable=false and never leaves LISTENING.  800 ns
+		 * is the 802.1AS default and is appropriate only for hardware
+		 * timestamping — software timestamps (QEMU, tap interfaces) can
+		 * easily produce peer delays in the microsecond range, which
+		 * would keep both ports stuck in LISTENING indefinitely.
+		 */
+		if (hw_ts)
+			fprintf(fp, "neighborPropDelayThresh 800\n");
 	} else {
 		fprintf(fp, "transportSpecific       0\n");
 	}
@@ -130,7 +139,7 @@ static const char *instance_time_stamping(struct lyd_node *inst, json_t *root)
 static int write_instance_conf(struct lyd_node *inst, json_t *root)
 {
 	struct lyd_node *default_ds, *port, *port_ds;
-	const char *instance_type, *clock_type, *profile;
+	const char *instance_type, *clock_type, *profile, *ts;
 	const char *v;
 	char path[256];
 	uint16_t idx;
@@ -154,7 +163,7 @@ static int write_instance_conf(struct lyd_node *inst, json_t *root)
 
 	default_ds    = lydx_get_child(inst, "default-ds");
 	instance_type = lydx_get_cattr(default_ds, "instance-type");
-	profile       = lydx_get_cattr(default_ds, "infix-ptp:profile");
+	profile       = lydx_get_cattr(default_ds, "profile");
 
 	clock_type = instance_type_to_clock_type(instance_type);
 	tc = (clock_type != NULL);
@@ -164,10 +173,11 @@ static int write_instance_conf(struct lyd_node *inst, json_t *root)
 	fprintf(fp, "uds_address        /var/run/ptp4l-%u\n", idx);
 
 	/* Timestamping mode: hardware if all ports support it, software otherwise */
-	fprintf(fp, "time_stamping      %s\n", instance_time_stamping(inst, root));
+	ts = instance_time_stamping(inst, root);
+	fprintf(fp, "time_stamping      %s\n", ts);
 
 	/* Profile — sets transportSpecific and all protocol-mandatory options */
-	dot1as = emit_profile_globals(fp, profile);
+	dot1as = emit_profile_globals(fp, profile, !strcmp(ts, "hardware"));
 
 	/* domainNumber */
 	v = lydx_get_cattr(default_ds, "domain-number");

test/case/all.yaml

@@ -35,6 +35,9 @@
 - name: "NTP Server"
   suite: ntp/all.yaml
 
+- name: "PTP"
+  suite: ptp/all.yaml
+
 - name: "Routing"
   suite: routing/all.yaml
 

test/case/ptp/Readme.adoc

@@ -0,0 +1,46 @@
+:testgroup:
+== PTP Tests
+
+Tests for PTP (IEEE 1588 Precision Time Protocol) functionality across
+different clock types and operational scenarios:
+
+ - Basic smoke test: full stack end-to-end
+ - BTCA: grandmaster election and runtime re-election via `priority1`
+ - Boundary Clock: two-port BC forwarding time with `steps-removed` accounting
+ - Transparent Clock: E2E and P2P TC on hardware-timestamping nodes
+ - Port fault recovery: link-down/link-up state machine and re-convergence
+
+The offset convergence threshold in the tests varies with the timestamping
+capability of the nodes under test:
+
+[cols="1,1,3",options="header"]
+|===
+| Timestamping | Default Threshold | Typical scenario
+| Software     | 100 000 ns        | Virtual machines, QEMU tap interfaces
+| Hardware     | 1 000 ns          | Nodes with PHC hardware timestamping
+|===
+
+Tests that accept a `--threshold-ns` option may use that value instead.
+When no option is given, the threshold is selected automatically based
+on the `ptp-hwts` capability of the relevant node in the physical test
+system's topology file.
+
+<<<
+
+include::basic/Readme.adoc[]
+
+<<<
+
+include::bmca/Readme.adoc[]
+
+<<<
+
+include::boundary_clock/Readme.adoc[]
+
+<<<
+
+include::transparent_clock/Readme.adoc[]
+
+<<<
+
+include::port_recovery/Readme.adoc[]

test/case/ptp/all.yaml

@@ -0,0 +1,15 @@
+---
+- name: PTP basic
+  suite: basic/test.yaml
+
+- name: PTP BTCA grandmaster election
+  suite: bmca/test.yaml
+
+- name: PTP boundary clock
+  suite: boundary_clock/test.yaml
+
+- name: PTP transparent clock
+  suite: transparent_clock/test.yaml
+
+- name: PTP port fault recovery
+  case: port_recovery/test.py

test/case/ptp/basic/Readme.adoc

@@ -0,0 +1,6 @@
+include::ieee1588.adoc[]
+
+<<<
+
+include::ieee802dot1as.adoc[]
+

test/case/ptp/basic/ieee1588.adoc

@@ -0,0 +1,28 @@
+=== PTP basic (IEEE 1588)
+
+ifdef::topdoc[:imagesdir: {topdoc}../../test/case/ptp/basic]
+
+==== Description
+
+Verify basic PTP operation end-to-end: clock configuration, port state
+transitions, and clock servo convergence.
+
+Two Ordinary Clocks are connected back-to-back.  The grandmaster is
+configured with `priority1=1` so it always wins the BTCA election; the
+time receiver is configured with `time-receiver-only` so it never
+attempts to become grandmaster.  The test is run once per supported
+profile, covering both IEEE 1588-2019 (UDP/IPv4, E2E) and IEEE 802.1AS
+(Layer 2, P2P).
+
+==== Topology
+
+image::topology.svg[PTP basic (IEEE 1588) topology, align=center, scaledwidth=75%]
+
+==== Sequence
+
+. Set up topology and attach to DUTs
+. Configure grandmaster (OC, ieee1588, priority1=1) and time receiver (ieee1588, priority1=128, client-only)
+. Wait for grandmaster and time receiver ports to reach active states
+. Wait for time receiver offset to converge
+
+

test/case/ptp/basic/ieee1588.py

@@ -0,0 +1 @@
+test.py

test/case/ptp/basic/ieee802dot1as.adoc

@@ -0,0 +1,28 @@
+=== PTP basic (IEEE 802.1AS)
+
+ifdef::topdoc[:imagesdir: {topdoc}../../test/case/ptp/basic]
+
+==== Description
+
+Verify basic PTP operation end-to-end: clock configuration, port state
+transitions, and clock servo convergence.
+
+Two Ordinary Clocks are connected back-to-back.  The grandmaster is
+configured with `priority1=1` so it always wins the BTCA election; the
+time receiver is configured with `time-receiver-only` so it never
+attempts to become grandmaster.  The test is run once per supported
+profile, covering both IEEE 1588-2019 (UDP/IPv4, E2E) and IEEE 802.1AS
+(Layer 2, P2P).
+
+==== Topology
+
+image::topology.svg[PTP basic (IEEE 802.1AS) topology, align=center, scaledwidth=75%]
+
+==== Sequence
+
+. Set up topology and attach to DUTs
+. Configure grandmaster (OC, ieee802-dot1as, priority1=1) and time receiver (ieee802-dot1as, priority1=128, client-only)
+. Wait for grandmaster and time receiver ports to reach active states
+. Wait for time receiver offset to converge
+
+

test/case/ptp/basic/ieee802dot1as.py

@@ -0,0 +1 @@
+test.py