Skip to content

Commit 8989682

Browse files
committed
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: Jakub Kicinski <kuba@kernel.org>
2 parents 0e0c52d + c8afdc0 commit 8989682

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

Documentation/driver-api/dpll.rst

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,19 @@ with.
119119
If a pin was registered with multiple parent pins, they behave like a
120120
multiple output multiplexer. In this case output of a
121121
``DPLL_CMD_PIN_GET`` would contain multiple pin-parent nested
122-
attributes with current state related to each parent, like:
123-
124-
'pin': [{{
125-
'clock-id': 282574471561216,
126-
'module-name': 'ice',
127-
'capabilities': 4,
128-
'id': 13,
129-
'parent-pin': [
130-
{'parent-id': 2, 'state': 'connected'},
131-
{'parent-id': 3, 'state': 'disconnected'}
132-
],
133-
'type': 'synce-eth-port'
134-
}}]
122+
attributes with current state related to each parent, like::
123+
124+
'pin': [{{
125+
'clock-id': 282574471561216,
126+
'module-name': 'ice',
127+
'capabilities': 4,
128+
'id': 13,
129+
'parent-pin': [
130+
{'parent-id': 2, 'state': 'connected'},
131+
{'parent-id': 3, 'state': 'disconnected'}
132+
],
133+
'type': 'synce-eth-port'
134+
}}]
135135

136136
Only one child pin can provide its signal to the parent MUX-type pin at
137137
a time, the selection is done by requesting change of a child pin state
@@ -425,6 +425,7 @@ The simplest implementation is in the OCP TimeCard driver. The ops
425425
structures are defined like this:
426426

427427
.. code-block:: c
428+
428429
static const struct dpll_device_ops dpll_ops = {
429430
.lock_status_get = ptp_ocp_dpll_lock_status_get,
430431
.mode_get = ptp_ocp_dpll_mode_get,
@@ -442,6 +443,7 @@ structures are defined like this:
442443
The registration part is then looks like this part:
443444

444445
.. code-block:: c
446+
445447
clkid = pci_get_dsn(pdev);
446448
bp->dpll = dpll_device_get(clkid, 0, THIS_MODULE);
447449
if (IS_ERR(bp->dpll)) {
@@ -472,6 +474,7 @@ The registration part is then looks like this part:
472474
In the error path we have to rewind every allocation in the reverse order:
473475

474476
.. code-block:: c
477+
475478
while (i) {
476479
--i;
477480
dpll_pin_unregister(bp->dpll, bp->sma[i].dpll_pin, &dpll_pins_ops, &bp->sma[i]);

0 commit comments

Comments
 (0)