Skip to content

Commit 45d9699

Browse files
committed
drm/dp: Fixup kernel docs for struct drm_dp_aux
* Make sure that struct members are referred to using @, otherwise they won't be formatted as such * Make sure to refer to other struct types using & so they link back to each struct's definition * Make sure to precede constant values with % so they're formatted correctly Signed-off-by: Lyude Paul <[email protected]> Acked-by: Randy Dunlap <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
1 parent be318fd commit 45d9699

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

include/drm/drm_dp_helper.h

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1839,34 +1839,34 @@ struct drm_dp_aux_cec {
18391839
* @crc_count: counter of captured frame CRCs
18401840
* @transfer: transfers a message representing a single AUX transaction
18411841
*
1842-
* The .dev field should be set to a pointer to the device that implements
1843-
* the AUX channel.
1842+
* The @dev field should be set to a pointer to the device that implements the
1843+
* AUX channel.
18441844
*
1845-
* The .name field may be used to specify the name of the I2C adapter. If set to
1846-
* NULL, dev_name() of .dev will be used.
1845+
* The @name field may be used to specify the name of the I2C adapter. If set to
1846+
* %NULL, dev_name() of @dev will be used.
18471847
*
1848-
* Drivers provide a hardware-specific implementation of how transactions
1849-
* are executed via the .transfer() function. A pointer to a drm_dp_aux_msg
1848+
* Drivers provide a hardware-specific implementation of how transactions are
1849+
* executed via the @transfer() function. A pointer to a &drm_dp_aux_msg
18501850
* structure describing the transaction is passed into this function. Upon
1851-
* success, the implementation should return the number of payload bytes
1852-
* that were transferred, or a negative error-code on failure. Helpers
1853-
* propagate errors from the .transfer() function, with the exception of
1854-
* the -EBUSY error, which causes a transaction to be retried. On a short,
1855-
* helpers will return -EPROTO to make it simpler to check for failure.
1851+
* success, the implementation should return the number of payload bytes that
1852+
* were transferred, or a negative error-code on failure. Helpers propagate
1853+
* errors from the @transfer() function, with the exception of the %-EBUSY
1854+
* error, which causes a transaction to be retried. On a short, helpers will
1855+
* return %-EPROTO to make it simpler to check for failure.
18561856
*
18571857
* An AUX channel can also be used to transport I2C messages to a sink. A
1858-
* typical application of that is to access an EDID that's present in the
1859-
* sink device. The .transfer() function can also be used to execute such
1860-
* transactions. The drm_dp_aux_register() function registers an I2C
1861-
* adapter that can be passed to drm_probe_ddc(). Upon removal, drivers
1862-
* should call drm_dp_aux_unregister() to remove the I2C adapter.
1863-
* The I2C adapter uses long transfers by default; if a partial response is
1864-
* received, the adapter will drop down to the size given by the partial
1865-
* response for this transaction only.
1858+
* typical application of that is to access an EDID that's present in the sink
1859+
* device. The @transfer() function can also be used to execute such
1860+
* transactions. The drm_dp_aux_register() function registers an I2C adapter
1861+
* that can be passed to drm_probe_ddc(). Upon removal, drivers should call
1862+
* drm_dp_aux_unregister() to remove the I2C adapter. The I2C adapter uses long
1863+
* transfers by default; if a partial response is received, the adapter will
1864+
* drop down to the size given by the partial response for this transaction
1865+
* only.
18661866
*
1867-
* Note that the aux helper code assumes that the .transfer() function
1868-
* only modifies the reply field of the drm_dp_aux_msg structure. The
1869-
* retry logic and i2c helpers assume this is the case.
1867+
* Note that the aux helper code assumes that the @transfer() function only
1868+
* modifies the reply field of the &drm_dp_aux_msg structure. The retry logic
1869+
* and i2c helpers assume this is the case.
18701870
*/
18711871
struct drm_dp_aux {
18721872
const char *name;

0 commit comments

Comments
 (0)