Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
media: v4l2-common: Improve devm_v4l2_sensor_clk_get() documentation
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>
authored by
Sakari Ailus
and committed by
Hans Verkuil
2412f16c
380e6896
+9
-1
+9
-1
include/media/v4l2-common.h
+9
-1
include/media/v4l2-common.h
···
623
623
624
624
/**
625
625
* devm_v4l2_sensor_clk_get - lookup and obtain a reference to a clock producer
626
-
* for a camera sensor.
626
+
* for a camera sensor
627
627
*
628
628
* @dev: device for v4l2 sensor clock "consumer"
629
629
* @id: clock consumer ID
···
642
642
* by a camera sensor PMIC driver (e.g. int3472/tps68470.c)
643
643
*
644
644
* In this case try to set the clock-frequency value to the provided clock.
645
+
*
646
+
* As the name indicates, this function may only be used on camera sensor
647
+
* devices. This is because generally only camera sensors do need a clock to
648
+
* query the frequency from, due to the requirement to configure the PLL for a
649
+
* given CSI-2 interface frequency where the sensor's external clock frequency
650
+
* is a factor. Additionally, the clock frequency tends to be available on ACPI
651
+
* firmware based systems for camera sensors specifically (if e.g. DisCo for
652
+
* Imaging compliant).
645
653
*
646
654
* Returns a pointer to a struct clk on success or an error pointer on failure.
647
655
*/