The DPLL subsystem has no in-tree driver that can run without real
hardware, so core changes and userspace tooling are hard to exercise in
CI, and the pin-on-pin and reference sync paths see almost no coverage
outside the vendors' labs. This series adds dpllsim, a simulated DPLL
device driver, together with selftests that run against it.
The driver is controlled through configfs, following gpio-sim. Writing a
clock ID into a device directory and setting "live" to 1 registers a
DPLL device with the core. Pins are directories under pins/ with their
type, frequency, direction and priority as attributes, and all of them
are registered when the device goes live. The split between creating
the configuration and going live keeps the register and unregister
paths reachable from userspace, so they can be exercised repeatedly
without reloading the module. Nothing in the simulator is a stable ABI.
The patches follow the shape of the zl3073x introduction. The
driver starts with the device alone, then gains pins and the static pin
operations one at a time (state, priority, frequency, phase adjustment),
and every feature patch is followed by the selftest that covers it. The
last two patches add concurrency stress tests and reference tracker
leak tests for the lifecycle paths.
The simulation loop (lock state machine, phase and frequency
measurements, monitoring features), the topology features (MUX pin
hierarchies, reference sync, media failure injection), netdevsim
integration and device mode setting follow in two further series once
this one is in, to stay within the 15 patch limit.
The driver and the selftests were developed with an LLM coding
assistant (Claude Code) working under my direction. I chose the
configfs design, the split into one feature per patch and the test
scenarios, and I reviewed every line. The assistant wrote most of the
code and the first drafts of the changelogs, and it found and fixed
bugs by running the suite on the lab host. The series then went
through several rounds of an LLM based patch reviewer whose findings
were fixed, and through a mutation test in which deliberately broken
driver and core code was caught by the tests.
The selftests live in tools/testing/selftests/drivers/dpll and run
with "make -C tools/testing/selftests TARGETS=drivers/dpll run_tests".
By default they create dpllsim devices; with DPLL_DEV_ID=<id> the basic
and feature scripts run against an existing device instead, so the same
suite exercises real hardware, and DPLL_DRIVER=<module name> picks the
first device of that driver, dpllsim for a simulated one. The whole
suite was run through the kselftest runner in a KVM guest and on an ice
E810 host with CONFIG_KASAN, CONFIG_PROVE_LOCKING and
CONFIG_DPLL_REFCNT_TRACKER enabled, against the simulator and, with
DPLL_DRIVER=ice, against the ice DPLL, where the tests that need a
simulator skip and the pin state and priorities of the hardware are
left as they were. All pass with no warnings in dmesg.
---
v3:
- move the selftests from tools/testing/selftests/drivers/net/dpll to
tools/testing/selftests/drivers/dpll, with the shared library as a
TEST_FILES entry of that directory, so that the tests sit where the
drivers do
- let dpllsim refuse pin states that are not valid in the device mode:
connected is refused in automatic mode, which the simulator runs in,
as Documentation/driver-api/dpll.rst reserves it for manual mode
(Ivan Vecera)
- make the pin state test follow the mode of the device under test and
check on the simulator that connected is refused in automatic mode;
cycle the stress tests through the states of automatic mode only
- add DPLL_DRIVER to pick the device of a given driver, or the simulator
with DPLL_DRIVER=dpllsim, on a system that has hardware DPLL devices
- describe what the leak check waits for instead of a concurrent dump
holding references, which nothing does (Ivan Vecera)
- carry the Reviewed-by and the set Acked-by of v2 over to the patches
whose code did not change or only moved; patches 2, 5 and 6 changed
and ask for a new look
v2:
- sort tools/testing/selftests/drivers/net/dpll/config alphabetically
and make the scripts clean under the shellcheck run of the netdev CI
(quoted exit and return values, shellcheck directives for the globals
shared between the library and the scripts and for the optional
argument of dpllsim_setup_standard_device())
v2: https://lore.kernel.org/all/20261105151852.1844305-1-poros@redhat.com/ (local)
v1: https://lore.kernel.org/all/20261103093910.596225-1-poros@redhat.com/ (local)
---
Petr Oros (14):
dpll: dpllsim: Add simulated DPLL device driver
selftests: dpll: add test library and device lifecycle tests
dpll: dpllsim: Add configurable pins
selftests: dpll: add pin enumeration and property tests
dpll: dpllsim: Add support to set input pin state
selftests: dpll: add pin state tests
dpll: dpllsim: Add support to get/set priority on input pins
selftests: dpll: add pin priority test
dpll: dpllsim: Add support to set frequency on pins
selftests: dpll: add pin frequency test
dpll: dpllsim: Add support to adjust phase
selftests: dpll: add pin phase adjust test
selftests: dpll: add concurrency stress tests
selftests: dpll: add reference leak tests
Documentation/driver-api/dpllsim.rst | 72 ++
Documentation/driver-api/index.rst | 1 +
MAINTAINERS | 8 +
drivers/dpll/Kconfig | 1 +
drivers/dpll/Makefile | 1 +
drivers/dpll/dpllsim/Kconfig | 16 +
drivers/dpll/dpllsim/Makefile | 4 +
drivers/dpll/dpllsim/core.c | 471 ++++++++++
drivers/dpll/dpllsim/dpll.c | 498 ++++++++++
drivers/dpll/dpllsim/dpllsim.h | 99 ++
tools/testing/selftests/Makefile | 1 +
tools/testing/selftests/drivers/dpll/Makefile | 17 +
tools/testing/selftests/drivers/dpll/config | 6 +
.../selftests/drivers/dpll/dpll_basic.sh | 223 +++++
.../selftests/drivers/dpll/dpll_features.sh | 470 ++++++++++
.../selftests/drivers/dpll/dpll_lib.sh | 872 ++++++++++++++++++
.../selftests/drivers/dpll/dpll_reftrack.sh | 184 ++++
.../selftests/drivers/dpll/dpll_stress.sh | 563 +++++++++++
tools/testing/selftests/drivers/dpll/settings | 1 +
19 files changed, 3508 insertions(+)
create mode 100644 Documentation/driver-api/dpllsim.rst
create mode 100644 drivers/dpll/dpllsim/Kconfig
create mode 100644 drivers/dpll/dpllsim/Makefile
create mode 100644 drivers/dpll/dpllsim/core.c
create mode 100644 drivers/dpll/dpllsim/dpll.c
create mode 100644 drivers/dpll/dpllsim/dpllsim.h
create mode 100644 tools/testing/selftests/drivers/dpll/Makefile
create mode 100644 tools/testing/selftests/drivers/dpll/config
create mode 100755 tools/testing/selftests/drivers/dpll/dpll_basic.sh
create mode 100755 tools/testing/selftests/drivers/dpll/dpll_features.sh
create mode 100644 tools/testing/selftests/drivers/dpll/dpll_lib.sh
create mode 100755 tools/testing/selftests/drivers/dpll/dpll_reftrack.sh
create mode 100755 tools/testing/selftests/drivers/dpll/dpll_stress.sh
create mode 100644 tools/testing/selftests/drivers/dpll/settings
--
2.56.0