mirror of
https://github.com/AuxXxilium/linux_dsm_epyc7002.git
synced 2024-12-26 15:05:24 +07: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>
108 lines
3.7 KiB
ReStructuredText
108 lines
3.7 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _sdr:
|
|
|
|
**************************************
|
|
Software Defined Radio Interface (SDR)
|
|
**************************************
|
|
|
|
SDR is an abbreviation of Software Defined Radio, the radio device which
|
|
uses application software for modulation or demodulation. This interface
|
|
is intended for controlling and data streaming of such devices.
|
|
|
|
SDR devices are accessed through character device special files named
|
|
``/dev/swradio0`` to ``/dev/swradio255`` with major number 81 and
|
|
dynamically allocated minor numbers 0 to 255.
|
|
|
|
|
|
Querying Capabilities
|
|
=====================
|
|
|
|
Devices supporting the SDR receiver interface set the
|
|
``V4L2_CAP_SDR_CAPTURE`` and ``V4L2_CAP_TUNER`` flag in the
|
|
``capabilities`` field of struct
|
|
:c:type:`v4l2_capability` returned by the
|
|
:ref:`VIDIOC_QUERYCAP` ioctl. That flag means the
|
|
device has an Analog to Digital Converter (ADC), which is a mandatory
|
|
element for the SDR receiver.
|
|
|
|
Devices supporting the SDR transmitter interface set the
|
|
``V4L2_CAP_SDR_OUTPUT`` and ``V4L2_CAP_MODULATOR`` flag in the
|
|
``capabilities`` field of struct
|
|
:c:type:`v4l2_capability` returned by the
|
|
:ref:`VIDIOC_QUERYCAP` ioctl. That flag means the
|
|
device has an Digital to Analog Converter (DAC), which is a mandatory
|
|
element for the SDR transmitter.
|
|
|
|
At least one of the read/write, streaming or asynchronous I/O methods
|
|
must be supported.
|
|
|
|
|
|
Supplemental Functions
|
|
======================
|
|
|
|
SDR devices can support :ref:`controls <control>`, and must support
|
|
the :ref:`tuner` ioctls. Tuner ioctls are used for setting the
|
|
ADC/DAC sampling rate (sampling frequency) and the possible radio
|
|
frequency (RF).
|
|
|
|
The ``V4L2_TUNER_SDR`` tuner type is used for setting SDR device ADC/DAC
|
|
frequency, and the ``V4L2_TUNER_RF`` tuner type is used for setting
|
|
radio frequency. The tuner index of the RF tuner (if any) must always
|
|
follow the SDR tuner index. Normally the SDR tuner is #0 and the RF
|
|
tuner is #1.
|
|
|
|
The :ref:`VIDIOC_S_HW_FREQ_SEEK` ioctl is
|
|
not supported.
|
|
|
|
|
|
Data Format Negotiation
|
|
=======================
|
|
|
|
The SDR device uses the :ref:`format` ioctls to select the
|
|
capture and output format. Both the sampling resolution and the data
|
|
streaming format are bound to that selectable format. In addition to the
|
|
basic :ref:`format` ioctls, the
|
|
:ref:`VIDIOC_ENUM_FMT` ioctl must be supported as
|
|
well.
|
|
|
|
To use the :ref:`format` ioctls applications set the ``type``
|
|
field of a struct :c:type:`v4l2_format` to
|
|
``V4L2_BUF_TYPE_SDR_CAPTURE`` or ``V4L2_BUF_TYPE_SDR_OUTPUT`` and use
|
|
the struct :c:type:`v4l2_sdr_format` ``sdr`` member
|
|
of the ``fmt`` union as needed per the desired operation. Currently
|
|
there is two fields, ``pixelformat`` and ``buffersize``, of struct
|
|
struct :c:type:`v4l2_sdr_format` which are used.
|
|
Content of the ``pixelformat`` is V4L2 FourCC code of the data format.
|
|
The ``buffersize`` field is maximum buffer size in bytes required for
|
|
data transfer, set by the driver in order to inform application.
|
|
|
|
|
|
.. c:type:: v4l2_sdr_format
|
|
|
|
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
|
|
|
|
.. flat-table:: struct v4l2_sdr_format
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 1 1 2
|
|
|
|
* - __u32
|
|
- ``pixelformat``
|
|
- The data format or type of compression, set by the application.
|
|
This is a little endian
|
|
:ref:`four character code <v4l2-fourcc>`. V4L2 defines SDR
|
|
formats in :ref:`sdr-formats`.
|
|
* - __u32
|
|
- ``buffersize``
|
|
- Maximum size in bytes required for data. Value is set by the
|
|
driver.
|
|
* - __u8
|
|
- ``reserved[24]``
|
|
- This array is reserved for future extensions. Drivers and
|
|
applications must set it to zero.
|
|
|
|
|
|
An SDR device may support :ref:`read/write <rw>` and/or streaming
|
|
(:ref:`memory mapping <mmap>` or :ref:`user pointer <userp>`) I/O.
|