media: uapi: v4l2-core: Add ISP statistics output V4L2 fourcc type
[platform/kernel/linux-rpi.git] / Documentation / userspace-api / media / v4l / pixfmt-meta-bcm2835-isp-stats.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _v4l2-meta-fmt-bcm2835-isp-stats:
11
12 *****************************************
13 V4L2_META_FMT_BCM2835_ISP_STATS  ('BSTA')
14 *****************************************
15
16 BCM2835 ISP Statistics
17
18 Description
19 ===========
20
21 The BCM2835 ISP hardware calculate image statistics for an input Bayer frame.
22 These statistics are obtained from the "bcm2835-isp0-capture3" device node
23 using the :c:type:`v4l2_meta_format` interface. They are formatted as described
24 by the :c:type:`bcm2835_isp_stats` structure below.
25
26 .. code-block:: c
27
28         #define DEFAULT_AWB_REGIONS_X 16
29         #define DEFAULT_AWB_REGIONS_Y 12
30
31         #define NUM_HISTOGRAMS 2
32         #define NUM_HISTOGRAM_BINS 128
33         #define AWB_REGIONS (DEFAULT_AWB_REGIONS_X * DEFAULT_AWB_REGIONS_Y)
34         #define FLOATING_REGIONS 16
35         #define AGC_REGIONS 16
36         #define FOCUS_REGIONS 12
37
38 .. kernel-doc:: include/uapi/linux/bcm2835-isp.h
39    :functions: bcm2835_isp_stats_hist bcm2835_isp_stats_region
40                      bcm2835_isp_stats_focus bcm2835_isp_stats
41