xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/v4l/v4l2-selection-flags.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun.. _v4l2-selection-flags:
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun***************
6*4882a593SmuzhiyunSelection flags
7*4882a593Smuzhiyun***************
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun.. tabularcolumns:: |p{5.2cm}|p{2.0cm}|p{6.5cm}|p{1.2cm}|p{1.6cm}|
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun.. _v4l2-selection-flags-table:
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun.. flat-table:: Selection flag definitions
14*4882a593Smuzhiyun    :header-rows:  1
15*4882a593Smuzhiyun    :stub-columns: 0
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun    * - Flag name
18*4882a593Smuzhiyun      - id
19*4882a593Smuzhiyun      - Definition
20*4882a593Smuzhiyun      - Valid for V4L2
21*4882a593Smuzhiyun      - Valid for V4L2 subdev
22*4882a593Smuzhiyun    * - ``V4L2_SEL_FLAG_GE``
23*4882a593Smuzhiyun      - (1 << 0)
24*4882a593Smuzhiyun      - Suggest the driver it should choose greater or equal rectangle (in
25*4882a593Smuzhiyun	size) than was requested. Albeit the driver may choose a lesser
26*4882a593Smuzhiyun	size, it will only do so due to hardware limitations. Without this
27*4882a593Smuzhiyun	flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
28*4882a593Smuzhiyun	closest possible rectangle.
29*4882a593Smuzhiyun      - Yes
30*4882a593Smuzhiyun      - Yes
31*4882a593Smuzhiyun    * - ``V4L2_SEL_FLAG_LE``
32*4882a593Smuzhiyun      - (1 << 1)
33*4882a593Smuzhiyun      - Suggest the driver it should choose lesser or equal rectangle (in
34*4882a593Smuzhiyun	size) than was requested. Albeit the driver may choose a greater
35*4882a593Smuzhiyun	size, it will only do so due to hardware limitations.
36*4882a593Smuzhiyun      - Yes
37*4882a593Smuzhiyun      - Yes
38*4882a593Smuzhiyun    * - ``V4L2_SEL_FLAG_KEEP_CONFIG``
39*4882a593Smuzhiyun      - (1 << 2)
40*4882a593Smuzhiyun      - The configuration must not be propagated to any further processing
41*4882a593Smuzhiyun	steps. If this flag is not given, the configuration is propagated
42*4882a593Smuzhiyun	inside the subdevice to all further processing steps.
43*4882a593Smuzhiyun      - No
44*4882a593Smuzhiyun      - Yes
45