mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-23 12:43:55 +08:00
c2b66cafdf
Shorten the tables by removing row numbers in comments, allowing for
later insertion of rows with minimal diffs.
All changes have been generated by the following script.
import io
import re
import sys
def process_table(fname, data):
if fname.endswith('hist-v4l2.rst'):
data = re.sub(u'\n{1,2}\t( ?) -( ?) ?', u'\n\t\\1 -\\2', data, flags = re.MULTILINE)
data = re.sub(u'\n(\t| )- \.\. row [0-9]+\n\t ?-( ?) ?', u'\\1* -\\2', data, flags = re.MULTILINE)
else:
data = re.sub(u'\n{1,2} -( ?) ?', u'\n -\\1', data, flags = re.MULTILINE)
data = re.sub(u'(\n?)(\n\n - \.\. row 1\n)', u'\n\\2', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. row [0-9]+\n -( ?) ?', u' * -\\1', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. row [0-9]+\n \.\. (_[A-Z0-9_`-]*:)', u'\n - .. \\1', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. (_[A-Z0-9_`-]*:)\n -', u' * .. \\1\n\n -', data, flags = re.MULTILINE)
data = re.sub(u'^ - ', u' -', data, flags = re.MULTILINE)
data = re.sub(u'^(\t{1,2}) ', u'\\1', data, flags = re.MULTILINE)
return data
def process_file(fname, data):
buf = io.StringIO(data)
output = ''
in_table = False
table_separator = 0
for line in buf.readlines():
if line.find('.. flat-table::') != -1:
in_table = True
table = ''
elif in_table and not re.match('^[\t\n]|( )', line):
in_table = False
output += process_table(fname, table)
if in_table:
table += line
else:
output += line
if in_table:
in_table = False
output += process_table(fname, table)
return output
fname = sys.argv[1]
data = file(fname, 'rb').read().decode('utf-8')
data = process_file(fname, data)
file(fname, 'wb').write(data.encode('utf-8'))
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
118 lines
3.3 KiB
ReStructuredText
118 lines
3.3 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _VIDIOC_SUBDEV_G_SELECTION:
|
|
|
|
**********************************************************
|
|
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
|
|
**********************************************************
|
|
|
|
Name
|
|
====
|
|
|
|
VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
|
|
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_G_SELECTION, struct v4l2_subdev_selection *argp )
|
|
:name: VIDIOC_SUBDEV_G_SELECTION
|
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_S_SELECTION, struct v4l2_subdev_selection *argp )
|
|
:name: VIDIOC_SUBDEV_S_SELECTION
|
|
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by :ref:`open() <func-open>`.
|
|
|
|
``argp``
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
The selections are used to configure various image processing
|
|
functionality performed by the subdevs which affect the image size. This
|
|
currently includes cropping, scaling and composition.
|
|
|
|
The selection API replaces
|
|
:ref:`the old subdev crop API <VIDIOC_SUBDEV_G_CROP>`. All the
|
|
function of the crop API, and more, are supported by the selections API.
|
|
|
|
See :ref:`subdev` for more information on how each selection target
|
|
affects the image processing pipeline inside the subdevice.
|
|
|
|
|
|
Types of selection targets
|
|
--------------------------
|
|
|
|
There are two types of selection targets: actual and bounds. The actual
|
|
targets are the targets which configure the hardware. The BOUNDS target
|
|
will return a rectangle that contain all possible actual rectangles.
|
|
|
|
|
|
Discovering supported features
|
|
------------------------------
|
|
|
|
To discover which targets are supported, the user can perform
|
|
``VIDIOC_SUBDEV_G_SELECTION`` on them. Any unsupported target will
|
|
return ``EINVAL``.
|
|
|
|
Selection targets and flags are documented in
|
|
:ref:`v4l2-selections-common`.
|
|
|
|
|
|
.. c:type:: v4l2_subdev_selection
|
|
|
|
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
|
|
|
|
.. flat-table:: struct v4l2_subdev_selection
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 1 1 2
|
|
|
|
* - __u32
|
|
- ``which``
|
|
- Active or try selection, from enum
|
|
:ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
|
|
* - __u32
|
|
- ``pad``
|
|
- Pad number as reported by the media framework.
|
|
* - __u32
|
|
- ``target``
|
|
- Target selection rectangle. See :ref:`v4l2-selections-common`.
|
|
* - __u32
|
|
- ``flags``
|
|
- Flags. See :ref:`v4l2-selection-flags`.
|
|
* - struct :c:type:`v4l2_rect`
|
|
- ``r``
|
|
- Selection rectangle, in pixels.
|
|
* - __u32
|
|
- ``reserved``\ [8]
|
|
- Reserved for future extensions. Applications and drivers must set
|
|
the array to zero.
|
|
|
|
|
|
Return Value
|
|
============
|
|
|
|
On success 0 is returned, on error -1 and the ``errno`` variable is set
|
|
appropriately. The generic error codes are described at the
|
|
:ref:`Generic Error Codes <gen-errors>` chapter.
|
|
|
|
EBUSY
|
|
The selection rectangle can't be changed because the pad is
|
|
currently busy. This can be caused, for instance, by an active video
|
|
stream on the pad. The ioctl must not be retried without performing
|
|
another action to fix the problem first. Only returned by
|
|
``VIDIOC_SUBDEV_S_SELECTION``
|
|
|
|
EINVAL
|
|
The struct :c:type:`v4l2_subdev_selection`
|
|
``pad`` references a non-existing pad, the ``which`` field
|
|
references a non-existing format, or the selection target is not
|
|
supported on the given subdev pad.
|