From 92425d08a60814b4a2e91626f1e24e4fd5fd5c7e Mon Sep 17 00:00:00 2001 From: Bagas Sanjaya Date: Thu, 28 Sep 2023 12:27:07 +0700 Subject: [PATCH 1/2] Documentation: dpll: Fix code blocks kernel test robot and Stephen Rothwell report htmldocs warnings: Documentation/driver-api/dpll.rst:427: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 18 supplied. .. code-block:: c ... Documentation/driver-api/dpll.rst:444: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 21 supplied. .. code-block:: c ... Documentation/driver-api/dpll.rst:474: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 12 supplied. .. code-block:: c ... Fix these above by adding missing blank line separator after code-block directive. Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202309180456.lOhxy9gS-lkp@intel.com/ Reported-by: Stephen Rothwell Closes: https://lore.kernel.org/linux-next/20230918131521.155e9e63@canb.auug.org.au/ Fixes: dbb291f19393b6 ("dpll: documentation on DPLL subsystem interface") Signed-off-by: Bagas Sanjaya Acked-by: Randy Dunlap Tested-by: Randy Dunlap Reviewed-by: Vadim Fedorenko Link: https://lore.kernel.org/r/20230928052708.44820-2-bagasdotme@gmail.com Signed-off-by: Jakub Kicinski --- Documentation/driver-api/dpll.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst index bb52f1b8c0be..01eb4de86703 100644 --- a/Documentation/driver-api/dpll.rst +++ b/Documentation/driver-api/dpll.rst @@ -425,6 +425,7 @@ The simplest implementation is in the OCP TimeCard driver. The ops structures are defined like this: .. code-block:: c + static const struct dpll_device_ops dpll_ops = { .lock_status_get = ptp_ocp_dpll_lock_status_get, .mode_get = ptp_ocp_dpll_mode_get, @@ -442,6 +443,7 @@ structures are defined like this: The registration part is then looks like this part: .. code-block:: c + clkid = pci_get_dsn(pdev); bp->dpll = dpll_device_get(clkid, 0, THIS_MODULE); if (IS_ERR(bp->dpll)) { @@ -472,6 +474,7 @@ The registration part is then looks like this part: In the error path we have to rewind every allocation in the reverse order: .. code-block:: c + while (i) { --i; dpll_pin_unregister(bp->dpll, bp->sma[i].dpll_pin, &dpll_pins_ops, &bp->sma[i]); From c8afdc01832943fab030103bd027ce021d26ddcf Mon Sep 17 00:00:00 2001 From: Bagas Sanjaya Date: Thu, 28 Sep 2023 12:27:08 +0700 Subject: [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block DPLL_CMD_PIN_GET netlink command output for mux-type pins looks ugly with normal paragraph formatting. Format it as a code block instead. Signed-off-by: Bagas Sanjaya Acked-by: Randy Dunlap Tested-by: Randy Dunlap Reviewed-by: Vadim Fedorenko Link: https://lore.kernel.org/r/20230928052708.44820-3-bagasdotme@gmail.com Signed-off-by: Jakub Kicinski --- Documentation/driver-api/dpll.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst index 01eb4de86703..69670deb8c4e 100644 --- a/Documentation/driver-api/dpll.rst +++ b/Documentation/driver-api/dpll.rst @@ -119,19 +119,19 @@ with. If a pin was registered with multiple parent pins, they behave like a multiple output multiplexer. In this case output of a ``DPLL_CMD_PIN_GET`` would contain multiple pin-parent nested -attributes with current state related to each parent, like: +attributes with current state related to each parent, like:: -'pin': [{{ - 'clock-id': 282574471561216, - 'module-name': 'ice', - 'capabilities': 4, - 'id': 13, - 'parent-pin': [ - {'parent-id': 2, 'state': 'connected'}, - {'parent-id': 3, 'state': 'disconnected'} - ], - 'type': 'synce-eth-port' - }}] + 'pin': [{{ + 'clock-id': 282574471561216, + 'module-name': 'ice', + 'capabilities': 4, + 'id': 13, + 'parent-pin': [ + {'parent-id': 2, 'state': 'connected'}, + {'parent-id': 3, 'state': 'disconnected'} + ], + 'type': 'synce-eth-port' + }}] Only one child pin can provide its signal to the parent MUX-type pin at a time, the selection is done by requesting change of a child pin state