aboutsummaryrefslogtreecommitdiff
path: root/Documentation/dev-tools/kunit/api
diff options
context:
space:
mode:
authorStephen Boyd <[email protected]>2024-07-18 14:05:05 -0700
committerStephen Boyd <[email protected]>2024-07-29 15:33:12 -0700
commitd690bd11e87adfc684265209a5aabd1f58fa367e (patch)
tree187f63373b8beca42e945d7f755b51e405ddeaaf /Documentation/dev-tools/kunit/api
parent5ac79730324c6f37106ce397586020ffe6e8e234 (diff)
clk: Add test managed clk provider/consumer APIs
Unit tests are more ergonomic and simpler to understand if they don't have to hoist a bunch of code into the test harness init and exit functions. Add some test managed wrappers for the clk APIs so that clk unit tests can write more code in the actual test and less code in the harness. Only add APIs that are used for now. More wrappers can be added in the future as necessary. Cc: Brendan Higgins <[email protected]> Cc: David Gow <[email protected]> Cc: Rae Moar <[email protected]> Signed-off-by: Stephen Boyd <[email protected]> Link: https://lore.kernel.org/r/[email protected]
Diffstat (limited to 'Documentation/dev-tools/kunit/api')
-rw-r--r--Documentation/dev-tools/kunit/api/clk.rst10
-rw-r--r--Documentation/dev-tools/kunit/api/index.rst5
2 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/api/clk.rst b/Documentation/dev-tools/kunit/api/clk.rst
new file mode 100644
index 000000000000..eeaa50089453
--- /dev/null
+++ b/Documentation/dev-tools/kunit/api/clk.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+========
+Clk API
+========
+
+The KUnit clk API is used to test clk providers and clk consumers.
+
+.. kernel-doc:: drivers/clk/clk_kunit_helpers.c
+ :export:
diff --git a/Documentation/dev-tools/kunit/api/index.rst b/Documentation/dev-tools/kunit/api/index.rst
index 02b26f5e8750..5cdb552a0808 100644
--- a/Documentation/dev-tools/kunit/api/index.rst
+++ b/Documentation/dev-tools/kunit/api/index.rst
@@ -9,6 +9,7 @@ API Reference
test
resource
functionredirection
+ clk
of
platformdevice
@@ -34,6 +35,10 @@ Documentation/dev-tools/kunit/api/functionredirection.rst
Driver KUnit API
================
+Documentation/dev-tools/kunit/api/clk.rst
+
+ - Documents the KUnit clk API
+
Documentation/dev-tools/kunit/api/of.rst
- Documents the KUnit device tree (OF) API