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