media: Documentation: fix several typos
Use codespell to fix lots of typos over frontends. Manually verified to avoid false-positives. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Philipp Zabel <p.zabel@pengutronix.de> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>hifive-unleashed-5.1
parent
2f8ee0dd84
commit
adf48e3f1f
|
@ -125,7 +125,7 @@ https://linuxtv.org/wiki/index.php/DVB_USB
|
||||||
|
|
||||||
2004-12-26
|
2004-12-26
|
||||||
|
|
||||||
- refactored the dibusb-driver, splitted into separate files
|
- refactored the dibusb-driver, split into separate files
|
||||||
- i2c-probing enabled
|
- i2c-probing enabled
|
||||||
|
|
||||||
2004-12-06
|
2004-12-06
|
||||||
|
|
|
@ -12,7 +12,7 @@ Digital TV devices are implemented by several different drivers:
|
||||||
- Frontend drivers that are usually implemented as two separate drivers:
|
- Frontend drivers that are usually implemented as two separate drivers:
|
||||||
|
|
||||||
- A tuner driver that implements the logic with commands the part of the
|
- A tuner driver that implements the logic with commands the part of the
|
||||||
hardware with is reponsible to tune into a digital TV transponder or
|
hardware with is responsible to tune into a digital TV transponder or
|
||||||
physical channel. The output of a tuner is usually a baseband or
|
physical channel. The output of a tuner is usually a baseband or
|
||||||
Intermediate Frequency (IF) signal;
|
Intermediate Frequency (IF) signal;
|
||||||
|
|
||||||
|
|
|
@ -328,7 +328,7 @@ Statistics collect
|
||||||
|
|
||||||
On almost all frontend hardware, the bit and byte counts are stored by
|
On almost all frontend hardware, the bit and byte counts are stored by
|
||||||
the hardware after a certain amount of time or after the total bit/block
|
the hardware after a certain amount of time or after the total bit/block
|
||||||
counter reaches a certain value (usually programable), for example, on
|
counter reaches a certain value (usually programmable), for example, on
|
||||||
every 1000 ms or after receiving 1,000,000 bits.
|
every 1000 ms or after receiving 1,000,000 bits.
|
||||||
|
|
||||||
So, if you read the registers too soon, you'll end by reading the same
|
So, if you read the registers too soon, you'll end by reading the same
|
||||||
|
|
|
@ -60,7 +60,7 @@ Drivers initialize entity pads by calling
|
||||||
|
|
||||||
Drivers register entities with a media device by calling
|
Drivers register entities with a media device by calling
|
||||||
:c:func:`media_device_register_entity()`
|
:c:func:`media_device_register_entity()`
|
||||||
and unregistred by calling
|
and unregistered by calling
|
||||||
:c:func:`media_device_unregister_entity()`.
|
:c:func:`media_device_unregister_entity()`.
|
||||||
|
|
||||||
Interfaces
|
Interfaces
|
||||||
|
|
|
@ -93,7 +93,7 @@ You can iterate over all registered devices as follows:
|
||||||
int err;
|
int err;
|
||||||
|
|
||||||
/* Find driver 'ivtv' on the PCI bus.
|
/* Find driver 'ivtv' on the PCI bus.
|
||||||
pci_bus_type is a global. For USB busses use usb_bus_type. */
|
pci_bus_type is a global. For USB buses use usb_bus_type. */
|
||||||
drv = driver_find("ivtv", &pci_bus_type);
|
drv = driver_find("ivtv", &pci_bus_type);
|
||||||
/* iterate over all ivtv device instances */
|
/* iterate over all ivtv device instances */
|
||||||
err = driver_for_each_device(drv, NULL, p, callback);
|
err = driver_for_each_device(drv, NULL, p, callback);
|
||||||
|
|
|
@ -11,7 +11,7 @@ hardware: most devices have multiple ICs, export multiple device nodes in
|
||||||
Especially the fact that V4L2 drivers have to setup supporting ICs to
|
Especially the fact that V4L2 drivers have to setup supporting ICs to
|
||||||
do audio/video muxing/encoding/decoding makes it more complex than most.
|
do audio/video muxing/encoding/decoding makes it more complex than most.
|
||||||
Usually these ICs are connected to the main bridge driver through one or
|
Usually these ICs are connected to the main bridge driver through one or
|
||||||
more I2C busses, but other busses can also be used. Such devices are
|
more I2C buses, but other buses can also be used. Such devices are
|
||||||
called 'sub-devices'.
|
called 'sub-devices'.
|
||||||
|
|
||||||
For a long time the framework was limited to the video_device struct for
|
For a long time the framework was limited to the video_device struct for
|
||||||
|
|
|
@ -23,7 +23,7 @@ device data.
|
||||||
|
|
||||||
You also need a way to go from the low-level struct to :c:type:`v4l2_subdev`.
|
You also need a way to go from the low-level struct to :c:type:`v4l2_subdev`.
|
||||||
For the common i2c_client struct the i2c_set_clientdata() call is used to store
|
For the common i2c_client struct the i2c_set_clientdata() call is used to store
|
||||||
a :c:type:`v4l2_subdev` pointer, for other busses you may have to use other
|
a :c:type:`v4l2_subdev` pointer, for other buses you may have to use other
|
||||||
methods.
|
methods.
|
||||||
|
|
||||||
Bridges might also need to store per-subdev private data, such as a pointer to
|
Bridges might also need to store per-subdev private data, such as a pointer to
|
||||||
|
@ -33,7 +33,7 @@ provides host private data for that purpose that can be accessed with
|
||||||
|
|
||||||
From the bridge driver perspective, you load the sub-device module and somehow
|
From the bridge driver perspective, you load the sub-device module and somehow
|
||||||
obtain the :c:type:`v4l2_subdev` pointer. For i2c devices this is easy: you call
|
obtain the :c:type:`v4l2_subdev` pointer. For i2c devices this is easy: you call
|
||||||
``i2c_get_clientdata()``. For other busses something similar needs to be done.
|
``i2c_get_clientdata()``. For other buses something similar needs to be done.
|
||||||
Helper functions exists for sub-devices on an I2C bus that do most of this
|
Helper functions exists for sub-devices on an I2C bus that do most of this
|
||||||
tricky work for you.
|
tricky work for you.
|
||||||
|
|
||||||
|
|
|
@ -57,7 +57,7 @@ Description
|
||||||
|
|
||||||
This ioctl call asks the Audio Device to bypass the Audio decoder and
|
This ioctl call asks the Audio Device to bypass the Audio decoder and
|
||||||
forward the stream without decoding. This mode shall be used if streams
|
forward the stream without decoding. This mode shall be used if streams
|
||||||
that can’t be handled by the Digial TV system shall be decoded. Dolby
|
that can’t be handled by the Digital TV system shall be decoded. Dolby
|
||||||
DigitalTM streams are automatically forwarded by the Digital TV subsystem if
|
DigitalTM streams are automatically forwarded by the Digital TV subsystem if
|
||||||
the hardware can handle it.
|
the hardware can handle it.
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
CA_SET_DESCR is used for feeding descrambler CA slots with descrambling
|
CA_SET_DESCR is used for feeding descrambler CA slots with descrambling
|
||||||
keys (refered as control words).
|
keys (referred as control words).
|
||||||
|
|
||||||
Return Value
|
Return Value
|
||||||
------------
|
------------
|
||||||
|
|
|
@ -61,7 +61,7 @@ the device is closed.
|
||||||
|
|
||||||
Applications call the ``DMX_DQBUF`` ioctl to dequeue a filled
|
Applications call the ``DMX_DQBUF`` ioctl to dequeue a filled
|
||||||
(capturing) buffer from the driver's outgoing queue.
|
(capturing) buffer from the driver's outgoing queue.
|
||||||
They just set the ``index`` field withe the buffer ID to be queued.
|
They just set the ``index`` field with the buffer ID to be queued.
|
||||||
When ``DMX_DQBUF`` is called with a pointer to struct :c:type:`dmx_buffer`,
|
When ``DMX_DQBUF`` is called with a pointer to struct :c:type:`dmx_buffer`,
|
||||||
the driver fills the remaining fields or returns an error code.
|
the driver fills the remaining fields or returns an error code.
|
||||||
|
|
||||||
|
|
|
@ -44,7 +44,7 @@ with supports all digital TV delivery systems.
|
||||||
struct :c:type:`dvb_frontend_parameters`.
|
struct :c:type:`dvb_frontend_parameters`.
|
||||||
|
|
||||||
2. Don't use DVB API version 3 calls on hardware with supports
|
2. Don't use DVB API version 3 calls on hardware with supports
|
||||||
newer standards. Such API provides no suport or a very limited
|
newer standards. Such API provides no support or a very limited
|
||||||
support to new standards and/or new hardware.
|
support to new standards and/or new hardware.
|
||||||
|
|
||||||
3. Nowadays, most frontends support multiple delivery systems.
|
3. Nowadays, most frontends support multiple delivery systems.
|
||||||
|
|
|
@ -202,7 +202,7 @@ If video_blank is set video will be blanked out if the channel is
|
||||||
changed or if playback is stopped. Otherwise, the last picture will be
|
changed or if playback is stopped. Otherwise, the last picture will be
|
||||||
displayed. play_state indicates if the video is currently frozen,
|
displayed. play_state indicates if the video is currently frozen,
|
||||||
stopped, or being played back. The stream_source corresponds to the
|
stopped, or being played back. The stream_source corresponds to the
|
||||||
seleted source for the video stream. It can come either from the
|
selected source for the video stream. It can come either from the
|
||||||
demultiplexer or from memory. The video_format indicates the aspect
|
demultiplexer or from memory. The video_format indicates the aspect
|
||||||
ratio (one of 4:3 or 16:9) of the currently played video stream.
|
ratio (one of 4:3 or 16:9) of the currently played video stream.
|
||||||
Finally, display_format corresponds to the selected cropping mode in
|
Finally, display_format corresponds to the selected cropping mode in
|
||||||
|
|
|
@ -363,7 +363,7 @@ various documents with a single copy that is included in the collection,
|
||||||
provided that you follow the rules of this License for verbatim copying
|
provided that you follow the rules of this License for verbatim copying
|
||||||
of each of the documents in all other respects.
|
of each of the documents in all other respects.
|
||||||
|
|
||||||
You may extract a single document from such a collection, and dispbibute
|
You may extract a single document from such a collection, and distribute
|
||||||
it individually under this License, provided you insert a copy of this
|
it individually under this License, provided you insert a copy of this
|
||||||
License into the extracted document, and follow this License in all
|
License into the extracted document, and follow this License in all
|
||||||
other respects regarding verbatim copying of that document.
|
other respects regarding verbatim copying of that document.
|
||||||
|
|
|
@ -164,7 +164,7 @@ Types and flags used to represent the media graph elements
|
||||||
|
|
||||||
* - ``MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV``
|
* - ``MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV``
|
||||||
- Video pixel encoding converter. An entity capable of pixel
|
- Video pixel encoding converter. An entity capable of pixel
|
||||||
enconding conversion must have at least one sink pad and one
|
encoding conversion must have at least one sink pad and one
|
||||||
source pad, and convert the encoding of pixels received on
|
source pad, and convert the encoding of pixels received on
|
||||||
its sink pad(s) to a different encoding output on its source
|
its sink pad(s) to a different encoding output on its source
|
||||||
pad(s). Pixel encoding conversion includes but isn't limited
|
pad(s). Pixel encoding conversion includes but isn't limited
|
||||||
|
|
|
@ -385,7 +385,7 @@ the remote via /dev/input/event devices.
|
||||||
|
|
||||||
- ``KEY_CHANNELDOWN``
|
- ``KEY_CHANNELDOWN``
|
||||||
|
|
||||||
- Decrease channel sequencially
|
- Decrease channel sequentially
|
||||||
|
|
||||||
- CHANNEL - / CHANNEL DOWN / DOWN
|
- CHANNEL - / CHANNEL DOWN / DOWN
|
||||||
|
|
||||||
|
@ -393,7 +393,7 @@ the remote via /dev/input/event devices.
|
||||||
|
|
||||||
- ``KEY_CHANNELUP``
|
- ``KEY_CHANNELUP``
|
||||||
|
|
||||||
- Increase channel sequencially
|
- Increase channel sequentially
|
||||||
|
|
||||||
- CHANNEL + / CHANNEL UP / UP
|
- CHANNEL + / CHANNEL UP / UP
|
||||||
|
|
||||||
|
|
|
@ -499,7 +499,7 @@ Example: Changing controls
|
||||||
.. [#f1]
|
.. [#f1]
|
||||||
The use of ``V4L2_CID_PRIVATE_BASE`` is problematic because different
|
The use of ``V4L2_CID_PRIVATE_BASE`` is problematic because different
|
||||||
drivers may use the same ``V4L2_CID_PRIVATE_BASE`` ID for different
|
drivers may use the same ``V4L2_CID_PRIVATE_BASE`` ID for different
|
||||||
controls. This makes it hard to programatically set such controls
|
controls. This makes it hard to programmatically set such controls
|
||||||
since the meaning of the control with that ID is driver dependent. In
|
since the meaning of the control with that ID is driver dependent. In
|
||||||
order to resolve this drivers use unique IDs and the
|
order to resolve this drivers use unique IDs and the
|
||||||
``V4L2_CID_PRIVATE_BASE`` IDs are mapped to those unique IDs by the
|
``V4L2_CID_PRIVATE_BASE`` IDs are mapped to those unique IDs by the
|
||||||
|
|
|
@ -1562,7 +1562,7 @@ MFC 5.1 Control IDs
|
||||||
Display delay value for H264 decoder. The decoder is forced to
|
Display delay value for H264 decoder. The decoder is forced to
|
||||||
return a decoded frame after the set 'display delay' number of
|
return a decoded frame after the set 'display delay' number of
|
||||||
frames. If this number is low it may result in frames returned out
|
frames. If this number is low it may result in frames returned out
|
||||||
of dispaly order, in addition the hardware may still be using the
|
of display order, in addition the hardware may still be using the
|
||||||
returned buffer as a reference picture for subsequent frames.
|
returned buffer as a reference picture for subsequent frames.
|
||||||
|
|
||||||
``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)``
|
``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)``
|
||||||
|
|
|
@ -75,15 +75,15 @@ Media Bus Pixel Codes
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
The media bus pixel codes describe image formats as flowing over
|
The media bus pixel codes describe image formats as flowing over
|
||||||
physical busses (both between separate physical components and inside
|
physical buses (both between separate physical components and inside
|
||||||
SoC devices). This should not be confused with the V4L2 pixel formats
|
SoC devices). This should not be confused with the V4L2 pixel formats
|
||||||
that describe, using four character codes, image formats as stored in
|
that describe, using four character codes, image formats as stored in
|
||||||
memory.
|
memory.
|
||||||
|
|
||||||
While there is a relationship between image formats on busses and image
|
While there is a relationship between image formats on buses and image
|
||||||
formats in memory (a raw Bayer image won't be magically converted to
|
formats in memory (a raw Bayer image won't be magically converted to
|
||||||
JPEG just by storing it to memory), there is no one-to-one
|
JPEG just by storing it to memory), there is no one-to-one
|
||||||
correspondance between them.
|
correspondence between them.
|
||||||
|
|
||||||
|
|
||||||
Packed RGB Formats
|
Packed RGB Formats
|
||||||
|
|
|
@ -213,7 +213,7 @@ union holding separate parameters for input and output devices.
|
||||||
|
|
||||||
.. _parm-caps:
|
.. _parm-caps:
|
||||||
|
|
||||||
.. flat-table:: Streaming Parameters Capabilites
|
.. flat-table:: Streaming Parameters Capabilities
|
||||||
:header-rows: 0
|
:header-rows: 0
|
||||||
:stub-columns: 0
|
:stub-columns: 0
|
||||||
:widths: 3 1 4
|
:widths: 3 1 4
|
||||||
|
|
|
@ -85,7 +85,7 @@ same card listens there is much higher...
|
||||||
For problems with sound: There are a lot of different systems used
|
For problems with sound: There are a lot of different systems used
|
||||||
for TV sound all over the world. And there are also different chips
|
for TV sound all over the world. And there are also different chips
|
||||||
which decode the audio signal. Reports about sound problems ("stereo
|
which decode the audio signal. Reports about sound problems ("stereo
|
||||||
does'nt work") are pretty useless unless you include some details
|
doesn't work") are pretty useless unless you include some details
|
||||||
about your hardware and the TV sound scheme used in your country (or
|
about your hardware and the TV sound scheme used in your country (or
|
||||||
at least the country you are living in).
|
at least the country you are living in).
|
||||||
|
|
||||||
|
@ -771,7 +771,7 @@ Identifying:
|
||||||
- Lifeview.com.tw states (Feb. 2002):
|
- Lifeview.com.tw states (Feb. 2002):
|
||||||
"The FlyVideo2000 and FlyVideo2000s product name have renamed to FlyVideo98."
|
"The FlyVideo2000 and FlyVideo2000s product name have renamed to FlyVideo98."
|
||||||
Their Bt8x8 cards are listed as discontinued.
|
Their Bt8x8 cards are listed as discontinued.
|
||||||
- Flyvideo 2000S was probably sold as Flyvideo 3000 in some contries(Europe?).
|
- Flyvideo 2000S was probably sold as Flyvideo 3000 in some countries(Europe?).
|
||||||
The new Flyvideo 2000/3000 are SAA7130/SAA7134 based.
|
The new Flyvideo 2000/3000 are SAA7130/SAA7134 based.
|
||||||
|
|
||||||
"Flyvideo II" had been the name for the 848 cards, nowadays (in Germany)
|
"Flyvideo II" had been the name for the 848 cards, nowadays (in Germany)
|
||||||
|
|
|
@ -29,7 +29,7 @@ de-interlacing by interweaving even and odd lines during transfer
|
||||||
(without motion compensation which requires the VDIC).
|
(without motion compensation which requires the VDIC).
|
||||||
|
|
||||||
The CSI is the backend capture unit that interfaces directly with
|
The CSI is the backend capture unit that interfaces directly with
|
||||||
camera sensors over Parallel, BT.656/1120, and MIPI CSI-2 busses.
|
camera sensors over Parallel, BT.656/1120, and MIPI CSI-2 buses.
|
||||||
|
|
||||||
The IC handles color-space conversion, resizing (downscaling and
|
The IC handles color-space conversion, resizing (downscaling and
|
||||||
upscaling), horizontal flip, and 90/270 degree rotation operations.
|
upscaling), horizontal flip, and 90/270 degree rotation operations.
|
||||||
|
@ -207,7 +207,7 @@ The CSI supports cropping the incoming raw sensor frames. This is
|
||||||
implemented in the ipuX_csiY entities at the sink pad, using the
|
implemented in the ipuX_csiY entities at the sink pad, using the
|
||||||
crop selection subdev API.
|
crop selection subdev API.
|
||||||
|
|
||||||
The CSI also supports fixed divide-by-two downscaling indepently in
|
The CSI also supports fixed divide-by-two downscaling independently in
|
||||||
width and height. This is implemented in the ipuX_csiY entities at
|
width and height. This is implemented in the ipuX_csiY entities at
|
||||||
the sink pad, using the compose selection subdev API.
|
the sink pad, using the compose selection subdev API.
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ Global video workflow
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
a) QCI stopped
|
a) QCI stopped
|
||||||
Initialy, the QCI interface is stopped.
|
Initially, the QCI interface is stopped.
|
||||||
When a buffer is queued (pxa_videobuf_ops->buf_queue), the QCI starts.
|
When a buffer is queued (pxa_videobuf_ops->buf_queue), the QCI starts.
|
||||||
|
|
||||||
b) QCI started
|
b) QCI started
|
||||||
|
|
|
@ -123,7 +123,7 @@ The considerations to split the driver in this particular way are as follows:
|
||||||
- representing CSIPHY and CSID modules by a separate sub-device for each module
|
- representing CSIPHY and CSID modules by a separate sub-device for each module
|
||||||
allows to model the hardware links between these modules;
|
allows to model the hardware links between these modules;
|
||||||
- representing VFE by a separate sub-devices for each input interface allows
|
- representing VFE by a separate sub-devices for each input interface allows
|
||||||
to use the input interfaces concurently and independently as this is
|
to use the input interfaces concurrently and independently as this is
|
||||||
supported by the hardware;
|
supported by the hardware;
|
||||||
- representing ISPIF by a number of sub-devices equal to the number of CSID
|
- representing ISPIF by a number of sub-devices equal to the number of CSID
|
||||||
sub-devices allows to create linear media controller pipelines when using two
|
sub-devices allows to create linear media controller pipelines when using two
|
||||||
|
|
Loading…
Reference in New Issue