Merge tag 'armsoc-defconfig' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[linux-2.6-microblaze.git] / Documentation / userspace-api / media / v4l / pixfmt-meta-rkisp1.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 .. _v4l2-meta-fmt-params-rkisp1:
4 .. _v4l2-meta-fmt-stat-rkisp1:
5
6 *****************************************************************************
7 V4L2_META_FMT_RK_ISP1_PARAMS ('rk1p'), V4L2_META_FMT_RK_ISP1_STAT_3A ('rk1s')
8 *****************************************************************************
9
10 Configuration parameters
11 ========================
12
13 The configuration parameters are passed to the
14 :ref:`rkisp1_params <rkisp1_params>` metadata output video node, using
15 the :c:type:`v4l2_meta_format` interface. The buffer contains
16 a single instance of the C structure :c:type:`rkisp1_params_cfg` defined in
17 ``rkisp1-config.h``. So the structure can be obtained from the buffer by:
18
19 .. code-block:: c
20
21         struct rkisp1_params_cfg *params = (struct rkisp1_params_cfg*) buffer;
22
23 .. rkisp1_stat_buffer
24
25 3A and histogram statistics
26 ===========================
27
28 The ISP1 device collects different statistics over an input Bayer frame.
29 Those statistics are obtained from the :ref:`rkisp1_stats <rkisp1_stats>`
30 metadata capture video node,
31 using the :c:type:`v4l2_meta_format` interface. The buffer contains a single
32 instance of the C structure :c:type:`rkisp1_stat_buffer` defined in
33 ``rkisp1-config.h``. So the structure can be obtained from the buffer by:
34
35 .. code-block:: c
36
37         struct rkisp1_stat_buffer *stats = (struct rkisp1_stat_buffer*) buffer;
38
39 The statistics collected are Exposure, AWB (Auto-white balance), Histogram and
40 AF (Auto-focus). See :c:type:`rkisp1_stat_buffer` for details of the statistics.
41
42 The 3A statistics and configuration parameters described here are usually
43 consumed and produced by dedicated user space libraries that comprise the
44 important tuning tools using software control loop.
45
46 rkisp1 uAPI data types
47 ======================
48
49 .. kernel-doc:: drivers/staging/media/rkisp1/uapi/rkisp1-config.h