jsauer/torvalds-linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-01-11 17:10:13 +00:00
Code

media: v4l2-common: Improve devm_v4l2_sensor_clk_get() documentation

Browse Source 
Remove the extra leading period and provide more elaborate explanation for
why devm_v4l2_sensor_clk_get() is only allowed to be used on camera sensor
devices.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Hans Verkuil <hverkuil+cisco@kernel.org>
This commit is contained in:
Sakari Ailus 2025-08-14 16:50:07 +03:00 committed by Hans Verkuil
parent 380e6896c2
commit 2412f16c9a
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/media/v4l2-common.h
View File

@ -623,7 +623,7 @@ int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
/**
* devm_v4l2_sensor_clk_get - lookup and obtain a reference to a clock producer
* for a camera sensor.
* for a camera sensor
*
* @dev: device for v4l2 sensor clock "consumer"
* @id: clock consumer ID
@ -643,6 +643,14 @@ int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
*
* In this case try to set the clock-frequency value to the provided clock.
*
* As the name indicates, this function may only be used on camera sensor
* devices. This is because generally only camera sensors do need a clock to
* query the frequency from, due to the requirement to configure the PLL for a
* given CSI-2 interface frequency where the sensor's external clock frequency
* is a factor. Additionally, the clock frequency tends to be available on ACPI
* firmware based systems for camera sensors specifically (if e.g. DisCo for
* Imaging compliant).
*
* Returns a pointer to a struct clk on success or an error pointer on failure.
*/
struct clk *devm_v4l2_sensor_clk_get(struct device *dev, const char *id);