Documentation/media/kapi/v4l2-clocks.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 V4L2 clocks
   4 -----------
   5
   6 .. attention::
   7
   8         This is a temporary API and it shall be replaced by the generic
   9         clock API, when the latter becomes widely available.
  10
  11 Many subdevices, like camera sensors, TV decoders and encoders, need a clock
  12 signal to be supplied by the system. Often this clock is supplied by the
  13 respective bridge device. The Linux kernel provides a Common Clock Framework for
  14 this purpose. However, it is not (yet) available on all architectures. Besides,
  15 the nature of the multi-functional (clock, data + synchronisation, I2C control)
  16 connection of subdevices to the system might impose special requirements on the
  17 clock API usage. E.g. V4L2 has to support clock provider driver unregistration
  18 while a subdevice driver is holding a reference to the clock. For these reasons
  19 a V4L2 clock helper API has been developed and is provided to bridge and
  20 subdevice drivers.
  21
  22 The API consists of two parts: two functions to register and unregister a V4L2
  23 clock source: v4l2_clk_register() and v4l2_clk_unregister() and calls to control
  24 a clock object, similar to the respective generic clock API calls:
  25 v4l2_clk_get(), v4l2_clk_put(), v4l2_clk_enable(), v4l2_clk_disable(),
  26 v4l2_clk_get_rate(), and v4l2_clk_set_rate(). Clock suppliers have to provide
  27 clock operations that will be called when clock users invoke respective API
  28 methods.
  29
  30 It is expected that once the CCF becomes available on all relevant
  31 architectures this API will be removed.