Commit 8989682a authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'documentation-fixes-for-dpll-subsystem' 

Bagas Sanjaya says:

====================
Documentation fixes for dpll subsystem

Here is a mini docs fixes for dpll subsystem. The fixes are all code
block-related.

This series is triggered because I was emailed by kernel test robot,
alerting htmldocs warnings (see patch [1/2]).

[1]: https://lore.kernel.org/all/20230918093240.29824-1-bagasdotme@gmail.com/
====================

Link: https://lore.kernel.org/r/20230928052708.44820-1-bagasdotme@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents 0e0c52d6 c8afdc01

Documentation/driver-api/dpll.rst

+16 −13
Original line number Diff line number Diff line
@@ -119,7 +119,7 @@ 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,
@@ -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]);