mirror of
https://github.com/lkl/linux.git
synced 2025-12-19 16:13:19 +09:00
media: Documentation: media: Fix v4l2-async kerneldoc syntax
Fix kerneldoc syntax in v4l2-async. The references were not produced correctly. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
committed by
Mauro Carvalho Chehab
parent
b9a5433642
commit
6f8f9fdec8
@@ -5,7 +5,7 @@
|
|||||||
Pixel data transmitter and receiver drivers
|
Pixel data transmitter and receiver drivers
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
V4L2 supports various devices that transmit and receiver pixel data. Examples of
|
V4L2 supports various devices that transmit and receive pixel data. Examples of
|
||||||
these devices include a camera sensor, a TV tuner and a parallel or a CSI-2
|
these devices include a camera sensor, a TV tuner and a parallel or a CSI-2
|
||||||
receiver in an SoC.
|
receiver in an SoC.
|
||||||
|
|
||||||
@@ -95,9 +95,9 @@ LP-11 and LP-111 modes
|
|||||||
|
|
||||||
The transmitter drivers must, if possible, configure the CSI-2 transmitter to
|
The transmitter drivers must, if possible, configure the CSI-2 transmitter to
|
||||||
*LP-11 or LP-111 mode* whenever the transmitter is powered on but not active,
|
*LP-11 or LP-111 mode* whenever the transmitter is powered on but not active,
|
||||||
and maintain *LP-11 or LP-111 mode* until stream on. Only at stream on should
|
and maintain *LP-11 or LP-111 mode* until stream on. Only at stream on time
|
||||||
the transmitter activate the clock on the clock lane and transition to *HS
|
should the transmitter activate the clock on the clock lane and transition to
|
||||||
mode*.
|
*HS mode*.
|
||||||
|
|
||||||
Some transmitters do this automatically but some have to be explicitly
|
Some transmitters do this automatically but some have to be explicitly
|
||||||
programmed to do so, and some are unable to do so altogether due to
|
programmed to do so, and some are unable to do so altogether due to
|
||||||
|
|||||||
@@ -37,6 +37,8 @@ Image Process Control IDs
|
|||||||
by selecting the desired horizontal and vertical blanking. The unit
|
by selecting the desired horizontal and vertical blanking. The unit
|
||||||
of this control is Hz.
|
of this control is Hz.
|
||||||
|
|
||||||
|
.. _v4l2-cid-pixel-rate:
|
||||||
|
|
||||||
``V4L2_CID_PIXEL_RATE (64-bit integer)``
|
``V4L2_CID_PIXEL_RATE (64-bit integer)``
|
||||||
Pixel rate in the source pads of the subdev. This control is
|
Pixel rate in the source pads of the subdev. This control is
|
||||||
read-only and its unit is pixels / second.
|
read-only and its unit is pixels / second.
|
||||||
|
|||||||
@@ -129,11 +129,11 @@ void v4l2_async_debug_init(struct dentry *debugfs_dir);
|
|||||||
*
|
*
|
||||||
* This function initializes the notifier @asd_list. It must be called
|
* This function initializes the notifier @asd_list. It must be called
|
||||||
* before adding a subdevice to a notifier, using one of:
|
* before adding a subdevice to a notifier, using one of:
|
||||||
* @v4l2_async_notifier_add_fwnode_remote_subdev,
|
* v4l2_async_notifier_add_fwnode_remote_subdev(),
|
||||||
* @v4l2_async_notifier_add_fwnode_subdev,
|
* v4l2_async_notifier_add_fwnode_subdev(),
|
||||||
* @v4l2_async_notifier_add_i2c_subdev,
|
* v4l2_async_notifier_add_i2c_subdev(),
|
||||||
* @__v4l2_async_notifier_add_subdev or
|
* __v4l2_async_notifier_add_subdev() or
|
||||||
* @v4l2_async_notifier_parse_fwnode_endpoints.
|
* v4l2_async_notifier_parse_fwnode_endpoints().
|
||||||
*/
|
*/
|
||||||
void v4l2_async_notifier_init(struct v4l2_async_notifier *notifier);
|
void v4l2_async_notifier_init(struct v4l2_async_notifier *notifier);
|
||||||
|
|
||||||
@@ -145,9 +145,9 @@ void v4l2_async_notifier_init(struct v4l2_async_notifier *notifier);
|
|||||||
* @asd: pointer to &struct v4l2_async_subdev
|
* @asd: pointer to &struct v4l2_async_subdev
|
||||||
*
|
*
|
||||||
* \warning: Drivers should avoid using this function and instead use one of:
|
* \warning: Drivers should avoid using this function and instead use one of:
|
||||||
* @v4l2_async_notifier_add_fwnode_subdev,
|
* v4l2_async_notifier_add_fwnode_subdev(),
|
||||||
* @v4l2_async_notifier_add_fwnode_remote_subdev or
|
* v4l2_async_notifier_add_fwnode_remote_subdev() or
|
||||||
* @v4l2_async_notifier_add_i2c_subdev.
|
* v4l2_async_notifier_add_i2c_subdev().
|
||||||
*
|
*
|
||||||
* Call this function before registering a notifier to link the provided @asd to
|
* Call this function before registering a notifier to link the provided @asd to
|
||||||
* the notifiers master @asd_list. The @asd must be allocated with k*alloc() as
|
* the notifiers master @asd_list. The @asd must be allocated with k*alloc() as
|
||||||
@@ -200,7 +200,7 @@ __v4l2_async_notifier_add_fwnode_remote_subdev(struct v4l2_async_notifier *notif
|
|||||||
* function also gets a reference of the fwnode which is released later at
|
* function also gets a reference of the fwnode which is released later at
|
||||||
* notifier cleanup time.
|
* notifier cleanup time.
|
||||||
*
|
*
|
||||||
* This is just like @v4l2_async_notifier_add_fwnode_subdev, but with the
|
* This is just like v4l2_async_notifier_add_fwnode_subdev(), but with the
|
||||||
* exception that the fwnode refers to a local endpoint, not the remote one.
|
* exception that the fwnode refers to a local endpoint, not the remote one.
|
||||||
*/
|
*/
|
||||||
#define v4l2_async_notifier_add_fwnode_remote_subdev(notifier, ep, type) \
|
#define v4l2_async_notifier_add_fwnode_remote_subdev(notifier, ep, type) \
|
||||||
@@ -265,13 +265,13 @@ void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
|
|||||||
* sub-devices allocated for the purposes of the notifier but not the notifier
|
* sub-devices allocated for the purposes of the notifier but not the notifier
|
||||||
* itself. The user is responsible for calling this function to clean up the
|
* itself. The user is responsible for calling this function to clean up the
|
||||||
* notifier after calling
|
* notifier after calling
|
||||||
* @v4l2_async_notifier_add_fwnode_remote_subdev,
|
* v4l2_async_notifier_add_fwnode_remote_subdev(),
|
||||||
* @v4l2_async_notifier_add_fwnode_subdev,
|
* v4l2_async_notifier_add_fwnode_subdev(),
|
||||||
* @v4l2_async_notifier_add_i2c_subdev,
|
* v4l2_async_notifier_add_i2c_subdev(),
|
||||||
* @__v4l2_async_notifier_add_subdev or
|
* __v4l2_async_notifier_add_subdev() or
|
||||||
* @v4l2_async_notifier_parse_fwnode_endpoints.
|
* v4l2_async_notifier_parse_fwnode_endpoints().
|
||||||
*
|
*
|
||||||
* There is no harm from calling v4l2_async_notifier_cleanup in other
|
* There is no harm from calling v4l2_async_notifier_cleanup() in other
|
||||||
* cases as long as its memory has been zeroed after it has been
|
* cases as long as its memory has been zeroed after it has been
|
||||||
* allocated.
|
* allocated.
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user