xref: /openbmc/linux/Documentation/userspace-api/media/v4l/v4l2-selection-flags.rst (revision 8be98d2f2a0a262f8bf8a0bc1fdf522b3c7aab17)
1059b1c5bSMauro Carvalho Chehab.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
254f38fcaSMauro Carvalho Chehab
354f38fcaSMauro Carvalho Chehab.. _v4l2-selection-flags:
454f38fcaSMauro Carvalho Chehab
554f38fcaSMauro Carvalho Chehab***************
654f38fcaSMauro Carvalho ChehabSelection flags
754f38fcaSMauro Carvalho Chehab***************
854f38fcaSMauro Carvalho Chehab
954f38fcaSMauro Carvalho Chehab.. _v4l2-selection-flags-table:
1054f38fcaSMauro Carvalho Chehab
11*fea13a69SMauro Carvalho Chehab.. raw:: latex
12*fea13a69SMauro Carvalho Chehab
13*fea13a69SMauro Carvalho Chehab   \small
14*fea13a69SMauro Carvalho Chehab
15*fea13a69SMauro Carvalho Chehab.. tabularcolumns:: |p{5.6cm}|p{2.0cm}|p{6.5cm}|p{1.2cm}|p{1.2cm}|
16*fea13a69SMauro Carvalho Chehab
17*fea13a69SMauro Carvalho Chehab.. cssclass:: longtable
18*fea13a69SMauro Carvalho Chehab
1954f38fcaSMauro Carvalho Chehab.. flat-table:: Selection flag definitions
2054f38fcaSMauro Carvalho Chehab    :header-rows:  1
2154f38fcaSMauro Carvalho Chehab    :stub-columns: 0
2254f38fcaSMauro Carvalho Chehab
2354f38fcaSMauro Carvalho Chehab    * - Flag name
2454f38fcaSMauro Carvalho Chehab      - id
2554f38fcaSMauro Carvalho Chehab      - Definition
2654f38fcaSMauro Carvalho Chehab      - Valid for V4L2
2754f38fcaSMauro Carvalho Chehab      - Valid for V4L2 subdev
2854f38fcaSMauro Carvalho Chehab    * - ``V4L2_SEL_FLAG_GE``
2954f38fcaSMauro Carvalho Chehab      - (1 << 0)
3054f38fcaSMauro Carvalho Chehab      - Suggest the driver it should choose greater or equal rectangle (in
3154f38fcaSMauro Carvalho Chehab	size) than was requested. Albeit the driver may choose a lesser
3254f38fcaSMauro Carvalho Chehab	size, it will only do so due to hardware limitations. Without this
3354f38fcaSMauro Carvalho Chehab	flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
3454f38fcaSMauro Carvalho Chehab	closest possible rectangle.
3554f38fcaSMauro Carvalho Chehab      - Yes
3654f38fcaSMauro Carvalho Chehab      - Yes
3754f38fcaSMauro Carvalho Chehab    * - ``V4L2_SEL_FLAG_LE``
3854f38fcaSMauro Carvalho Chehab      - (1 << 1)
3954f38fcaSMauro Carvalho Chehab      - Suggest the driver it should choose lesser or equal rectangle (in
4054f38fcaSMauro Carvalho Chehab	size) than was requested. Albeit the driver may choose a greater
4154f38fcaSMauro Carvalho Chehab	size, it will only do so due to hardware limitations.
4254f38fcaSMauro Carvalho Chehab      - Yes
4354f38fcaSMauro Carvalho Chehab      - Yes
4454f38fcaSMauro Carvalho Chehab    * - ``V4L2_SEL_FLAG_KEEP_CONFIG``
4554f38fcaSMauro Carvalho Chehab      - (1 << 2)
4654f38fcaSMauro Carvalho Chehab      - The configuration must not be propagated to any further processing
4754f38fcaSMauro Carvalho Chehab	steps. If this flag is not given, the configuration is propagated
4854f38fcaSMauro Carvalho Chehab	inside the subdevice to all further processing steps.
4954f38fcaSMauro Carvalho Chehab      - No
5054f38fcaSMauro Carvalho Chehab      - Yes
51*fea13a69SMauro Carvalho Chehab
52*fea13a69SMauro Carvalho Chehab.. raw:: latex
53*fea13a69SMauro Carvalho Chehab
54*fea13a69SMauro Carvalho Chehab   \normalsize
55