RFCv1 [1] was an initial proposal defining testable code specifications for some functions in /drivers/char/mem.c. However it was not clear how to write specifications according to the format and wording used for them, plus tests were missing.
RFCv2 [2] proposed a guideline explaining how to write such testable code specifications and also added kselftest for read_mem, however there was reluctance to accept the proposed addition before having clarity on who needs it, who is going to maintain it and for which APIs in the kernel it is needed. RFCv3 (this one) proposes kernel-doc API documentation according to the current doc-guide for some APIs of /dev/mem introducing the concept of traceable specifications to KUnit tests. For read_mem() Kunit tests traced to the corresponding specifications are also introduced, so that in case of test failure it is clear which specification is violated and it would be easier to review incoming patches agaisnt the intended behavior of the code. [1] https://lore.kernel.org/all/[email protected]/ [2] https://lore.kernel.org/all/[email protected]/ Alessandro Carminati (4): kunit: add visibility helpers for static inline functions char: mem: expose devmem helpers for KUnit testing char: mem: add KUnit tests for /dev/mem read_mem() char: mem: add Kconfig option for devmem KUnit tests Gabriele Paoloni (2): Documentation: extend the 'Function documentation' with expected behavior and constraints of use /dev/mem: Add initial documentation of memory_open() and mem_fops Documentation/doc-guide/kernel-doc.rst | 19 + drivers/char/Kconfig | 21 + drivers/char/Makefile | 1 + drivers/char/mem.c | 211 +++- drivers/char/mem.h | 17 + drivers/char/mem_kunit_test.c | 1323 ++++++++++++++++++++++++ include/kunit/visibility.h | 2 + 7 files changed, 1584 insertions(+), 10 deletions(-) create mode 100644 drivers/char/mem.h create mode 100644 drivers/char/mem_kunit_test.c -- 2.48.1
